diff --git a/examples/1.9.x/client-android/java/account/create.md b/examples/1.9.x/client-android/java/account/create.md index 333b1f36f..9cf0a722c 100644 --- a/examples/1.9.x/client-android/java/account/create.md +++ b/examples/1.9.x/client-android/java/account/create.md @@ -12,7 +12,7 @@ Account account = new Account(client); account.create( "", // userId "email@example.com", // email - "", // password + "password", // password "", // name (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { diff --git a/examples/1.9.x/client-android/java/account/update-password.md b/examples/1.9.x/client-android/java/account/update-password.md index 075a869b1..9d07bdbbb 100644 --- a/examples/1.9.x/client-android/java/account/update-password.md +++ b/examples/1.9.x/client-android/java/account/update-password.md @@ -10,7 +10,7 @@ Client client = new Client(context) Account account = new Account(client); account.updatePassword( - "", // password + "password", // password "password", // oldPassword (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { diff --git a/examples/1.9.x/client-android/java/account/update-recovery.md b/examples/1.9.x/client-android/java/account/update-recovery.md index 2ea21c97b..ce60d60af 100644 --- a/examples/1.9.x/client-android/java/account/update-recovery.md +++ b/examples/1.9.x/client-android/java/account/update-recovery.md @@ -12,7 +12,7 @@ Account account = new Account(client); account.updateRecovery( "", // userId "", // secret - "", // password + "password", // password new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.9.x/client-android/java/avatars/get-browser.md b/examples/1.9.x/client-android/java/avatars/get-browser.md index f107aee61..e06252ca8 100644 --- a/examples/1.9.x/client-android/java/avatars/get-browser.md +++ b/examples/1.9.x/client-android/java/avatars/get-browser.md @@ -6,7 +6,8 @@ import io.appwrite.enums.Browser; Client client = new Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject(""); // Your project ID + .setProject("") // Your project ID + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/client-android/java/avatars/get-credit-card.md b/examples/1.9.x/client-android/java/avatars/get-credit-card.md index 40fb5660e..6b9165235 100644 --- a/examples/1.9.x/client-android/java/avatars/get-credit-card.md +++ b/examples/1.9.x/client-android/java/avatars/get-credit-card.md @@ -6,7 +6,8 @@ import io.appwrite.enums.CreditCard; Client client = new Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject(""); // Your project ID + .setProject("") // Your project ID + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/client-android/java/avatars/get-favicon.md b/examples/1.9.x/client-android/java/avatars/get-favicon.md index 3427b59d3..e4f9cbfe1 100644 --- a/examples/1.9.x/client-android/java/avatars/get-favicon.md +++ b/examples/1.9.x/client-android/java/avatars/get-favicon.md @@ -5,7 +5,8 @@ import io.appwrite.services.Avatars; Client client = new Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject(""); // Your project ID + .setProject("") // Your project ID + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/client-android/java/avatars/get-flag.md b/examples/1.9.x/client-android/java/avatars/get-flag.md index 812282ff7..f02c715ed 100644 --- a/examples/1.9.x/client-android/java/avatars/get-flag.md +++ b/examples/1.9.x/client-android/java/avatars/get-flag.md @@ -6,7 +6,8 @@ import io.appwrite.enums.Flag; Client client = new Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject(""); // Your project ID + .setProject("") // Your project ID + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/client-android/java/avatars/get-image.md b/examples/1.9.x/client-android/java/avatars/get-image.md index 1289ec1f6..b5f7786f7 100644 --- a/examples/1.9.x/client-android/java/avatars/get-image.md +++ b/examples/1.9.x/client-android/java/avatars/get-image.md @@ -5,7 +5,8 @@ import io.appwrite.services.Avatars; Client client = new Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject(""); // Your project ID + .setProject("") // Your project ID + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/client-android/java/avatars/get-initials.md b/examples/1.9.x/client-android/java/avatars/get-initials.md index 419ca5e5d..b4aeb0daa 100644 --- a/examples/1.9.x/client-android/java/avatars/get-initials.md +++ b/examples/1.9.x/client-android/java/avatars/get-initials.md @@ -5,7 +5,8 @@ import io.appwrite.services.Avatars; Client client = new Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject(""); // Your project ID + .setProject("") // Your project ID + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/client-android/java/avatars/get-qr.md b/examples/1.9.x/client-android/java/avatars/get-qr.md index be4d11c37..3e6d2a14f 100644 --- a/examples/1.9.x/client-android/java/avatars/get-qr.md +++ b/examples/1.9.x/client-android/java/avatars/get-qr.md @@ -5,7 +5,8 @@ import io.appwrite.services.Avatars; Client client = new Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject(""); // Your project ID + .setProject("") // Your project ID + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/client-android/java/avatars/get-screenshot.md b/examples/1.9.x/client-android/java/avatars/get-screenshot.md index c016ea5f6..f8ad8f152 100644 --- a/examples/1.9.x/client-android/java/avatars/get-screenshot.md +++ b/examples/1.9.x/client-android/java/avatars/get-screenshot.md @@ -9,7 +9,8 @@ import io.appwrite.enums.ImageFormat; Client client = new Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject(""); // Your project ID + .setProject("") // Your project ID + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/client-android/java/storage/get-file-download.md b/examples/1.9.x/client-android/java/storage/get-file-download.md index 91d91b7d0..be52602cc 100644 --- a/examples/1.9.x/client-android/java/storage/get-file-download.md +++ b/examples/1.9.x/client-android/java/storage/get-file-download.md @@ -5,7 +5,8 @@ import io.appwrite.services.Storage; Client client = new Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject(""); // Your project ID + .setProject("") // Your project ID + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = new Storage(client); diff --git a/examples/1.9.x/client-android/java/storage/get-file-preview.md b/examples/1.9.x/client-android/java/storage/get-file-preview.md index 9355dc68a..dac0f318b 100644 --- a/examples/1.9.x/client-android/java/storage/get-file-preview.md +++ b/examples/1.9.x/client-android/java/storage/get-file-preview.md @@ -7,7 +7,8 @@ import io.appwrite.enums.ImageFormat; Client client = new Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject(""); // Your project ID + .setProject("") // Your project ID + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = new Storage(client); diff --git a/examples/1.9.x/client-android/java/storage/get-file-view.md b/examples/1.9.x/client-android/java/storage/get-file-view.md index 66762c2b6..af3936dfc 100644 --- a/examples/1.9.x/client-android/java/storage/get-file-view.md +++ b/examples/1.9.x/client-android/java/storage/get-file-view.md @@ -5,7 +5,8 @@ import io.appwrite.services.Storage; Client client = new Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject(""); // Your project ID + .setProject("") // Your project ID + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = new Storage(client); diff --git a/examples/1.9.x/client-android/kotlin/account/create.md b/examples/1.9.x/client-android/kotlin/account/create.md index 9f80913a3..8e7f12c51 100644 --- a/examples/1.9.x/client-android/kotlin/account/create.md +++ b/examples/1.9.x/client-android/kotlin/account/create.md @@ -12,7 +12,7 @@ val account = Account(client) val result = account.create( userId = "", email = "email@example.com", - password = "", + password = "password", name = "", // (optional) ) ``` diff --git a/examples/1.9.x/client-android/kotlin/account/update-password.md b/examples/1.9.x/client-android/kotlin/account/update-password.md index ce9ae9049..1ec378a1a 100644 --- a/examples/1.9.x/client-android/kotlin/account/update-password.md +++ b/examples/1.9.x/client-android/kotlin/account/update-password.md @@ -10,7 +10,7 @@ val client = Client(context) val account = Account(client) val result = account.updatePassword( - password = "", + password = "password", oldPassword = "password", // (optional) ) ``` diff --git a/examples/1.9.x/client-android/kotlin/account/update-recovery.md b/examples/1.9.x/client-android/kotlin/account/update-recovery.md index 8e16074e3..c18262570 100644 --- a/examples/1.9.x/client-android/kotlin/account/update-recovery.md +++ b/examples/1.9.x/client-android/kotlin/account/update-recovery.md @@ -12,6 +12,6 @@ val account = Account(client) val result = account.updateRecovery( userId = "", secret = "", - password = "", + password = "password", ) ``` diff --git a/examples/1.9.x/client-android/kotlin/avatars/get-browser.md b/examples/1.9.x/client-android/kotlin/avatars/get-browser.md index 7c32ad2d9..b8828c291 100644 --- a/examples/1.9.x/client-android/kotlin/avatars/get-browser.md +++ b/examples/1.9.x/client-android/kotlin/avatars/get-browser.md @@ -7,6 +7,7 @@ import io.appwrite.enums.Browser val client = Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/client-android/kotlin/avatars/get-credit-card.md b/examples/1.9.x/client-android/kotlin/avatars/get-credit-card.md index 54244acc9..5d2910a14 100644 --- a/examples/1.9.x/client-android/kotlin/avatars/get-credit-card.md +++ b/examples/1.9.x/client-android/kotlin/avatars/get-credit-card.md @@ -7,6 +7,7 @@ import io.appwrite.enums.CreditCard val client = Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/client-android/kotlin/avatars/get-favicon.md b/examples/1.9.x/client-android/kotlin/avatars/get-favicon.md index d55a0b424..b8c409c3b 100644 --- a/examples/1.9.x/client-android/kotlin/avatars/get-favicon.md +++ b/examples/1.9.x/client-android/kotlin/avatars/get-favicon.md @@ -6,6 +6,7 @@ import io.appwrite.services.Avatars val client = Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/client-android/kotlin/avatars/get-flag.md b/examples/1.9.x/client-android/kotlin/avatars/get-flag.md index c03ccb3f9..0d994a35d 100644 --- a/examples/1.9.x/client-android/kotlin/avatars/get-flag.md +++ b/examples/1.9.x/client-android/kotlin/avatars/get-flag.md @@ -7,6 +7,7 @@ import io.appwrite.enums.Flag val client = Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/client-android/kotlin/avatars/get-image.md b/examples/1.9.x/client-android/kotlin/avatars/get-image.md index 4e22185de..9d4c9a683 100644 --- a/examples/1.9.x/client-android/kotlin/avatars/get-image.md +++ b/examples/1.9.x/client-android/kotlin/avatars/get-image.md @@ -6,6 +6,7 @@ import io.appwrite.services.Avatars val client = Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/client-android/kotlin/avatars/get-initials.md b/examples/1.9.x/client-android/kotlin/avatars/get-initials.md index 1cb76a185..79a4d3de2 100644 --- a/examples/1.9.x/client-android/kotlin/avatars/get-initials.md +++ b/examples/1.9.x/client-android/kotlin/avatars/get-initials.md @@ -6,6 +6,7 @@ import io.appwrite.services.Avatars val client = Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/client-android/kotlin/avatars/get-qr.md b/examples/1.9.x/client-android/kotlin/avatars/get-qr.md index e962ef309..6d1381de6 100644 --- a/examples/1.9.x/client-android/kotlin/avatars/get-qr.md +++ b/examples/1.9.x/client-android/kotlin/avatars/get-qr.md @@ -6,6 +6,7 @@ import io.appwrite.services.Avatars val client = Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/client-android/kotlin/avatars/get-screenshot.md b/examples/1.9.x/client-android/kotlin/avatars/get-screenshot.md index 1093c060f..292d526db 100644 --- a/examples/1.9.x/client-android/kotlin/avatars/get-screenshot.md +++ b/examples/1.9.x/client-android/kotlin/avatars/get-screenshot.md @@ -10,6 +10,7 @@ import io.appwrite.enums.ImageFormat val client = Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/client-android/kotlin/storage/get-file-download.md b/examples/1.9.x/client-android/kotlin/storage/get-file-download.md index d60b5fa4a..206093f07 100644 --- a/examples/1.9.x/client-android/kotlin/storage/get-file-download.md +++ b/examples/1.9.x/client-android/kotlin/storage/get-file-download.md @@ -6,6 +6,7 @@ import io.appwrite.services.Storage val client = Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val storage = Storage(client) diff --git a/examples/1.9.x/client-android/kotlin/storage/get-file-preview.md b/examples/1.9.x/client-android/kotlin/storage/get-file-preview.md index 2bb8cffd8..739447007 100644 --- a/examples/1.9.x/client-android/kotlin/storage/get-file-preview.md +++ b/examples/1.9.x/client-android/kotlin/storage/get-file-preview.md @@ -8,6 +8,7 @@ import io.appwrite.enums.ImageFormat val client = Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val storage = Storage(client) diff --git a/examples/1.9.x/client-android/kotlin/storage/get-file-view.md b/examples/1.9.x/client-android/kotlin/storage/get-file-view.md index 6e6e77f46..119c57478 100644 --- a/examples/1.9.x/client-android/kotlin/storage/get-file-view.md +++ b/examples/1.9.x/client-android/kotlin/storage/get-file-view.md @@ -6,6 +6,7 @@ import io.appwrite.services.Storage val client = Client(context) .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val storage = Storage(client) diff --git a/examples/1.9.x/client-apple/examples/account/create.md b/examples/1.9.x/client-apple/examples/account/create.md index 6faa4daf8..7bebdefce 100644 --- a/examples/1.9.x/client-apple/examples/account/create.md +++ b/examples/1.9.x/client-apple/examples/account/create.md @@ -10,7 +10,7 @@ let account = Account(client) let user = try await account.create( userId: "", email: "email@example.com", - password: "", + password: "password", name: "" // optional ) diff --git a/examples/1.9.x/client-apple/examples/account/update-password.md b/examples/1.9.x/client-apple/examples/account/update-password.md index fe287d71c..fe1479efd 100644 --- a/examples/1.9.x/client-apple/examples/account/update-password.md +++ b/examples/1.9.x/client-apple/examples/account/update-password.md @@ -8,7 +8,7 @@ let client = Client() let account = Account(client) let user = try await account.updatePassword( - password: "", + password: "password", oldPassword: "password" // optional ) diff --git a/examples/1.9.x/client-apple/examples/account/update-recovery.md b/examples/1.9.x/client-apple/examples/account/update-recovery.md index f0a43c505..f785d8f63 100644 --- a/examples/1.9.x/client-apple/examples/account/update-recovery.md +++ b/examples/1.9.x/client-apple/examples/account/update-recovery.md @@ -10,7 +10,7 @@ let account = Account(client) let token = try await account.updateRecovery( userId: "", secret: "", - password: "" + password: "password" ) ``` diff --git a/examples/1.9.x/client-apple/examples/avatars/get-browser.md b/examples/1.9.x/client-apple/examples/avatars/get-browser.md index 9825d8804..e0c129a68 100644 --- a/examples/1.9.x/client-apple/examples/avatars/get-browser.md +++ b/examples/1.9.x/client-apple/examples/avatars/get-browser.md @@ -5,6 +5,7 @@ import AppwriteEnums let client = Client() .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/client-apple/examples/avatars/get-credit-card.md b/examples/1.9.x/client-apple/examples/avatars/get-credit-card.md index a294929a6..19f70a820 100644 --- a/examples/1.9.x/client-apple/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/client-apple/examples/avatars/get-credit-card.md @@ -5,6 +5,7 @@ import AppwriteEnums let client = Client() .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/client-apple/examples/avatars/get-favicon.md b/examples/1.9.x/client-apple/examples/avatars/get-favicon.md index 0d5435214..ec9b6dd06 100644 --- a/examples/1.9.x/client-apple/examples/avatars/get-favicon.md +++ b/examples/1.9.x/client-apple/examples/avatars/get-favicon.md @@ -4,6 +4,7 @@ import Appwrite let client = Client() .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/client-apple/examples/avatars/get-flag.md b/examples/1.9.x/client-apple/examples/avatars/get-flag.md index ae4586067..74121bac1 100644 --- a/examples/1.9.x/client-apple/examples/avatars/get-flag.md +++ b/examples/1.9.x/client-apple/examples/avatars/get-flag.md @@ -5,6 +5,7 @@ import AppwriteEnums let client = Client() .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/client-apple/examples/avatars/get-image.md b/examples/1.9.x/client-apple/examples/avatars/get-image.md index 0cbc666ae..75926fc64 100644 --- a/examples/1.9.x/client-apple/examples/avatars/get-image.md +++ b/examples/1.9.x/client-apple/examples/avatars/get-image.md @@ -4,6 +4,7 @@ import Appwrite let client = Client() .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/client-apple/examples/avatars/get-initials.md b/examples/1.9.x/client-apple/examples/avatars/get-initials.md index d1f6d7c2d..e265dc257 100644 --- a/examples/1.9.x/client-apple/examples/avatars/get-initials.md +++ b/examples/1.9.x/client-apple/examples/avatars/get-initials.md @@ -4,6 +4,7 @@ import Appwrite let client = Client() .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/client-apple/examples/avatars/get-qr.md b/examples/1.9.x/client-apple/examples/avatars/get-qr.md index 86a43fba1..23817fc4d 100644 --- a/examples/1.9.x/client-apple/examples/avatars/get-qr.md +++ b/examples/1.9.x/client-apple/examples/avatars/get-qr.md @@ -4,6 +4,7 @@ import Appwrite let client = Client() .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/client-apple/examples/avatars/get-screenshot.md b/examples/1.9.x/client-apple/examples/avatars/get-screenshot.md index 7711677f4..3ccded0f2 100644 --- a/examples/1.9.x/client-apple/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/client-apple/examples/avatars/get-screenshot.md @@ -5,6 +5,7 @@ import AppwriteEnums let client = Client() .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/client-apple/examples/storage/get-file-download.md b/examples/1.9.x/client-apple/examples/storage/get-file-download.md index c46d0723a..7303487dc 100644 --- a/examples/1.9.x/client-apple/examples/storage/get-file-download.md +++ b/examples/1.9.x/client-apple/examples/storage/get-file-download.md @@ -4,6 +4,7 @@ import Appwrite let client = Client() .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let storage = Storage(client) diff --git a/examples/1.9.x/client-apple/examples/storage/get-file-preview.md b/examples/1.9.x/client-apple/examples/storage/get-file-preview.md index 5ba403231..26de4918e 100644 --- a/examples/1.9.x/client-apple/examples/storage/get-file-preview.md +++ b/examples/1.9.x/client-apple/examples/storage/get-file-preview.md @@ -5,6 +5,7 @@ import AppwriteEnums let client = Client() .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let storage = Storage(client) diff --git a/examples/1.9.x/client-apple/examples/storage/get-file-view.md b/examples/1.9.x/client-apple/examples/storage/get-file-view.md index 1364d8ef6..7026f5af0 100644 --- a/examples/1.9.x/client-apple/examples/storage/get-file-view.md +++ b/examples/1.9.x/client-apple/examples/storage/get-file-view.md @@ -4,6 +4,7 @@ import Appwrite let client = Client() .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .setProject("") // Your project ID + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let storage = Storage(client) diff --git a/examples/1.9.x/client-flutter/examples/account/create.md b/examples/1.9.x/client-flutter/examples/account/create.md index d4bf5757a..8343f6284 100644 --- a/examples/1.9.x/client-flutter/examples/account/create.md +++ b/examples/1.9.x/client-flutter/examples/account/create.md @@ -10,7 +10,7 @@ Account account = Account(client); User result = await account.create( userId: '', email: 'email@example.com', - password: '', + password: 'password', name: '', // optional ); ``` diff --git a/examples/1.9.x/client-flutter/examples/account/update-password.md b/examples/1.9.x/client-flutter/examples/account/update-password.md index 33ae55f41..c2604a9c2 100644 --- a/examples/1.9.x/client-flutter/examples/account/update-password.md +++ b/examples/1.9.x/client-flutter/examples/account/update-password.md @@ -8,7 +8,7 @@ Client client = Client() Account account = Account(client); User result = await account.updatePassword( - password: '', + password: 'password', oldPassword: 'password', // optional ); ``` diff --git a/examples/1.9.x/client-flutter/examples/account/update-recovery.md b/examples/1.9.x/client-flutter/examples/account/update-recovery.md index 87ff07bda..809aa0448 100644 --- a/examples/1.9.x/client-flutter/examples/account/update-recovery.md +++ b/examples/1.9.x/client-flutter/examples/account/update-recovery.md @@ -10,6 +10,6 @@ Account account = Account(client); Token result = await account.updateRecovery( userId: '', secret: '', - password: '', + password: 'password', ); ``` diff --git a/examples/1.9.x/client-flutter/examples/avatars/get-browser.md b/examples/1.9.x/client-flutter/examples/avatars/get-browser.md index 19026083e..1cdf87b56 100644 --- a/examples/1.9.x/client-flutter/examples/avatars/get-browser.md +++ b/examples/1.9.x/client-flutter/examples/avatars/get-browser.md @@ -4,7 +4,8 @@ import 'package:appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/client-flutter/examples/avatars/get-credit-card.md b/examples/1.9.x/client-flutter/examples/avatars/get-credit-card.md index 395608a4b..7d2d08b75 100644 --- a/examples/1.9.x/client-flutter/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/client-flutter/examples/avatars/get-credit-card.md @@ -4,7 +4,8 @@ import 'package:appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/client-flutter/examples/avatars/get-favicon.md b/examples/1.9.x/client-flutter/examples/avatars/get-favicon.md index fd1d0df70..afcbd1e54 100644 --- a/examples/1.9.x/client-flutter/examples/avatars/get-favicon.md +++ b/examples/1.9.x/client-flutter/examples/avatars/get-favicon.md @@ -3,7 +3,8 @@ import 'package:appwrite/appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/client-flutter/examples/avatars/get-flag.md b/examples/1.9.x/client-flutter/examples/avatars/get-flag.md index a5753f6cf..c43508ffa 100644 --- a/examples/1.9.x/client-flutter/examples/avatars/get-flag.md +++ b/examples/1.9.x/client-flutter/examples/avatars/get-flag.md @@ -4,7 +4,8 @@ import 'package:appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/client-flutter/examples/avatars/get-image.md b/examples/1.9.x/client-flutter/examples/avatars/get-image.md index 4e75bc7ea..5ed8492cd 100644 --- a/examples/1.9.x/client-flutter/examples/avatars/get-image.md +++ b/examples/1.9.x/client-flutter/examples/avatars/get-image.md @@ -3,7 +3,8 @@ import 'package:appwrite/appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/client-flutter/examples/avatars/get-initials.md b/examples/1.9.x/client-flutter/examples/avatars/get-initials.md index 3b5bb68ed..16c3e510a 100644 --- a/examples/1.9.x/client-flutter/examples/avatars/get-initials.md +++ b/examples/1.9.x/client-flutter/examples/avatars/get-initials.md @@ -3,7 +3,8 @@ import 'package:appwrite/appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/client-flutter/examples/avatars/get-qr.md b/examples/1.9.x/client-flutter/examples/avatars/get-qr.md index 8a6dc7704..262d14be9 100644 --- a/examples/1.9.x/client-flutter/examples/avatars/get-qr.md +++ b/examples/1.9.x/client-flutter/examples/avatars/get-qr.md @@ -3,7 +3,8 @@ import 'package:appwrite/appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/client-flutter/examples/avatars/get-screenshot.md b/examples/1.9.x/client-flutter/examples/avatars/get-screenshot.md index 7de27d7bc..9f7559a88 100644 --- a/examples/1.9.x/client-flutter/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/client-flutter/examples/avatars/get-screenshot.md @@ -4,7 +4,8 @@ import 'package:appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/client-flutter/examples/storage/get-file-download.md b/examples/1.9.x/client-flutter/examples/storage/get-file-download.md index 8fc48d152..d115831b9 100644 --- a/examples/1.9.x/client-flutter/examples/storage/get-file-download.md +++ b/examples/1.9.x/client-flutter/examples/storage/get-file-download.md @@ -3,7 +3,8 @@ import 'package:appwrite/appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = Storage(client); diff --git a/examples/1.9.x/client-flutter/examples/storage/get-file-preview.md b/examples/1.9.x/client-flutter/examples/storage/get-file-preview.md index 06e583a39..6ad484c4a 100644 --- a/examples/1.9.x/client-flutter/examples/storage/get-file-preview.md +++ b/examples/1.9.x/client-flutter/examples/storage/get-file-preview.md @@ -4,7 +4,8 @@ import 'package:appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = Storage(client); diff --git a/examples/1.9.x/client-flutter/examples/storage/get-file-view.md b/examples/1.9.x/client-flutter/examples/storage/get-file-view.md index 56d2652d2..13e51165a 100644 --- a/examples/1.9.x/client-flutter/examples/storage/get-file-view.md +++ b/examples/1.9.x/client-flutter/examples/storage/get-file-view.md @@ -3,7 +3,8 @@ import 'package:appwrite/appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = Storage(client); diff --git a/examples/1.9.x/client-graphql/examples/account/create-anonymous-session.md b/examples/1.9.x/client-graphql/examples/account/create-anonymous-session.md index c040efb8c..f771acf4e 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-anonymous-session.md +++ b/examples/1.9.x/client-graphql/examples/account/create-anonymous-session.md @@ -32,4 +32,37 @@ mutation { mfaUpdatedAt } } +mutation { + accountCreateAnonymousSession { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-email-password-session.md b/examples/1.9.x/client-graphql/examples/account/create-email-password-session.md index c68a4feb2..682c540d6 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-email-password-session.md +++ b/examples/1.9.x/client-graphql/examples/account/create-email-password-session.md @@ -35,4 +35,40 @@ mutation { mfaUpdatedAt } } +mutation { + accountCreateEmailPasswordSession( + email: "email@example.com", + password: "password" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-email-token.md b/examples/1.9.x/client-graphql/examples/account/create-email-token.md index f9db2e2cc..29d694a22 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-email-token.md +++ b/examples/1.9.x/client-graphql/examples/account/create-email-token.md @@ -13,4 +13,18 @@ mutation { phrase } } +mutation { + accountCreateEmailToken( + userId: "", + email: "email@example.com", + phrase: false + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-email-verification.md b/examples/1.9.x/client-graphql/examples/account/create-email-verification.md index 3a4c559b2..d36352a4e 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-email-verification.md +++ b/examples/1.9.x/client-graphql/examples/account/create-email-verification.md @@ -11,4 +11,16 @@ mutation { phrase } } +mutation { + accountCreateEmailVerification( + url: "https://example.com" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-jwt.md b/examples/1.9.x/client-graphql/examples/account/create-jwt.md index 8bc8f9acd..fab58b5a0 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-jwt.md +++ b/examples/1.9.x/client-graphql/examples/account/create-jwt.md @@ -6,4 +6,11 @@ mutation { jwt } } +mutation { + accountCreateJWT( + duration: 0 + ) { + jwt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-magic-url-token.md b/examples/1.9.x/client-graphql/examples/account/create-magic-url-token.md index 59b2c94f2..619f5f5b3 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-magic-url-token.md +++ b/examples/1.9.x/client-graphql/examples/account/create-magic-url-token.md @@ -14,4 +14,19 @@ mutation { phrase } } +mutation { + accountCreateMagicURLToken( + userId: "", + email: "email@example.com", + url: "https://example.com", + phrase: false + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-mfa-authenticator.md b/examples/1.9.x/client-graphql/examples/account/create-mfa-authenticator.md index a3920a197..8259085b3 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-mfa-authenticator.md +++ b/examples/1.9.x/client-graphql/examples/account/create-mfa-authenticator.md @@ -7,4 +7,12 @@ mutation { uri } } +mutation { + accountCreateMFAAuthenticator( + type: "totp" + ) { + secret + uri + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-mfa-challenge.md b/examples/1.9.x/client-graphql/examples/account/create-mfa-challenge.md index 3da400f67..e255dfdda 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-mfa-challenge.md +++ b/examples/1.9.x/client-graphql/examples/account/create-mfa-challenge.md @@ -9,4 +9,14 @@ mutation { expire } } +mutation { + accountCreateMFAChallenge( + factor: "email" + ) { + _id + _createdAt + userId + expire + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-mfa-recovery-codes.md b/examples/1.9.x/client-graphql/examples/account/create-mfa-recovery-codes.md index 9f1c3596e..de6cb59fe 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-mfa-recovery-codes.md +++ b/examples/1.9.x/client-graphql/examples/account/create-mfa-recovery-codes.md @@ -4,4 +4,9 @@ mutation { recoveryCodes } } +mutation { + accountCreateMFARecoveryCodes { + recoveryCodes + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-phone-token.md b/examples/1.9.x/client-graphql/examples/account/create-phone-token.md index e382df55c..5fa32b750 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-phone-token.md +++ b/examples/1.9.x/client-graphql/examples/account/create-phone-token.md @@ -12,4 +12,17 @@ mutation { phrase } } +mutation { + accountCreatePhoneToken( + userId: "", + phone: "+12065550100" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-phone-verification.md b/examples/1.9.x/client-graphql/examples/account/create-phone-verification.md index 88ce51a14..9247f2bd5 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-phone-verification.md +++ b/examples/1.9.x/client-graphql/examples/account/create-phone-verification.md @@ -9,4 +9,14 @@ mutation { phrase } } +mutation { + accountCreatePhoneVerification { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-push-target.md b/examples/1.9.x/client-graphql/examples/account/create-push-target.md index 3b47523db..923964e7c 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-push-target.md +++ b/examples/1.9.x/client-graphql/examples/account/create-push-target.md @@ -16,4 +16,21 @@ mutation { expired } } +mutation { + accountCreatePushTarget( + targetId: "", + identifier: "", + providerId: "" + ) { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-recovery.md b/examples/1.9.x/client-graphql/examples/account/create-recovery.md index f72f5a653..ac7640295 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-recovery.md +++ b/examples/1.9.x/client-graphql/examples/account/create-recovery.md @@ -12,4 +12,17 @@ mutation { phrase } } +mutation { + accountCreateRecovery( + email: "email@example.com", + url: "https://example.com" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-session.md b/examples/1.9.x/client-graphql/examples/account/create-session.md index b5dda77e1..f7cc421ce 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-session.md +++ b/examples/1.9.x/client-graphql/examples/account/create-session.md @@ -35,4 +35,40 @@ mutation { mfaUpdatedAt } } +mutation { + accountCreateSession( + userId: "", + secret: "" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create-verification.md b/examples/1.9.x/client-graphql/examples/account/create-verification.md index 818efe4dd..1aeeb7d4b 100644 --- a/examples/1.9.x/client-graphql/examples/account/create-verification.md +++ b/examples/1.9.x/client-graphql/examples/account/create-verification.md @@ -11,4 +11,16 @@ mutation { phrase } } +mutation { + accountCreateVerification( + url: "https://example.com" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/create.md b/examples/1.9.x/client-graphql/examples/account/create.md index 290b738cb..bf76897a2 100644 --- a/examples/1.9.x/client-graphql/examples/account/create.md +++ b/examples/1.9.x/client-graphql/examples/account/create.md @@ -3,7 +3,7 @@ mutation { accountCreate( userId: "", email: "email@example.com", - password: "", + password: "password", name: "" ) { _id @@ -20,6 +20,58 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountCreate( + userId: "", + email: "email@example.com", + password: "password", + name: "" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/client-graphql/examples/account/get-mfa-recovery-codes.md b/examples/1.9.x/client-graphql/examples/account/get-mfa-recovery-codes.md index d7962b96e..430d5f42c 100644 --- a/examples/1.9.x/client-graphql/examples/account/get-mfa-recovery-codes.md +++ b/examples/1.9.x/client-graphql/examples/account/get-mfa-recovery-codes.md @@ -1,2 +1,7 @@ ```graphql +query { + accountGetMFARecoveryCodes { + recoveryCodes + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/get-prefs.md b/examples/1.9.x/client-graphql/examples/account/get-prefs.md index d7962b96e..f7920fc2e 100644 --- a/examples/1.9.x/client-graphql/examples/account/get-prefs.md +++ b/examples/1.9.x/client-graphql/examples/account/get-prefs.md @@ -1,2 +1,7 @@ ```graphql +query { + accountGetPrefs { + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/get-session.md b/examples/1.9.x/client-graphql/examples/account/get-session.md index d7962b96e..0ff57c396 100644 --- a/examples/1.9.x/client-graphql/examples/account/get-session.md +++ b/examples/1.9.x/client-graphql/examples/account/get-session.md @@ -1,2 +1,37 @@ ```graphql +query { + accountGetSession( + sessionId: "" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/get.md b/examples/1.9.x/client-graphql/examples/account/get.md index d7962b96e..0a4a636d5 100644 --- a/examples/1.9.x/client-graphql/examples/account/get.md +++ b/examples/1.9.x/client-graphql/examples/account/get.md @@ -1,2 +1,44 @@ ```graphql +query { + accountGet { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/list-identities.md b/examples/1.9.x/client-graphql/examples/account/list-identities.md index d7962b96e..237e67175 100644 --- a/examples/1.9.x/client-graphql/examples/account/list-identities.md +++ b/examples/1.9.x/client-graphql/examples/account/list-identities.md @@ -1,2 +1,22 @@ ```graphql +query { + accountListIdentities( + queries: [], + total: false + ) { + total + identities { + _id + _createdAt + _updatedAt + userId + provider + providerUid + providerEmail + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/list-logs.md b/examples/1.9.x/client-graphql/examples/account/list-logs.md index d7962b96e..f7511ee73 100644 --- a/examples/1.9.x/client-graphql/examples/account/list-logs.md +++ b/examples/1.9.x/client-graphql/examples/account/list-logs.md @@ -1,2 +1,34 @@ ```graphql +query { + accountListLogs( + queries: [], + total: false + ) { + total + logs { + event + userId + userEmail + userName + mode + userType + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/list-mfa-factors.md b/examples/1.9.x/client-graphql/examples/account/list-mfa-factors.md index d7962b96e..983822381 100644 --- a/examples/1.9.x/client-graphql/examples/account/list-mfa-factors.md +++ b/examples/1.9.x/client-graphql/examples/account/list-mfa-factors.md @@ -1,2 +1,10 @@ ```graphql +query { + accountListMFAFactors { + totp + phone + email + recoveryCode + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/list-sessions.md b/examples/1.9.x/client-graphql/examples/account/list-sessions.md index d7962b96e..106419a76 100644 --- a/examples/1.9.x/client-graphql/examples/account/list-sessions.md +++ b/examples/1.9.x/client-graphql/examples/account/list-sessions.md @@ -1,2 +1,38 @@ ```graphql +query { + accountListSessions { + total + sessions { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/update-email-verification.md b/examples/1.9.x/client-graphql/examples/account/update-email-verification.md index 9a045dd80..085a14f52 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-email-verification.md +++ b/examples/1.9.x/client-graphql/examples/account/update-email-verification.md @@ -12,4 +12,17 @@ mutation { phrase } } +mutation { + accountUpdateEmailVerification( + userId: "", + secret: "" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/update-email.md b/examples/1.9.x/client-graphql/examples/account/update-email.md index bf4acbad7..7c33c5bff 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-email.md +++ b/examples/1.9.x/client-graphql/examples/account/update-email.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdateEmail( + email: "email@example.com", + password: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/client-graphql/examples/account/update-magic-url-session.md b/examples/1.9.x/client-graphql/examples/account/update-magic-url-session.md index 92ad9693d..5f6fd6643 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-magic-url-session.md +++ b/examples/1.9.x/client-graphql/examples/account/update-magic-url-session.md @@ -35,4 +35,40 @@ mutation { mfaUpdatedAt } } +mutation { + accountUpdateMagicURLSession( + userId: "", + secret: "" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/update-mfa-authenticator.md b/examples/1.9.x/client-graphql/examples/account/update-mfa-authenticator.md index 3d7047ffd..0fbe94edd 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-mfa-authenticator.md +++ b/examples/1.9.x/client-graphql/examples/account/update-mfa-authenticator.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdateMFAAuthenticator( + type: "totp", + otp: "" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/client-graphql/examples/account/update-mfa-challenge.md b/examples/1.9.x/client-graphql/examples/account/update-mfa-challenge.md index d3a438cf0..f6b1ba366 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-mfa-challenge.md +++ b/examples/1.9.x/client-graphql/examples/account/update-mfa-challenge.md @@ -35,4 +35,40 @@ mutation { mfaUpdatedAt } } +mutation { + accountUpdateMFAChallenge( + challengeId: "", + otp: "" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/update-mfa-recovery-codes.md b/examples/1.9.x/client-graphql/examples/account/update-mfa-recovery-codes.md index 5f0c5c2d6..185fd26e4 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-mfa-recovery-codes.md +++ b/examples/1.9.x/client-graphql/examples/account/update-mfa-recovery-codes.md @@ -4,4 +4,9 @@ mutation { recoveryCodes } } +mutation { + accountUpdateMFARecoveryCodes { + recoveryCodes + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/update-mfa.md b/examples/1.9.x/client-graphql/examples/account/update-mfa.md index 8b6aa027a..49dda9773 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-mfa.md +++ b/examples/1.9.x/client-graphql/examples/account/update-mfa.md @@ -17,6 +17,55 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdateMFA( + mfa: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/client-graphql/examples/account/update-name.md b/examples/1.9.x/client-graphql/examples/account/update-name.md index 17ec78ab5..2c6ca434c 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-name.md +++ b/examples/1.9.x/client-graphql/examples/account/update-name.md @@ -17,6 +17,55 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdateName( + name: "" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/client-graphql/examples/account/update-password.md b/examples/1.9.x/client-graphql/examples/account/update-password.md index 3bd5a356f..fefd26ac2 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-password.md +++ b/examples/1.9.x/client-graphql/examples/account/update-password.md @@ -1,7 +1,7 @@ ```graphql mutation { accountUpdatePassword( - password: "", + password: "password", oldPassword: "password" ) { _id @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdatePassword( + password: "password", + oldPassword: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/client-graphql/examples/account/update-phone-session.md b/examples/1.9.x/client-graphql/examples/account/update-phone-session.md index aa054709d..15dfeb4b1 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-phone-session.md +++ b/examples/1.9.x/client-graphql/examples/account/update-phone-session.md @@ -35,4 +35,40 @@ mutation { mfaUpdatedAt } } +mutation { + accountUpdatePhoneSession( + userId: "", + secret: "" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/update-phone-verification.md b/examples/1.9.x/client-graphql/examples/account/update-phone-verification.md index 2122d41be..405af168f 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-phone-verification.md +++ b/examples/1.9.x/client-graphql/examples/account/update-phone-verification.md @@ -12,4 +12,17 @@ mutation { phrase } } +mutation { + accountUpdatePhoneVerification( + userId: "", + secret: "" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/update-phone.md b/examples/1.9.x/client-graphql/examples/account/update-phone.md index 68806aeef..3bc44ceec 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-phone.md +++ b/examples/1.9.x/client-graphql/examples/account/update-phone.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdatePhone( + phone: "+12065550100", + password: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/client-graphql/examples/account/update-prefs.md b/examples/1.9.x/client-graphql/examples/account/update-prefs.md index b22bbf67e..676eca1e2 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-prefs.md +++ b/examples/1.9.x/client-graphql/examples/account/update-prefs.md @@ -17,6 +17,55 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdatePrefs( + prefs: "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/client-graphql/examples/account/update-push-target.md b/examples/1.9.x/client-graphql/examples/account/update-push-target.md index 9cd77d826..3abc663de 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-push-target.md +++ b/examples/1.9.x/client-graphql/examples/account/update-push-target.md @@ -15,4 +15,20 @@ mutation { expired } } +mutation { + accountUpdatePushTarget( + targetId: "", + identifier: "" + ) { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/update-recovery.md b/examples/1.9.x/client-graphql/examples/account/update-recovery.md index 90933c165..26b363ec2 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-recovery.md +++ b/examples/1.9.x/client-graphql/examples/account/update-recovery.md @@ -3,7 +3,21 @@ mutation { accountUpdateRecovery( userId: "", secret: "", - password: "" + password: "password" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} +mutation { + accountUpdateRecovery( + userId: "", + secret: "", + password: "password" ) { _id _createdAt diff --git a/examples/1.9.x/client-graphql/examples/account/update-session.md b/examples/1.9.x/client-graphql/examples/account/update-session.md index c045df3c1..9958b225a 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-session.md +++ b/examples/1.9.x/client-graphql/examples/account/update-session.md @@ -34,4 +34,39 @@ mutation { mfaUpdatedAt } } +mutation { + accountUpdateSession( + sessionId: "" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/account/update-status.md b/examples/1.9.x/client-graphql/examples/account/update-status.md index 13b0d7cec..cd86da7f4 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-status.md +++ b/examples/1.9.x/client-graphql/examples/account/update-status.md @@ -15,6 +15,53 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdateStatus { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/client-graphql/examples/account/update-verification.md b/examples/1.9.x/client-graphql/examples/account/update-verification.md index 927ce4953..4af24939b 100644 --- a/examples/1.9.x/client-graphql/examples/account/update-verification.md +++ b/examples/1.9.x/client-graphql/examples/account/update-verification.md @@ -12,4 +12,17 @@ mutation { phrase } } +mutation { + accountUpdateVerification( + userId: "", + secret: "" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/avatars/get-browser.md b/examples/1.9.x/client-graphql/examples/avatars/get-browser.md index d7962b96e..2f432681b 100644 --- a/examples/1.9.x/client-graphql/examples/avatars/get-browser.md +++ b/examples/1.9.x/client-graphql/examples/avatars/get-browser.md @@ -1,2 +1,12 @@ ```graphql +query { + avatarsGetBrowser( + code: "aa", + width: 0, + height: 0, + quality: -1 + ) { + status + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/avatars/get-credit-card.md b/examples/1.9.x/client-graphql/examples/avatars/get-credit-card.md index d7962b96e..952c23021 100644 --- a/examples/1.9.x/client-graphql/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/client-graphql/examples/avatars/get-credit-card.md @@ -1,2 +1,12 @@ ```graphql +query { + avatarsGetCreditCard( + code: "amex", + width: 0, + height: 0, + quality: -1 + ) { + status + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/avatars/get-favicon.md b/examples/1.9.x/client-graphql/examples/avatars/get-favicon.md index d7962b96e..22653ab58 100644 --- a/examples/1.9.x/client-graphql/examples/avatars/get-favicon.md +++ b/examples/1.9.x/client-graphql/examples/avatars/get-favicon.md @@ -1,2 +1,9 @@ ```graphql +query { + avatarsGetFavicon( + url: "https://example.com" + ) { + status + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/avatars/get-flag.md b/examples/1.9.x/client-graphql/examples/avatars/get-flag.md index d7962b96e..6444e6988 100644 --- a/examples/1.9.x/client-graphql/examples/avatars/get-flag.md +++ b/examples/1.9.x/client-graphql/examples/avatars/get-flag.md @@ -1,2 +1,12 @@ ```graphql +query { + avatarsGetFlag( + code: "af", + width: 0, + height: 0, + quality: -1 + ) { + status + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/avatars/get-image.md b/examples/1.9.x/client-graphql/examples/avatars/get-image.md index d7962b96e..8acc02134 100644 --- a/examples/1.9.x/client-graphql/examples/avatars/get-image.md +++ b/examples/1.9.x/client-graphql/examples/avatars/get-image.md @@ -1,2 +1,11 @@ ```graphql +query { + avatarsGetImage( + url: "https://example.com", + width: 0, + height: 0 + ) { + status + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/avatars/get-initials.md b/examples/1.9.x/client-graphql/examples/avatars/get-initials.md index d7962b96e..f848f5522 100644 --- a/examples/1.9.x/client-graphql/examples/avatars/get-initials.md +++ b/examples/1.9.x/client-graphql/examples/avatars/get-initials.md @@ -1,2 +1,12 @@ ```graphql +query { + avatarsGetInitials( + name: "", + width: 0, + height: 0, + background: "" + ) { + status + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/avatars/get-qr.md b/examples/1.9.x/client-graphql/examples/avatars/get-qr.md index d7962b96e..9206b404e 100644 --- a/examples/1.9.x/client-graphql/examples/avatars/get-qr.md +++ b/examples/1.9.x/client-graphql/examples/avatars/get-qr.md @@ -1,2 +1,12 @@ ```graphql +query { + avatarsGetQR( + text: "", + size: 1, + margin: 0, + download: false + ) { + status + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/avatars/get-screenshot.md b/examples/1.9.x/client-graphql/examples/avatars/get-screenshot.md index d7962b96e..c6ca96301 100644 --- a/examples/1.9.x/client-graphql/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/client-graphql/examples/avatars/get-screenshot.md @@ -1,2 +1,28 @@ ```graphql +query { + avatarsGetScreenshot( + url: "https://example.com", + headers: "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}", + viewportWidth: 1920, + viewportHeight: 1080, + scale: 2, + theme: "dark", + userAgent: "Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15", + fullpage: true, + locale: "en-US", + timezone: "America/New_York", + latitude: 37.7749, + longitude: -122.4194, + accuracy: 100, + touch: true, + permissions: ["geolocation","notifications"], + sleep: 3, + width: 800, + height: 600, + quality: 85, + output: "jpeg" + ) { + status + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/create-document.md b/examples/1.9.x/client-graphql/examples/databases/create-document.md index a4a363b97..c5ce65ab3 100644 --- a/examples/1.9.x/client-graphql/examples/databases/create-document.md +++ b/examples/1.9.x/client-graphql/examples/databases/create-document.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + databasesCreateDocument( + databaseId: "", + collectionId: "", + documentId: "", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/create-operations.md b/examples/1.9.x/client-graphql/examples/databases/create-operations.md index 7fa29cf3f..cada6c2d6 100644 --- a/examples/1.9.x/client-graphql/examples/databases/create-operations.md +++ b/examples/1.9.x/client-graphql/examples/databases/create-operations.md @@ -22,4 +22,27 @@ mutation { expiresAt } } +mutation { + databasesCreateOperations( + transactionId: "", + operations: [ + { + "action": "create", + "databaseId": "", + "collectionId": "", + "documentId": "", + "data": { + "name": "Walter O'Brien" + } + } + ] + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/create-transaction.md b/examples/1.9.x/client-graphql/examples/databases/create-transaction.md index d28f2eadc..6d2952505 100644 --- a/examples/1.9.x/client-graphql/examples/databases/create-transaction.md +++ b/examples/1.9.x/client-graphql/examples/databases/create-transaction.md @@ -11,4 +11,16 @@ mutation { expiresAt } } +mutation { + databasesCreateTransaction( + ttl: 60 + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/decrement-document-attribute.md b/examples/1.9.x/client-graphql/examples/databases/decrement-document-attribute.md index 4db00c0ae..e07463054 100644 --- a/examples/1.9.x/client-graphql/examples/databases/decrement-document-attribute.md +++ b/examples/1.9.x/client-graphql/examples/databases/decrement-document-attribute.md @@ -19,4 +19,24 @@ mutation { data } } +mutation { + databasesDecrementDocumentAttribute( + databaseId: "", + collectionId: "", + documentId: "", + attribute: "", + value: 0, + min: 0, + transactionId: "" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/get-document.md b/examples/1.9.x/client-graphql/examples/databases/get-document.md index d7962b96e..e188dee38 100644 --- a/examples/1.9.x/client-graphql/examples/databases/get-document.md +++ b/examples/1.9.x/client-graphql/examples/databases/get-document.md @@ -1,2 +1,20 @@ ```graphql +query { + databasesGetDocument( + databaseId: "", + collectionId: "", + documentId: "", + queries: [], + transactionId: "" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/get-transaction.md b/examples/1.9.x/client-graphql/examples/databases/get-transaction.md index d7962b96e..001554140 100644 --- a/examples/1.9.x/client-graphql/examples/databases/get-transaction.md +++ b/examples/1.9.x/client-graphql/examples/databases/get-transaction.md @@ -1,2 +1,14 @@ ```graphql +query { + databasesGetTransaction( + transactionId: "" + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/increment-document-attribute.md b/examples/1.9.x/client-graphql/examples/databases/increment-document-attribute.md index 58e462f58..7873727fa 100644 --- a/examples/1.9.x/client-graphql/examples/databases/increment-document-attribute.md +++ b/examples/1.9.x/client-graphql/examples/databases/increment-document-attribute.md @@ -19,4 +19,24 @@ mutation { data } } +mutation { + databasesIncrementDocumentAttribute( + databaseId: "", + collectionId: "", + documentId: "", + attribute: "", + value: 0, + max: 0, + transactionId: "" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/list-documents.md b/examples/1.9.x/client-graphql/examples/databases/list-documents.md index d7962b96e..d0e331d0e 100644 --- a/examples/1.9.x/client-graphql/examples/databases/list-documents.md +++ b/examples/1.9.x/client-graphql/examples/databases/list-documents.md @@ -1,2 +1,24 @@ ```graphql +query { + databasesListDocuments( + databaseId: "", + collectionId: "", + queries: [], + transactionId: "", + total: false, + ttl: 0 + ) { + total + documents { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/list-transactions.md b/examples/1.9.x/client-graphql/examples/databases/list-transactions.md index d7962b96e..2fc18db35 100644 --- a/examples/1.9.x/client-graphql/examples/databases/list-transactions.md +++ b/examples/1.9.x/client-graphql/examples/databases/list-transactions.md @@ -1,2 +1,17 @@ ```graphql +query { + databasesListTransactions( + queries: [] + ) { + total + transactions { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/update-document.md b/examples/1.9.x/client-graphql/examples/databases/update-document.md index fc1ce5cb1..7d2308817 100644 --- a/examples/1.9.x/client-graphql/examples/databases/update-document.md +++ b/examples/1.9.x/client-graphql/examples/databases/update-document.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + databasesUpdateDocument( + databaseId: "", + collectionId: "", + documentId: "", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/update-transaction.md b/examples/1.9.x/client-graphql/examples/databases/update-transaction.md index a2d8cb145..866cdb4d5 100644 --- a/examples/1.9.x/client-graphql/examples/databases/update-transaction.md +++ b/examples/1.9.x/client-graphql/examples/databases/update-transaction.md @@ -13,4 +13,18 @@ mutation { expiresAt } } +mutation { + databasesUpdateTransaction( + transactionId: "", + commit: false, + rollback: false + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/databases/upsert-document.md b/examples/1.9.x/client-graphql/examples/databases/upsert-document.md index 5d095baa9..a25f8416f 100644 --- a/examples/1.9.x/client-graphql/examples/databases/upsert-document.md +++ b/examples/1.9.x/client-graphql/examples/databases/upsert-document.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + databasesUpsertDocument( + databaseId: "", + collectionId: "", + documentId: "", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/functions/create-execution.md b/examples/1.9.x/client-graphql/examples/functions/create-execution.md index 88a157599..8024fba09 100644 --- a/examples/1.9.x/client-graphql/examples/functions/create-execution.md +++ b/examples/1.9.x/client-graphql/examples/functions/create-execution.md @@ -35,4 +35,40 @@ mutation { scheduledAt } } +mutation { + functionsCreateExecution( + functionId: "", + body: "", + async: false, + path: "", + method: "GET", + headers: "{}", + scheduledAt: "" + ) { + _id + _createdAt + _updatedAt + _permissions + functionId + deploymentId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + scheduledAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/functions/get-execution.md b/examples/1.9.x/client-graphql/examples/functions/get-execution.md index d7962b96e..082d3e401 100644 --- a/examples/1.9.x/client-graphql/examples/functions/get-execution.md +++ b/examples/1.9.x/client-graphql/examples/functions/get-execution.md @@ -1,2 +1,33 @@ ```graphql +query { + functionsGetExecution( + functionId: "", + executionId: "" + ) { + _id + _createdAt + _updatedAt + _permissions + functionId + deploymentId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + scheduledAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/functions/list-executions.md b/examples/1.9.x/client-graphql/examples/functions/list-executions.md index d7962b96e..5f8f3e826 100644 --- a/examples/1.9.x/client-graphql/examples/functions/list-executions.md +++ b/examples/1.9.x/client-graphql/examples/functions/list-executions.md @@ -1,2 +1,37 @@ ```graphql +query { + functionsListExecutions( + functionId: "", + queries: [], + total: false + ) { + total + executions { + _id + _createdAt + _updatedAt + _permissions + functionId + deploymentId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + scheduledAt + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/locale/get.md b/examples/1.9.x/client-graphql/examples/locale/get.md index d7962b96e..c591b694c 100644 --- a/examples/1.9.x/client-graphql/examples/locale/get.md +++ b/examples/1.9.x/client-graphql/examples/locale/get.md @@ -1,2 +1,13 @@ ```graphql +query { + localeGet { + ip + countryCode + country + continentCode + continent + eu + currency + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/locale/list-codes.md b/examples/1.9.x/client-graphql/examples/locale/list-codes.md index d7962b96e..0e3967246 100644 --- a/examples/1.9.x/client-graphql/examples/locale/list-codes.md +++ b/examples/1.9.x/client-graphql/examples/locale/list-codes.md @@ -1,2 +1,11 @@ ```graphql +query { + localeListCodes { + total + localeCodes { + code + name + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/locale/list-continents.md b/examples/1.9.x/client-graphql/examples/locale/list-continents.md index d7962b96e..16ad0fd94 100644 --- a/examples/1.9.x/client-graphql/examples/locale/list-continents.md +++ b/examples/1.9.x/client-graphql/examples/locale/list-continents.md @@ -1,2 +1,11 @@ ```graphql +query { + localeListContinents { + total + continents { + name + code + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/locale/list-countries-eu.md b/examples/1.9.x/client-graphql/examples/locale/list-countries-eu.md index d7962b96e..293d32c9c 100644 --- a/examples/1.9.x/client-graphql/examples/locale/list-countries-eu.md +++ b/examples/1.9.x/client-graphql/examples/locale/list-countries-eu.md @@ -1,2 +1,11 @@ ```graphql +query { + localeListCountriesEU { + total + countries { + name + code + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/locale/list-countries-phones.md b/examples/1.9.x/client-graphql/examples/locale/list-countries-phones.md index d7962b96e..b17b065e3 100644 --- a/examples/1.9.x/client-graphql/examples/locale/list-countries-phones.md +++ b/examples/1.9.x/client-graphql/examples/locale/list-countries-phones.md @@ -1,2 +1,12 @@ ```graphql +query { + localeListCountriesPhones { + total + phones { + code + countryCode + countryName + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/locale/list-countries.md b/examples/1.9.x/client-graphql/examples/locale/list-countries.md index d7962b96e..15f566af0 100644 --- a/examples/1.9.x/client-graphql/examples/locale/list-countries.md +++ b/examples/1.9.x/client-graphql/examples/locale/list-countries.md @@ -1,2 +1,11 @@ ```graphql +query { + localeListCountries { + total + countries { + name + code + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/locale/list-currencies.md b/examples/1.9.x/client-graphql/examples/locale/list-currencies.md index d7962b96e..374d67126 100644 --- a/examples/1.9.x/client-graphql/examples/locale/list-currencies.md +++ b/examples/1.9.x/client-graphql/examples/locale/list-currencies.md @@ -1,2 +1,16 @@ ```graphql +query { + localeListCurrencies { + total + currencies { + symbol + name + symbolNative + decimalDigits + rounding + code + namePlural + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/locale/list-languages.md b/examples/1.9.x/client-graphql/examples/locale/list-languages.md index d7962b96e..ed108f5a4 100644 --- a/examples/1.9.x/client-graphql/examples/locale/list-languages.md +++ b/examples/1.9.x/client-graphql/examples/locale/list-languages.md @@ -1,2 +1,12 @@ ```graphql +query { + localeListLanguages { + total + languages { + name + code + nativeName + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/messaging/create-subscriber.md b/examples/1.9.x/client-graphql/examples/messaging/create-subscriber.md index 50d67e14f..8a7cd1f57 100644 --- a/examples/1.9.x/client-graphql/examples/messaging/create-subscriber.md +++ b/examples/1.9.x/client-graphql/examples/messaging/create-subscriber.md @@ -26,4 +26,31 @@ mutation { providerType } } +mutation { + messagingCreateSubscriber( + topicId: "", + subscriberId: "", + targetId: "" + ) { + _id + _createdAt + _updatedAt + targetId + target { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + userId + userName + topicId + providerType + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/presences/get.md b/examples/1.9.x/client-graphql/examples/presences/get.md index d7962b96e..c7c9da818 100644 --- a/examples/1.9.x/client-graphql/examples/presences/get.md +++ b/examples/1.9.x/client-graphql/examples/presences/get.md @@ -1,2 +1,17 @@ ```graphql +query { + presencesGet( + presenceId: "" + ) { + _id + _createdAt + _updatedAt + _permissions + userId + status + source + expiresAt + metadata + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/presences/list.md b/examples/1.9.x/client-graphql/examples/presences/list.md index d7962b96e..ff95bbd1c 100644 --- a/examples/1.9.x/client-graphql/examples/presences/list.md +++ b/examples/1.9.x/client-graphql/examples/presences/list.md @@ -1,2 +1,22 @@ ```graphql +query { + presencesList( + queries: [], + total: false, + ttl: 0 + ) { + total + presences { + _id + _createdAt + _updatedAt + _permissions + userId + status + source + expiresAt + metadata + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/presences/update.md b/examples/1.9.x/client-graphql/examples/presences/update.md index cf97766c6..8d9a73fad 100644 --- a/examples/1.9.x/client-graphql/examples/presences/update.md +++ b/examples/1.9.x/client-graphql/examples/presences/update.md @@ -19,4 +19,24 @@ mutation { metadata } } +mutation { + presencesUpdate( + presenceId: "", + status: "", + expiresAt: "2020-10-15T06:38:00.000+00:00", + metadata: "{}", + permissions: ["read("any")"], + purge: false + ) { + _id + _createdAt + _updatedAt + _permissions + userId + status + source + expiresAt + metadata + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/presences/upsert.md b/examples/1.9.x/client-graphql/examples/presences/upsert.md index e77de3574..5e8df0607 100644 --- a/examples/1.9.x/client-graphql/examples/presences/upsert.md +++ b/examples/1.9.x/client-graphql/examples/presences/upsert.md @@ -18,4 +18,23 @@ mutation { metadata } } +mutation { + presencesUpsert( + presenceId: "", + status: "", + permissions: ["read("any")"], + expiresAt: "2020-10-15T06:38:00.000+00:00", + metadata: "{}" + ) { + _id + _createdAt + _updatedAt + _permissions + userId + status + source + expiresAt + metadata + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/storage/create-file.md b/examples/1.9.x/client-graphql/examples/storage/create-file.md index 4c400ca41..58e0a56a2 100644 --- a/examples/1.9.x/client-graphql/examples/storage/create-file.md +++ b/examples/1.9.x/client-graphql/examples/storage/create-file.md @@ -2,10 +2,9 @@ POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: Content-Length: *Length of your entity body in bytes* --cec8e8123c05ba25 @@ -24,4 +23,27 @@ Content-Disposition: form-data; name="0"; filename="file.ext" File contents --cec8e8123c05ba25-- +mutation { + storageCreateFile( + bucketId: "", + fileId: "", + file: null, + permissions: ["read("any")"] + ) { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + sizeActual + chunksTotal + chunksUploaded + encryption + compression + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/storage/get-file-download.md b/examples/1.9.x/client-graphql/examples/storage/get-file-download.md index d7962b96e..f323f21e2 100644 --- a/examples/1.9.x/client-graphql/examples/storage/get-file-download.md +++ b/examples/1.9.x/client-graphql/examples/storage/get-file-download.md @@ -1,2 +1,11 @@ ```graphql +query { + storageGetFileDownload( + bucketId: "", + fileId: "", + token: "" + ) { + status + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/storage/get-file-preview.md b/examples/1.9.x/client-graphql/examples/storage/get-file-preview.md index d7962b96e..9435ad116 100644 --- a/examples/1.9.x/client-graphql/examples/storage/get-file-preview.md +++ b/examples/1.9.x/client-graphql/examples/storage/get-file-preview.md @@ -1,2 +1,22 @@ ```graphql +query { + storageGetFilePreview( + bucketId: "", + fileId: "", + width: 0, + height: 0, + gravity: "center", + quality: -1, + borderWidth: 0, + borderColor: "", + borderRadius: 0, + opacity: 0, + rotation: -360, + background: "", + output: "jpg", + token: "" + ) { + status + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/storage/get-file-view.md b/examples/1.9.x/client-graphql/examples/storage/get-file-view.md index d7962b96e..7871a3111 100644 --- a/examples/1.9.x/client-graphql/examples/storage/get-file-view.md +++ b/examples/1.9.x/client-graphql/examples/storage/get-file-view.md @@ -1,2 +1,11 @@ ```graphql +query { + storageGetFileView( + bucketId: "", + fileId: "", + token: "" + ) { + status + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/storage/get-file.md b/examples/1.9.x/client-graphql/examples/storage/get-file.md index d7962b96e..2614d069f 100644 --- a/examples/1.9.x/client-graphql/examples/storage/get-file.md +++ b/examples/1.9.x/client-graphql/examples/storage/get-file.md @@ -1,2 +1,23 @@ ```graphql +query { + storageGetFile( + bucketId: "", + fileId: "" + ) { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + sizeActual + chunksTotal + chunksUploaded + encryption + compression + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/storage/list-files.md b/examples/1.9.x/client-graphql/examples/storage/list-files.md index d7962b96e..54bafc6ff 100644 --- a/examples/1.9.x/client-graphql/examples/storage/list-files.md +++ b/examples/1.9.x/client-graphql/examples/storage/list-files.md @@ -1,2 +1,28 @@ ```graphql +query { + storageListFiles( + bucketId: "", + queries: [], + search: "", + total: false + ) { + total + files { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + sizeActual + chunksTotal + chunksUploaded + encryption + compression + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/storage/update-file.md b/examples/1.9.x/client-graphql/examples/storage/update-file.md index 3442c043d..858be546a 100644 --- a/examples/1.9.x/client-graphql/examples/storage/update-file.md +++ b/examples/1.9.x/client-graphql/examples/storage/update-file.md @@ -22,4 +22,27 @@ mutation { compression } } +mutation { + storageUpdateFile( + bucketId: "", + fileId: "", + name: "", + permissions: ["read("any")"] + ) { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + sizeActual + chunksTotal + chunksUploaded + encryption + compression + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/create-operations.md b/examples/1.9.x/client-graphql/examples/tablesdb/create-operations.md index f5721ece9..e0651eece 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/create-operations.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/create-operations.md @@ -22,4 +22,27 @@ mutation { expiresAt } } +mutation { + tablesDBCreateOperations( + transactionId: "", + operations: [ + { + "action": "create", + "databaseId": "", + "tableId": "", + "rowId": "", + "data": { + "name": "Walter O'Brien" + } + } + ] + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/create-row.md b/examples/1.9.x/client-graphql/examples/tablesdb/create-row.md index 2de9bda39..a35a68e76 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/create-row.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/create-row.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + tablesDBCreateRow( + databaseId: "", + tableId: "", + rowId: "", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/create-transaction.md b/examples/1.9.x/client-graphql/examples/tablesdb/create-transaction.md index 2ecb30310..d66891e15 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/create-transaction.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/create-transaction.md @@ -11,4 +11,16 @@ mutation { expiresAt } } +mutation { + tablesDBCreateTransaction( + ttl: 60 + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/decrement-row-column.md b/examples/1.9.x/client-graphql/examples/tablesdb/decrement-row-column.md index 981013c72..63064823e 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/decrement-row-column.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/decrement-row-column.md @@ -19,4 +19,24 @@ mutation { data } } +mutation { + tablesDBDecrementRowColumn( + databaseId: "", + tableId: "", + rowId: "", + column: "", + value: 0, + min: 0, + transactionId: "" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/get-row.md b/examples/1.9.x/client-graphql/examples/tablesdb/get-row.md index d7962b96e..354f847dc 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/get-row.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/get-row.md @@ -1,2 +1,20 @@ ```graphql +query { + tablesDBGetRow( + databaseId: "", + tableId: "", + rowId: "", + queries: [], + transactionId: "" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/get-transaction.md b/examples/1.9.x/client-graphql/examples/tablesdb/get-transaction.md index d7962b96e..0c520f611 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/get-transaction.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/get-transaction.md @@ -1,2 +1,14 @@ ```graphql +query { + tablesDBGetTransaction( + transactionId: "" + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/increment-row-column.md b/examples/1.9.x/client-graphql/examples/tablesdb/increment-row-column.md index 6d2b7e47a..8a0e478cd 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/increment-row-column.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/increment-row-column.md @@ -19,4 +19,24 @@ mutation { data } } +mutation { + tablesDBIncrementRowColumn( + databaseId: "", + tableId: "", + rowId: "", + column: "", + value: 0, + max: 0, + transactionId: "" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/list-rows.md b/examples/1.9.x/client-graphql/examples/tablesdb/list-rows.md index d7962b96e..6927344f1 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/list-rows.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/list-rows.md @@ -1,2 +1,24 @@ ```graphql +query { + tablesDBListRows( + databaseId: "", + tableId: "", + queries: [], + transactionId: "", + total: false, + ttl: 0 + ) { + total + rows { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/list-transactions.md b/examples/1.9.x/client-graphql/examples/tablesdb/list-transactions.md index d7962b96e..bc3663bec 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/list-transactions.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/list-transactions.md @@ -1,2 +1,17 @@ ```graphql +query { + tablesDBListTransactions( + queries: [] + ) { + total + transactions { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/update-row.md b/examples/1.9.x/client-graphql/examples/tablesdb/update-row.md index 5210f16e3..0a61504a9 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/update-row.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/update-row.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + tablesDBUpdateRow( + databaseId: "", + tableId: "", + rowId: "", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/update-transaction.md b/examples/1.9.x/client-graphql/examples/tablesdb/update-transaction.md index 0d0986b85..8c198fa45 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/update-transaction.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/update-transaction.md @@ -13,4 +13,18 @@ mutation { expiresAt } } +mutation { + tablesDBUpdateTransaction( + transactionId: "", + commit: false, + rollback: false + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/tablesdb/upsert-row.md b/examples/1.9.x/client-graphql/examples/tablesdb/upsert-row.md index 8b085a975..43f3e351f 100644 --- a/examples/1.9.x/client-graphql/examples/tablesdb/upsert-row.md +++ b/examples/1.9.x/client-graphql/examples/tablesdb/upsert-row.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + tablesDBUpsertRow( + databaseId: "", + tableId: "", + rowId: "", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/teams/create-membership.md b/examples/1.9.x/client-graphql/examples/teams/create-membership.md index 07b85b69e..fd578fee8 100644 --- a/examples/1.9.x/client-graphql/examples/teams/create-membership.md +++ b/examples/1.9.x/client-graphql/examples/teams/create-membership.md @@ -22,6 +22,34 @@ mutation { joined confirm mfa + userAccessedAt + roles + } +} +mutation { + teamsCreateMembership( + teamId: "", + roles: [], + email: "email@example.com", + userId: "", + phone: "+12065550100", + url: "https://example.com", + name: "" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + userPhone + teamId + teamName + invited + joined + confirm + mfa + userAccessedAt roles } } diff --git a/examples/1.9.x/client-graphql/examples/teams/create.md b/examples/1.9.x/client-graphql/examples/teams/create.md index c31af8335..fd085d926 100644 --- a/examples/1.9.x/client-graphql/examples/teams/create.md +++ b/examples/1.9.x/client-graphql/examples/teams/create.md @@ -15,4 +15,20 @@ mutation { } } } +mutation { + teamsCreate( + teamId: "", + name: "", + roles: [] + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/teams/get-membership.md b/examples/1.9.x/client-graphql/examples/teams/get-membership.md index d7962b96e..cccc945b4 100644 --- a/examples/1.9.x/client-graphql/examples/teams/get-membership.md +++ b/examples/1.9.x/client-graphql/examples/teams/get-membership.md @@ -1,2 +1,24 @@ ```graphql +query { + teamsGetMembership( + teamId: "", + membershipId: "" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + userPhone + teamId + teamName + invited + joined + confirm + mfa + userAccessedAt + roles + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/teams/get-prefs.md b/examples/1.9.x/client-graphql/examples/teams/get-prefs.md index d7962b96e..182735730 100644 --- a/examples/1.9.x/client-graphql/examples/teams/get-prefs.md +++ b/examples/1.9.x/client-graphql/examples/teams/get-prefs.md @@ -1,2 +1,9 @@ ```graphql +query { + teamsGetPrefs( + teamId: "" + ) { + data + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/teams/get.md b/examples/1.9.x/client-graphql/examples/teams/get.md index d7962b96e..17f4a5ee9 100644 --- a/examples/1.9.x/client-graphql/examples/teams/get.md +++ b/examples/1.9.x/client-graphql/examples/teams/get.md @@ -1,2 +1,16 @@ ```graphql +query { + teamsGet( + teamId: "" + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/teams/list-memberships.md b/examples/1.9.x/client-graphql/examples/teams/list-memberships.md index d7962b96e..9f76ab1d5 100644 --- a/examples/1.9.x/client-graphql/examples/teams/list-memberships.md +++ b/examples/1.9.x/client-graphql/examples/teams/list-memberships.md @@ -1,2 +1,29 @@ ```graphql +query { + teamsListMemberships( + teamId: "", + queries: [], + search: "", + total: false + ) { + total + memberships { + _id + _createdAt + _updatedAt + userId + userName + userEmail + userPhone + teamId + teamName + invited + joined + confirm + mfa + userAccessedAt + roles + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/teams/list.md b/examples/1.9.x/client-graphql/examples/teams/list.md index d7962b96e..a714bd0bc 100644 --- a/examples/1.9.x/client-graphql/examples/teams/list.md +++ b/examples/1.9.x/client-graphql/examples/teams/list.md @@ -1,2 +1,21 @@ ```graphql +query { + teamsList( + queries: [], + search: "", + total: false + ) { + total + teams { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/teams/update-membership-status.md b/examples/1.9.x/client-graphql/examples/teams/update-membership-status.md index 58d25696e..06bbe8aef 100644 --- a/examples/1.9.x/client-graphql/examples/teams/update-membership-status.md +++ b/examples/1.9.x/client-graphql/examples/teams/update-membership-status.md @@ -19,6 +19,31 @@ mutation { joined confirm mfa + userAccessedAt + roles + } +} +mutation { + teamsUpdateMembershipStatus( + teamId: "", + membershipId: "", + userId: "", + secret: "" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + userPhone + teamId + teamName + invited + joined + confirm + mfa + userAccessedAt roles } } diff --git a/examples/1.9.x/client-graphql/examples/teams/update-membership.md b/examples/1.9.x/client-graphql/examples/teams/update-membership.md index 4653e9bca..305b7b30f 100644 --- a/examples/1.9.x/client-graphql/examples/teams/update-membership.md +++ b/examples/1.9.x/client-graphql/examples/teams/update-membership.md @@ -18,6 +18,30 @@ mutation { joined confirm mfa + userAccessedAt + roles + } +} +mutation { + teamsUpdateMembership( + teamId: "", + membershipId: "", + roles: [] + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + userPhone + teamId + teamName + invited + joined + confirm + mfa + userAccessedAt roles } } diff --git a/examples/1.9.x/client-graphql/examples/teams/update-name.md b/examples/1.9.x/client-graphql/examples/teams/update-name.md index a3ce2bd1f..a5fa8def0 100644 --- a/examples/1.9.x/client-graphql/examples/teams/update-name.md +++ b/examples/1.9.x/client-graphql/examples/teams/update-name.md @@ -14,4 +14,19 @@ mutation { } } } +mutation { + teamsUpdateName( + teamId: "", + name: "" + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} ``` diff --git a/examples/1.9.x/client-graphql/examples/teams/update-prefs.md b/examples/1.9.x/client-graphql/examples/teams/update-prefs.md index 411431a12..0c63092a0 100644 --- a/examples/1.9.x/client-graphql/examples/teams/update-prefs.md +++ b/examples/1.9.x/client-graphql/examples/teams/update-prefs.md @@ -7,4 +7,12 @@ mutation { data } } +mutation { + teamsUpdatePrefs( + teamId: "", + prefs: "{}" + ) { + data + } +} ``` diff --git a/examples/1.9.x/client-react-native/examples/account/create.md b/examples/1.9.x/client-react-native/examples/account/create.md index c29ddc71e..14bb50d21 100644 --- a/examples/1.9.x/client-react-native/examples/account/create.md +++ b/examples/1.9.x/client-react-native/examples/account/create.md @@ -10,7 +10,7 @@ const account = new Account(client); const result = await account.create({ userId: '', email: 'email@example.com', - password: '', + password: 'password', name: '' // optional }); diff --git a/examples/1.9.x/client-react-native/examples/account/update-password.md b/examples/1.9.x/client-react-native/examples/account/update-password.md index 7ea08255d..5c3860c29 100644 --- a/examples/1.9.x/client-react-native/examples/account/update-password.md +++ b/examples/1.9.x/client-react-native/examples/account/update-password.md @@ -8,7 +8,7 @@ const client = new Client() const account = new Account(client); const result = await account.updatePassword({ - password: '', + password: 'password', oldPassword: 'password' // optional }); diff --git a/examples/1.9.x/client-react-native/examples/account/update-recovery.md b/examples/1.9.x/client-react-native/examples/account/update-recovery.md index faebfc469..6beab09a9 100644 --- a/examples/1.9.x/client-react-native/examples/account/update-recovery.md +++ b/examples/1.9.x/client-react-native/examples/account/update-recovery.md @@ -10,7 +10,7 @@ const account = new Account(client); const result = await account.updateRecovery({ userId: '', secret: '', - password: '' + password: 'password' }); console.log(result); diff --git a/examples/1.9.x/client-react-native/examples/avatars/get-browser.md b/examples/1.9.x/client-react-native/examples/avatars/get-browser.md index ff14a8c90..1fa157bae 100644 --- a/examples/1.9.x/client-react-native/examples/avatars/get-browser.md +++ b/examples/1.9.x/client-react-native/examples/avatars/get-browser.md @@ -3,7 +3,8 @@ import { Client, Avatars, Browser } from "react-native-appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-react-native/examples/avatars/get-credit-card.md b/examples/1.9.x/client-react-native/examples/avatars/get-credit-card.md index 1c83c95bc..2ff666179 100644 --- a/examples/1.9.x/client-react-native/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/client-react-native/examples/avatars/get-credit-card.md @@ -3,7 +3,8 @@ import { Client, Avatars, CreditCard } from "react-native-appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-react-native/examples/avatars/get-favicon.md b/examples/1.9.x/client-react-native/examples/avatars/get-favicon.md index c08209219..2153cafae 100644 --- a/examples/1.9.x/client-react-native/examples/avatars/get-favicon.md +++ b/examples/1.9.x/client-react-native/examples/avatars/get-favicon.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "react-native-appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-react-native/examples/avatars/get-flag.md b/examples/1.9.x/client-react-native/examples/avatars/get-flag.md index dd0fb7342..35398c995 100644 --- a/examples/1.9.x/client-react-native/examples/avatars/get-flag.md +++ b/examples/1.9.x/client-react-native/examples/avatars/get-flag.md @@ -3,7 +3,8 @@ import { Client, Avatars, Flag } from "react-native-appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-react-native/examples/avatars/get-image.md b/examples/1.9.x/client-react-native/examples/avatars/get-image.md index da1074827..a5cbbf80e 100644 --- a/examples/1.9.x/client-react-native/examples/avatars/get-image.md +++ b/examples/1.9.x/client-react-native/examples/avatars/get-image.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "react-native-appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-react-native/examples/avatars/get-initials.md b/examples/1.9.x/client-react-native/examples/avatars/get-initials.md index fbcf43ed0..8f3f9c4bd 100644 --- a/examples/1.9.x/client-react-native/examples/avatars/get-initials.md +++ b/examples/1.9.x/client-react-native/examples/avatars/get-initials.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "react-native-appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-react-native/examples/avatars/get-qr.md b/examples/1.9.x/client-react-native/examples/avatars/get-qr.md index b73c62150..746ba446f 100644 --- a/examples/1.9.x/client-react-native/examples/avatars/get-qr.md +++ b/examples/1.9.x/client-react-native/examples/avatars/get-qr.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "react-native-appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-react-native/examples/avatars/get-screenshot.md b/examples/1.9.x/client-react-native/examples/avatars/get-screenshot.md index bf88cf2b3..00d1f0433 100644 --- a/examples/1.9.x/client-react-native/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/client-react-native/examples/avatars/get-screenshot.md @@ -3,7 +3,8 @@ import { Client, Avatars, BrowserTheme, Timezone, BrowserPermission, ImageFormat const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-react-native/examples/storage/get-file-download.md b/examples/1.9.x/client-react-native/examples/storage/get-file-download.md index 52f602b9d..5a8e2bd04 100644 --- a/examples/1.9.x/client-react-native/examples/storage/get-file-download.md +++ b/examples/1.9.x/client-react-native/examples/storage/get-file-download.md @@ -3,7 +3,8 @@ import { Client, Storage } from "react-native-appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new Storage(client); diff --git a/examples/1.9.x/client-react-native/examples/storage/get-file-preview.md b/examples/1.9.x/client-react-native/examples/storage/get-file-preview.md index d3c944adc..d96cb01fb 100644 --- a/examples/1.9.x/client-react-native/examples/storage/get-file-preview.md +++ b/examples/1.9.x/client-react-native/examples/storage/get-file-preview.md @@ -3,7 +3,8 @@ import { Client, Storage, ImageGravity, ImageFormat } from "react-native-appwrit const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new Storage(client); diff --git a/examples/1.9.x/client-react-native/examples/storage/get-file-view.md b/examples/1.9.x/client-react-native/examples/storage/get-file-view.md index 28e6e43ab..f41c60242 100644 --- a/examples/1.9.x/client-react-native/examples/storage/get-file-view.md +++ b/examples/1.9.x/client-react-native/examples/storage/get-file-view.md @@ -3,7 +3,8 @@ import { Client, Storage } from "react-native-appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new Storage(client); diff --git a/examples/1.9.x/client-rest/examples/account/create-anonymous-session.md b/examples/1.9.x/client-rest/examples/account/create-anonymous-session.md index 4d9374b1f..86cfd4eb1 100644 --- a/examples/1.9.x/client-rest/examples/account/create-anonymous-session.md +++ b/examples/1.9.x/client-rest/examples/account/create-anonymous-session.md @@ -2,9 +2,9 @@ POST /v1/account/sessions/anonymous HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/create-email-password-session.md b/examples/1.9.x/client-rest/examples/account/create-email-password-session.md index 95c87871d..d37a82554 100644 --- a/examples/1.9.x/client-rest/examples/account/create-email-password-session.md +++ b/examples/1.9.x/client-rest/examples/account/create-email-password-session.md @@ -2,10 +2,14 @@ POST /v1/account/sessions/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "email": "email@example.com", + "password": "password" +} { "email": "email@example.com", diff --git a/examples/1.9.x/client-rest/examples/account/create-email-token.md b/examples/1.9.x/client-rest/examples/account/create-email-token.md index 8f2763ae6..f09aa38be 100644 --- a/examples/1.9.x/client-rest/examples/account/create-email-token.md +++ b/examples/1.9.x/client-rest/examples/account/create-email-token.md @@ -2,10 +2,15 @@ POST /v1/account/tokens/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "userId": "", + "email": "email@example.com", + "phrase": false +} { "userId": "", diff --git a/examples/1.9.x/client-rest/examples/account/create-email-verification.md b/examples/1.9.x/client-rest/examples/account/create-email-verification.md index f11c9256d..70f169608 100644 --- a/examples/1.9.x/client-rest/examples/account/create-email-verification.md +++ b/examples/1.9.x/client-rest/examples/account/create-email-verification.md @@ -2,10 +2,13 @@ POST /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "url": "https://example.com" +} { "url": "https://example.com" diff --git a/examples/1.9.x/client-rest/examples/account/create-jwt.md b/examples/1.9.x/client-rest/examples/account/create-jwt.md index 80b7cbb11..4fb1f39f4 100644 --- a/examples/1.9.x/client-rest/examples/account/create-jwt.md +++ b/examples/1.9.x/client-rest/examples/account/create-jwt.md @@ -2,10 +2,13 @@ POST /v1/account/jwts HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "duration": 0 +} { "duration": 0 diff --git a/examples/1.9.x/client-rest/examples/account/create-magic-url-token.md b/examples/1.9.x/client-rest/examples/account/create-magic-url-token.md index caadbb17e..162eadcc4 100644 --- a/examples/1.9.x/client-rest/examples/account/create-magic-url-token.md +++ b/examples/1.9.x/client-rest/examples/account/create-magic-url-token.md @@ -2,10 +2,16 @@ POST /v1/account/tokens/magic-url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "userId": "", + "email": "email@example.com", + "url": "https://example.com", + "phrase": false +} { "userId": "", diff --git a/examples/1.9.x/client-rest/examples/account/create-mfa-authenticator.md b/examples/1.9.x/client-rest/examples/account/create-mfa-authenticator.md index 549895b69..6985e4dd7 100644 --- a/examples/1.9.x/client-rest/examples/account/create-mfa-authenticator.md +++ b/examples/1.9.x/client-rest/examples/account/create-mfa-authenticator.md @@ -2,9 +2,9 @@ POST /v1/account/mfa/authenticators/{type} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/create-mfa-challenge.md b/examples/1.9.x/client-rest/examples/account/create-mfa-challenge.md index a4d644866..74d99f626 100644 --- a/examples/1.9.x/client-rest/examples/account/create-mfa-challenge.md +++ b/examples/1.9.x/client-rest/examples/account/create-mfa-challenge.md @@ -2,10 +2,13 @@ POST /v1/account/mfa/challenges HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "factor": "email" +} { "factor": "email" diff --git a/examples/1.9.x/client-rest/examples/account/create-mfa-recovery-codes.md b/examples/1.9.x/client-rest/examples/account/create-mfa-recovery-codes.md index 59ada759c..fdc7d3375 100644 --- a/examples/1.9.x/client-rest/examples/account/create-mfa-recovery-codes.md +++ b/examples/1.9.x/client-rest/examples/account/create-mfa-recovery-codes.md @@ -2,9 +2,9 @@ POST /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/create-o-auth-2-session.md b/examples/1.9.x/client-rest/examples/account/create-o-auth-2-session.md index a22860075..a1db8939a 100644 --- a/examples/1.9.x/client-rest/examples/account/create-o-auth-2-session.md +++ b/examples/1.9.x/client-rest/examples/account/create-o-auth-2-session.md @@ -1,8 +1,7 @@ ```http GET /v1/account/sessions/oauth2/{provider} HTTP/1.1 Host: cloud.appwrite.io +Accept: text/html X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/account/create-o-auth-2-token.md b/examples/1.9.x/client-rest/examples/account/create-o-auth-2-token.md index 660264560..931a965f1 100644 --- a/examples/1.9.x/client-rest/examples/account/create-o-auth-2-token.md +++ b/examples/1.9.x/client-rest/examples/account/create-o-auth-2-token.md @@ -1,8 +1,7 @@ ```http GET /v1/account/tokens/oauth2/{provider} HTTP/1.1 Host: cloud.appwrite.io +Accept: text/html X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/account/create-phone-token.md b/examples/1.9.x/client-rest/examples/account/create-phone-token.md index a5c677b33..2c78cef88 100644 --- a/examples/1.9.x/client-rest/examples/account/create-phone-token.md +++ b/examples/1.9.x/client-rest/examples/account/create-phone-token.md @@ -2,10 +2,14 @@ POST /v1/account/tokens/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "userId": "", + "phone": "+12065550100" +} { "userId": "", diff --git a/examples/1.9.x/client-rest/examples/account/create-phone-verification.md b/examples/1.9.x/client-rest/examples/account/create-phone-verification.md index 3e37fdde1..144fbe7a3 100644 --- a/examples/1.9.x/client-rest/examples/account/create-phone-verification.md +++ b/examples/1.9.x/client-rest/examples/account/create-phone-verification.md @@ -2,9 +2,9 @@ POST /v1/account/verifications/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/create-push-target.md b/examples/1.9.x/client-rest/examples/account/create-push-target.md index 5e80f853d..716d587ed 100644 --- a/examples/1.9.x/client-rest/examples/account/create-push-target.md +++ b/examples/1.9.x/client-rest/examples/account/create-push-target.md @@ -2,9 +2,15 @@ POST /v1/account/targets/push HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: + +{ + "targetId": "", + "identifier": "", + "providerId": "" +} { "targetId": "", diff --git a/examples/1.9.x/client-rest/examples/account/create-recovery.md b/examples/1.9.x/client-rest/examples/account/create-recovery.md index 7b3512ae9..ff610b1f8 100644 --- a/examples/1.9.x/client-rest/examples/account/create-recovery.md +++ b/examples/1.9.x/client-rest/examples/account/create-recovery.md @@ -2,10 +2,14 @@ POST /v1/account/recovery HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "email": "email@example.com", + "url": "https://example.com" +} { "email": "email@example.com", diff --git a/examples/1.9.x/client-rest/examples/account/create-session.md b/examples/1.9.x/client-rest/examples/account/create-session.md index 13aef6b2a..5f3cecc67 100644 --- a/examples/1.9.x/client-rest/examples/account/create-session.md +++ b/examples/1.9.x/client-rest/examples/account/create-session.md @@ -2,10 +2,14 @@ POST /v1/account/sessions/token HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "userId": "", + "secret": "" +} { "userId": "", diff --git a/examples/1.9.x/client-rest/examples/account/create-verification.md b/examples/1.9.x/client-rest/examples/account/create-verification.md index f11c9256d..70f169608 100644 --- a/examples/1.9.x/client-rest/examples/account/create-verification.md +++ b/examples/1.9.x/client-rest/examples/account/create-verification.md @@ -2,10 +2,13 @@ POST /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "url": "https://example.com" +} { "url": "https://example.com" diff --git a/examples/1.9.x/client-rest/examples/account/create.md b/examples/1.9.x/client-rest/examples/account/create.md index 1f845f01a..78a8adfcc 100644 --- a/examples/1.9.x/client-rest/examples/account/create.md +++ b/examples/1.9.x/client-rest/examples/account/create.md @@ -2,15 +2,21 @@ POST /v1/account HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: { "userId": "", "email": "email@example.com", - "password": "", + "password": "password", + "name": "" +} + +{ + "userId": "", + "email": "email@example.com", + "password": "password", "name": "" } ``` diff --git a/examples/1.9.x/client-rest/examples/account/delete-identity.md b/examples/1.9.x/client-rest/examples/account/delete-identity.md index c510090af..9833b6143 100644 --- a/examples/1.9.x/client-rest/examples/account/delete-identity.md +++ b/examples/1.9.x/client-rest/examples/account/delete-identity.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/account/delete-mfa-authenticator.md b/examples/1.9.x/client-rest/examples/account/delete-mfa-authenticator.md index 8da06fb10..2d5dac3e3 100644 --- a/examples/1.9.x/client-rest/examples/account/delete-mfa-authenticator.md +++ b/examples/1.9.x/client-rest/examples/account/delete-mfa-authenticator.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/account/delete-push-target.md b/examples/1.9.x/client-rest/examples/account/delete-push-target.md index d2bbd4463..f81afddc3 100644 --- a/examples/1.9.x/client-rest/examples/account/delete-push-target.md +++ b/examples/1.9.x/client-rest/examples/account/delete-push-target.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: ``` diff --git a/examples/1.9.x/client-rest/examples/account/delete-session.md b/examples/1.9.x/client-rest/examples/account/delete-session.md index 7044fb19e..13f4ac7a0 100644 --- a/examples/1.9.x/client-rest/examples/account/delete-session.md +++ b/examples/1.9.x/client-rest/examples/account/delete-session.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/account/delete-sessions.md b/examples/1.9.x/client-rest/examples/account/delete-sessions.md index 511f8d151..1bf29ad2e 100644 --- a/examples/1.9.x/client-rest/examples/account/delete-sessions.md +++ b/examples/1.9.x/client-rest/examples/account/delete-sessions.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/account/get-mfa-recovery-codes.md b/examples/1.9.x/client-rest/examples/account/get-mfa-recovery-codes.md index a0a902f9a..232d81807 100644 --- a/examples/1.9.x/client-rest/examples/account/get-mfa-recovery-codes.md +++ b/examples/1.9.x/client-rest/examples/account/get-mfa-recovery-codes.md @@ -1,8 +1,8 @@ ```http GET /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/get-prefs.md b/examples/1.9.x/client-rest/examples/account/get-prefs.md index 99b97bcf5..229107e49 100644 --- a/examples/1.9.x/client-rest/examples/account/get-prefs.md +++ b/examples/1.9.x/client-rest/examples/account/get-prefs.md @@ -1,8 +1,8 @@ ```http GET /v1/account/prefs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/get-session.md b/examples/1.9.x/client-rest/examples/account/get-session.md index 3799251ab..5eddb7f77 100644 --- a/examples/1.9.x/client-rest/examples/account/get-session.md +++ b/examples/1.9.x/client-rest/examples/account/get-session.md @@ -1,8 +1,8 @@ ```http GET /v1/account/sessions/{sessionId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/get.md b/examples/1.9.x/client-rest/examples/account/get.md index e61f07626..f4ff4b834 100644 --- a/examples/1.9.x/client-rest/examples/account/get.md +++ b/examples/1.9.x/client-rest/examples/account/get.md @@ -1,8 +1,8 @@ ```http GET /v1/account HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/list-identities.md b/examples/1.9.x/client-rest/examples/account/list-identities.md index 0813a1bf5..418556f0d 100644 --- a/examples/1.9.x/client-rest/examples/account/list-identities.md +++ b/examples/1.9.x/client-rest/examples/account/list-identities.md @@ -1,8 +1,8 @@ ```http GET /v1/account/identities HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/list-logs.md b/examples/1.9.x/client-rest/examples/account/list-logs.md index cc8110e07..24ad00cf2 100644 --- a/examples/1.9.x/client-rest/examples/account/list-logs.md +++ b/examples/1.9.x/client-rest/examples/account/list-logs.md @@ -1,8 +1,8 @@ ```http GET /v1/account/logs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/list-mfa-factors.md b/examples/1.9.x/client-rest/examples/account/list-mfa-factors.md index 2de5e9a27..b2429265f 100644 --- a/examples/1.9.x/client-rest/examples/account/list-mfa-factors.md +++ b/examples/1.9.x/client-rest/examples/account/list-mfa-factors.md @@ -1,8 +1,8 @@ ```http GET /v1/account/mfa/factors HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/list-sessions.md b/examples/1.9.x/client-rest/examples/account/list-sessions.md index c7dc84d7b..4da0c7014 100644 --- a/examples/1.9.x/client-rest/examples/account/list-sessions.md +++ b/examples/1.9.x/client-rest/examples/account/list-sessions.md @@ -1,8 +1,8 @@ ```http GET /v1/account/sessions HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/update-email-verification.md b/examples/1.9.x/client-rest/examples/account/update-email-verification.md index 6ea3255e7..c2f9de20a 100644 --- a/examples/1.9.x/client-rest/examples/account/update-email-verification.md +++ b/examples/1.9.x/client-rest/examples/account/update-email-verification.md @@ -2,10 +2,14 @@ PUT /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "userId": "", + "secret": "" +} { "userId": "", diff --git a/examples/1.9.x/client-rest/examples/account/update-email.md b/examples/1.9.x/client-rest/examples/account/update-email.md index 841d076b8..05de98b21 100644 --- a/examples/1.9.x/client-rest/examples/account/update-email.md +++ b/examples/1.9.x/client-rest/examples/account/update-email.md @@ -2,10 +2,14 @@ PATCH /v1/account/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "email": "email@example.com", + "password": "password" +} { "email": "email@example.com", diff --git a/examples/1.9.x/client-rest/examples/account/update-magic-url-session.md b/examples/1.9.x/client-rest/examples/account/update-magic-url-session.md index 273bf326b..38e294434 100644 --- a/examples/1.9.x/client-rest/examples/account/update-magic-url-session.md +++ b/examples/1.9.x/client-rest/examples/account/update-magic-url-session.md @@ -2,10 +2,14 @@ PUT /v1/account/sessions/magic-url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "userId": "", + "secret": "" +} { "userId": "", diff --git a/examples/1.9.x/client-rest/examples/account/update-mfa-authenticator.md b/examples/1.9.x/client-rest/examples/account/update-mfa-authenticator.md index e7464765d..4c794f227 100644 --- a/examples/1.9.x/client-rest/examples/account/update-mfa-authenticator.md +++ b/examples/1.9.x/client-rest/examples/account/update-mfa-authenticator.md @@ -2,10 +2,13 @@ PUT /v1/account/mfa/authenticators/{type} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "otp": "" +} { "otp": "" diff --git a/examples/1.9.x/client-rest/examples/account/update-mfa-challenge.md b/examples/1.9.x/client-rest/examples/account/update-mfa-challenge.md index 9964263cc..16d693747 100644 --- a/examples/1.9.x/client-rest/examples/account/update-mfa-challenge.md +++ b/examples/1.9.x/client-rest/examples/account/update-mfa-challenge.md @@ -2,10 +2,14 @@ PUT /v1/account/mfa/challenges HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "challengeId": "", + "otp": "" +} { "challengeId": "", diff --git a/examples/1.9.x/client-rest/examples/account/update-mfa-recovery-codes.md b/examples/1.9.x/client-rest/examples/account/update-mfa-recovery-codes.md index bd2c3832d..9887b4374 100644 --- a/examples/1.9.x/client-rest/examples/account/update-mfa-recovery-codes.md +++ b/examples/1.9.x/client-rest/examples/account/update-mfa-recovery-codes.md @@ -2,9 +2,9 @@ PATCH /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/update-mfa.md b/examples/1.9.x/client-rest/examples/account/update-mfa.md index a117bb6e1..f0ab3fee3 100644 --- a/examples/1.9.x/client-rest/examples/account/update-mfa.md +++ b/examples/1.9.x/client-rest/examples/account/update-mfa.md @@ -2,10 +2,13 @@ PATCH /v1/account/mfa HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "mfa": false +} { "mfa": false diff --git a/examples/1.9.x/client-rest/examples/account/update-name.md b/examples/1.9.x/client-rest/examples/account/update-name.md index 7159a49e3..2ea52fb66 100644 --- a/examples/1.9.x/client-rest/examples/account/update-name.md +++ b/examples/1.9.x/client-rest/examples/account/update-name.md @@ -2,10 +2,13 @@ PATCH /v1/account/name HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "name": "" +} { "name": "" diff --git a/examples/1.9.x/client-rest/examples/account/update-password.md b/examples/1.9.x/client-rest/examples/account/update-password.md index dbde18b56..f191517bd 100644 --- a/examples/1.9.x/client-rest/examples/account/update-password.md +++ b/examples/1.9.x/client-rest/examples/account/update-password.md @@ -2,13 +2,17 @@ PATCH /v1/account/password HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: { - "password": "", + "password": "password", + "oldPassword": "password" +} + +{ + "password": "password", "oldPassword": "password" } ``` diff --git a/examples/1.9.x/client-rest/examples/account/update-phone-session.md b/examples/1.9.x/client-rest/examples/account/update-phone-session.md index 82e387bf7..afeb4dfb0 100644 --- a/examples/1.9.x/client-rest/examples/account/update-phone-session.md +++ b/examples/1.9.x/client-rest/examples/account/update-phone-session.md @@ -2,10 +2,14 @@ PUT /v1/account/sessions/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "userId": "", + "secret": "" +} { "userId": "", diff --git a/examples/1.9.x/client-rest/examples/account/update-phone-verification.md b/examples/1.9.x/client-rest/examples/account/update-phone-verification.md index 1f68f5080..b8f78ba32 100644 --- a/examples/1.9.x/client-rest/examples/account/update-phone-verification.md +++ b/examples/1.9.x/client-rest/examples/account/update-phone-verification.md @@ -2,10 +2,14 @@ PUT /v1/account/verifications/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "userId": "", + "secret": "" +} { "userId": "", diff --git a/examples/1.9.x/client-rest/examples/account/update-phone.md b/examples/1.9.x/client-rest/examples/account/update-phone.md index 42d99202e..cfe3dfda9 100644 --- a/examples/1.9.x/client-rest/examples/account/update-phone.md +++ b/examples/1.9.x/client-rest/examples/account/update-phone.md @@ -2,10 +2,14 @@ PATCH /v1/account/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "phone": "+12065550100", + "password": "password" +} { "phone": "+12065550100", diff --git a/examples/1.9.x/client-rest/examples/account/update-prefs.md b/examples/1.9.x/client-rest/examples/account/update-prefs.md index 5795da398..69dae5c7f 100644 --- a/examples/1.9.x/client-rest/examples/account/update-prefs.md +++ b/examples/1.9.x/client-rest/examples/account/update-prefs.md @@ -2,10 +2,17 @@ PATCH /v1/account/prefs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "prefs": { + "language": "en", + "timezone": "UTC", + "darkTheme": true + } +} { "prefs": { diff --git a/examples/1.9.x/client-rest/examples/account/update-push-target.md b/examples/1.9.x/client-rest/examples/account/update-push-target.md index f5ec15530..901daca8b 100644 --- a/examples/1.9.x/client-rest/examples/account/update-push-target.md +++ b/examples/1.9.x/client-rest/examples/account/update-push-target.md @@ -2,9 +2,13 @@ PUT /v1/account/targets/{targetId}/push HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: + +{ + "identifier": "" +} { "identifier": "" diff --git a/examples/1.9.x/client-rest/examples/account/update-recovery.md b/examples/1.9.x/client-rest/examples/account/update-recovery.md index ebe7ee91f..4227f9fab 100644 --- a/examples/1.9.x/client-rest/examples/account/update-recovery.md +++ b/examples/1.9.x/client-rest/examples/account/update-recovery.md @@ -2,14 +2,19 @@ PUT /v1/account/recovery HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: { "userId": "", "secret": "", - "password": "" + "password": "password" +} + +{ + "userId": "", + "secret": "", + "password": "password" } ``` diff --git a/examples/1.9.x/client-rest/examples/account/update-session.md b/examples/1.9.x/client-rest/examples/account/update-session.md index 6c9cf78f7..e29298f70 100644 --- a/examples/1.9.x/client-rest/examples/account/update-session.md +++ b/examples/1.9.x/client-rest/examples/account/update-session.md @@ -2,9 +2,9 @@ PATCH /v1/account/sessions/{sessionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/update-status.md b/examples/1.9.x/client-rest/examples/account/update-status.md index b57e878df..43905851e 100644 --- a/examples/1.9.x/client-rest/examples/account/update-status.md +++ b/examples/1.9.x/client-rest/examples/account/update-status.md @@ -2,9 +2,9 @@ PATCH /v1/account/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/account/update-verification.md b/examples/1.9.x/client-rest/examples/account/update-verification.md index 6ea3255e7..c2f9de20a 100644 --- a/examples/1.9.x/client-rest/examples/account/update-verification.md +++ b/examples/1.9.x/client-rest/examples/account/update-verification.md @@ -2,10 +2,14 @@ PUT /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "userId": "", + "secret": "" +} { "userId": "", diff --git a/examples/1.9.x/client-rest/examples/avatars/get-browser.md b/examples/1.9.x/client-rest/examples/avatars/get-browser.md index 4d101a2b2..08aa956fd 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-browser.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-browser.md @@ -1,8 +1,7 @@ ```http GET /v1/avatars/browsers/{code} HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/avatars/get-credit-card.md b/examples/1.9.x/client-rest/examples/avatars/get-credit-card.md index fb2c879ca..e77defdb2 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-credit-card.md @@ -1,8 +1,7 @@ ```http GET /v1/avatars/credit-cards/{code} HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/avatars/get-favicon.md b/examples/1.9.x/client-rest/examples/avatars/get-favicon.md index 5e5a2222f..aa2b1712f 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-favicon.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-favicon.md @@ -1,8 +1,7 @@ ```http GET /v1/avatars/favicon HTTP/1.1 Host: cloud.appwrite.io +Accept: image/* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/avatars/get-flag.md b/examples/1.9.x/client-rest/examples/avatars/get-flag.md index 389a4fd86..084eff36a 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-flag.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-flag.md @@ -1,8 +1,7 @@ ```http GET /v1/avatars/flags/{code} HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/avatars/get-image.md b/examples/1.9.x/client-rest/examples/avatars/get-image.md index a05f1b477..72309cc58 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-image.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-image.md @@ -1,8 +1,7 @@ ```http GET /v1/avatars/image HTTP/1.1 Host: cloud.appwrite.io +Accept: image/* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/avatars/get-initials.md b/examples/1.9.x/client-rest/examples/avatars/get-initials.md index 4b160d053..4cf077af7 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-initials.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-initials.md @@ -1,8 +1,7 @@ ```http GET /v1/avatars/initials HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/avatars/get-qr.md b/examples/1.9.x/client-rest/examples/avatars/get-qr.md index 5412b8450..1b0e9c60c 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-qr.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-qr.md @@ -1,8 +1,7 @@ ```http GET /v1/avatars/qr HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/avatars/get-screenshot.md b/examples/1.9.x/client-rest/examples/avatars/get-screenshot.md index c3089203c..aaa7340a5 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-screenshot.md @@ -1,8 +1,7 @@ ```http GET /v1/avatars/screenshots HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/databases/create-document.md b/examples/1.9.x/client-rest/examples/databases/create-document.md index bbed1636b..d6a37128b 100644 --- a/examples/1.9.x/client-rest/examples/databases/create-document.md +++ b/examples/1.9.x/client-rest/examples/databases/create-document.md @@ -2,10 +2,22 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "documentId": "", + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "" +} { "documentId": "", diff --git a/examples/1.9.x/client-rest/examples/databases/create-operations.md b/examples/1.9.x/client-rest/examples/databases/create-operations.md index 381988cff..74537e862 100644 --- a/examples/1.9.x/client-rest/examples/databases/create-operations.md +++ b/examples/1.9.x/client-rest/examples/databases/create-operations.md @@ -2,10 +2,23 @@ POST /v1/databases/transactions/{transactionId}/operations HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "operations": [ + { + "action": "create", + "databaseId": "", + "collectionId": "", + "documentId": "", + "data": { + "name": "Walter O'Brien" + } + } + ] +} { "operations": [ diff --git a/examples/1.9.x/client-rest/examples/databases/create-transaction.md b/examples/1.9.x/client-rest/examples/databases/create-transaction.md index 21c60559d..4fde327e7 100644 --- a/examples/1.9.x/client-rest/examples/databases/create-transaction.md +++ b/examples/1.9.x/client-rest/examples/databases/create-transaction.md @@ -2,10 +2,13 @@ POST /v1/databases/transactions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "ttl": 60 +} { "ttl": 60 diff --git a/examples/1.9.x/client-rest/examples/databases/decrement-document-attribute.md b/examples/1.9.x/client-rest/examples/databases/decrement-document-attribute.md index ac42e81f5..a1b48c20a 100644 --- a/examples/1.9.x/client-rest/examples/databases/decrement-document-attribute.md +++ b/examples/1.9.x/client-rest/examples/databases/decrement-document-attribute.md @@ -2,10 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/decrement HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "value": 0, + "min": 0, + "transactionId": "" +} { "value": 0, diff --git a/examples/1.9.x/client-rest/examples/databases/delete-document.md b/examples/1.9.x/client-rest/examples/databases/delete-document.md index c820f6955..a4472d07a 100644 --- a/examples/1.9.x/client-rest/examples/databases/delete-document.md +++ b/examples/1.9.x/client-rest/examples/databases/delete-document.md @@ -4,8 +4,6 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: { "transactionId": "" diff --git a/examples/1.9.x/client-rest/examples/databases/delete-transaction.md b/examples/1.9.x/client-rest/examples/databases/delete-transaction.md index 41650ec61..d7d8e21d3 100644 --- a/examples/1.9.x/client-rest/examples/databases/delete-transaction.md +++ b/examples/1.9.x/client-rest/examples/databases/delete-transaction.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/databases/get-document.md b/examples/1.9.x/client-rest/examples/databases/get-document.md index 88c505c03..6760bfe21 100644 --- a/examples/1.9.x/client-rest/examples/databases/get-document.md +++ b/examples/1.9.x/client-rest/examples/databases/get-document.md @@ -1,8 +1,8 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/databases/get-transaction.md b/examples/1.9.x/client-rest/examples/databases/get-transaction.md index 00685e04f..2ccc35124 100644 --- a/examples/1.9.x/client-rest/examples/databases/get-transaction.md +++ b/examples/1.9.x/client-rest/examples/databases/get-transaction.md @@ -1,8 +1,8 @@ ```http GET /v1/databases/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/databases/increment-document-attribute.md b/examples/1.9.x/client-rest/examples/databases/increment-document-attribute.md index 71f218530..6e1e384e1 100644 --- a/examples/1.9.x/client-rest/examples/databases/increment-document-attribute.md +++ b/examples/1.9.x/client-rest/examples/databases/increment-document-attribute.md @@ -2,10 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/increment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "value": 0, + "max": 0, + "transactionId": "" +} { "value": 0, diff --git a/examples/1.9.x/client-rest/examples/databases/list-documents.md b/examples/1.9.x/client-rest/examples/databases/list-documents.md index d28bd015a..71fedf120 100644 --- a/examples/1.9.x/client-rest/examples/databases/list-documents.md +++ b/examples/1.9.x/client-rest/examples/databases/list-documents.md @@ -1,8 +1,8 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/databases/list-transactions.md b/examples/1.9.x/client-rest/examples/databases/list-transactions.md index b3d38b242..45b09ded2 100644 --- a/examples/1.9.x/client-rest/examples/databases/list-transactions.md +++ b/examples/1.9.x/client-rest/examples/databases/list-transactions.md @@ -1,8 +1,8 @@ ```http GET /v1/databases/transactions HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/databases/update-document.md b/examples/1.9.x/client-rest/examples/databases/update-document.md index ab96d6f44..1e99373c4 100644 --- a/examples/1.9.x/client-rest/examples/databases/update-document.md +++ b/examples/1.9.x/client-rest/examples/databases/update-document.md @@ -2,10 +2,21 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "" +} { "data": { diff --git a/examples/1.9.x/client-rest/examples/databases/update-transaction.md b/examples/1.9.x/client-rest/examples/databases/update-transaction.md index cbe45ac43..34acb91b1 100644 --- a/examples/1.9.x/client-rest/examples/databases/update-transaction.md +++ b/examples/1.9.x/client-rest/examples/databases/update-transaction.md @@ -2,10 +2,14 @@ PATCH /v1/databases/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "commit": false, + "rollback": false +} { "commit": false, diff --git a/examples/1.9.x/client-rest/examples/databases/upsert-document.md b/examples/1.9.x/client-rest/examples/databases/upsert-document.md index 8b7672527..3dde00359 100644 --- a/examples/1.9.x/client-rest/examples/databases/upsert-document.md +++ b/examples/1.9.x/client-rest/examples/databases/upsert-document.md @@ -2,10 +2,21 @@ PUT /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "" +} { "data": { diff --git a/examples/1.9.x/client-rest/examples/functions/create-execution.md b/examples/1.9.x/client-rest/examples/functions/create-execution.md index 8e298ceae..c118443fb 100644 --- a/examples/1.9.x/client-rest/examples/functions/create-execution.md +++ b/examples/1.9.x/client-rest/examples/functions/create-execution.md @@ -2,10 +2,18 @@ POST /v1/functions/{functionId}/executions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "body": "", + "async": false, + "path": "", + "method": "GET", + "headers": {}, + "scheduledAt": "" +} { "body": "", diff --git a/examples/1.9.x/client-rest/examples/functions/get-execution.md b/examples/1.9.x/client-rest/examples/functions/get-execution.md index 93a2399cf..2a48f2abd 100644 --- a/examples/1.9.x/client-rest/examples/functions/get-execution.md +++ b/examples/1.9.x/client-rest/examples/functions/get-execution.md @@ -1,8 +1,8 @@ ```http GET /v1/functions/{functionId}/executions/{executionId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/functions/list-executions.md b/examples/1.9.x/client-rest/examples/functions/list-executions.md index 453de6d13..e4fe41b1b 100644 --- a/examples/1.9.x/client-rest/examples/functions/list-executions.md +++ b/examples/1.9.x/client-rest/examples/functions/list-executions.md @@ -1,8 +1,8 @@ ```http GET /v1/functions/{functionId}/executions HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/graphql/mutation.md b/examples/1.9.x/client-rest/examples/graphql/mutation.md index cfc268ff0..3885359b7 100644 --- a/examples/1.9.x/client-rest/examples/graphql/mutation.md +++ b/examples/1.9.x/client-rest/examples/graphql/mutation.md @@ -3,10 +3,13 @@ POST /v1/graphql/mutation HTTP/1.1 Host: cloud.appwrite.io X-Sdk-Graphql: true Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "query": {} +} { "query": {} diff --git a/examples/1.9.x/client-rest/examples/graphql/query.md b/examples/1.9.x/client-rest/examples/graphql/query.md index 70d218693..02fbb9f31 100644 --- a/examples/1.9.x/client-rest/examples/graphql/query.md +++ b/examples/1.9.x/client-rest/examples/graphql/query.md @@ -3,10 +3,13 @@ POST /v1/graphql HTTP/1.1 Host: cloud.appwrite.io X-Sdk-Graphql: true Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "query": {} +} { "query": {} diff --git a/examples/1.9.x/client-rest/examples/locale/get.md b/examples/1.9.x/client-rest/examples/locale/get.md index 991249d62..0a94eabb9 100644 --- a/examples/1.9.x/client-rest/examples/locale/get.md +++ b/examples/1.9.x/client-rest/examples/locale/get.md @@ -1,8 +1,8 @@ ```http GET /v1/locale HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/locale/list-codes.md b/examples/1.9.x/client-rest/examples/locale/list-codes.md index d4b151bf8..8c3d3b0be 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-codes.md +++ b/examples/1.9.x/client-rest/examples/locale/list-codes.md @@ -1,8 +1,8 @@ ```http GET /v1/locale/codes HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/locale/list-continents.md b/examples/1.9.x/client-rest/examples/locale/list-continents.md index 77a6240e6..65bd3de26 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-continents.md +++ b/examples/1.9.x/client-rest/examples/locale/list-continents.md @@ -1,8 +1,8 @@ ```http GET /v1/locale/continents HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/locale/list-countries-eu.md b/examples/1.9.x/client-rest/examples/locale/list-countries-eu.md index 7cf0d2cf1..70c694303 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-countries-eu.md +++ b/examples/1.9.x/client-rest/examples/locale/list-countries-eu.md @@ -1,8 +1,8 @@ ```http GET /v1/locale/countries/eu HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/locale/list-countries-phones.md b/examples/1.9.x/client-rest/examples/locale/list-countries-phones.md index 6a4154e92..87d891629 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-countries-phones.md +++ b/examples/1.9.x/client-rest/examples/locale/list-countries-phones.md @@ -1,8 +1,8 @@ ```http GET /v1/locale/countries/phones HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/locale/list-countries.md b/examples/1.9.x/client-rest/examples/locale/list-countries.md index ef37ce08a..1da657fa0 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-countries.md +++ b/examples/1.9.x/client-rest/examples/locale/list-countries.md @@ -1,8 +1,8 @@ ```http GET /v1/locale/countries HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/locale/list-currencies.md b/examples/1.9.x/client-rest/examples/locale/list-currencies.md index 7e345328d..7aa5bf1a8 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-currencies.md +++ b/examples/1.9.x/client-rest/examples/locale/list-currencies.md @@ -1,8 +1,8 @@ ```http GET /v1/locale/currencies HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/locale/list-languages.md b/examples/1.9.x/client-rest/examples/locale/list-languages.md index 0d45a439b..a4f74808f 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-languages.md +++ b/examples/1.9.x/client-rest/examples/locale/list-languages.md @@ -1,8 +1,8 @@ ```http GET /v1/locale/languages HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/messaging/create-subscriber.md b/examples/1.9.x/client-rest/examples/messaging/create-subscriber.md index 42325cf12..b024bf092 100644 --- a/examples/1.9.x/client-rest/examples/messaging/create-subscriber.md +++ b/examples/1.9.x/client-rest/examples/messaging/create-subscriber.md @@ -2,10 +2,14 @@ POST /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-JWT: -X-Appwrite-Session: + +{ + "subscriberId": "", + "targetId": "" +} { "subscriberId": "", diff --git a/examples/1.9.x/client-rest/examples/messaging/delete-subscriber.md b/examples/1.9.x/client-rest/examples/messaging/delete-subscriber.md index a028c7312..3c0e3402c 100644 --- a/examples/1.9.x/client-rest/examples/messaging/delete-subscriber.md +++ b/examples/1.9.x/client-rest/examples/messaging/delete-subscriber.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-JWT: -X-Appwrite-Session: ``` diff --git a/examples/1.9.x/client-rest/examples/presences/delete.md b/examples/1.9.x/client-rest/examples/presences/delete.md index ce437718b..e8360375a 100644 --- a/examples/1.9.x/client-rest/examples/presences/delete.md +++ b/examples/1.9.x/client-rest/examples/presences/delete.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/presences/get.md b/examples/1.9.x/client-rest/examples/presences/get.md index efd0a0811..d7a45180b 100644 --- a/examples/1.9.x/client-rest/examples/presences/get.md +++ b/examples/1.9.x/client-rest/examples/presences/get.md @@ -1,8 +1,8 @@ ```http GET /v1/presences/{presenceId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/presences/list.md b/examples/1.9.x/client-rest/examples/presences/list.md index ee10a24a2..d64d29391 100644 --- a/examples/1.9.x/client-rest/examples/presences/list.md +++ b/examples/1.9.x/client-rest/examples/presences/list.md @@ -1,8 +1,8 @@ ```http GET /v1/presences HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/presences/update.md b/examples/1.9.x/client-rest/examples/presences/update.md index 2acc28581..6191d94f4 100644 --- a/examples/1.9.x/client-rest/examples/presences/update.md +++ b/examples/1.9.x/client-rest/examples/presences/update.md @@ -2,9 +2,17 @@ PATCH /v1/presences/{presenceId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: + +{ + "status": "", + "expiresAt": "2020-10-15T06:38:00.000+00:00", + "metadata": {}, + "permissions": ["read(\"any\")"], + "purge": false +} { "status": "", diff --git a/examples/1.9.x/client-rest/examples/presences/upsert.md b/examples/1.9.x/client-rest/examples/presences/upsert.md index 2c069a283..e2ed75341 100644 --- a/examples/1.9.x/client-rest/examples/presences/upsert.md +++ b/examples/1.9.x/client-rest/examples/presences/upsert.md @@ -2,9 +2,16 @@ PUT /v1/presences/{presenceId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: + +{ + "status": "", + "permissions": ["read(\"any\")"], + "expiresAt": "2020-10-15T06:38:00.000+00:00", + "metadata": {} +} { "status": "", diff --git a/examples/1.9.x/client-rest/examples/storage/create-file.md b/examples/1.9.x/client-rest/examples/storage/create-file.md index 256ddaa07..a126c6c86 100644 --- a/examples/1.9.x/client-rest/examples/storage/create-file.md +++ b/examples/1.9.x/client-rest/examples/storage/create-file.md @@ -2,10 +2,9 @@ POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: Content-Length: *Length of your entity body in bytes* --cec8e8123c05ba25 @@ -24,4 +23,10 @@ Content-Disposition: form-data; name="permissions[]" ["read(\"any\")"] --cec8e8123c05ba25-- + +{ + "fileId": "", + "file": cf 94 84 24 8d c4 91 10 0f dc 54 26 6c 8e 4b bc e8 ee 55 94 29 e7 94 89 19 26 28 01 26 29 3f 16..., + "permissions": ["read(\"any\")"] +} ``` diff --git a/examples/1.9.x/client-rest/examples/storage/delete-file.md b/examples/1.9.x/client-rest/examples/storage/delete-file.md index ac731d3da..6896905e0 100644 --- a/examples/1.9.x/client-rest/examples/storage/delete-file.md +++ b/examples/1.9.x/client-rest/examples/storage/delete-file.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/storage/get-file-download.md b/examples/1.9.x/client-rest/examples/storage/get-file-download.md index e2060a678..65a2b3fd4 100644 --- a/examples/1.9.x/client-rest/examples/storage/get-file-download.md +++ b/examples/1.9.x/client-rest/examples/storage/get-file-download.md @@ -1,8 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/download HTTP/1.1 Host: cloud.appwrite.io +Accept: */* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/storage/get-file-preview.md b/examples/1.9.x/client-rest/examples/storage/get-file-preview.md index cb6909f80..b2530d485 100644 --- a/examples/1.9.x/client-rest/examples/storage/get-file-preview.md +++ b/examples/1.9.x/client-rest/examples/storage/get-file-preview.md @@ -1,8 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/preview HTTP/1.1 Host: cloud.appwrite.io +Accept: image/* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/storage/get-file-view.md b/examples/1.9.x/client-rest/examples/storage/get-file-view.md index 59aec7cd6..385fe3c61 100644 --- a/examples/1.9.x/client-rest/examples/storage/get-file-view.md +++ b/examples/1.9.x/client-rest/examples/storage/get-file-view.md @@ -1,8 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/view HTTP/1.1 Host: cloud.appwrite.io +Accept: */* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/storage/get-file.md b/examples/1.9.x/client-rest/examples/storage/get-file.md index a442bc64d..3eae0c9ea 100644 --- a/examples/1.9.x/client-rest/examples/storage/get-file.md +++ b/examples/1.9.x/client-rest/examples/storage/get-file.md @@ -1,8 +1,8 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/storage/list-files.md b/examples/1.9.x/client-rest/examples/storage/list-files.md index c34a0e1a3..f8cdc1118 100644 --- a/examples/1.9.x/client-rest/examples/storage/list-files.md +++ b/examples/1.9.x/client-rest/examples/storage/list-files.md @@ -1,8 +1,8 @@ ```http GET /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/storage/update-file.md b/examples/1.9.x/client-rest/examples/storage/update-file.md index e99dfa87e..366058549 100644 --- a/examples/1.9.x/client-rest/examples/storage/update-file.md +++ b/examples/1.9.x/client-rest/examples/storage/update-file.md @@ -2,10 +2,14 @@ PUT /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "name": "", + "permissions": ["read(\"any\")"] +} { "name": "", diff --git a/examples/1.9.x/client-rest/examples/tablesdb/create-operations.md b/examples/1.9.x/client-rest/examples/tablesdb/create-operations.md index d4e248251..f33e029cd 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/create-operations.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/create-operations.md @@ -2,10 +2,23 @@ POST /v1/tablesdb/transactions/{transactionId}/operations HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "operations": [ + { + "action": "create", + "databaseId": "", + "tableId": "", + "rowId": "", + "data": { + "name": "Walter O'Brien" + } + } + ] +} { "operations": [ diff --git a/examples/1.9.x/client-rest/examples/tablesdb/create-row.md b/examples/1.9.x/client-rest/examples/tablesdb/create-row.md index 627cdc419..52de0256f 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/create-row.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/create-row.md @@ -2,10 +2,22 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "rowId": "", + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "" +} { "rowId": "", diff --git a/examples/1.9.x/client-rest/examples/tablesdb/create-transaction.md b/examples/1.9.x/client-rest/examples/tablesdb/create-transaction.md index bbd4ffb41..df6deb44a 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/create-transaction.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/create-transaction.md @@ -2,10 +2,13 @@ POST /v1/tablesdb/transactions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "ttl": 60 +} { "ttl": 60 diff --git a/examples/1.9.x/client-rest/examples/tablesdb/decrement-row-column.md b/examples/1.9.x/client-rest/examples/tablesdb/decrement-row-column.md index 4eb417bf3..78b1b86b9 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/decrement-row-column.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/decrement-row-column.md @@ -2,10 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}/{column}/decrement HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "value": 0, + "min": 0, + "transactionId": "" +} { "value": 0, diff --git a/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md b/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md index 802d788d7..277afbd1c 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md @@ -4,8 +4,6 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: { "transactionId": "" diff --git a/examples/1.9.x/client-rest/examples/tablesdb/delete-transaction.md b/examples/1.9.x/client-rest/examples/tablesdb/delete-transaction.md index d20b08586..91257dbe8 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/delete-transaction.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/delete-transaction.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/tablesdb/get-row.md b/examples/1.9.x/client-rest/examples/tablesdb/get-row.md index 68e0fb5fe..364d09472 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/get-row.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/get-row.md @@ -1,8 +1,8 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/tablesdb/get-transaction.md b/examples/1.9.x/client-rest/examples/tablesdb/get-transaction.md index 1dc41dbec..54b0abe1a 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/get-transaction.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/get-transaction.md @@ -1,8 +1,8 @@ ```http GET /v1/tablesdb/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/tablesdb/increment-row-column.md b/examples/1.9.x/client-rest/examples/tablesdb/increment-row-column.md index 893d1f703..aee67a5e8 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/increment-row-column.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/increment-row-column.md @@ -2,10 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}/{column}/increment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "value": 0, + "max": 0, + "transactionId": "" +} { "value": 0, diff --git a/examples/1.9.x/client-rest/examples/tablesdb/list-rows.md b/examples/1.9.x/client-rest/examples/tablesdb/list-rows.md index af15210fd..32447db8a 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/list-rows.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/list-rows.md @@ -1,8 +1,8 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/tablesdb/list-transactions.md b/examples/1.9.x/client-rest/examples/tablesdb/list-transactions.md index 6431cb4e7..afa16fd8d 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/list-transactions.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/list-transactions.md @@ -1,8 +1,8 @@ ```http GET /v1/tablesdb/transactions HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/tablesdb/update-row.md b/examples/1.9.x/client-rest/examples/tablesdb/update-row.md index 3fc285210..e467827b5 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/update-row.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/update-row.md @@ -2,10 +2,21 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "" +} { "data": { diff --git a/examples/1.9.x/client-rest/examples/tablesdb/update-transaction.md b/examples/1.9.x/client-rest/examples/tablesdb/update-transaction.md index c836f8cde..6062f2c21 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/update-transaction.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/update-transaction.md @@ -2,10 +2,14 @@ PATCH /v1/tablesdb/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "commit": false, + "rollback": false +} { "commit": false, diff --git a/examples/1.9.x/client-rest/examples/tablesdb/upsert-row.md b/examples/1.9.x/client-rest/examples/tablesdb/upsert-row.md index c9e0a7c5d..7a12c6622 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/upsert-row.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/upsert-row.md @@ -2,10 +2,21 @@ PUT /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "" +} { "data": { diff --git a/examples/1.9.x/client-rest/examples/teams/create-membership.md b/examples/1.9.x/client-rest/examples/teams/create-membership.md index 14cbb753a..2a51992d4 100644 --- a/examples/1.9.x/client-rest/examples/teams/create-membership.md +++ b/examples/1.9.x/client-rest/examples/teams/create-membership.md @@ -2,10 +2,18 @@ POST /v1/teams/{teamId}/memberships HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "email": "email@example.com", + "userId": "", + "phone": "+12065550100", + "roles": [], + "url": "https://example.com", + "name": "" +} { "email": "email@example.com", diff --git a/examples/1.9.x/client-rest/examples/teams/create.md b/examples/1.9.x/client-rest/examples/teams/create.md index 7f7796da6..29bf29db9 100644 --- a/examples/1.9.x/client-rest/examples/teams/create.md +++ b/examples/1.9.x/client-rest/examples/teams/create.md @@ -2,10 +2,15 @@ POST /v1/teams HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "teamId": "", + "name": "", + "roles": [] +} { "teamId": "", diff --git a/examples/1.9.x/client-rest/examples/teams/delete-membership.md b/examples/1.9.x/client-rest/examples/teams/delete-membership.md index ffe511532..867583674 100644 --- a/examples/1.9.x/client-rest/examples/teams/delete-membership.md +++ b/examples/1.9.x/client-rest/examples/teams/delete-membership.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/teams/delete.md b/examples/1.9.x/client-rest/examples/teams/delete.md index 8276a9417..4e7264791 100644 --- a/examples/1.9.x/client-rest/examples/teams/delete.md +++ b/examples/1.9.x/client-rest/examples/teams/delete.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: ``` diff --git a/examples/1.9.x/client-rest/examples/teams/get-membership.md b/examples/1.9.x/client-rest/examples/teams/get-membership.md index 55f82319b..1fd0dd33b 100644 --- a/examples/1.9.x/client-rest/examples/teams/get-membership.md +++ b/examples/1.9.x/client-rest/examples/teams/get-membership.md @@ -1,8 +1,8 @@ ```http GET /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/teams/get-prefs.md b/examples/1.9.x/client-rest/examples/teams/get-prefs.md index 16af3d333..dc7a3eefb 100644 --- a/examples/1.9.x/client-rest/examples/teams/get-prefs.md +++ b/examples/1.9.x/client-rest/examples/teams/get-prefs.md @@ -1,8 +1,8 @@ ```http GET /v1/teams/{teamId}/prefs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/teams/get.md b/examples/1.9.x/client-rest/examples/teams/get.md index d335dbc68..d905f4377 100644 --- a/examples/1.9.x/client-rest/examples/teams/get.md +++ b/examples/1.9.x/client-rest/examples/teams/get.md @@ -1,8 +1,8 @@ ```http GET /v1/teams/{teamId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/teams/list-memberships.md b/examples/1.9.x/client-rest/examples/teams/list-memberships.md index 0d75b45a3..7a1c29085 100644 --- a/examples/1.9.x/client-rest/examples/teams/list-memberships.md +++ b/examples/1.9.x/client-rest/examples/teams/list-memberships.md @@ -1,8 +1,8 @@ ```http GET /v1/teams/{teamId}/memberships HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/teams/list.md b/examples/1.9.x/client-rest/examples/teams/list.md index dd800deb5..9bd0d9671 100644 --- a/examples/1.9.x/client-rest/examples/teams/list.md +++ b/examples/1.9.x/client-rest/examples/teams/list.md @@ -1,8 +1,8 @@ ```http GET /v1/teams HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + ``` diff --git a/examples/1.9.x/client-rest/examples/teams/update-membership-status.md b/examples/1.9.x/client-rest/examples/teams/update-membership-status.md index d9f376fbb..bc085747d 100644 --- a/examples/1.9.x/client-rest/examples/teams/update-membership-status.md +++ b/examples/1.9.x/client-rest/examples/teams/update-membership-status.md @@ -2,10 +2,14 @@ PATCH /v1/teams/{teamId}/memberships/{membershipId}/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "userId": "", + "secret": "" +} { "userId": "", diff --git a/examples/1.9.x/client-rest/examples/teams/update-membership.md b/examples/1.9.x/client-rest/examples/teams/update-membership.md index 48bcca2f2..14c545e6e 100644 --- a/examples/1.9.x/client-rest/examples/teams/update-membership.md +++ b/examples/1.9.x/client-rest/examples/teams/update-membership.md @@ -2,10 +2,13 @@ PATCH /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "roles": [] +} { "roles": [] diff --git a/examples/1.9.x/client-rest/examples/teams/update-name.md b/examples/1.9.x/client-rest/examples/teams/update-name.md index b21ebbd75..6b033f89b 100644 --- a/examples/1.9.x/client-rest/examples/teams/update-name.md +++ b/examples/1.9.x/client-rest/examples/teams/update-name.md @@ -2,10 +2,13 @@ PUT /v1/teams/{teamId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "name": "" +} { "name": "" diff --git a/examples/1.9.x/client-rest/examples/teams/update-prefs.md b/examples/1.9.x/client-rest/examples/teams/update-prefs.md index ec1eefacc..826c07001 100644 --- a/examples/1.9.x/client-rest/examples/teams/update-prefs.md +++ b/examples/1.9.x/client-rest/examples/teams/update-prefs.md @@ -2,10 +2,13 @@ PUT /v1/teams/{teamId}/prefs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -X-Appwrite-Session: -X-Appwrite-JWT: + +{ + "prefs": {} +} { "prefs": {} diff --git a/examples/1.9.x/client-web/examples/account/create.md b/examples/1.9.x/client-web/examples/account/create.md index a78197cde..1fb3971ad 100644 --- a/examples/1.9.x/client-web/examples/account/create.md +++ b/examples/1.9.x/client-web/examples/account/create.md @@ -10,7 +10,7 @@ const account = new Account(client); const result = await account.create({ userId: '', email: 'email@example.com', - password: '', + password: 'password', name: '' // optional }); diff --git a/examples/1.9.x/client-web/examples/account/update-password.md b/examples/1.9.x/client-web/examples/account/update-password.md index 360c577f3..9918b1d49 100644 --- a/examples/1.9.x/client-web/examples/account/update-password.md +++ b/examples/1.9.x/client-web/examples/account/update-password.md @@ -8,7 +8,7 @@ const client = new Client() const account = new Account(client); const result = await account.updatePassword({ - password: '', + password: 'password', oldPassword: 'password' // optional }); diff --git a/examples/1.9.x/client-web/examples/account/update-recovery.md b/examples/1.9.x/client-web/examples/account/update-recovery.md index e08d48cb2..52da3fb5c 100644 --- a/examples/1.9.x/client-web/examples/account/update-recovery.md +++ b/examples/1.9.x/client-web/examples/account/update-recovery.md @@ -10,7 +10,7 @@ const account = new Account(client); const result = await account.updateRecovery({ userId: '', secret: '', - password: '' + password: 'password' }); console.log(result); diff --git a/examples/1.9.x/client-web/examples/avatars/get-browser.md b/examples/1.9.x/client-web/examples/avatars/get-browser.md index d4c1a40fb..f08e718bf 100644 --- a/examples/1.9.x/client-web/examples/avatars/get-browser.md +++ b/examples/1.9.x/client-web/examples/avatars/get-browser.md @@ -3,7 +3,8 @@ import { Client, Avatars, Browser } from "appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-web/examples/avatars/get-credit-card.md b/examples/1.9.x/client-web/examples/avatars/get-credit-card.md index 57758501a..ecf804510 100644 --- a/examples/1.9.x/client-web/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/client-web/examples/avatars/get-credit-card.md @@ -3,7 +3,8 @@ import { Client, Avatars, CreditCard } from "appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-web/examples/avatars/get-favicon.md b/examples/1.9.x/client-web/examples/avatars/get-favicon.md index 8b09f65ff..3fb27de0c 100644 --- a/examples/1.9.x/client-web/examples/avatars/get-favicon.md +++ b/examples/1.9.x/client-web/examples/avatars/get-favicon.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-web/examples/avatars/get-flag.md b/examples/1.9.x/client-web/examples/avatars/get-flag.md index d24b9b407..1f385c9ae 100644 --- a/examples/1.9.x/client-web/examples/avatars/get-flag.md +++ b/examples/1.9.x/client-web/examples/avatars/get-flag.md @@ -3,7 +3,8 @@ import { Client, Avatars, Flag } from "appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-web/examples/avatars/get-image.md b/examples/1.9.x/client-web/examples/avatars/get-image.md index f8f33731b..fce204490 100644 --- a/examples/1.9.x/client-web/examples/avatars/get-image.md +++ b/examples/1.9.x/client-web/examples/avatars/get-image.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-web/examples/avatars/get-initials.md b/examples/1.9.x/client-web/examples/avatars/get-initials.md index 0722a72df..42085c717 100644 --- a/examples/1.9.x/client-web/examples/avatars/get-initials.md +++ b/examples/1.9.x/client-web/examples/avatars/get-initials.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-web/examples/avatars/get-qr.md b/examples/1.9.x/client-web/examples/avatars/get-qr.md index 829c71214..f385421a6 100644 --- a/examples/1.9.x/client-web/examples/avatars/get-qr.md +++ b/examples/1.9.x/client-web/examples/avatars/get-qr.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-web/examples/avatars/get-screenshot.md b/examples/1.9.x/client-web/examples/avatars/get-screenshot.md index d45f1e6ec..ee50262f9 100644 --- a/examples/1.9.x/client-web/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/client-web/examples/avatars/get-screenshot.md @@ -3,7 +3,8 @@ import { Client, Avatars, BrowserTheme, Timezone, BrowserPermission, ImageFormat const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/client-web/examples/storage/get-file-download.md b/examples/1.9.x/client-web/examples/storage/get-file-download.md index 7758c7b49..43b9f8f07 100644 --- a/examples/1.9.x/client-web/examples/storage/get-file-download.md +++ b/examples/1.9.x/client-web/examples/storage/get-file-download.md @@ -3,7 +3,8 @@ import { Client, Storage } from "appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new Storage(client); diff --git a/examples/1.9.x/client-web/examples/storage/get-file-preview.md b/examples/1.9.x/client-web/examples/storage/get-file-preview.md index 4d01ef0ce..dc6deccd2 100644 --- a/examples/1.9.x/client-web/examples/storage/get-file-preview.md +++ b/examples/1.9.x/client-web/examples/storage/get-file-preview.md @@ -3,7 +3,8 @@ import { Client, Storage, ImageGravity, ImageFormat } from "appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new Storage(client); diff --git a/examples/1.9.x/client-web/examples/storage/get-file-view.md b/examples/1.9.x/client-web/examples/storage/get-file-view.md index 682e947c4..b5b4abf9a 100644 --- a/examples/1.9.x/client-web/examples/storage/get-file-view.md +++ b/examples/1.9.x/client-web/examples/storage/get-file-view.md @@ -3,7 +3,8 @@ import { Client, Storage } from "appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new Storage(client); diff --git a/examples/1.9.x/console-cli/examples/account/create.md b/examples/1.9.x/console-cli/examples/account/create.md index f4fd9643c..f2450ef80 100644 --- a/examples/1.9.x/console-cli/examples/account/create.md +++ b/examples/1.9.x/console-cli/examples/account/create.md @@ -2,5 +2,5 @@ appwrite account create \ --user-id \ --email email@example.com \ - --password '' + --password password ``` diff --git a/examples/1.9.x/console-cli/examples/account/update-password.md b/examples/1.9.x/console-cli/examples/account/update-password.md index db0c17642..b7df48645 100644 --- a/examples/1.9.x/console-cli/examples/account/update-password.md +++ b/examples/1.9.x/console-cli/examples/account/update-password.md @@ -1,4 +1,4 @@ ```bash appwrite account update-password \ - --password '' + --password password ``` diff --git a/examples/1.9.x/console-cli/examples/account/update-recovery.md b/examples/1.9.x/console-cli/examples/account/update-recovery.md index d4f70b2ca..5873ac863 100644 --- a/examples/1.9.x/console-cli/examples/account/update-recovery.md +++ b/examples/1.9.x/console-cli/examples/account/update-recovery.md @@ -2,5 +2,5 @@ appwrite account update-recovery \ --user-id \ --secret \ - --password '' + --password password ``` diff --git a/examples/1.9.x/console-cli/examples/messaging/create-ses-provider.md b/examples/1.9.x/console-cli/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..b8b1b6a8e --- /dev/null +++ b/examples/1.9.x/console-cli/examples/messaging/create-ses-provider.md @@ -0,0 +1,5 @@ +```bash +appwrite messaging create-ses-provider \ + --provider-id \ + --name +``` diff --git a/examples/1.9.x/console-cli/examples/messaging/update-ses-provider.md b/examples/1.9.x/console-cli/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..101a8e871 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/messaging/update-ses-provider.md @@ -0,0 +1,4 @@ +```bash +appwrite messaging update-ses-provider \ + --provider-id +``` diff --git a/examples/1.9.x/console-cli/examples/migrations/create-n-host-migration.md b/examples/1.9.x/console-cli/examples/migrations/create-n-host-migration.md index 703d3ec09..bf2f92c30 100644 --- a/examples/1.9.x/console-cli/examples/migrations/create-n-host-migration.md +++ b/examples/1.9.x/console-cli/examples/migrations/create-n-host-migration.md @@ -6,5 +6,5 @@ appwrite migrations create-n-host-migration \ --admin-secret \ --database \ --username \ - --password + --password password ``` diff --git a/examples/1.9.x/console-cli/examples/migrations/create-supabase-migration.md b/examples/1.9.x/console-cli/examples/migrations/create-supabase-migration.md index d89211c4b..76cae2ac8 100644 --- a/examples/1.9.x/console-cli/examples/migrations/create-supabase-migration.md +++ b/examples/1.9.x/console-cli/examples/migrations/create-supabase-migration.md @@ -5,5 +5,5 @@ appwrite migrations create-supabase-migration \ --api-key \ --database-host \ --username \ - --password + --password password ``` diff --git a/examples/1.9.x/console-cli/examples/migrations/get-n-host-report.md b/examples/1.9.x/console-cli/examples/migrations/get-n-host-report.md index 8e472c6ee..03bee64c6 100644 --- a/examples/1.9.x/console-cli/examples/migrations/get-n-host-report.md +++ b/examples/1.9.x/console-cli/examples/migrations/get-n-host-report.md @@ -6,5 +6,5 @@ appwrite migrations get-n-host-report \ --admin-secret \ --database \ --username \ - --password + --password password ``` diff --git a/examples/1.9.x/console-cli/examples/migrations/get-supabase-report.md b/examples/1.9.x/console-cli/examples/migrations/get-supabase-report.md index 9aabb7144..d728cb3d9 100644 --- a/examples/1.9.x/console-cli/examples/migrations/get-supabase-report.md +++ b/examples/1.9.x/console-cli/examples/migrations/get-supabase-report.md @@ -5,5 +5,5 @@ appwrite migrations get-supabase-report \ --api-key \ --database-host \ --username \ - --password + --password password ``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-server.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..a2a3596d9 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-server.md @@ -0,0 +1,5 @@ +```bash +appwrite project update-o-auth-2-server \ + --enabled false \ + --authorization-url https://example.com +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-password-strength-policy.md b/examples/1.9.x/console-cli/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..baa7ca9f5 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-password-strength-policy.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-password-strength-policy +``` diff --git a/examples/1.9.x/console-cli/examples/users/update-password.md b/examples/1.9.x/console-cli/examples/users/update-password.md index 1298b26e7..84c6374c6 100644 --- a/examples/1.9.x/console-cli/examples/users/update-password.md +++ b/examples/1.9.x/console-cli/examples/users/update-password.md @@ -1,5 +1,5 @@ ```bash appwrite users update-password \ --user-id \ - --password '' + --password password ``` diff --git a/examples/1.9.x/console-web/examples/account/create.md b/examples/1.9.x/console-web/examples/account/create.md index 060f3188d..f1696abdb 100644 --- a/examples/1.9.x/console-web/examples/account/create.md +++ b/examples/1.9.x/console-web/examples/account/create.md @@ -10,7 +10,7 @@ const account = new Account(client); const result = await account.create({ userId: '', email: 'email@example.com', - password: '', + password: 'password', name: '' // optional }); diff --git a/examples/1.9.x/console-web/examples/account/update-password.md b/examples/1.9.x/console-web/examples/account/update-password.md index 5699dab48..f85a28b9d 100644 --- a/examples/1.9.x/console-web/examples/account/update-password.md +++ b/examples/1.9.x/console-web/examples/account/update-password.md @@ -8,7 +8,7 @@ const client = new Client() const account = new Account(client); const result = await account.updatePassword({ - password: '', + password: 'password', oldPassword: 'password' // optional }); diff --git a/examples/1.9.x/console-web/examples/account/update-recovery.md b/examples/1.9.x/console-web/examples/account/update-recovery.md index e283313b0..001a77eb7 100644 --- a/examples/1.9.x/console-web/examples/account/update-recovery.md +++ b/examples/1.9.x/console-web/examples/account/update-recovery.md @@ -10,7 +10,7 @@ const account = new Account(client); const result = await account.updateRecovery({ userId: '', secret: '', - password: '' + password: 'password' }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/apps/create-secret.md b/examples/1.9.x/console-web/examples/apps/create-secret.md new file mode 100644 index 000000000..651f45ac0 --- /dev/null +++ b/examples/1.9.x/console-web/examples/apps/create-secret.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Apps } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const apps = new Apps(client); + +const result = await apps.createSecret({ + appId: '' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/apps/create.md b/examples/1.9.x/console-web/examples/apps/create.md new file mode 100644 index 000000000..05f6ad6eb --- /dev/null +++ b/examples/1.9.x/console-web/examples/apps/create.md @@ -0,0 +1,21 @@ +```javascript +import { Client, Apps } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const apps = new Apps(client); + +const result = await apps.create({ + appId: '', + name: '', + redirectUris: [], + enabled: false, // optional + type: 'public', // optional + deviceFlow: false, // optional + teamId: '' // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/apps/delete-secret.md b/examples/1.9.x/console-web/examples/apps/delete-secret.md new file mode 100644 index 000000000..563d686fd --- /dev/null +++ b/examples/1.9.x/console-web/examples/apps/delete-secret.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Apps } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const apps = new Apps(client); + +const result = await apps.deleteSecret({ + appId: '', + secretId: '' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/apps/delete-tokens.md b/examples/1.9.x/console-web/examples/apps/delete-tokens.md new file mode 100644 index 000000000..ed8b5ead3 --- /dev/null +++ b/examples/1.9.x/console-web/examples/apps/delete-tokens.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Apps } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const apps = new Apps(client); + +const result = await apps.deleteTokens({ + appId: '' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/apps/delete.md b/examples/1.9.x/console-web/examples/apps/delete.md new file mode 100644 index 000000000..4ca4b2c7d --- /dev/null +++ b/examples/1.9.x/console-web/examples/apps/delete.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Apps } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const apps = new Apps(client); + +const result = await apps.delete({ + appId: '' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/apps/get-secret.md b/examples/1.9.x/console-web/examples/apps/get-secret.md new file mode 100644 index 000000000..84c820820 --- /dev/null +++ b/examples/1.9.x/console-web/examples/apps/get-secret.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Apps } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const apps = new Apps(client); + +const result = await apps.getSecret({ + appId: '', + secretId: '' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/apps/get.md b/examples/1.9.x/console-web/examples/apps/get.md new file mode 100644 index 000000000..5a278482d --- /dev/null +++ b/examples/1.9.x/console-web/examples/apps/get.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Apps } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const apps = new Apps(client); + +const result = await apps.get({ + appId: '' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/apps/list-secrets.md b/examples/1.9.x/console-web/examples/apps/list-secrets.md new file mode 100644 index 000000000..581240869 --- /dev/null +++ b/examples/1.9.x/console-web/examples/apps/list-secrets.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Apps } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const apps = new Apps(client); + +const result = await apps.listSecrets({ + appId: '', + queries: [], // optional + total: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/apps/list.md b/examples/1.9.x/console-web/examples/apps/list.md new file mode 100644 index 000000000..7fadc60d3 --- /dev/null +++ b/examples/1.9.x/console-web/examples/apps/list.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Apps } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const apps = new Apps(client); + +const result = await apps.list({ + queries: [], // optional + total: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/apps/update-team.md b/examples/1.9.x/console-web/examples/apps/update-team.md new file mode 100644 index 000000000..fc93365ca --- /dev/null +++ b/examples/1.9.x/console-web/examples/apps/update-team.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Apps } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const apps = new Apps(client); + +const result = await apps.updateTeam({ + appId: '', + teamId: '' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/apps/update.md b/examples/1.9.x/console-web/examples/apps/update.md new file mode 100644 index 000000000..41c377ead --- /dev/null +++ b/examples/1.9.x/console-web/examples/apps/update.md @@ -0,0 +1,20 @@ +```javascript +import { Client, Apps } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const apps = new Apps(client); + +const result = await apps.update({ + appId: '', + name: '', + enabled: false, // optional + redirectUris: [], // optional + type: 'public', // optional + deviceFlow: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/avatars/get-browser.md b/examples/1.9.x/console-web/examples/avatars/get-browser.md index b28ec7d93..c0c83e4e4 100644 --- a/examples/1.9.x/console-web/examples/avatars/get-browser.md +++ b/examples/1.9.x/console-web/examples/avatars/get-browser.md @@ -3,7 +3,8 @@ import { Client, Avatars, Browser } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/console-web/examples/avatars/get-credit-card.md b/examples/1.9.x/console-web/examples/avatars/get-credit-card.md index 8949b1f4a..291191216 100644 --- a/examples/1.9.x/console-web/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/console-web/examples/avatars/get-credit-card.md @@ -3,7 +3,8 @@ import { Client, Avatars, CreditCard } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/console-web/examples/avatars/get-favicon.md b/examples/1.9.x/console-web/examples/avatars/get-favicon.md index 0df25533e..afccc9515 100644 --- a/examples/1.9.x/console-web/examples/avatars/get-favicon.md +++ b/examples/1.9.x/console-web/examples/avatars/get-favicon.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/console-web/examples/avatars/get-flag.md b/examples/1.9.x/console-web/examples/avatars/get-flag.md index 122c988f1..5921e5c57 100644 --- a/examples/1.9.x/console-web/examples/avatars/get-flag.md +++ b/examples/1.9.x/console-web/examples/avatars/get-flag.md @@ -3,7 +3,8 @@ import { Client, Avatars, Flag } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/console-web/examples/avatars/get-image.md b/examples/1.9.x/console-web/examples/avatars/get-image.md index d24f49efc..d0f1349d0 100644 --- a/examples/1.9.x/console-web/examples/avatars/get-image.md +++ b/examples/1.9.x/console-web/examples/avatars/get-image.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/console-web/examples/avatars/get-initials.md b/examples/1.9.x/console-web/examples/avatars/get-initials.md index 892497b2b..ecac3f543 100644 --- a/examples/1.9.x/console-web/examples/avatars/get-initials.md +++ b/examples/1.9.x/console-web/examples/avatars/get-initials.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/console-web/examples/avatars/get-qr.md b/examples/1.9.x/console-web/examples/avatars/get-qr.md index f15fa6e97..b42160ddb 100644 --- a/examples/1.9.x/console-web/examples/avatars/get-qr.md +++ b/examples/1.9.x/console-web/examples/avatars/get-qr.md @@ -3,7 +3,8 @@ import { Client, Avatars } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/console-web/examples/avatars/get-screenshot.md b/examples/1.9.x/console-web/examples/avatars/get-screenshot.md index 45e3517f3..1025b3443 100644 --- a/examples/1.9.x/console-web/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/console-web/examples/avatars/get-screenshot.md @@ -3,7 +3,8 @@ import { Client, Avatars, BrowserTheme, Timezone, BrowserPermission, ImageFormat const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new Avatars(client); diff --git a/examples/1.9.x/console-web/examples/compute/create-database-migration.md b/examples/1.9.x/console-web/examples/compute/create-database-migration.md index 787b249bc..9e08e3cec 100644 --- a/examples/1.9.x/console-web/examples/compute/create-database-migration.md +++ b/examples/1.9.x/console-web/examples/compute/create-database-migration.md @@ -9,7 +9,8 @@ const compute = new Compute(client); const result = await compute.createDatabaseMigration({ databaseId: '', - targetType: 'shared' + targetType: 'shared', + specification: '' // optional }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/compute/list-database-specifications.md b/examples/1.9.x/console-web/examples/compute/list-database-specifications.md new file mode 100644 index 000000000..3a7ef6fc0 --- /dev/null +++ b/examples/1.9.x/console-web/examples/compute/list-database-specifications.md @@ -0,0 +1,13 @@ +```javascript +import { Client, Compute } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const compute = new Compute(client); + +const result = await compute.listDatabaseSpecifications(); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/documentsdb/create.md b/examples/1.9.x/console-web/examples/documentsdb/create.md index a0cc85ab2..5d73221aa 100644 --- a/examples/1.9.x/console-web/examples/documentsdb/create.md +++ b/examples/1.9.x/console-web/examples/documentsdb/create.md @@ -10,7 +10,8 @@ const documentsDB = new DocumentsDB(client); const result = await documentsDB.create({ databaseId: '', name: '', - enabled: false // optional + enabled: false, // optional + specification: '' // optional }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/functions/create.md b/examples/1.9.x/console-web/examples/functions/create.md index c7b20209d..cd1c7983f 100644 --- a/examples/1.9.x/console-web/examples/functions/create.md +++ b/examples/1.9.x/console-web/examples/functions/create.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Functions, FunctionRuntime, ProjectKeyScopes } from "@appwrite.io/console"; +import { Client, Functions, Runtime, ProjectKeyScopes } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -10,7 +10,7 @@ const functions = new Functions(client); const result = await functions.create({ functionId: '', name: '', - runtime: FunctionRuntime.Node145, + runtime: Runtime.Node145, execute: ["any"], // optional events: [], // optional schedule: '', // optional diff --git a/examples/1.9.x/console-web/examples/functions/get-deployment-download.md b/examples/1.9.x/console-web/examples/functions/get-deployment-download.md index d6b46f1d7..5b0245634 100644 --- a/examples/1.9.x/console-web/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/console-web/examples/functions/get-deployment-download.md @@ -3,7 +3,8 @@ import { Client, Functions, DeploymentDownloadType } from "@appwrite.io/console" const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const functions = new Functions(client); diff --git a/examples/1.9.x/console-web/examples/functions/list-templates.md b/examples/1.9.x/console-web/examples/functions/list-templates.md index e28df0b49..0218028a0 100644 --- a/examples/1.9.x/console-web/examples/functions/list-templates.md +++ b/examples/1.9.x/console-web/examples/functions/list-templates.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Functions, FunctionRuntime, FunctionTemplateUseCase } from "@appwrite.io/console"; +import { Client, Functions, Runtime, FunctionTemplateUseCase } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -8,7 +8,7 @@ const client = new Client() const functions = new Functions(client); const result = await functions.listTemplates({ - runtimes: [FunctionRuntime.Node145], // optional + runtimes: [Runtime.Node145], // optional useCases: [FunctionTemplateUseCase.Starter], // optional limit: 1, // optional offset: 0, // optional diff --git a/examples/1.9.x/console-web/examples/functions/update.md b/examples/1.9.x/console-web/examples/functions/update.md index c84018bb1..98a161dee 100644 --- a/examples/1.9.x/console-web/examples/functions/update.md +++ b/examples/1.9.x/console-web/examples/functions/update.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Functions, FunctionRuntime, ProjectKeyScopes } from "@appwrite.io/console"; +import { Client, Functions, Runtime, ProjectKeyScopes } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -10,7 +10,7 @@ const functions = new Functions(client); const result = await functions.update({ functionId: '', name: '', - runtime: FunctionRuntime.Node145, // optional + runtime: Runtime.Node145, // optional execute: ["any"], // optional events: [], // optional schedule: '', // optional diff --git a/examples/1.9.x/console-web/examples/health/get-audits-db.md b/examples/1.9.x/console-web/examples/health/get-audits-db.md new file mode 100644 index 000000000..0dbf5a890 --- /dev/null +++ b/examples/1.9.x/console-web/examples/health/get-audits-db.md @@ -0,0 +1,13 @@ +```javascript +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const health = new Health(client); + +const result = await health.getAuditsDB(); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/messaging/create-ses-provider.md b/examples/1.9.x/console-web/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..2021d4421 --- /dev/null +++ b/examples/1.9.x/console-web/examples/messaging/create-ses-provider.md @@ -0,0 +1,24 @@ +```javascript +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createSesProvider({ + providerId: '', + name: '', + accessKey: '', // optional + secretKey: '', // optional + region: '', // optional + fromName: '', // optional + fromEmail: 'email@example.com', // optional + replyToName: '', // optional + replyToEmail: 'email@example.com', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/messaging/create-smtp-provider.md b/examples/1.9.x/console-web/examples/messaging/create-smtp-provider.md index 5e7099ad3..aa0b8bcc7 100644 --- a/examples/1.9.x/console-web/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/console-web/examples/messaging/create-smtp-provider.md @@ -13,7 +13,7 @@ const result = await messaging.createSMTPProvider({ host: '', port: 1, // optional username: '', // optional - password: '', // optional + password: 'password', // optional encryption: SmtpEncryption.None, // optional autoTLS: false, // optional mailer: '', // optional diff --git a/examples/1.9.x/console-web/examples/messaging/update-ses-provider.md b/examples/1.9.x/console-web/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..63d572f33 --- /dev/null +++ b/examples/1.9.x/console-web/examples/messaging/update-ses-provider.md @@ -0,0 +1,24 @@ +```javascript +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateSesProvider({ + providerId: '', + name: '', // optional + enabled: false, // optional + accessKey: '', // optional + secretKey: '', // optional + region: '', // optional + fromName: '', // optional + fromEmail: 'email@example.com', // optional + replyToName: '', // optional + replyToEmail: '' // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/messaging/update-smtp-provider.md b/examples/1.9.x/console-web/examples/messaging/update-smtp-provider.md index ebd649b7e..353ad3c99 100644 --- a/examples/1.9.x/console-web/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/console-web/examples/messaging/update-smtp-provider.md @@ -13,7 +13,7 @@ const result = await messaging.updateSMTPProvider({ host: '', // optional port: 1, // optional username: '', // optional - password: '', // optional + password: 'password', // optional encryption: SmtpEncryption.None, // optional autoTLS: false, // optional mailer: '', // optional diff --git a/examples/1.9.x/console-web/examples/migrations/create-appwrite-migration.md b/examples/1.9.x/console-web/examples/migrations/create-appwrite-migration.md index 39d13eed0..9729806fa 100644 --- a/examples/1.9.x/console-web/examples/migrations/create-appwrite-migration.md +++ b/examples/1.9.x/console-web/examples/migrations/create-appwrite-migration.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Migrations, AppwriteMigrationResource, MigrationOnDuplicate } from "@appwrite.io/console"; +import { Client, Migrations, AppwriteMigrationResource, OnDuplicate } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -12,7 +12,7 @@ const result = await migrations.createAppwriteMigration({ endpoint: 'https://example.com', projectId: '', apiKey: '', - onDuplicate: MigrationOnDuplicate.Fail // optional + onDuplicate: OnDuplicate.Fail // optional }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/migrations/create-csv-import.md b/examples/1.9.x/console-web/examples/migrations/create-csv-import.md index 1a2a97d8a..d24792b68 100644 --- a/examples/1.9.x/console-web/examples/migrations/create-csv-import.md +++ b/examples/1.9.x/console-web/examples/migrations/create-csv-import.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Migrations, MigrationOnDuplicate } from "@appwrite.io/console"; +import { Client, Migrations, OnDuplicate } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -12,7 +12,7 @@ const result = await migrations.createCSVImport({ fileId: '', resourceId: '', internalFile: false, // optional - onDuplicate: MigrationOnDuplicate.Fail // optional + onDuplicate: OnDuplicate.Fail // optional }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/migrations/create-json-import.md b/examples/1.9.x/console-web/examples/migrations/create-json-import.md index 7af6d23e0..f55fc8ffa 100644 --- a/examples/1.9.x/console-web/examples/migrations/create-json-import.md +++ b/examples/1.9.x/console-web/examples/migrations/create-json-import.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Migrations, MigrationOnDuplicate } from "@appwrite.io/console"; +import { Client, Migrations, OnDuplicate } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -12,7 +12,7 @@ const result = await migrations.createJSONImport({ fileId: '', resourceId: '', internalFile: false, // optional - onDuplicate: MigrationOnDuplicate.Fail // optional + onDuplicate: OnDuplicate.Fail // optional }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/migrations/create-n-host-migration.md b/examples/1.9.x/console-web/examples/migrations/create-n-host-migration.md index cd17162ab..1b7faec8c 100644 --- a/examples/1.9.x/console-web/examples/migrations/create-n-host-migration.md +++ b/examples/1.9.x/console-web/examples/migrations/create-n-host-migration.md @@ -14,7 +14,7 @@ const result = await migrations.createNHostMigration({ adminSecret: '', database: '', username: '', - password: '', + password: 'password', port: null // optional }); diff --git a/examples/1.9.x/console-web/examples/migrations/create-supabase-migration.md b/examples/1.9.x/console-web/examples/migrations/create-supabase-migration.md index 6463d3582..359400390 100644 --- a/examples/1.9.x/console-web/examples/migrations/create-supabase-migration.md +++ b/examples/1.9.x/console-web/examples/migrations/create-supabase-migration.md @@ -13,7 +13,7 @@ const result = await migrations.createSupabaseMigration({ apiKey: '', databaseHost: '', username: '', - password: '', + password: 'password', port: null // optional }); diff --git a/examples/1.9.x/console-web/examples/migrations/get-n-host-report.md b/examples/1.9.x/console-web/examples/migrations/get-n-host-report.md index 4ed95ea92..c4f5285ad 100644 --- a/examples/1.9.x/console-web/examples/migrations/get-n-host-report.md +++ b/examples/1.9.x/console-web/examples/migrations/get-n-host-report.md @@ -14,7 +14,7 @@ const result = await migrations.getNHostReport({ adminSecret: '', database: '', username: '', - password: '', + password: 'password', port: null // optional }); diff --git a/examples/1.9.x/console-web/examples/migrations/get-supabase-report.md b/examples/1.9.x/console-web/examples/migrations/get-supabase-report.md index 834dd6bbc..9beeeceb8 100644 --- a/examples/1.9.x/console-web/examples/migrations/get-supabase-report.md +++ b/examples/1.9.x/console-web/examples/migrations/get-supabase-report.md @@ -13,7 +13,7 @@ const result = await migrations.getSupabaseReport({ apiKey: '', databaseHost: '', username: '', - password: '', + password: 'password', port: null // optional }); diff --git a/examples/1.9.x/console-web/examples/organizations/get-addon-price.md b/examples/1.9.x/console-web/examples/organizations/get-addon-price.md index 90043327f..1f96ba391 100644 --- a/examples/1.9.x/console-web/examples/organizations/get-addon-price.md +++ b/examples/1.9.x/console-web/examples/organizations/get-addon-price.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Organizations, OrganizationAddon } from "@appwrite.io/console"; +import { Client, Organizations, Addon } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -9,7 +9,7 @@ const organizations = new Organizations(client); const result = await organizations.getAddonPrice({ organizationId: '', - addon: OrganizationAddon.Baa + addon: Addon.Baa }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/organizations/get-invoice-download.md b/examples/1.9.x/console-web/examples/organizations/get-invoice-download.md index d20191ee5..e35da2fee 100644 --- a/examples/1.9.x/console-web/examples/organizations/get-invoice-download.md +++ b/examples/1.9.x/console-web/examples/organizations/get-invoice-download.md @@ -3,11 +3,12 @@ import { Client, Organizations } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const organizations = new Organizations(client); -const result = await organizations.getInvoiceDownload({ +const result = organizations.getInvoiceDownload({ organizationId: '', invoiceId: '' }); diff --git a/examples/1.9.x/console-web/examples/organizations/get-invoice-view.md b/examples/1.9.x/console-web/examples/organizations/get-invoice-view.md index 58d822e5c..1a5b24252 100644 --- a/examples/1.9.x/console-web/examples/organizations/get-invoice-view.md +++ b/examples/1.9.x/console-web/examples/organizations/get-invoice-view.md @@ -3,11 +3,12 @@ import { Client, Organizations } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const organizations = new Organizations(client); -const result = await organizations.getInvoiceView({ +const result = organizations.getInvoiceView({ organizationId: '', invoiceId: '' }); diff --git a/examples/1.9.x/console-web/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/console-web/examples/project/update-membership-privacy-policy.md index 006f1f82c..ae8ef9786 100644 --- a/examples/1.9.x/console-web/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/console-web/examples/project/update-membership-privacy-policy.md @@ -12,7 +12,8 @@ const result = await project.updateMembershipPrivacyPolicy({ userEmail: false, // optional userPhone: false, // optional userName: false, // optional - userMFA: false // optional + userMFA: false, // optional + userAccessedAt: false // optional }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-server.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..860e4f71d --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-server.md @@ -0,0 +1,27 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Server({ + enabled: false, + authorizationUrl: 'https://example.com', + scopes: [], // optional + authorizationDetailsTypes: [], // optional + accessTokenDuration: 60, // optional + refreshTokenDuration: 60, // optional + publicAccessTokenDuration: 60, // optional + publicRefreshTokenDuration: 60, // optional + confidentialPkce: false, // optional + verificationUrl: 'https://example.com', // optional + userCodeLength: 6, // optional + userCodeFormat: 'numeric', // optional + deviceCodeDuration: 60 // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-password-strength-policy.md b/examples/1.9.x/console-web/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..88913c745 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-password-strength-policy.md @@ -0,0 +1,19 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updatePasswordStrengthPolicy({ + min: 8, // optional + uppercase: false, // optional + lowercase: false, // optional + number: false, // optional + symbols: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-smtp.md b/examples/1.9.x/console-web/examples/project/update-smtp.md index c2236be50..0dda510a5 100644 --- a/examples/1.9.x/console-web/examples/project/update-smtp.md +++ b/examples/1.9.x/console-web/examples/project/update-smtp.md @@ -11,7 +11,7 @@ const result = await project.updateSMTP({ host: '', // optional port: null, // optional username: '', // optional - password: '', // optional + password: 'password', // optional senderEmail: 'email@example.com', // optional senderName: '', // optional replyToEmail: 'email@example.com', // optional diff --git a/examples/1.9.x/console-web/examples/projects/update-status.md b/examples/1.9.x/console-web/examples/projects/update-status.md index 42345b7cc..d795d87e5 100644 --- a/examples/1.9.x/console-web/examples/projects/update-status.md +++ b/examples/1.9.x/console-web/examples/projects/update-status.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Projects, ProjectStatus } from "@appwrite.io/console"; +import { Client, Projects, Status } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -9,7 +9,7 @@ const projects = new Projects(client); const result = await projects.updateStatus({ projectId: '', - status: ProjectStatus.Active + status: Status.Active }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/proxy/create-redirect-rule.md b/examples/1.9.x/console-web/examples/proxy/create-redirect-rule.md index 0e632cc2f..0ab36157c 100644 --- a/examples/1.9.x/console-web/examples/proxy/create-redirect-rule.md +++ b/examples/1.9.x/console-web/examples/proxy/create-redirect-rule.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Proxy, RedirectStatusCode, ProxyResourceType } from "@appwrite.io/console"; +import { Client, Proxy, StatusCode, ProxyResourceType } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -10,7 +10,7 @@ const proxy = new Proxy(client); const result = await proxy.createRedirectRule({ domain: '', url: 'https://example.com', - statusCode: RedirectStatusCode.MovedPermanently, + statusCode: StatusCode.MovedPermanently, resourceId: '', resourceType: ProxyResourceType.Site }); diff --git a/examples/1.9.x/console-web/examples/sites/create.md b/examples/1.9.x/console-web/examples/sites/create.md index 8a4f15956..b6d0c8b6d 100644 --- a/examples/1.9.x/console-web/examples/sites/create.md +++ b/examples/1.9.x/console-web/examples/sites/create.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Sites, SiteFramework, SiteBuildRuntime, SiteAdapter } from "@appwrite.io/console"; +import { Client, Sites, Framework, BuildRuntime, Adapter } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -10,8 +10,8 @@ const sites = new Sites(client); const result = await sites.create({ siteId: '', name: '', - framework: SiteFramework.Analog, - buildRuntime: SiteBuildRuntime.Node145, + framework: Framework.Analog, + buildRuntime: BuildRuntime.Node145, enabled: false, // optional logging: false, // optional timeout: 1, // optional @@ -19,7 +19,7 @@ const result = await sites.create({ buildCommand: '', // optional startCommand: '', // optional outputDirectory: '', // optional - adapter: SiteAdapter.Static, // optional + adapter: Adapter.Static, // optional installationId: '', // optional fallbackFile: '', // optional providerRepositoryId: '', // optional diff --git a/examples/1.9.x/console-web/examples/sites/get-deployment-download.md b/examples/1.9.x/console-web/examples/sites/get-deployment-download.md index 2645bd510..288d3f8b8 100644 --- a/examples/1.9.x/console-web/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/console-web/examples/sites/get-deployment-download.md @@ -3,7 +3,8 @@ import { Client, Sites, DeploymentDownloadType } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const sites = new Sites(client); diff --git a/examples/1.9.x/console-web/examples/sites/list-templates.md b/examples/1.9.x/console-web/examples/sites/list-templates.md index 50b562406..bf6db4d11 100644 --- a/examples/1.9.x/console-web/examples/sites/list-templates.md +++ b/examples/1.9.x/console-web/examples/sites/list-templates.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Sites, SiteFramework, SiteTemplateUseCase } from "@appwrite.io/console"; +import { Client, Sites, Framework, SiteTemplateUseCase } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -8,7 +8,7 @@ const client = new Client() const sites = new Sites(client); const result = await sites.listTemplates({ - frameworks: [SiteFramework.Analog], // optional + frameworks: [Framework.Analog], // optional useCases: [SiteTemplateUseCase.Portfolio], // optional limit: 1, // optional offset: 0 // optional diff --git a/examples/1.9.x/console-web/examples/sites/update.md b/examples/1.9.x/console-web/examples/sites/update.md index 47f2f7ae1..e635761d2 100644 --- a/examples/1.9.x/console-web/examples/sites/update.md +++ b/examples/1.9.x/console-web/examples/sites/update.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Sites, SiteFramework, SiteBuildRuntime, SiteAdapter } from "@appwrite.io/console"; +import { Client, Sites, Framework, BuildRuntime, Adapter } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -10,7 +10,7 @@ const sites = new Sites(client); const result = await sites.update({ siteId: '', name: '', - framework: SiteFramework.Analog, + framework: Framework.Analog, enabled: false, // optional logging: false, // optional timeout: 1, // optional @@ -18,8 +18,8 @@ const result = await sites.update({ buildCommand: '', // optional startCommand: '', // optional outputDirectory: '', // optional - buildRuntime: SiteBuildRuntime.Node145, // optional - adapter: SiteAdapter.Static, // optional + buildRuntime: BuildRuntime.Node145, // optional + adapter: Adapter.Static, // optional fallbackFile: '', // optional installationId: '', // optional providerRepositoryId: '', // optional diff --git a/examples/1.9.x/console-web/examples/storage/get-file-download.md b/examples/1.9.x/console-web/examples/storage/get-file-download.md index 1e940d16f..227a9c3e4 100644 --- a/examples/1.9.x/console-web/examples/storage/get-file-download.md +++ b/examples/1.9.x/console-web/examples/storage/get-file-download.md @@ -3,7 +3,8 @@ import { Client, Storage } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new Storage(client); diff --git a/examples/1.9.x/console-web/examples/storage/get-file-preview.md b/examples/1.9.x/console-web/examples/storage/get-file-preview.md index 781c5cc4d..0dcbc3251 100644 --- a/examples/1.9.x/console-web/examples/storage/get-file-preview.md +++ b/examples/1.9.x/console-web/examples/storage/get-file-preview.md @@ -3,7 +3,8 @@ import { Client, Storage, ImageGravity, ImageFormat } from "@appwrite.io/console const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new Storage(client); diff --git a/examples/1.9.x/console-web/examples/storage/get-file-view.md b/examples/1.9.x/console-web/examples/storage/get-file-view.md index 800f3f935..4984a010e 100644 --- a/examples/1.9.x/console-web/examples/storage/get-file-view.md +++ b/examples/1.9.x/console-web/examples/storage/get-file-view.md @@ -3,7 +3,8 @@ import { Client, Storage } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID + .setProject('') // Your project ID + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new Storage(client); diff --git a/examples/1.9.x/console-web/examples/users/create.md b/examples/1.9.x/console-web/examples/users/create.md index 1dcd2c245..83fa0bd79 100644 --- a/examples/1.9.x/console-web/examples/users/create.md +++ b/examples/1.9.x/console-web/examples/users/create.md @@ -11,7 +11,7 @@ const result = await users.create({ userId: '', email: 'email@example.com', // optional phone: '+12065550100', // optional - password: '', // optional + password: 'password', // optional name: '' // optional }); diff --git a/examples/1.9.x/console-web/examples/users/update-password.md b/examples/1.9.x/console-web/examples/users/update-password.md index 04b1a9a5c..48920f147 100644 --- a/examples/1.9.x/console-web/examples/users/update-password.md +++ b/examples/1.9.x/console-web/examples/users/update-password.md @@ -9,7 +9,7 @@ const users = new Users(client); const result = await users.updatePassword({ userId: '', - password: '' + password: 'password' }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/vectorsdb/create-text-embeddings.md b/examples/1.9.x/console-web/examples/vectorsdb/create-text-embeddings.md index 01654bc44..f5d825e4d 100644 --- a/examples/1.9.x/console-web/examples/vectorsdb/create-text-embeddings.md +++ b/examples/1.9.x/console-web/examples/vectorsdb/create-text-embeddings.md @@ -9,7 +9,7 @@ const vectorsDB = new VectorsDB(client); const result = await vectorsDB.createTextEmbeddings({ texts: [], - model: EmbeddingModel.Embeddinggemma // optional + model: EmbeddingModel.NomicEmbedText // optional }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/vectorsdb/create.md b/examples/1.9.x/console-web/examples/vectorsdb/create.md index d37467a0b..73dd7149c 100644 --- a/examples/1.9.x/console-web/examples/vectorsdb/create.md +++ b/examples/1.9.x/console-web/examples/vectorsdb/create.md @@ -10,7 +10,8 @@ const vectorsDB = new VectorsDB(client); const result = await vectorsDB.create({ databaseId: '', name: '', - enabled: false // optional + enabled: false, // optional + specification: '' // optional }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/webhooks/create.md b/examples/1.9.x/console-web/examples/webhooks/create.md index 72661fd4c..e44da2bb1 100644 --- a/examples/1.9.x/console-web/examples/webhooks/create.md +++ b/examples/1.9.x/console-web/examples/webhooks/create.md @@ -15,7 +15,7 @@ const result = await webhooks.create({ enabled: false, // optional tls: false, // optional authUsername: '', // optional - authPassword: '', // optional + authPassword: 'password', // optional secret: '' // optional }); diff --git a/examples/1.9.x/console-web/examples/webhooks/update.md b/examples/1.9.x/console-web/examples/webhooks/update.md index fb1b70b6d..6d3bf024b 100644 --- a/examples/1.9.x/console-web/examples/webhooks/update.md +++ b/examples/1.9.x/console-web/examples/webhooks/update.md @@ -15,7 +15,7 @@ const result = await webhooks.update({ enabled: false, // optional tls: false, // optional authUsername: '', // optional - authPassword: '' // optional + authPassword: 'password' // optional }); console.log(result); diff --git a/examples/1.9.x/server-dart/examples/account/create.md b/examples/1.9.x/server-dart/examples/account/create.md index fd08fa83c..59b961161 100644 --- a/examples/1.9.x/server-dart/examples/account/create.md +++ b/examples/1.9.x/server-dart/examples/account/create.md @@ -11,7 +11,7 @@ Account account = Account(client); User result = await account.create( userId: '', email: 'email@example.com', - password: '', + password: 'password', name: '', // (optional) ); ``` diff --git a/examples/1.9.x/server-dart/examples/account/update-password.md b/examples/1.9.x/server-dart/examples/account/update-password.md index 9f4ad4894..e903f1a1b 100644 --- a/examples/1.9.x/server-dart/examples/account/update-password.md +++ b/examples/1.9.x/server-dart/examples/account/update-password.md @@ -9,7 +9,7 @@ Client client = Client() Account account = Account(client); User result = await account.updatePassword( - password: '', + password: 'password', oldPassword: 'password', // (optional) ); ``` diff --git a/examples/1.9.x/server-dart/examples/account/update-recovery.md b/examples/1.9.x/server-dart/examples/account/update-recovery.md index 7b6920e1b..fd69c45fa 100644 --- a/examples/1.9.x/server-dart/examples/account/update-recovery.md +++ b/examples/1.9.x/server-dart/examples/account/update-recovery.md @@ -11,6 +11,6 @@ Account account = Account(client); Token result = await account.updateRecovery( userId: '', secret: '', - password: '', + password: 'password', ); ``` diff --git a/examples/1.9.x/server-dart/examples/avatars/get-browser.md b/examples/1.9.x/server-dart/examples/avatars/get-browser.md index b4626789b..ab781be69 100644 --- a/examples/1.9.x/server-dart/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-dart/examples/avatars/get-browser.md @@ -5,7 +5,8 @@ import 'package:dart_appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/server-dart/examples/avatars/get-credit-card.md b/examples/1.9.x/server-dart/examples/avatars/get-credit-card.md index b5eb4f427..c8c5611f1 100644 --- a/examples/1.9.x/server-dart/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-dart/examples/avatars/get-credit-card.md @@ -5,7 +5,8 @@ import 'package:dart_appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/server-dart/examples/avatars/get-favicon.md b/examples/1.9.x/server-dart/examples/avatars/get-favicon.md index 1bfa9b721..177eadc9a 100644 --- a/examples/1.9.x/server-dart/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-dart/examples/avatars/get-favicon.md @@ -4,7 +4,8 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/server-dart/examples/avatars/get-flag.md b/examples/1.9.x/server-dart/examples/avatars/get-flag.md index 920ccc5d8..4e360f221 100644 --- a/examples/1.9.x/server-dart/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-dart/examples/avatars/get-flag.md @@ -5,7 +5,8 @@ import 'package:dart_appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/server-dart/examples/avatars/get-image.md b/examples/1.9.x/server-dart/examples/avatars/get-image.md index c4c347102..9c83c246e 100644 --- a/examples/1.9.x/server-dart/examples/avatars/get-image.md +++ b/examples/1.9.x/server-dart/examples/avatars/get-image.md @@ -4,7 +4,8 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/server-dart/examples/avatars/get-initials.md b/examples/1.9.x/server-dart/examples/avatars/get-initials.md index 65ff5806b..4b0f13b74 100644 --- a/examples/1.9.x/server-dart/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-dart/examples/avatars/get-initials.md @@ -4,7 +4,8 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/server-dart/examples/avatars/get-qr.md b/examples/1.9.x/server-dart/examples/avatars/get-qr.md index 9c470360e..f142f2c46 100644 --- a/examples/1.9.x/server-dart/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-dart/examples/avatars/get-qr.md @@ -4,7 +4,8 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/server-dart/examples/avatars/get-screenshot.md b/examples/1.9.x/server-dart/examples/avatars/get-screenshot.md index b2c005e37..98054e0a4 100644 --- a/examples/1.9.x/server-dart/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-dart/examples/avatars/get-screenshot.md @@ -5,7 +5,8 @@ import 'package:dart_appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = Avatars(client); diff --git a/examples/1.9.x/server-dart/examples/functions/create.md b/examples/1.9.x/server-dart/examples/functions/create.md index 10a5ec798..f801a6209 100644 --- a/examples/1.9.x/server-dart/examples/functions/create.md +++ b/examples/1.9.x/server-dart/examples/functions/create.md @@ -12,7 +12,7 @@ Functions functions = Functions(client); Func result = await functions.create( functionId: '', name: '', - runtime: enums.FunctionRuntime.node145, + runtime: enums.Runtime.node145, execute: ["any"], // (optional) events: [], // (optional) schedule: '', // (optional) diff --git a/examples/1.9.x/server-dart/examples/functions/get-deployment-download.md b/examples/1.9.x/server-dart/examples/functions/get-deployment-download.md index 378a366ad..e11c80d8c 100644 --- a/examples/1.9.x/server-dart/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-dart/examples/functions/get-deployment-download.md @@ -5,7 +5,8 @@ import 'package:dart_appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setKey(''); // Your secret API key + .setKey('') // Your secret API key + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Functions functions = Functions(client); diff --git a/examples/1.9.x/server-dart/examples/functions/update.md b/examples/1.9.x/server-dart/examples/functions/update.md index b63e553e9..9a950dee5 100644 --- a/examples/1.9.x/server-dart/examples/functions/update.md +++ b/examples/1.9.x/server-dart/examples/functions/update.md @@ -12,7 +12,7 @@ Functions functions = Functions(client); Func result = await functions.update( functionId: '', name: '', - runtime: enums.FunctionRuntime.node145, // (optional) + runtime: enums.Runtime.node145, // (optional) execute: ["any"], // (optional) events: [], // (optional) schedule: '', // (optional) diff --git a/examples/1.9.x/server-dart/examples/health/get-audits-db.md b/examples/1.9.x/server-dart/examples/health/get-audits-db.md new file mode 100644 index 000000000..7fcace697 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/health/get-audits-db.md @@ -0,0 +1,12 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Health health = Health(client); + +HealthStatusList result = await health.getAuditsDB(); +``` diff --git a/examples/1.9.x/server-dart/examples/messaging/create-ses-provider.md b/examples/1.9.x/server-dart/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..254166c12 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/messaging/create-ses-provider.md @@ -0,0 +1,23 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.createSesProvider( + providerId: '', + name: '', + accessKey: '', // (optional) + secretKey: '', // (optional) + region: '', // (optional) + fromName: '', // (optional) + fromEmail: 'email@example.com', // (optional) + replyToName: '', // (optional) + replyToEmail: 'email@example.com', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-dart/examples/messaging/create-smtp-provider.md index 6d7d7e9df..d54de6500 100644 --- a/examples/1.9.x/server-dart/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-dart/examples/messaging/create-smtp-provider.md @@ -15,7 +15,7 @@ Provider result = await messaging.createSMTPProvider( host: '', port: 1, // (optional) username: '', // (optional) - password: '', // (optional) + password: 'password', // (optional) encryption: enums.SmtpEncryption.none, // (optional) autoTLS: false, // (optional) mailer: '', // (optional) diff --git a/examples/1.9.x/server-dart/examples/messaging/update-ses-provider.md b/examples/1.9.x/server-dart/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..a2e100752 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/messaging/update-ses-provider.md @@ -0,0 +1,23 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.updateSesProvider( + providerId: '', + name: '', // (optional) + enabled: false, // (optional) + accessKey: '', // (optional) + secretKey: '', // (optional) + region: '', // (optional) + fromName: '', // (optional) + fromEmail: 'email@example.com', // (optional) + replyToName: '', // (optional) + replyToEmail: '', // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-dart/examples/messaging/update-smtp-provider.md index e77b1455d..e88708cf0 100644 --- a/examples/1.9.x/server-dart/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-dart/examples/messaging/update-smtp-provider.md @@ -15,7 +15,7 @@ Provider result = await messaging.updateSMTPProvider( host: '', // (optional) port: 1, // (optional) username: '', // (optional) - password: '', // (optional) + password: 'password', // (optional) encryption: enums.SmtpEncryption.none, // (optional) autoTLS: false, // (optional) mailer: '', // (optional) diff --git a/examples/1.9.x/server-dart/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-dart/examples/project/update-membership-privacy-policy.md index df34e2c4c..d1164b7ff 100644 --- a/examples/1.9.x/server-dart/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-dart/examples/project/update-membership-privacy-policy.md @@ -14,5 +14,6 @@ Project result = await project.updateMembershipPrivacyPolicy( userPhone: false, // (optional) userName: false, // (optional) userMFA: false, // (optional) + userAccessedAt: false, // (optional) ); ``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-server.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..3bf5a9590 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-server.md @@ -0,0 +1,26 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +Project result = await project.updateOAuth2Server( + enabled: false, + authorizationUrl: 'https://example.com', + scopes: [], // (optional) + authorizationDetailsTypes: [], // (optional) + accessTokenDuration: 60, // (optional) + refreshTokenDuration: 60, // (optional) + publicAccessTokenDuration: 60, // (optional) + publicRefreshTokenDuration: 60, // (optional) + confidentialPkce: false, // (optional) + verificationUrl: 'https://example.com', // (optional) + userCodeLength: 6, // (optional) + userCodeFormat: 'numeric', // (optional) + deviceCodeDuration: 60, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-password-strength-policy.md b/examples/1.9.x/server-dart/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..eca34320a --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-password-strength-policy.md @@ -0,0 +1,18 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +PolicyPasswordStrength result = await project.updatePasswordStrengthPolicy( + min: 8, // (optional) + uppercase: false, // (optional) + lowercase: false, // (optional) + number: false, // (optional) + symbols: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-smtp.md b/examples/1.9.x/server-dart/examples/project/update-smtp.md index c688371c6..625c4f8af 100644 --- a/examples/1.9.x/server-dart/examples/project/update-smtp.md +++ b/examples/1.9.x/server-dart/examples/project/update-smtp.md @@ -13,7 +13,7 @@ Project result = await project.updateSMTP( host: '', // (optional) port: 0, // (optional) username: '', // (optional) - password: '', // (optional) + password: 'password', // (optional) senderEmail: 'email@example.com', // (optional) senderName: '', // (optional) replyToEmail: 'email@example.com', // (optional) diff --git a/examples/1.9.x/server-dart/examples/proxy/create-redirect-rule.md b/examples/1.9.x/server-dart/examples/proxy/create-redirect-rule.md index 561789df4..e6a834877 100644 --- a/examples/1.9.x/server-dart/examples/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-dart/examples/proxy/create-redirect-rule.md @@ -12,7 +12,7 @@ Proxy proxy = Proxy(client); ProxyRule result = await proxy.createRedirectRule( domain: '', url: 'https://example.com', - statusCode: enums.RedirectStatusCode.movedPermanently, + statusCode: enums.StatusCode.movedPermanently, resourceId: '', resourceType: enums.ProxyResourceType.site, ); diff --git a/examples/1.9.x/server-dart/examples/sites/create.md b/examples/1.9.x/server-dart/examples/sites/create.md index 435c69cae..8ebd3a050 100644 --- a/examples/1.9.x/server-dart/examples/sites/create.md +++ b/examples/1.9.x/server-dart/examples/sites/create.md @@ -12,8 +12,8 @@ Sites sites = Sites(client); Site result = await sites.create( siteId: '', name: '', - framework: enums.SiteFramework.analog, - buildRuntime: enums.SiteBuildRuntime.node145, + framework: enums.Framework.analog, + buildRuntime: enums.BuildRuntime.node145, enabled: false, // (optional) logging: false, // (optional) timeout: 1, // (optional) @@ -21,7 +21,7 @@ Site result = await sites.create( buildCommand: '', // (optional) startCommand: '', // (optional) outputDirectory: '', // (optional) - adapter: enums.SiteAdapter.static, // (optional) + adapter: enums.Adapter.static, // (optional) installationId: '', // (optional) fallbackFile: '', // (optional) providerRepositoryId: '', // (optional) diff --git a/examples/1.9.x/server-dart/examples/sites/get-deployment-download.md b/examples/1.9.x/server-dart/examples/sites/get-deployment-download.md index b9e4baa1d..d8a5c00d4 100644 --- a/examples/1.9.x/server-dart/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-dart/examples/sites/get-deployment-download.md @@ -5,7 +5,8 @@ import 'package:dart_appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setKey(''); // Your secret API key + .setKey('') // Your secret API key + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Sites sites = Sites(client); diff --git a/examples/1.9.x/server-dart/examples/sites/update.md b/examples/1.9.x/server-dart/examples/sites/update.md index 00a2a1ef8..053ad5f94 100644 --- a/examples/1.9.x/server-dart/examples/sites/update.md +++ b/examples/1.9.x/server-dart/examples/sites/update.md @@ -12,7 +12,7 @@ Sites sites = Sites(client); Site result = await sites.update( siteId: '', name: '', - framework: enums.SiteFramework.analog, + framework: enums.Framework.analog, enabled: false, // (optional) logging: false, // (optional) timeout: 1, // (optional) @@ -20,8 +20,8 @@ Site result = await sites.update( buildCommand: '', // (optional) startCommand: '', // (optional) outputDirectory: '', // (optional) - buildRuntime: enums.SiteBuildRuntime.node145, // (optional) - adapter: enums.SiteAdapter.static, // (optional) + buildRuntime: enums.BuildRuntime.node145, // (optional) + adapter: enums.Adapter.static, // (optional) fallbackFile: '', // (optional) installationId: '', // (optional) providerRepositoryId: '', // (optional) diff --git a/examples/1.9.x/server-dart/examples/storage/get-file-download.md b/examples/1.9.x/server-dart/examples/storage/get-file-download.md index 3eefb650e..33b52defb 100644 --- a/examples/1.9.x/server-dart/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-dart/examples/storage/get-file-download.md @@ -4,7 +4,8 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = Storage(client); diff --git a/examples/1.9.x/server-dart/examples/storage/get-file-preview.md b/examples/1.9.x/server-dart/examples/storage/get-file-preview.md index 382080fb0..182ec0ee1 100644 --- a/examples/1.9.x/server-dart/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-dart/examples/storage/get-file-preview.md @@ -5,7 +5,8 @@ import 'package:dart_appwrite/enums.dart' as enums; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = Storage(client); diff --git a/examples/1.9.x/server-dart/examples/storage/get-file-view.md b/examples/1.9.x/server-dart/examples/storage/get-file-view.md index 63cd86995..d3bc0f817 100644 --- a/examples/1.9.x/server-dart/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-dart/examples/storage/get-file-view.md @@ -4,7 +4,8 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = Storage(client); diff --git a/examples/1.9.x/server-dart/examples/users/create.md b/examples/1.9.x/server-dart/examples/users/create.md index 247460b4e..1bbccb8ce 100644 --- a/examples/1.9.x/server-dart/examples/users/create.md +++ b/examples/1.9.x/server-dart/examples/users/create.md @@ -12,7 +12,7 @@ User result = await users.create( userId: '', email: 'email@example.com', // (optional) phone: '+12065550100', // (optional) - password: '', // (optional) + password: 'password', // (optional) name: '', // (optional) ); ``` diff --git a/examples/1.9.x/server-dart/examples/users/update-password.md b/examples/1.9.x/server-dart/examples/users/update-password.md index d4ea3a262..4968bae42 100644 --- a/examples/1.9.x/server-dart/examples/users/update-password.md +++ b/examples/1.9.x/server-dart/examples/users/update-password.md @@ -10,6 +10,6 @@ Users users = Users(client); User result = await users.updatePassword( userId: '', - password: '', + password: 'password', ); ``` diff --git a/examples/1.9.x/server-dart/examples/webhooks/create.md b/examples/1.9.x/server-dart/examples/webhooks/create.md index a401dffde..6e2c2c0f7 100644 --- a/examples/1.9.x/server-dart/examples/webhooks/create.md +++ b/examples/1.9.x/server-dart/examples/webhooks/create.md @@ -16,7 +16,7 @@ Webhook result = await webhooks.create( enabled: false, // (optional) tls: false, // (optional) authUsername: '', // (optional) - authPassword: '', // (optional) + authPassword: 'password', // (optional) secret: '', // (optional) ); ``` diff --git a/examples/1.9.x/server-dart/examples/webhooks/update.md b/examples/1.9.x/server-dart/examples/webhooks/update.md index 7185c65ac..e495ad542 100644 --- a/examples/1.9.x/server-dart/examples/webhooks/update.md +++ b/examples/1.9.x/server-dart/examples/webhooks/update.md @@ -16,6 +16,6 @@ Webhook result = await webhooks.update( enabled: false, // (optional) tls: false, // (optional) authUsername: '', // (optional) - authPassword: '', // (optional) + authPassword: 'password', // (optional) ); ``` diff --git a/examples/1.9.x/server-dotnet/examples/account/create.md b/examples/1.9.x/server-dotnet/examples/account/create.md index bbc8ae236..3488b4a40 100644 --- a/examples/1.9.x/server-dotnet/examples/account/create.md +++ b/examples/1.9.x/server-dotnet/examples/account/create.md @@ -13,6 +13,6 @@ Account account = new Account(client); User result = await account.Create( userId: "", email: "email@example.com", - password: "", + password: "password", name: "" // optional );``` diff --git a/examples/1.9.x/server-dotnet/examples/account/update-password.md b/examples/1.9.x/server-dotnet/examples/account/update-password.md index 4c468ddc5..17e459e12 100644 --- a/examples/1.9.x/server-dotnet/examples/account/update-password.md +++ b/examples/1.9.x/server-dotnet/examples/account/update-password.md @@ -11,6 +11,6 @@ Client client = new Client() Account account = new Account(client); User result = await account.UpdatePassword( - password: "", + password: "password", oldPassword: "password" // optional );``` diff --git a/examples/1.9.x/server-dotnet/examples/account/update-recovery.md b/examples/1.9.x/server-dotnet/examples/account/update-recovery.md index a822d3e40..ea5712530 100644 --- a/examples/1.9.x/server-dotnet/examples/account/update-recovery.md +++ b/examples/1.9.x/server-dotnet/examples/account/update-recovery.md @@ -13,5 +13,5 @@ Account account = new Account(client); Token result = await account.UpdateRecovery( userId: "", secret: "", - password: "" + password: "password" );``` diff --git a/examples/1.9.x/server-dotnet/examples/avatars/get-browser.md b/examples/1.9.x/server-dotnet/examples/avatars/get-browser.md index f17be7dd3..b3ca0ee2f 100644 --- a/examples/1.9.x/server-dotnet/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-dotnet/examples/avatars/get-browser.md @@ -7,7 +7,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetSession(""); // The user session to authenticate with + .SetSession("") // The user session to authenticate with + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-dotnet/examples/avatars/get-credit-card.md b/examples/1.9.x/server-dotnet/examples/avatars/get-credit-card.md index 6d1647ee0..41d5088ea 100644 --- a/examples/1.9.x/server-dotnet/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-dotnet/examples/avatars/get-credit-card.md @@ -7,7 +7,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetSession(""); // The user session to authenticate with + .SetSession("") // The user session to authenticate with + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-dotnet/examples/avatars/get-favicon.md b/examples/1.9.x/server-dotnet/examples/avatars/get-favicon.md index 4443daf46..291215ed1 100644 --- a/examples/1.9.x/server-dotnet/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-dotnet/examples/avatars/get-favicon.md @@ -6,7 +6,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetSession(""); // The user session to authenticate with + .SetSession("") // The user session to authenticate with + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-dotnet/examples/avatars/get-flag.md b/examples/1.9.x/server-dotnet/examples/avatars/get-flag.md index 2242497af..048f4e2e3 100644 --- a/examples/1.9.x/server-dotnet/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-dotnet/examples/avatars/get-flag.md @@ -7,7 +7,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetSession(""); // The user session to authenticate with + .SetSession("") // The user session to authenticate with + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-dotnet/examples/avatars/get-image.md b/examples/1.9.x/server-dotnet/examples/avatars/get-image.md index 99518bedd..2b7277b14 100644 --- a/examples/1.9.x/server-dotnet/examples/avatars/get-image.md +++ b/examples/1.9.x/server-dotnet/examples/avatars/get-image.md @@ -6,7 +6,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetSession(""); // The user session to authenticate with + .SetSession("") // The user session to authenticate with + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-dotnet/examples/avatars/get-initials.md b/examples/1.9.x/server-dotnet/examples/avatars/get-initials.md index 8f6f1cd4f..f9497bf5e 100644 --- a/examples/1.9.x/server-dotnet/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-dotnet/examples/avatars/get-initials.md @@ -6,7 +6,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetSession(""); // The user session to authenticate with + .SetSession("") // The user session to authenticate with + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-dotnet/examples/avatars/get-qr.md b/examples/1.9.x/server-dotnet/examples/avatars/get-qr.md index 2414e3d5b..02a4de7fb 100644 --- a/examples/1.9.x/server-dotnet/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-dotnet/examples/avatars/get-qr.md @@ -6,7 +6,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetSession(""); // The user session to authenticate with + .SetSession("") // The user session to authenticate with + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-dotnet/examples/avatars/get-screenshot.md b/examples/1.9.x/server-dotnet/examples/avatars/get-screenshot.md index eaa39c8d1..c04927bb5 100644 --- a/examples/1.9.x/server-dotnet/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-dotnet/examples/avatars/get-screenshot.md @@ -7,7 +7,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetSession(""); // The user session to authenticate with + .SetSession("") // The user session to authenticate with + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-dotnet/examples/functions/create.md b/examples/1.9.x/server-dotnet/examples/functions/create.md index 485b47a88..5df83e1d3 100644 --- a/examples/1.9.x/server-dotnet/examples/functions/create.md +++ b/examples/1.9.x/server-dotnet/examples/functions/create.md @@ -14,7 +14,7 @@ Functions functions = new Functions(client); Function result = await functions.Create( functionId: "", name: "", - runtime: FunctionRuntime.Node145, + runtime: Runtime.Node145, execute: ["any"], // optional events: new List(), // optional schedule: "", // optional diff --git a/examples/1.9.x/server-dotnet/examples/functions/get-deployment-download.md b/examples/1.9.x/server-dotnet/examples/functions/get-deployment-download.md index d78d52a71..7ad51429d 100644 --- a/examples/1.9.x/server-dotnet/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-dotnet/examples/functions/get-deployment-download.md @@ -7,7 +7,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetKey(""); // Your secret API key + .SetKey("") // Your secret API key + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Functions functions = new Functions(client); diff --git a/examples/1.9.x/server-dotnet/examples/functions/update.md b/examples/1.9.x/server-dotnet/examples/functions/update.md index 60b74549a..3d5aaeae7 100644 --- a/examples/1.9.x/server-dotnet/examples/functions/update.md +++ b/examples/1.9.x/server-dotnet/examples/functions/update.md @@ -14,7 +14,7 @@ Functions functions = new Functions(client); Function result = await functions.Update( functionId: "", name: "", - runtime: FunctionRuntime.Node145, // optional + runtime: Runtime.Node145, // optional execute: ["any"], // optional events: new List(), // optional schedule: "", // optional diff --git a/examples/1.9.x/server-dotnet/examples/health/get-audits-db.md b/examples/1.9.x/server-dotnet/examples/health/get-audits-db.md new file mode 100644 index 000000000..1bf229a54 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/health/get-audits-db.md @@ -0,0 +1,14 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Health health = new Health(client); + +HealthStatusList result = await health.GetAuditsDB(); +``` diff --git a/examples/1.9.x/server-dotnet/examples/messaging/create-ses-provider.md b/examples/1.9.x/server-dotnet/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..5750c3a61 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/messaging/create-ses-provider.md @@ -0,0 +1,24 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.CreateSesProvider( + providerId: "", + name: "", + accessKey: "", // optional + secretKey: "", // optional + region: "", // optional + fromName: "", // optional + fromEmail: "email@example.com", // optional + replyToName: "", // optional + replyToEmail: "email@example.com", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-dotnet/examples/messaging/create-smtp-provider.md index 1e28297e6..4ec4314f7 100644 --- a/examples/1.9.x/server-dotnet/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-dotnet/examples/messaging/create-smtp-provider.md @@ -17,7 +17,7 @@ Provider result = await messaging.CreateSMTPProvider( host: "", port: 1, // optional username: "", // optional - password: "", // optional + password: "password", // optional encryption: SmtpEncryption.None, // optional autoTLS: false, // optional mailer: "", // optional diff --git a/examples/1.9.x/server-dotnet/examples/messaging/update-ses-provider.md b/examples/1.9.x/server-dotnet/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..32a67f018 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/messaging/update-ses-provider.md @@ -0,0 +1,24 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.UpdateSesProvider( + providerId: "", + name: "", // optional + enabled: false, // optional + accessKey: "", // optional + secretKey: "", // optional + region: "", // optional + fromName: "", // optional + fromEmail: "email@example.com", // optional + replyToName: "", // optional + replyToEmail: "" // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-dotnet/examples/messaging/update-smtp-provider.md index b9f0436fd..9789829c9 100644 --- a/examples/1.9.x/server-dotnet/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-dotnet/examples/messaging/update-smtp-provider.md @@ -17,7 +17,7 @@ Provider result = await messaging.UpdateSMTPProvider( host: "", // optional port: 1, // optional username: "", // optional - password: "", // optional + password: "password", // optional encryption: SmtpEncryption.None, // optional autoTLS: false, // optional mailer: "", // optional diff --git a/examples/1.9.x/server-dotnet/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-dotnet/examples/project/update-membership-privacy-policy.md index 37ef7fe1b..bd452cf8e 100644 --- a/examples/1.9.x/server-dotnet/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-dotnet/examples/project/update-membership-privacy-policy.md @@ -15,5 +15,6 @@ Project result = await project.UpdateMembershipPrivacyPolicy( userEmail: false, // optional userPhone: false, // optional userName: false, // optional - userMFA: false // optional + userMFA: false, // optional + userAccessedAt: false // optional );``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-server.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..585b0fea5 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-server.md @@ -0,0 +1,27 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +Project result = await project.UpdateOAuth2Server( + enabled: false, + authorizationUrl: "https://example.com", + scopes: new List(), // optional + authorizationDetailsTypes: new List(), // optional + accessTokenDuration: 60, // optional + refreshTokenDuration: 60, // optional + publicAccessTokenDuration: 60, // optional + publicRefreshTokenDuration: 60, // optional + confidentialPkce: false, // optional + verificationUrl: "https://example.com", // optional + userCodeLength: 6, // optional + userCodeFormat: "numeric", // optional + deviceCodeDuration: 60 // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-password-strength-policy.md b/examples/1.9.x/server-dotnet/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..6394609b6 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-password-strength-policy.md @@ -0,0 +1,19 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +PolicyPasswordStrength result = await project.UpdatePasswordStrengthPolicy( + min: 8, // optional + uppercase: false, // optional + lowercase: false, // optional + number: false, // optional + symbols: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-smtp.md b/examples/1.9.x/server-dotnet/examples/project/update-smtp.md index c4918f4e7..91c2fda25 100644 --- a/examples/1.9.x/server-dotnet/examples/project/update-smtp.md +++ b/examples/1.9.x/server-dotnet/examples/project/update-smtp.md @@ -15,7 +15,7 @@ Project result = await project.UpdateSMTP( host: "", // optional port: 0, // optional username: "", // optional - password: "", // optional + password: "password", // optional senderEmail: "email@example.com", // optional senderName: "", // optional replyToEmail: "email@example.com", // optional diff --git a/examples/1.9.x/server-dotnet/examples/proxy/create-redirect-rule.md b/examples/1.9.x/server-dotnet/examples/proxy/create-redirect-rule.md index 34d677f7e..494a41c2d 100644 --- a/examples/1.9.x/server-dotnet/examples/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-dotnet/examples/proxy/create-redirect-rule.md @@ -14,7 +14,7 @@ Proxy proxy = new Proxy(client); ProxyRule result = await proxy.CreateRedirectRule( domain: "", url: "https://example.com", - statusCode: RedirectStatusCode.MovedPermanently, + statusCode: StatusCode.MovedPermanently, resourceId: "", resourceType: ProxyResourceType.Site );``` diff --git a/examples/1.9.x/server-dotnet/examples/sites/create.md b/examples/1.9.x/server-dotnet/examples/sites/create.md index ffc0d8ef6..65fd4f078 100644 --- a/examples/1.9.x/server-dotnet/examples/sites/create.md +++ b/examples/1.9.x/server-dotnet/examples/sites/create.md @@ -14,8 +14,8 @@ Sites sites = new Sites(client); Site result = await sites.Create( siteId: "", name: "", - framework: SiteFramework.Analog, - buildRuntime: SiteBuildRuntime.Node145, + framework: Framework.Analog, + buildRuntime: BuildRuntime.Node145, enabled: false, // optional logging: false, // optional timeout: 1, // optional @@ -23,7 +23,7 @@ Site result = await sites.Create( buildCommand: "", // optional startCommand: "", // optional outputDirectory: "", // optional - adapter: SiteAdapter.Static, // optional + adapter: Adapter.Static, // optional installationId: "", // optional fallbackFile: "", // optional providerRepositoryId: "", // optional diff --git a/examples/1.9.x/server-dotnet/examples/sites/get-deployment-download.md b/examples/1.9.x/server-dotnet/examples/sites/get-deployment-download.md index 25bc376b4..c206b15ef 100644 --- a/examples/1.9.x/server-dotnet/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-dotnet/examples/sites/get-deployment-download.md @@ -7,7 +7,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetKey(""); // Your secret API key + .SetKey("") // Your secret API key + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Sites sites = new Sites(client); diff --git a/examples/1.9.x/server-dotnet/examples/sites/update.md b/examples/1.9.x/server-dotnet/examples/sites/update.md index 8ffbf1ed9..5a7fd0caa 100644 --- a/examples/1.9.x/server-dotnet/examples/sites/update.md +++ b/examples/1.9.x/server-dotnet/examples/sites/update.md @@ -14,7 +14,7 @@ Sites sites = new Sites(client); Site result = await sites.Update( siteId: "", name: "", - framework: SiteFramework.Analog, + framework: Framework.Analog, enabled: false, // optional logging: false, // optional timeout: 1, // optional @@ -22,8 +22,8 @@ Site result = await sites.Update( buildCommand: "", // optional startCommand: "", // optional outputDirectory: "", // optional - buildRuntime: SiteBuildRuntime.Node145, // optional - adapter: SiteAdapter.Static, // optional + buildRuntime: BuildRuntime.Node145, // optional + adapter: Adapter.Static, // optional fallbackFile: "", // optional installationId: "", // optional providerRepositoryId: "", // optional diff --git a/examples/1.9.x/server-dotnet/examples/storage/get-file-download.md b/examples/1.9.x/server-dotnet/examples/storage/get-file-download.md index 02ad30d55..512d21cd8 100644 --- a/examples/1.9.x/server-dotnet/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-dotnet/examples/storage/get-file-download.md @@ -6,7 +6,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetSession(""); // The user session to authenticate with + .SetSession("") // The user session to authenticate with + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = new Storage(client); diff --git a/examples/1.9.x/server-dotnet/examples/storage/get-file-preview.md b/examples/1.9.x/server-dotnet/examples/storage/get-file-preview.md index cc3d88a8a..2160c8a80 100644 --- a/examples/1.9.x/server-dotnet/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-dotnet/examples/storage/get-file-preview.md @@ -7,7 +7,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetSession(""); // The user session to authenticate with + .SetSession("") // The user session to authenticate with + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = new Storage(client); diff --git a/examples/1.9.x/server-dotnet/examples/storage/get-file-view.md b/examples/1.9.x/server-dotnet/examples/storage/get-file-view.md index b9088d006..7ef164fcf 100644 --- a/examples/1.9.x/server-dotnet/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-dotnet/examples/storage/get-file-view.md @@ -6,7 +6,8 @@ using Appwrite.Services; Client client = new Client() .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint .SetProject("") // Your project ID - .SetSession(""); // The user session to authenticate with + .SetSession("") // The user session to authenticate with + .SetImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = new Storage(client); diff --git a/examples/1.9.x/server-dotnet/examples/users/create.md b/examples/1.9.x/server-dotnet/examples/users/create.md index e15c2071e..dd8d684c8 100644 --- a/examples/1.9.x/server-dotnet/examples/users/create.md +++ b/examples/1.9.x/server-dotnet/examples/users/create.md @@ -14,6 +14,6 @@ User result = await users.Create( userId: "", email: "email@example.com", // optional phone: "+12065550100", // optional - password: "", // optional + password: "password", // optional name: "" // optional );``` diff --git a/examples/1.9.x/server-dotnet/examples/users/update-password.md b/examples/1.9.x/server-dotnet/examples/users/update-password.md index 0222d6f6b..17e3a35ce 100644 --- a/examples/1.9.x/server-dotnet/examples/users/update-password.md +++ b/examples/1.9.x/server-dotnet/examples/users/update-password.md @@ -12,5 +12,5 @@ Users users = new Users(client); User result = await users.UpdatePassword( userId: "", - password: "" + password: "password" );``` diff --git a/examples/1.9.x/server-dotnet/examples/webhooks/create.md b/examples/1.9.x/server-dotnet/examples/webhooks/create.md index 35647c9b0..c3e9f5584 100644 --- a/examples/1.9.x/server-dotnet/examples/webhooks/create.md +++ b/examples/1.9.x/server-dotnet/examples/webhooks/create.md @@ -18,6 +18,6 @@ Webhook result = await webhooks.Create( enabled: false, // optional tls: false, // optional authUsername: "", // optional - authPassword: "", // optional + authPassword: "password", // optional secret: "" // optional );``` diff --git a/examples/1.9.x/server-dotnet/examples/webhooks/update.md b/examples/1.9.x/server-dotnet/examples/webhooks/update.md index ca1fac728..d34858554 100644 --- a/examples/1.9.x/server-dotnet/examples/webhooks/update.md +++ b/examples/1.9.x/server-dotnet/examples/webhooks/update.md @@ -18,5 +18,5 @@ Webhook result = await webhooks.Update( enabled: false, // optional tls: false, // optional authUsername: "", // optional - authPassword: "" // optional + authPassword: "password" // optional );``` diff --git a/examples/1.9.x/server-go/examples/account/create-anonymous-session.md b/examples/1.9.x/server-go/examples/account/create-anonymous-session.md index 7a8cb087c..1b609e109 100644 --- a/examples/1.9.x/server-go/examples/account/create-anonymous-session.md +++ b/examples/1.9.x/server-go/examples/account/create-anonymous-session.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-email-password-session.md b/examples/1.9.x/server-go/examples/account/create-email-password-session.md index 7410ddd75..7ed0f12a6 100644 --- a/examples/1.9.x/server-go/examples/account/create-email-password-session.md +++ b/examples/1.9.x/server-go/examples/account/create-email-password-session.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-email-token.md b/examples/1.9.x/server-go/examples/account/create-email-token.md index e90ba45e6..cc386bb0a 100644 --- a/examples/1.9.x/server-go/examples/account/create-email-token.md +++ b/examples/1.9.x/server-go/examples/account/create-email-token.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-email-verification.md b/examples/1.9.x/server-go/examples/account/create-email-verification.md index 46c6782cf..bb8be8192 100644 --- a/examples/1.9.x/server-go/examples/account/create-email-verification.md +++ b/examples/1.9.x/server-go/examples/account/create-email-verification.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-jwt.md b/examples/1.9.x/server-go/examples/account/create-jwt.md index a55208343..84243c361 100644 --- a/examples/1.9.x/server-go/examples/account/create-jwt.md +++ b/examples/1.9.x/server-go/examples/account/create-jwt.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-magic-url-token.md b/examples/1.9.x/server-go/examples/account/create-magic-url-token.md index aa6792aff..adedee466 100644 --- a/examples/1.9.x/server-go/examples/account/create-magic-url-token.md +++ b/examples/1.9.x/server-go/examples/account/create-magic-url-token.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-mfa-authenticator.md b/examples/1.9.x/server-go/examples/account/create-mfa-authenticator.md index 8df4fd181..6aacada80 100644 --- a/examples/1.9.x/server-go/examples/account/create-mfa-authenticator.md +++ b/examples/1.9.x/server-go/examples/account/create-mfa-authenticator.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-mfa-challenge.md b/examples/1.9.x/server-go/examples/account/create-mfa-challenge.md index ccb5898b2..7803cf1fa 100644 --- a/examples/1.9.x/server-go/examples/account/create-mfa-challenge.md +++ b/examples/1.9.x/server-go/examples/account/create-mfa-challenge.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-mfa-recovery-codes.md b/examples/1.9.x/server-go/examples/account/create-mfa-recovery-codes.md index 33f824ffe..9fca3a63c 100644 --- a/examples/1.9.x/server-go/examples/account/create-mfa-recovery-codes.md +++ b/examples/1.9.x/server-go/examples/account/create-mfa-recovery-codes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-o-auth-2-token.md b/examples/1.9.x/server-go/examples/account/create-o-auth-2-token.md index c8da31bbb..67be14e7e 100644 --- a/examples/1.9.x/server-go/examples/account/create-o-auth-2-token.md +++ b/examples/1.9.x/server-go/examples/account/create-o-auth-2-token.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( @@ -19,6 +19,6 @@ response, error := service.CreateOAuth2Token( "amazon", account.WithCreateOAuth2TokenSuccess("https://example.com"), account.WithCreateOAuth2TokenFailure("https://example.com"), - account.WithCreateOAuth2TokenScopes([]interface{}{}), + account.WithCreateOAuth2TokenScopes([]string{}), ) ``` diff --git a/examples/1.9.x/server-go/examples/account/create-phone-token.md b/examples/1.9.x/server-go/examples/account/create-phone-token.md index c91d7192b..27a2df7bd 100644 --- a/examples/1.9.x/server-go/examples/account/create-phone-token.md +++ b/examples/1.9.x/server-go/examples/account/create-phone-token.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-phone-verification.md b/examples/1.9.x/server-go/examples/account/create-phone-verification.md index 8ecf3f5c6..940aa2d75 100644 --- a/examples/1.9.x/server-go/examples/account/create-phone-verification.md +++ b/examples/1.9.x/server-go/examples/account/create-phone-verification.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-recovery.md b/examples/1.9.x/server-go/examples/account/create-recovery.md index 242ddedc3..a325cd325 100644 --- a/examples/1.9.x/server-go/examples/account/create-recovery.md +++ b/examples/1.9.x/server-go/examples/account/create-recovery.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-session.md b/examples/1.9.x/server-go/examples/account/create-session.md index c25f3ac70..89000d934 100644 --- a/examples/1.9.x/server-go/examples/account/create-session.md +++ b/examples/1.9.x/server-go/examples/account/create-session.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create-verification.md b/examples/1.9.x/server-go/examples/account/create-verification.md index ab8ca98a6..56ec68954 100644 --- a/examples/1.9.x/server-go/examples/account/create-verification.md +++ b/examples/1.9.x/server-go/examples/account/create-verification.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/create.md b/examples/1.9.x/server-go/examples/account/create.md index 9844f9409..12b46a4b2 100644 --- a/examples/1.9.x/server-go/examples/account/create.md +++ b/examples/1.9.x/server-go/examples/account/create.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( @@ -18,7 +18,7 @@ service := account.New(client) response, error := service.Create( "", "email@example.com", - "", + "password", account.WithCreateName(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/account/delete-identity.md b/examples/1.9.x/server-go/examples/account/delete-identity.md index 54e5adad4..0fcd8b941 100644 --- a/examples/1.9.x/server-go/examples/account/delete-identity.md +++ b/examples/1.9.x/server-go/examples/account/delete-identity.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/delete-mfa-authenticator.md b/examples/1.9.x/server-go/examples/account/delete-mfa-authenticator.md index 0def48210..9c7d04fe3 100644 --- a/examples/1.9.x/server-go/examples/account/delete-mfa-authenticator.md +++ b/examples/1.9.x/server-go/examples/account/delete-mfa-authenticator.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/delete-session.md b/examples/1.9.x/server-go/examples/account/delete-session.md index 3bde43588..2550c28df 100644 --- a/examples/1.9.x/server-go/examples/account/delete-session.md +++ b/examples/1.9.x/server-go/examples/account/delete-session.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/delete-sessions.md b/examples/1.9.x/server-go/examples/account/delete-sessions.md index d0351d351..c3ffe9a02 100644 --- a/examples/1.9.x/server-go/examples/account/delete-sessions.md +++ b/examples/1.9.x/server-go/examples/account/delete-sessions.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/get-mfa-recovery-codes.md b/examples/1.9.x/server-go/examples/account/get-mfa-recovery-codes.md index e37c0a4a6..3a51cad02 100644 --- a/examples/1.9.x/server-go/examples/account/get-mfa-recovery-codes.md +++ b/examples/1.9.x/server-go/examples/account/get-mfa-recovery-codes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/get-prefs.md b/examples/1.9.x/server-go/examples/account/get-prefs.md index dcd569e6a..7e8a2d691 100644 --- a/examples/1.9.x/server-go/examples/account/get-prefs.md +++ b/examples/1.9.x/server-go/examples/account/get-prefs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/get-session.md b/examples/1.9.x/server-go/examples/account/get-session.md index 5b29d6751..64017fa4e 100644 --- a/examples/1.9.x/server-go/examples/account/get-session.md +++ b/examples/1.9.x/server-go/examples/account/get-session.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/get.md b/examples/1.9.x/server-go/examples/account/get.md index 2aca55af1..c6b773ff8 100644 --- a/examples/1.9.x/server-go/examples/account/get.md +++ b/examples/1.9.x/server-go/examples/account/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/list-identities.md b/examples/1.9.x/server-go/examples/account/list-identities.md index 74f6d6b4e..317690bac 100644 --- a/examples/1.9.x/server-go/examples/account/list-identities.md +++ b/examples/1.9.x/server-go/examples/account/list-identities.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := account.New(client) response, error := service.ListIdentities( - account.WithListIdentitiesQueries([]interface{}{}), + account.WithListIdentitiesQueries([]string{}), account.WithListIdentitiesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/account/list-logs.md b/examples/1.9.x/server-go/examples/account/list-logs.md index 36024a120..47a31e788 100644 --- a/examples/1.9.x/server-go/examples/account/list-logs.md +++ b/examples/1.9.x/server-go/examples/account/list-logs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := account.New(client) response, error := service.ListLogs( - account.WithListLogsQueries([]interface{}{}), + account.WithListLogsQueries([]string{}), account.WithListLogsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/account/list-mfa-factors.md b/examples/1.9.x/server-go/examples/account/list-mfa-factors.md index ea5fa699c..a0da05007 100644 --- a/examples/1.9.x/server-go/examples/account/list-mfa-factors.md +++ b/examples/1.9.x/server-go/examples/account/list-mfa-factors.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/list-sessions.md b/examples/1.9.x/server-go/examples/account/list-sessions.md index 658f15321..931746a7c 100644 --- a/examples/1.9.x/server-go/examples/account/list-sessions.md +++ b/examples/1.9.x/server-go/examples/account/list-sessions.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-email-verification.md b/examples/1.9.x/server-go/examples/account/update-email-verification.md index f35c557bb..fe6fc5ee0 100644 --- a/examples/1.9.x/server-go/examples/account/update-email-verification.md +++ b/examples/1.9.x/server-go/examples/account/update-email-verification.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-email.md b/examples/1.9.x/server-go/examples/account/update-email.md index 09f8e4128..290f661da 100644 --- a/examples/1.9.x/server-go/examples/account/update-email.md +++ b/examples/1.9.x/server-go/examples/account/update-email.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-magic-url-session.md b/examples/1.9.x/server-go/examples/account/update-magic-url-session.md index b32687677..04888773e 100644 --- a/examples/1.9.x/server-go/examples/account/update-magic-url-session.md +++ b/examples/1.9.x/server-go/examples/account/update-magic-url-session.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-mfa-authenticator.md b/examples/1.9.x/server-go/examples/account/update-mfa-authenticator.md index ba4bb811e..2bea8698b 100644 --- a/examples/1.9.x/server-go/examples/account/update-mfa-authenticator.md +++ b/examples/1.9.x/server-go/examples/account/update-mfa-authenticator.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-mfa-challenge.md b/examples/1.9.x/server-go/examples/account/update-mfa-challenge.md index 2b8d97347..21ca328fc 100644 --- a/examples/1.9.x/server-go/examples/account/update-mfa-challenge.md +++ b/examples/1.9.x/server-go/examples/account/update-mfa-challenge.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-mfa-recovery-codes.md b/examples/1.9.x/server-go/examples/account/update-mfa-recovery-codes.md index 6e20f8016..f2ed0212a 100644 --- a/examples/1.9.x/server-go/examples/account/update-mfa-recovery-codes.md +++ b/examples/1.9.x/server-go/examples/account/update-mfa-recovery-codes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-mfa.md b/examples/1.9.x/server-go/examples/account/update-mfa.md index 2a37127a3..790922504 100644 --- a/examples/1.9.x/server-go/examples/account/update-mfa.md +++ b/examples/1.9.x/server-go/examples/account/update-mfa.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-name.md b/examples/1.9.x/server-go/examples/account/update-name.md index 00e1e84c0..905a7b9b5 100644 --- a/examples/1.9.x/server-go/examples/account/update-name.md +++ b/examples/1.9.x/server-go/examples/account/update-name.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-password.md b/examples/1.9.x/server-go/examples/account/update-password.md index 06c91d61e..52c55f13d 100644 --- a/examples/1.9.x/server-go/examples/account/update-password.md +++ b/examples/1.9.x/server-go/examples/account/update-password.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := account.New(client) response, error := service.UpdatePassword( - "", + "password", account.WithUpdatePasswordOldPassword("password"), ) ``` diff --git a/examples/1.9.x/server-go/examples/account/update-phone-session.md b/examples/1.9.x/server-go/examples/account/update-phone-session.md index c2cb52243..f407908fc 100644 --- a/examples/1.9.x/server-go/examples/account/update-phone-session.md +++ b/examples/1.9.x/server-go/examples/account/update-phone-session.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-phone-verification.md b/examples/1.9.x/server-go/examples/account/update-phone-verification.md index dac49195b..ce2cce211 100644 --- a/examples/1.9.x/server-go/examples/account/update-phone-verification.md +++ b/examples/1.9.x/server-go/examples/account/update-phone-verification.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-phone.md b/examples/1.9.x/server-go/examples/account/update-phone.md index 9cc4730b2..3b0dd1f30 100644 --- a/examples/1.9.x/server-go/examples/account/update-phone.md +++ b/examples/1.9.x/server-go/examples/account/update-phone.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-prefs.md b/examples/1.9.x/server-go/examples/account/update-prefs.md index fd9ceda2c..59c0cf27d 100644 --- a/examples/1.9.x/server-go/examples/account/update-prefs.md +++ b/examples/1.9.x/server-go/examples/account/update-prefs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-recovery.md b/examples/1.9.x/server-go/examples/account/update-recovery.md index 429edf412..d1383b37f 100644 --- a/examples/1.9.x/server-go/examples/account/update-recovery.md +++ b/examples/1.9.x/server-go/examples/account/update-recovery.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( @@ -18,6 +18,6 @@ service := account.New(client) response, error := service.UpdateRecovery( "", "", - "", + "password", ) ``` diff --git a/examples/1.9.x/server-go/examples/account/update-session.md b/examples/1.9.x/server-go/examples/account/update-session.md index b66c4b6b1..b5bc17273 100644 --- a/examples/1.9.x/server-go/examples/account/update-session.md +++ b/examples/1.9.x/server-go/examples/account/update-session.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-status.md b/examples/1.9.x/server-go/examples/account/update-status.md index 0bb0048a1..c2c7a23cf 100644 --- a/examples/1.9.x/server-go/examples/account/update-status.md +++ b/examples/1.9.x/server-go/examples/account/update-status.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/account/update-verification.md b/examples/1.9.x/server-go/examples/account/update-verification.md index 66f09a782..568d56cd9 100644 --- a/examples/1.9.x/server-go/examples/account/update-verification.md +++ b/examples/1.9.x/server-go/examples/account/update-verification.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/account" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/account" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/activities/get-event.md b/examples/1.9.x/server-go/examples/activities/get-event.md index 63b4a859d..4120d9ed0 100644 --- a/examples/1.9.x/server-go/examples/activities/get-event.md +++ b/examples/1.9.x/server-go/examples/activities/get-event.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/activities" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/activities" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/activities/list-events.md b/examples/1.9.x/server-go/examples/activities/list-events.md index 0c39e7274..5aa484db9 100644 --- a/examples/1.9.x/server-go/examples/activities/list-events.md +++ b/examples/1.9.x/server-go/examples/activities/list-events.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/activities" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/activities" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/advisor/delete-report.md b/examples/1.9.x/server-go/examples/advisor/delete-report.md index 4d5c0e630..370a33e29 100644 --- a/examples/1.9.x/server-go/examples/advisor/delete-report.md +++ b/examples/1.9.x/server-go/examples/advisor/delete-report.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/advisor" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/advisor" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/advisor/get-insight.md b/examples/1.9.x/server-go/examples/advisor/get-insight.md index a6b46eee5..4fa95148b 100644 --- a/examples/1.9.x/server-go/examples/advisor/get-insight.md +++ b/examples/1.9.x/server-go/examples/advisor/get-insight.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/advisor" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/advisor" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/advisor/get-report.md b/examples/1.9.x/server-go/examples/advisor/get-report.md index 082b9fd8e..c1d9c65db 100644 --- a/examples/1.9.x/server-go/examples/advisor/get-report.md +++ b/examples/1.9.x/server-go/examples/advisor/get-report.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/advisor" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/advisor" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/advisor/list-insights.md b/examples/1.9.x/server-go/examples/advisor/list-insights.md index 05765ad73..3754df2eb 100644 --- a/examples/1.9.x/server-go/examples/advisor/list-insights.md +++ b/examples/1.9.x/server-go/examples/advisor/list-insights.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/advisor" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/advisor" ) client := client.New( @@ -17,7 +17,7 @@ service := advisor.New(client) response, error := service.ListInsights( "", - advisor.WithListInsightsQueries([]interface{}{}), + advisor.WithListInsightsQueries([]string{}), advisor.WithListInsightsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/advisor/list-reports.md b/examples/1.9.x/server-go/examples/advisor/list-reports.md index ba919d546..0931e1887 100644 --- a/examples/1.9.x/server-go/examples/advisor/list-reports.md +++ b/examples/1.9.x/server-go/examples/advisor/list-reports.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/advisor" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/advisor" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := advisor.New(client) response, error := service.ListReports( - advisor.WithListReportsQueries([]interface{}{}), + advisor.WithListReportsQueries([]string{}), advisor.WithListReportsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/avatars/get-browser.md b/examples/1.9.x/server-go/examples/avatars/get-browser.md index 795527a6a..bbfd54adf 100644 --- a/examples/1.9.x/server-go/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-go/examples/avatars/get-browser.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/avatars" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/avatars" ) client := client.New( client.WithEndpoint("https://.cloud.appwrite.io/v1") client.WithProject("") client.WithSession("") + client.WithImpersonateUserId("") ) service := avatars.New(client) diff --git a/examples/1.9.x/server-go/examples/avatars/get-credit-card.md b/examples/1.9.x/server-go/examples/avatars/get-credit-card.md index f9cea7c88..c2474cb6f 100644 --- a/examples/1.9.x/server-go/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-go/examples/avatars/get-credit-card.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/avatars" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/avatars" ) client := client.New( client.WithEndpoint("https://.cloud.appwrite.io/v1") client.WithProject("") client.WithSession("") + client.WithImpersonateUserId("") ) service := avatars.New(client) diff --git a/examples/1.9.x/server-go/examples/avatars/get-favicon.md b/examples/1.9.x/server-go/examples/avatars/get-favicon.md index 09dff598c..6561915bd 100644 --- a/examples/1.9.x/server-go/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-go/examples/avatars/get-favicon.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/avatars" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/avatars" ) client := client.New( client.WithEndpoint("https://.cloud.appwrite.io/v1") client.WithProject("") client.WithSession("") + client.WithImpersonateUserId("") ) service := avatars.New(client) diff --git a/examples/1.9.x/server-go/examples/avatars/get-flag.md b/examples/1.9.x/server-go/examples/avatars/get-flag.md index 5a1e68b5f..6d3bd7218 100644 --- a/examples/1.9.x/server-go/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-go/examples/avatars/get-flag.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/avatars" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/avatars" ) client := client.New( client.WithEndpoint("https://.cloud.appwrite.io/v1") client.WithProject("") client.WithSession("") + client.WithImpersonateUserId("") ) service := avatars.New(client) diff --git a/examples/1.9.x/server-go/examples/avatars/get-image.md b/examples/1.9.x/server-go/examples/avatars/get-image.md index ec3b13108..8b16e3dd4 100644 --- a/examples/1.9.x/server-go/examples/avatars/get-image.md +++ b/examples/1.9.x/server-go/examples/avatars/get-image.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/avatars" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/avatars" ) client := client.New( client.WithEndpoint("https://.cloud.appwrite.io/v1") client.WithProject("") client.WithSession("") + client.WithImpersonateUserId("") ) service := avatars.New(client) diff --git a/examples/1.9.x/server-go/examples/avatars/get-initials.md b/examples/1.9.x/server-go/examples/avatars/get-initials.md index d522a6871..1b2c47f6d 100644 --- a/examples/1.9.x/server-go/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-go/examples/avatars/get-initials.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/avatars" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/avatars" ) client := client.New( client.WithEndpoint("https://.cloud.appwrite.io/v1") client.WithProject("") client.WithSession("") + client.WithImpersonateUserId("") ) service := avatars.New(client) diff --git a/examples/1.9.x/server-go/examples/avatars/get-qr.md b/examples/1.9.x/server-go/examples/avatars/get-qr.md index 39ea2dcef..55bdd9c3e 100644 --- a/examples/1.9.x/server-go/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-go/examples/avatars/get-qr.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/avatars" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/avatars" ) client := client.New( client.WithEndpoint("https://.cloud.appwrite.io/v1") client.WithProject("") client.WithSession("") + client.WithImpersonateUserId("") ) service := avatars.New(client) diff --git a/examples/1.9.x/server-go/examples/avatars/get-screenshot.md b/examples/1.9.x/server-go/examples/avatars/get-screenshot.md index e199c01bd..50c3ef72a 100644 --- a/examples/1.9.x/server-go/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-go/examples/avatars/get-screenshot.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/avatars" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/avatars" ) client := client.New( client.WithEndpoint("https://.cloud.appwrite.io/v1") client.WithProject("") client.WithSession("") + client.WithImpersonateUserId("") ) service := avatars.New(client) @@ -33,7 +34,7 @@ response, error := service.GetScreenshot( avatars.WithGetScreenshotLongitude(-122.4194), avatars.WithGetScreenshotAccuracy(100), avatars.WithGetScreenshotTouch(true), - avatars.WithGetScreenshotPermissions(interface{}{"geolocation","notifications"}), + avatars.WithGetScreenshotPermissions([]string{"geolocation","notifications"}), avatars.WithGetScreenshotSleep(3), avatars.WithGetScreenshotWidth(800), avatars.WithGetScreenshotHeight(600), diff --git a/examples/1.9.x/server-go/examples/backups/create-archive.md b/examples/1.9.x/server-go/examples/backups/create-archive.md index 9fc14e1bf..00dc8ddb3 100644 --- a/examples/1.9.x/server-go/examples/backups/create-archive.md +++ b/examples/1.9.x/server-go/examples/backups/create-archive.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := backups.New(client) response, error := service.CreateArchive( - []interface{}{}, + []string{}, backups.WithCreateArchiveResourceId(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/backups/create-policy.md b/examples/1.9.x/server-go/examples/backups/create-policy.md index a62ce8efc..8e35a232e 100644 --- a/examples/1.9.x/server-go/examples/backups/create-policy.md +++ b/examples/1.9.x/server-go/examples/backups/create-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( @@ -17,7 +17,7 @@ service := backups.New(client) response, error := service.CreatePolicy( "", - []interface{}{}, + []string{}, 1, "", backups.WithCreatePolicyName(""), diff --git a/examples/1.9.x/server-go/examples/backups/create-restoration.md b/examples/1.9.x/server-go/examples/backups/create-restoration.md index d7a00351d..bfb1e8fac 100644 --- a/examples/1.9.x/server-go/examples/backups/create-restoration.md +++ b/examples/1.9.x/server-go/examples/backups/create-restoration.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( @@ -17,7 +17,7 @@ service := backups.New(client) response, error := service.CreateRestoration( "", - []interface{}{}, + []string{}, backups.WithCreateRestorationNewResourceId(""), backups.WithCreateRestorationNewResourceName(""), ) diff --git a/examples/1.9.x/server-go/examples/backups/delete-archive.md b/examples/1.9.x/server-go/examples/backups/delete-archive.md index 8a44767d9..f44ff77cc 100644 --- a/examples/1.9.x/server-go/examples/backups/delete-archive.md +++ b/examples/1.9.x/server-go/examples/backups/delete-archive.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/backups/delete-policy.md b/examples/1.9.x/server-go/examples/backups/delete-policy.md index 740989d82..12d608c64 100644 --- a/examples/1.9.x/server-go/examples/backups/delete-policy.md +++ b/examples/1.9.x/server-go/examples/backups/delete-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/backups/get-archive.md b/examples/1.9.x/server-go/examples/backups/get-archive.md index 927ca8a7b..2d34ee1a6 100644 --- a/examples/1.9.x/server-go/examples/backups/get-archive.md +++ b/examples/1.9.x/server-go/examples/backups/get-archive.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/backups/get-policy.md b/examples/1.9.x/server-go/examples/backups/get-policy.md index 1ac6c8abf..86a9e8d25 100644 --- a/examples/1.9.x/server-go/examples/backups/get-policy.md +++ b/examples/1.9.x/server-go/examples/backups/get-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/backups/get-restoration.md b/examples/1.9.x/server-go/examples/backups/get-restoration.md index 916be261c..f42463d18 100644 --- a/examples/1.9.x/server-go/examples/backups/get-restoration.md +++ b/examples/1.9.x/server-go/examples/backups/get-restoration.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/backups/list-archives.md b/examples/1.9.x/server-go/examples/backups/list-archives.md index e17c54ec9..4a88c05be 100644 --- a/examples/1.9.x/server-go/examples/backups/list-archives.md +++ b/examples/1.9.x/server-go/examples/backups/list-archives.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( @@ -16,6 +16,6 @@ client := client.New( service := backups.New(client) response, error := service.ListArchives( - backups.WithListArchivesQueries([]interface{}{}), + backups.WithListArchivesQueries([]string{}), ) ``` diff --git a/examples/1.9.x/server-go/examples/backups/list-policies.md b/examples/1.9.x/server-go/examples/backups/list-policies.md index c053b75fe..db3cc1115 100644 --- a/examples/1.9.x/server-go/examples/backups/list-policies.md +++ b/examples/1.9.x/server-go/examples/backups/list-policies.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( @@ -16,6 +16,6 @@ client := client.New( service := backups.New(client) response, error := service.ListPolicies( - backups.WithListPoliciesQueries([]interface{}{}), + backups.WithListPoliciesQueries([]string{}), ) ``` diff --git a/examples/1.9.x/server-go/examples/backups/list-restorations.md b/examples/1.9.x/server-go/examples/backups/list-restorations.md index 1e1274367..c3bff2177 100644 --- a/examples/1.9.x/server-go/examples/backups/list-restorations.md +++ b/examples/1.9.x/server-go/examples/backups/list-restorations.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( @@ -16,6 +16,6 @@ client := client.New( service := backups.New(client) response, error := service.ListRestorations( - backups.WithListRestorationsQueries([]interface{}{}), + backups.WithListRestorationsQueries([]string{}), ) ``` diff --git a/examples/1.9.x/server-go/examples/backups/update-policy.md b/examples/1.9.x/server-go/examples/backups/update-policy.md index 26a6044b5..e4c555caf 100644 --- a/examples/1.9.x/server-go/examples/backups/update-policy.md +++ b/examples/1.9.x/server-go/examples/backups/update-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/backups" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/backups" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-big-int-attribute.md b/examples/1.9.x/server-go/examples/databases/create-big-int-attribute.md index db07a2381..3cf1c2851 100644 --- a/examples/1.9.x/server-go/examples/databases/create-big-int-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-big-int-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-boolean-attribute.md b/examples/1.9.x/server-go/examples/databases/create-boolean-attribute.md index cd81728f7..732059f0a 100644 --- a/examples/1.9.x/server-go/examples/databases/create-boolean-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-boolean-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-collection.md b/examples/1.9.x/server-go/examples/databases/create-collection.md index e4dc478ac..aaac7c102 100644 --- a/examples/1.9.x/server-go/examples/databases/create-collection.md +++ b/examples/1.9.x/server-go/examples/databases/create-collection.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.CreateCollection( "", "", "", - databases.WithCreateCollectionPermissions(interface{}{"read("any")"}), + databases.WithCreateCollectionPermissions([]string{"read("any")"}), databases.WithCreateCollectionDocumentSecurity(false), databases.WithCreateCollectionEnabled(false), databases.WithCreateCollectionAttributes([]interface{}{}), diff --git a/examples/1.9.x/server-go/examples/databases/create-datetime-attribute.md b/examples/1.9.x/server-go/examples/databases/create-datetime-attribute.md index aba44fb86..89a6706ea 100644 --- a/examples/1.9.x/server-go/examples/databases/create-datetime-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-datetime-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-document.md b/examples/1.9.x/server-go/examples/databases/create-document.md index c790b2b2c..a0a0f3e19 100644 --- a/examples/1.9.x/server-go/examples/databases/create-document.md +++ b/examples/1.9.x/server-go/examples/databases/create-document.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -26,7 +26,7 @@ response, error := service.CreateDocument( "age": 30, "isAdmin": false }, - databases.WithCreateDocumentPermissions(interface{}{"read("any")"}), + databases.WithCreateDocumentPermissions([]string{"read("any")"}), databases.WithCreateDocumentTransactionId(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/create-documents.md b/examples/1.9.x/server-go/examples/databases/create-documents.md index 8e7747443..2836230c9 100644 --- a/examples/1.9.x/server-go/examples/databases/create-documents.md +++ b/examples/1.9.x/server-go/examples/databases/create-documents.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-email-attribute.md b/examples/1.9.x/server-go/examples/databases/create-email-attribute.md index 8f4533510..f6cefb163 100644 --- a/examples/1.9.x/server-go/examples/databases/create-email-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-email-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-enum-attribute.md b/examples/1.9.x/server-go/examples/databases/create-enum-attribute.md index ec8762745..805af97b1 100644 --- a/examples/1.9.x/server-go/examples/databases/create-enum-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-enum-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.CreateEnumAttribute( "", "", "", - []interface{}{}, + []string{}, false, databases.WithCreateEnumAttributeDefault(""), databases.WithCreateEnumAttributeArray(false), diff --git a/examples/1.9.x/server-go/examples/databases/create-float-attribute.md b/examples/1.9.x/server-go/examples/databases/create-float-attribute.md index ebb845afb..b60c638a8 100644 --- a/examples/1.9.x/server-go/examples/databases/create-float-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-float-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-index.md b/examples/1.9.x/server-go/examples/databases/create-index.md index 2ce0d93f8..496000ee6 100644 --- a/examples/1.9.x/server-go/examples/databases/create-index.md +++ b/examples/1.9.x/server-go/examples/databases/create-index.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -20,8 +20,8 @@ response, error := service.CreateIndex( "", "", "key", - []interface{}{}, - databases.WithCreateIndexOrders([]interface{}{}), - databases.WithCreateIndexLengths([]interface{}{}), + []string{}, + databases.WithCreateIndexOrders([]string{}), + databases.WithCreateIndexLengths([]int{}), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/create-integer-attribute.md b/examples/1.9.x/server-go/examples/databases/create-integer-attribute.md index 35d1cb2a9..71db4b5e0 100644 --- a/examples/1.9.x/server-go/examples/databases/create-integer-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-integer-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-ip-attribute.md b/examples/1.9.x/server-go/examples/databases/create-ip-attribute.md index 689df8de4..cbc1802f0 100644 --- a/examples/1.9.x/server-go/examples/databases/create-ip-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-ip-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-line-attribute.md b/examples/1.9.x/server-go/examples/databases/create-line-attribute.md index f76653bec..8bc7a32b4 100644 --- a/examples/1.9.x/server-go/examples/databases/create-line-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-line-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -20,6 +20,6 @@ response, error := service.CreateLineAttribute( "", "", false, - databases.WithCreateLineAttributeDefault(interface{}{[1, 2], [3, 4], [5, 6]}), + databases.WithCreateLineAttributeDefault([]interface{}{[1, 2], [3, 4], [5, 6]}), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/create-longtext-attribute.md b/examples/1.9.x/server-go/examples/databases/create-longtext-attribute.md index 936bc933d..d22ff7361 100644 --- a/examples/1.9.x/server-go/examples/databases/create-longtext-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-longtext-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-mediumtext-attribute.md b/examples/1.9.x/server-go/examples/databases/create-mediumtext-attribute.md index 2ce24cad5..7f4a9233e 100644 --- a/examples/1.9.x/server-go/examples/databases/create-mediumtext-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-mediumtext-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-operations.md b/examples/1.9.x/server-go/examples/databases/create-operations.md index 37f43ca2f..16a0147c1 100644 --- a/examples/1.9.x/server-go/examples/databases/create-operations.md +++ b/examples/1.9.x/server-go/examples/databases/create-operations.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -17,7 +17,7 @@ service := databases.New(client) response, error := service.CreateOperations( "", - databases.WithCreateOperationsOperations(interface{}{ + databases.WithCreateOperationsOperations([]interface{}{ { "action": "create", "databaseId": "", diff --git a/examples/1.9.x/server-go/examples/databases/create-point-attribute.md b/examples/1.9.x/server-go/examples/databases/create-point-attribute.md index 10b3fb1ed..0eba78129 100644 --- a/examples/1.9.x/server-go/examples/databases/create-point-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-point-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -20,6 +20,6 @@ response, error := service.CreatePointAttribute( "", "", false, - databases.WithCreatePointAttributeDefault(interface{}{1, 2}), + databases.WithCreatePointAttributeDefault([]interface{}{1, 2}), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/create-polygon-attribute.md b/examples/1.9.x/server-go/examples/databases/create-polygon-attribute.md index c0c6e7d24..4835b7986 100644 --- a/examples/1.9.x/server-go/examples/databases/create-polygon-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-polygon-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -20,6 +20,6 @@ response, error := service.CreatePolygonAttribute( "", "", false, - databases.WithCreatePolygonAttributeDefault(interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), + databases.WithCreatePolygonAttributeDefault([]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/create-relationship-attribute.md b/examples/1.9.x/server-go/examples/databases/create-relationship-attribute.md index 759e7996b..53da85ff2 100644 --- a/examples/1.9.x/server-go/examples/databases/create-relationship-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-relationship-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-string-attribute.md b/examples/1.9.x/server-go/examples/databases/create-string-attribute.md index 11e9374be..b68cd180b 100644 --- a/examples/1.9.x/server-go/examples/databases/create-string-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-string-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-text-attribute.md b/examples/1.9.x/server-go/examples/databases/create-text-attribute.md index 4515b756f..6a1074993 100644 --- a/examples/1.9.x/server-go/examples/databases/create-text-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-text-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-transaction.md b/examples/1.9.x/server-go/examples/databases/create-transaction.md index 2a725d68a..410e6232a 100644 --- a/examples/1.9.x/server-go/examples/databases/create-transaction.md +++ b/examples/1.9.x/server-go/examples/databases/create-transaction.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-url-attribute.md b/examples/1.9.x/server-go/examples/databases/create-url-attribute.md index 5cf8095d3..60d2e708b 100644 --- a/examples/1.9.x/server-go/examples/databases/create-url-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-url-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create-varchar-attribute.md b/examples/1.9.x/server-go/examples/databases/create-varchar-attribute.md index d3b569af2..556debc93 100644 --- a/examples/1.9.x/server-go/examples/databases/create-varchar-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-varchar-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/create.md b/examples/1.9.x/server-go/examples/databases/create.md index c53535c97..a41baf5a8 100644 --- a/examples/1.9.x/server-go/examples/databases/create.md +++ b/examples/1.9.x/server-go/examples/databases/create.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/decrement-document-attribute.md b/examples/1.9.x/server-go/examples/databases/decrement-document-attribute.md index d0fa4a325..cab7b222f 100644 --- a/examples/1.9.x/server-go/examples/databases/decrement-document-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/decrement-document-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/delete-attribute.md b/examples/1.9.x/server-go/examples/databases/delete-attribute.md index 350a40832..19cdc2c42 100644 --- a/examples/1.9.x/server-go/examples/databases/delete-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/delete-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/delete-collection.md b/examples/1.9.x/server-go/examples/databases/delete-collection.md index cfe815b05..150f2585a 100644 --- a/examples/1.9.x/server-go/examples/databases/delete-collection.md +++ b/examples/1.9.x/server-go/examples/databases/delete-collection.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/delete-document.md b/examples/1.9.x/server-go/examples/databases/delete-document.md index 204294a84..a2508651e 100644 --- a/examples/1.9.x/server-go/examples/databases/delete-document.md +++ b/examples/1.9.x/server-go/examples/databases/delete-document.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/delete-documents.md b/examples/1.9.x/server-go/examples/databases/delete-documents.md index 33f15e387..c1e11a631 100644 --- a/examples/1.9.x/server-go/examples/databases/delete-documents.md +++ b/examples/1.9.x/server-go/examples/databases/delete-documents.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -18,7 +18,7 @@ service := databases.New(client) response, error := service.DeleteDocuments( "", "", - databases.WithDeleteDocumentsQueries([]interface{}{}), + databases.WithDeleteDocumentsQueries([]string{}), databases.WithDeleteDocumentsTransactionId(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/delete-index.md b/examples/1.9.x/server-go/examples/databases/delete-index.md index 7932d3ee0..f21805111 100644 --- a/examples/1.9.x/server-go/examples/databases/delete-index.md +++ b/examples/1.9.x/server-go/examples/databases/delete-index.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/delete-transaction.md b/examples/1.9.x/server-go/examples/databases/delete-transaction.md index 78ef85b0a..b33e9caf6 100644 --- a/examples/1.9.x/server-go/examples/databases/delete-transaction.md +++ b/examples/1.9.x/server-go/examples/databases/delete-transaction.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/delete.md b/examples/1.9.x/server-go/examples/databases/delete.md index 4a147b771..720be0d2b 100644 --- a/examples/1.9.x/server-go/examples/databases/delete.md +++ b/examples/1.9.x/server-go/examples/databases/delete.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/get-attribute.md b/examples/1.9.x/server-go/examples/databases/get-attribute.md index bfd3598c4..9b17f2d84 100644 --- a/examples/1.9.x/server-go/examples/databases/get-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/get-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/get-collection.md b/examples/1.9.x/server-go/examples/databases/get-collection.md index 01f950c60..7777ef1a9 100644 --- a/examples/1.9.x/server-go/examples/databases/get-collection.md +++ b/examples/1.9.x/server-go/examples/databases/get-collection.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/get-document.md b/examples/1.9.x/server-go/examples/databases/get-document.md index bb551646d..e43ec606f 100644 --- a/examples/1.9.x/server-go/examples/databases/get-document.md +++ b/examples/1.9.x/server-go/examples/databases/get-document.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.GetDocument( "", "", "", - databases.WithGetDocumentQueries([]interface{}{}), + databases.WithGetDocumentQueries([]string{}), databases.WithGetDocumentTransactionId(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/get-index.md b/examples/1.9.x/server-go/examples/databases/get-index.md index 8de6b15eb..90d6333ed 100644 --- a/examples/1.9.x/server-go/examples/databases/get-index.md +++ b/examples/1.9.x/server-go/examples/databases/get-index.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/get-transaction.md b/examples/1.9.x/server-go/examples/databases/get-transaction.md index 02e8b5b6f..651578cb8 100644 --- a/examples/1.9.x/server-go/examples/databases/get-transaction.md +++ b/examples/1.9.x/server-go/examples/databases/get-transaction.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/get.md b/examples/1.9.x/server-go/examples/databases/get.md index 5b5df1e9b..8e4fad519 100644 --- a/examples/1.9.x/server-go/examples/databases/get.md +++ b/examples/1.9.x/server-go/examples/databases/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/increment-document-attribute.md b/examples/1.9.x/server-go/examples/databases/increment-document-attribute.md index 331fb44bd..aa1c3858d 100644 --- a/examples/1.9.x/server-go/examples/databases/increment-document-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/increment-document-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/list-attributes.md b/examples/1.9.x/server-go/examples/databases/list-attributes.md index e53c5cd9d..9269e6841 100644 --- a/examples/1.9.x/server-go/examples/databases/list-attributes.md +++ b/examples/1.9.x/server-go/examples/databases/list-attributes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -18,7 +18,7 @@ service := databases.New(client) response, error := service.ListAttributes( "", "", - databases.WithListAttributesQueries([]interface{}{}), + databases.WithListAttributesQueries([]string{}), databases.WithListAttributesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/list-collections.md b/examples/1.9.x/server-go/examples/databases/list-collections.md index aac8213c6..a79199493 100644 --- a/examples/1.9.x/server-go/examples/databases/list-collections.md +++ b/examples/1.9.x/server-go/examples/databases/list-collections.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -17,7 +17,7 @@ service := databases.New(client) response, error := service.ListCollections( "", - databases.WithListCollectionsQueries([]interface{}{}), + databases.WithListCollectionsQueries([]string{}), databases.WithListCollectionsSearch(""), databases.WithListCollectionsTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/databases/list-documents.md b/examples/1.9.x/server-go/examples/databases/list-documents.md index fe8f3cea7..813425d42 100644 --- a/examples/1.9.x/server-go/examples/databases/list-documents.md +++ b/examples/1.9.x/server-go/examples/databases/list-documents.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -18,7 +18,7 @@ service := databases.New(client) response, error := service.ListDocuments( "", "", - databases.WithListDocumentsQueries([]interface{}{}), + databases.WithListDocumentsQueries([]string{}), databases.WithListDocumentsTransactionId(""), databases.WithListDocumentsTotal(false), databases.WithListDocumentsTtl(0), diff --git a/examples/1.9.x/server-go/examples/databases/list-indexes.md b/examples/1.9.x/server-go/examples/databases/list-indexes.md index d8a85b81a..c40153696 100644 --- a/examples/1.9.x/server-go/examples/databases/list-indexes.md +++ b/examples/1.9.x/server-go/examples/databases/list-indexes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -18,7 +18,7 @@ service := databases.New(client) response, error := service.ListIndexes( "", "", - databases.WithListIndexesQueries([]interface{}{}), + databases.WithListIndexesQueries([]string{}), databases.WithListIndexesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/list-transactions.md b/examples/1.9.x/server-go/examples/databases/list-transactions.md index f2a7854f7..4e90044cb 100644 --- a/examples/1.9.x/server-go/examples/databases/list-transactions.md +++ b/examples/1.9.x/server-go/examples/databases/list-transactions.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -16,6 +16,6 @@ client := client.New( service := databases.New(client) response, error := service.ListTransactions( - databases.WithListTransactionsQueries([]interface{}{}), + databases.WithListTransactionsQueries([]string{}), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/list.md b/examples/1.9.x/server-go/examples/databases/list.md index ce620ef68..db1c33481 100644 --- a/examples/1.9.x/server-go/examples/databases/list.md +++ b/examples/1.9.x/server-go/examples/databases/list.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := databases.New(client) response, error := service.List( - databases.WithListQueries([]interface{}{}), + databases.WithListQueries([]string{}), databases.WithListSearch(""), databases.WithListTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/databases/update-big-int-attribute.md b/examples/1.9.x/server-go/examples/databases/update-big-int-attribute.md index 5363c9610..0d3c454d4 100644 --- a/examples/1.9.x/server-go/examples/databases/update-big-int-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-big-int-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-boolean-attribute.md b/examples/1.9.x/server-go/examples/databases/update-boolean-attribute.md index 7e663539a..ab3aa1b6d 100644 --- a/examples/1.9.x/server-go/examples/databases/update-boolean-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-boolean-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-collection.md b/examples/1.9.x/server-go/examples/databases/update-collection.md index bb232c009..2fe288aa6 100644 --- a/examples/1.9.x/server-go/examples/databases/update-collection.md +++ b/examples/1.9.x/server-go/examples/databases/update-collection.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.UpdateCollection( "", "", databases.WithUpdateCollectionName(""), - databases.WithUpdateCollectionPermissions(interface{}{"read("any")"}), + databases.WithUpdateCollectionPermissions([]string{"read("any")"}), databases.WithUpdateCollectionDocumentSecurity(false), databases.WithUpdateCollectionEnabled(false), databases.WithUpdateCollectionPurge(false), diff --git a/examples/1.9.x/server-go/examples/databases/update-datetime-attribute.md b/examples/1.9.x/server-go/examples/databases/update-datetime-attribute.md index 555c8780e..eafd3a77e 100644 --- a/examples/1.9.x/server-go/examples/databases/update-datetime-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-datetime-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-document.md b/examples/1.9.x/server-go/examples/databases/update-document.md index 28ca13c9d..9357db024 100644 --- a/examples/1.9.x/server-go/examples/databases/update-document.md +++ b/examples/1.9.x/server-go/examples/databases/update-document.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -26,7 +26,7 @@ response, error := service.UpdateDocument( "age": 33, "isAdmin": false }), - databases.WithUpdateDocumentPermissions(interface{}{"read("any")"}), + databases.WithUpdateDocumentPermissions([]string{"read("any")"}), databases.WithUpdateDocumentTransactionId(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/update-documents.md b/examples/1.9.x/server-go/examples/databases/update-documents.md index c9765d990..da99217d7 100644 --- a/examples/1.9.x/server-go/examples/databases/update-documents.md +++ b/examples/1.9.x/server-go/examples/databases/update-documents.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -25,7 +25,7 @@ response, error := service.UpdateDocuments( "age": 33, "isAdmin": false }), - databases.WithUpdateDocumentsQueries([]interface{}{}), + databases.WithUpdateDocumentsQueries([]string{}), databases.WithUpdateDocumentsTransactionId(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/update-email-attribute.md b/examples/1.9.x/server-go/examples/databases/update-email-attribute.md index e2e17646d..b1e90190f 100644 --- a/examples/1.9.x/server-go/examples/databases/update-email-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-email-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-enum-attribute.md b/examples/1.9.x/server-go/examples/databases/update-enum-attribute.md index e25e40fd8..c56645b8e 100644 --- a/examples/1.9.x/server-go/examples/databases/update-enum-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-enum-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.UpdateEnumAttribute( "", "", "", - []interface{}{}, + []string{}, false, "", databases.WithUpdateEnumAttributeNewKey(""), diff --git a/examples/1.9.x/server-go/examples/databases/update-float-attribute.md b/examples/1.9.x/server-go/examples/databases/update-float-attribute.md index a7065b45c..2c02d5cf4 100644 --- a/examples/1.9.x/server-go/examples/databases/update-float-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-float-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-integer-attribute.md b/examples/1.9.x/server-go/examples/databases/update-integer-attribute.md index 7a8452b27..52f7461cf 100644 --- a/examples/1.9.x/server-go/examples/databases/update-integer-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-integer-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-ip-attribute.md b/examples/1.9.x/server-go/examples/databases/update-ip-attribute.md index 7e399cdfb..d21c4ca54 100644 --- a/examples/1.9.x/server-go/examples/databases/update-ip-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-ip-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-line-attribute.md b/examples/1.9.x/server-go/examples/databases/update-line-attribute.md index 8da0bde73..7cae2576f 100644 --- a/examples/1.9.x/server-go/examples/databases/update-line-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-line-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -20,7 +20,7 @@ response, error := service.UpdateLineAttribute( "", "", false, - databases.WithUpdateLineAttributeDefault(interface{}{[1, 2], [3, 4], [5, 6]}), + databases.WithUpdateLineAttributeDefault([]interface{}{[1, 2], [3, 4], [5, 6]}), databases.WithUpdateLineAttributeNewKey(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/update-longtext-attribute.md b/examples/1.9.x/server-go/examples/databases/update-longtext-attribute.md index 0e9e154d1..f27d533d9 100644 --- a/examples/1.9.x/server-go/examples/databases/update-longtext-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-longtext-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-mediumtext-attribute.md b/examples/1.9.x/server-go/examples/databases/update-mediumtext-attribute.md index 86a6ed682..3d4961993 100644 --- a/examples/1.9.x/server-go/examples/databases/update-mediumtext-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-mediumtext-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-point-attribute.md b/examples/1.9.x/server-go/examples/databases/update-point-attribute.md index 2f11a5f3b..9da605d05 100644 --- a/examples/1.9.x/server-go/examples/databases/update-point-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-point-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -20,7 +20,7 @@ response, error := service.UpdatePointAttribute( "", "", false, - databases.WithUpdatePointAttributeDefault(interface{}{1, 2}), + databases.WithUpdatePointAttributeDefault([]interface{}{1, 2}), databases.WithUpdatePointAttributeNewKey(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/update-polygon-attribute.md b/examples/1.9.x/server-go/examples/databases/update-polygon-attribute.md index ac2cd16ee..5db33da86 100644 --- a/examples/1.9.x/server-go/examples/databases/update-polygon-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-polygon-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -20,7 +20,7 @@ response, error := service.UpdatePolygonAttribute( "", "", false, - databases.WithUpdatePolygonAttributeDefault(interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), + databases.WithUpdatePolygonAttributeDefault([]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), databases.WithUpdatePolygonAttributeNewKey(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/update-relationship-attribute.md b/examples/1.9.x/server-go/examples/databases/update-relationship-attribute.md index c0affa5a2..7ef894ef6 100644 --- a/examples/1.9.x/server-go/examples/databases/update-relationship-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-relationship-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-string-attribute.md b/examples/1.9.x/server-go/examples/databases/update-string-attribute.md index 9a20ba7e6..a3949812f 100644 --- a/examples/1.9.x/server-go/examples/databases/update-string-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-string-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-text-attribute.md b/examples/1.9.x/server-go/examples/databases/update-text-attribute.md index c5f907db3..7fe9a6bd5 100644 --- a/examples/1.9.x/server-go/examples/databases/update-text-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-text-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-transaction.md b/examples/1.9.x/server-go/examples/databases/update-transaction.md index bf165b9bf..cca98fbe8 100644 --- a/examples/1.9.x/server-go/examples/databases/update-transaction.md +++ b/examples/1.9.x/server-go/examples/databases/update-transaction.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-url-attribute.md b/examples/1.9.x/server-go/examples/databases/update-url-attribute.md index 79ee9ad08..9c6c1fd73 100644 --- a/examples/1.9.x/server-go/examples/databases/update-url-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-url-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update-varchar-attribute.md b/examples/1.9.x/server-go/examples/databases/update-varchar-attribute.md index 811d35598..3c360a96d 100644 --- a/examples/1.9.x/server-go/examples/databases/update-varchar-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-varchar-attribute.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/update.md b/examples/1.9.x/server-go/examples/databases/update.md index a5bb11bc8..1c2651545 100644 --- a/examples/1.9.x/server-go/examples/databases/update.md +++ b/examples/1.9.x/server-go/examples/databases/update.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/databases/upsert-document.md b/examples/1.9.x/server-go/examples/databases/upsert-document.md index d59fcea77..6c0c89b12 100644 --- a/examples/1.9.x/server-go/examples/databases/upsert-document.md +++ b/examples/1.9.x/server-go/examples/databases/upsert-document.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( @@ -26,7 +26,7 @@ response, error := service.UpsertDocument( "age": 30, "isAdmin": false }), - databases.WithUpsertDocumentPermissions(interface{}{"read("any")"}), + databases.WithUpsertDocumentPermissions([]string{"read("any")"}), databases.WithUpsertDocumentTransactionId(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/upsert-documents.md b/examples/1.9.x/server-go/examples/databases/upsert-documents.md index 6aee62e5a..f1d35f9a9 100644 --- a/examples/1.9.x/server-go/examples/databases/upsert-documents.md +++ b/examples/1.9.x/server-go/examples/databases/upsert-documents.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/databases" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/databases" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/create-deployment.md b/examples/1.9.x/server-go/examples/functions/create-deployment.md index ef9676feb..c2b921329 100644 --- a/examples/1.9.x/server-go/examples/functions/create-deployment.md +++ b/examples/1.9.x/server-go/examples/functions/create-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/create-duplicate-deployment.md b/examples/1.9.x/server-go/examples/functions/create-duplicate-deployment.md index e3dd6428e..1c250b9fb 100644 --- a/examples/1.9.x/server-go/examples/functions/create-duplicate-deployment.md +++ b/examples/1.9.x/server-go/examples/functions/create-duplicate-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/create-execution.md b/examples/1.9.x/server-go/examples/functions/create-execution.md index 1948927f1..90697f477 100644 --- a/examples/1.9.x/server-go/examples/functions/create-execution.md +++ b/examples/1.9.x/server-go/examples/functions/create-execution.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/create-template-deployment.md b/examples/1.9.x/server-go/examples/functions/create-template-deployment.md index a643cac35..e5609f287 100644 --- a/examples/1.9.x/server-go/examples/functions/create-template-deployment.md +++ b/examples/1.9.x/server-go/examples/functions/create-template-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/create-variable.md b/examples/1.9.x/server-go/examples/functions/create-variable.md index 3ce53661a..0ca38f211 100644 --- a/examples/1.9.x/server-go/examples/functions/create-variable.md +++ b/examples/1.9.x/server-go/examples/functions/create-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/create-vcs-deployment.md b/examples/1.9.x/server-go/examples/functions/create-vcs-deployment.md index b50034058..9c9b79ad2 100644 --- a/examples/1.9.x/server-go/examples/functions/create-vcs-deployment.md +++ b/examples/1.9.x/server-go/examples/functions/create-vcs-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/create.md b/examples/1.9.x/server-go/examples/functions/create.md index 6f76c22e4..e762387aa 100644 --- a/examples/1.9.x/server-go/examples/functions/create.md +++ b/examples/1.9.x/server-go/examples/functions/create.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( @@ -19,22 +19,22 @@ response, error := service.Create( "", "", "node-14.5", - functions.WithCreateExecute(interface{}{"any"}), - functions.WithCreateEvents([]interface{}{}), + functions.WithCreateExecute([]string{"any"}), + functions.WithCreateEvents([]string{}), functions.WithCreateSchedule(""), functions.WithCreateTimeout(1), functions.WithCreateEnabled(false), functions.WithCreateLogging(false), functions.WithCreateEntrypoint(""), functions.WithCreateCommands(""), - functions.WithCreateScopes([]interface{}{}), + functions.WithCreateScopes([]string{}), functions.WithCreateInstallationId(""), functions.WithCreateProviderRepositoryId(""), functions.WithCreateProviderBranch(""), functions.WithCreateProviderSilentMode(false), functions.WithCreateProviderRootDirectory(""), - functions.WithCreateProviderBranches([]interface{}{}), - functions.WithCreateProviderPaths([]interface{}{}), + functions.WithCreateProviderBranches([]string{}), + functions.WithCreateProviderPaths([]string{}), functions.WithCreateBuildSpecification(""), functions.WithCreateRuntimeSpecification(""), functions.WithCreateDeploymentRetention(0), diff --git a/examples/1.9.x/server-go/examples/functions/delete-deployment.md b/examples/1.9.x/server-go/examples/functions/delete-deployment.md index 3808fea90..ec7fef5a8 100644 --- a/examples/1.9.x/server-go/examples/functions/delete-deployment.md +++ b/examples/1.9.x/server-go/examples/functions/delete-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/delete-execution.md b/examples/1.9.x/server-go/examples/functions/delete-execution.md index 4fa801b5e..04fe7edc3 100644 --- a/examples/1.9.x/server-go/examples/functions/delete-execution.md +++ b/examples/1.9.x/server-go/examples/functions/delete-execution.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/delete-variable.md b/examples/1.9.x/server-go/examples/functions/delete-variable.md index 12cac4902..b33c94795 100644 --- a/examples/1.9.x/server-go/examples/functions/delete-variable.md +++ b/examples/1.9.x/server-go/examples/functions/delete-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/delete.md b/examples/1.9.x/server-go/examples/functions/delete.md index 0d09ebab2..178664472 100644 --- a/examples/1.9.x/server-go/examples/functions/delete.md +++ b/examples/1.9.x/server-go/examples/functions/delete.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/get-deployment-download.md b/examples/1.9.x/server-go/examples/functions/get-deployment-download.md index 56a40a730..1f07709a5 100644 --- a/examples/1.9.x/server-go/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-go/examples/functions/get-deployment-download.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( client.WithEndpoint("https://.cloud.appwrite.io/v1") client.WithProject("") client.WithKey("") + client.WithImpersonateUserId("") ) service := functions.New(client) diff --git a/examples/1.9.x/server-go/examples/functions/get-deployment.md b/examples/1.9.x/server-go/examples/functions/get-deployment.md index eda50476d..09b4a1b16 100644 --- a/examples/1.9.x/server-go/examples/functions/get-deployment.md +++ b/examples/1.9.x/server-go/examples/functions/get-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/get-execution.md b/examples/1.9.x/server-go/examples/functions/get-execution.md index 4c3c05aab..e6b5c0af7 100644 --- a/examples/1.9.x/server-go/examples/functions/get-execution.md +++ b/examples/1.9.x/server-go/examples/functions/get-execution.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/get-variable.md b/examples/1.9.x/server-go/examples/functions/get-variable.md index 33b5a6fb2..33bc5df36 100644 --- a/examples/1.9.x/server-go/examples/functions/get-variable.md +++ b/examples/1.9.x/server-go/examples/functions/get-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/get.md b/examples/1.9.x/server-go/examples/functions/get.md index 840d3de90..83bdc4da4 100644 --- a/examples/1.9.x/server-go/examples/functions/get.md +++ b/examples/1.9.x/server-go/examples/functions/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/list-deployments.md b/examples/1.9.x/server-go/examples/functions/list-deployments.md index ed933db06..da4aa742e 100644 --- a/examples/1.9.x/server-go/examples/functions/list-deployments.md +++ b/examples/1.9.x/server-go/examples/functions/list-deployments.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( @@ -17,7 +17,7 @@ service := functions.New(client) response, error := service.ListDeployments( "", - functions.WithListDeploymentsQueries([]interface{}{}), + functions.WithListDeploymentsQueries([]string{}), functions.WithListDeploymentsSearch(""), functions.WithListDeploymentsTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/functions/list-executions.md b/examples/1.9.x/server-go/examples/functions/list-executions.md index 6d615255d..8096bb19c 100644 --- a/examples/1.9.x/server-go/examples/functions/list-executions.md +++ b/examples/1.9.x/server-go/examples/functions/list-executions.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( @@ -17,7 +17,7 @@ service := functions.New(client) response, error := service.ListExecutions( "", - functions.WithListExecutionsQueries([]interface{}{}), + functions.WithListExecutionsQueries([]string{}), functions.WithListExecutionsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/functions/list-runtimes.md b/examples/1.9.x/server-go/examples/functions/list-runtimes.md index c7f5d4701..61b1157c0 100644 --- a/examples/1.9.x/server-go/examples/functions/list-runtimes.md +++ b/examples/1.9.x/server-go/examples/functions/list-runtimes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/list-specifications.md b/examples/1.9.x/server-go/examples/functions/list-specifications.md index 3594b7087..7c386a3e4 100644 --- a/examples/1.9.x/server-go/examples/functions/list-specifications.md +++ b/examples/1.9.x/server-go/examples/functions/list-specifications.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/list-variables.md b/examples/1.9.x/server-go/examples/functions/list-variables.md index 63b2efbce..777e5c67c 100644 --- a/examples/1.9.x/server-go/examples/functions/list-variables.md +++ b/examples/1.9.x/server-go/examples/functions/list-variables.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( @@ -17,7 +17,7 @@ service := functions.New(client) response, error := service.ListVariables( "", - functions.WithListVariablesQueries([]interface{}{}), + functions.WithListVariablesQueries([]string{}), functions.WithListVariablesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/functions/list.md b/examples/1.9.x/server-go/examples/functions/list.md index cb0e7a593..d20718fda 100644 --- a/examples/1.9.x/server-go/examples/functions/list.md +++ b/examples/1.9.x/server-go/examples/functions/list.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := functions.New(client) response, error := service.List( - functions.WithListQueries([]interface{}{}), + functions.WithListQueries([]string{}), functions.WithListSearch(""), functions.WithListTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/functions/update-deployment-status.md b/examples/1.9.x/server-go/examples/functions/update-deployment-status.md index b7f5175e6..c118a1338 100644 --- a/examples/1.9.x/server-go/examples/functions/update-deployment-status.md +++ b/examples/1.9.x/server-go/examples/functions/update-deployment-status.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/update-function-deployment.md b/examples/1.9.x/server-go/examples/functions/update-function-deployment.md index 882b8cd2d..81195b2e9 100644 --- a/examples/1.9.x/server-go/examples/functions/update-function-deployment.md +++ b/examples/1.9.x/server-go/examples/functions/update-function-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/update-variable.md b/examples/1.9.x/server-go/examples/functions/update-variable.md index dee9e710f..4b3f26858 100644 --- a/examples/1.9.x/server-go/examples/functions/update-variable.md +++ b/examples/1.9.x/server-go/examples/functions/update-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/functions/update.md b/examples/1.9.x/server-go/examples/functions/update.md index adc3d7a7a..74ea24883 100644 --- a/examples/1.9.x/server-go/examples/functions/update.md +++ b/examples/1.9.x/server-go/examples/functions/update.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/functions" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/functions" ) client := client.New( @@ -19,22 +19,22 @@ response, error := service.Update( "", "", functions.WithUpdateRuntime("node-14.5"), - functions.WithUpdateExecute(interface{}{"any"}), - functions.WithUpdateEvents([]interface{}{}), + functions.WithUpdateExecute([]string{"any"}), + functions.WithUpdateEvents([]string{}), functions.WithUpdateSchedule(""), functions.WithUpdateTimeout(1), functions.WithUpdateEnabled(false), functions.WithUpdateLogging(false), functions.WithUpdateEntrypoint(""), functions.WithUpdateCommands(""), - functions.WithUpdateScopes([]interface{}{}), + functions.WithUpdateScopes([]string{}), functions.WithUpdateInstallationId(""), functions.WithUpdateProviderRepositoryId(""), functions.WithUpdateProviderBranch(""), functions.WithUpdateProviderSilentMode(false), functions.WithUpdateProviderRootDirectory(""), - functions.WithUpdateProviderBranches([]interface{}{}), - functions.WithUpdateProviderPaths([]interface{}{}), + functions.WithUpdateProviderBranches([]string{}), + functions.WithUpdateProviderPaths([]string{}), functions.WithUpdateBuildSpecification(""), functions.WithUpdateRuntimeSpecification(""), functions.WithUpdateDeploymentRetention(0), diff --git a/examples/1.9.x/server-go/examples/graphql/mutation.md b/examples/1.9.x/server-go/examples/graphql/mutation.md index addf9b68b..b7e94ecdd 100644 --- a/examples/1.9.x/server-go/examples/graphql/mutation.md +++ b/examples/1.9.x/server-go/examples/graphql/mutation.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/graphql" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/graphql" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/graphql/query.md b/examples/1.9.x/server-go/examples/graphql/query.md index 7a62b5687..af59062bd 100644 --- a/examples/1.9.x/server-go/examples/graphql/query.md +++ b/examples/1.9.x/server-go/examples/graphql/query.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/graphql" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/graphql" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-antivirus.md b/examples/1.9.x/server-go/examples/health/get-antivirus.md index 34c4e7b3a..0123704f4 100644 --- a/examples/1.9.x/server-go/examples/health/get-antivirus.md +++ b/examples/1.9.x/server-go/examples/health/get-antivirus.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-audits-db.md b/examples/1.9.x/server-go/examples/health/get-audits-db.md new file mode 100644 index 000000000..ae35dc246 --- /dev/null +++ b/examples/1.9.x/server-go/examples/health/get-audits-db.md @@ -0,0 +1,19 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := health.New(client) + +response, error := service.GetAuditsDB()) +``` diff --git a/examples/1.9.x/server-go/examples/health/get-cache.md b/examples/1.9.x/server-go/examples/health/get-cache.md index 59b0743d9..e89996a42 100644 --- a/examples/1.9.x/server-go/examples/health/get-cache.md +++ b/examples/1.9.x/server-go/examples/health/get-cache.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-certificate.md b/examples/1.9.x/server-go/examples/health/get-certificate.md index 18149b05a..048283179 100644 --- a/examples/1.9.x/server-go/examples/health/get-certificate.md +++ b/examples/1.9.x/server-go/examples/health/get-certificate.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-console-pausing.md b/examples/1.9.x/server-go/examples/health/get-console-pausing.md index 88d150eb2..b3da19bc6 100644 --- a/examples/1.9.x/server-go/examples/health/get-console-pausing.md +++ b/examples/1.9.x/server-go/examples/health/get-console-pausing.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-db.md b/examples/1.9.x/server-go/examples/health/get-db.md index 8e9b03cd6..b7c97721b 100644 --- a/examples/1.9.x/server-go/examples/health/get-db.md +++ b/examples/1.9.x/server-go/examples/health/get-db.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-failed-jobs.md b/examples/1.9.x/server-go/examples/health/get-failed-jobs.md index d056cb687..ef75aff74 100644 --- a/examples/1.9.x/server-go/examples/health/get-failed-jobs.md +++ b/examples/1.9.x/server-go/examples/health/get-failed-jobs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-pub-sub.md b/examples/1.9.x/server-go/examples/health/get-pub-sub.md index ac7ec3706..ce6394295 100644 --- a/examples/1.9.x/server-go/examples/health/get-pub-sub.md +++ b/examples/1.9.x/server-go/examples/health/get-pub-sub.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-audits.md b/examples/1.9.x/server-go/examples/health/get-queue-audits.md index 589464746..9e2b1a4e6 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-audits.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-audits.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-builds.md b/examples/1.9.x/server-go/examples/health/get-queue-builds.md index b35242e2c..586e06851 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-builds.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-builds.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-certificates.md b/examples/1.9.x/server-go/examples/health/get-queue-certificates.md index c001ed833..8fe12df9a 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-certificates.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-certificates.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-databases.md b/examples/1.9.x/server-go/examples/health/get-queue-databases.md index e0b7e2a8d..bd619e7e5 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-databases.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-databases.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-deletes.md b/examples/1.9.x/server-go/examples/health/get-queue-deletes.md index ca8be1f1d..7619691fc 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-deletes.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-deletes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-functions.md b/examples/1.9.x/server-go/examples/health/get-queue-functions.md index 175eaae55..67ec8ce4c 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-functions.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-functions.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-logs.md b/examples/1.9.x/server-go/examples/health/get-queue-logs.md index 71a3a52ad..4c37f64b2 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-logs.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-logs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-mails.md b/examples/1.9.x/server-go/examples/health/get-queue-mails.md index 48ceb1d92..8274f9cd7 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-mails.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-mails.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-messaging.md b/examples/1.9.x/server-go/examples/health/get-queue-messaging.md index 5e7d7a153..622707763 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-messaging.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-messaging.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-migrations.md b/examples/1.9.x/server-go/examples/health/get-queue-migrations.md index cdf7db4ad..cc1d5c983 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-migrations.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-migrations.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-stats-resources.md b/examples/1.9.x/server-go/examples/health/get-queue-stats-resources.md index bbb6f7cf1..f3f571429 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-stats-resources.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-stats-resources.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-usage.md b/examples/1.9.x/server-go/examples/health/get-queue-usage.md index 57799c5a3..b6f60bd67 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-usage.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-usage.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-queue-webhooks.md b/examples/1.9.x/server-go/examples/health/get-queue-webhooks.md index 54de652fe..8d2ea59af 100644 --- a/examples/1.9.x/server-go/examples/health/get-queue-webhooks.md +++ b/examples/1.9.x/server-go/examples/health/get-queue-webhooks.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-storage-local.md b/examples/1.9.x/server-go/examples/health/get-storage-local.md index 4e68717c4..c192696dc 100644 --- a/examples/1.9.x/server-go/examples/health/get-storage-local.md +++ b/examples/1.9.x/server-go/examples/health/get-storage-local.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-storage.md b/examples/1.9.x/server-go/examples/health/get-storage.md index ab2eda870..0c91e8974 100644 --- a/examples/1.9.x/server-go/examples/health/get-storage.md +++ b/examples/1.9.x/server-go/examples/health/get-storage.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get-time.md b/examples/1.9.x/server-go/examples/health/get-time.md index 7e8f4f77d..d72373890 100644 --- a/examples/1.9.x/server-go/examples/health/get-time.md +++ b/examples/1.9.x/server-go/examples/health/get-time.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/health/get.md b/examples/1.9.x/server-go/examples/health/get.md index cd8268fff..5b38e982c 100644 --- a/examples/1.9.x/server-go/examples/health/get.md +++ b/examples/1.9.x/server-go/examples/health/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/health" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/health" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/locale/get.md b/examples/1.9.x/server-go/examples/locale/get.md index aac76debe..dc2f394c0 100644 --- a/examples/1.9.x/server-go/examples/locale/get.md +++ b/examples/1.9.x/server-go/examples/locale/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/locale" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/locale" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/locale/list-codes.md b/examples/1.9.x/server-go/examples/locale/list-codes.md index 18307fae1..be7df35f3 100644 --- a/examples/1.9.x/server-go/examples/locale/list-codes.md +++ b/examples/1.9.x/server-go/examples/locale/list-codes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/locale" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/locale" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/locale/list-continents.md b/examples/1.9.x/server-go/examples/locale/list-continents.md index ae8e476cf..b2e41ff14 100644 --- a/examples/1.9.x/server-go/examples/locale/list-continents.md +++ b/examples/1.9.x/server-go/examples/locale/list-continents.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/locale" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/locale" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/locale/list-countries-eu.md b/examples/1.9.x/server-go/examples/locale/list-countries-eu.md index 6b379fe7c..9a675f906 100644 --- a/examples/1.9.x/server-go/examples/locale/list-countries-eu.md +++ b/examples/1.9.x/server-go/examples/locale/list-countries-eu.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/locale" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/locale" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/locale/list-countries-phones.md b/examples/1.9.x/server-go/examples/locale/list-countries-phones.md index 494f3575f..600aa5efa 100644 --- a/examples/1.9.x/server-go/examples/locale/list-countries-phones.md +++ b/examples/1.9.x/server-go/examples/locale/list-countries-phones.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/locale" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/locale" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/locale/list-countries.md b/examples/1.9.x/server-go/examples/locale/list-countries.md index 85ef09235..0e820ea8e 100644 --- a/examples/1.9.x/server-go/examples/locale/list-countries.md +++ b/examples/1.9.x/server-go/examples/locale/list-countries.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/locale" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/locale" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/locale/list-currencies.md b/examples/1.9.x/server-go/examples/locale/list-currencies.md index ed897308a..0c2422a00 100644 --- a/examples/1.9.x/server-go/examples/locale/list-currencies.md +++ b/examples/1.9.x/server-go/examples/locale/list-currencies.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/locale" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/locale" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/locale/list-languages.md b/examples/1.9.x/server-go/examples/locale/list-languages.md index dc65b8b5e..af956b551 100644 --- a/examples/1.9.x/server-go/examples/locale/list-languages.md +++ b/examples/1.9.x/server-go/examples/locale/list-languages.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/locale" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/locale" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/create-apns-provider.md b/examples/1.9.x/server-go/examples/messaging/create-apns-provider.md index dbe9195d0..0d8ea7b76 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-apns-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/create-apns-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/create-email.md b/examples/1.9.x/server-go/examples/messaging/create-email.md index 3d7193dbe..8ef213a1e 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-email.md +++ b/examples/1.9.x/server-go/examples/messaging/create-email.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -19,12 +19,12 @@ response, error := service.CreateEmail( "", "", "", - messaging.WithCreateEmailTopics([]interface{}{}), - messaging.WithCreateEmailUsers([]interface{}{}), - messaging.WithCreateEmailTargets([]interface{}{}), - messaging.WithCreateEmailCc([]interface{}{}), - messaging.WithCreateEmailBcc([]interface{}{}), - messaging.WithCreateEmailAttachments([]interface{}{}), + messaging.WithCreateEmailTopics([]string{}), + messaging.WithCreateEmailUsers([]string{}), + messaging.WithCreateEmailTargets([]string{}), + messaging.WithCreateEmailCc([]string{}), + messaging.WithCreateEmailBcc([]string{}), + messaging.WithCreateEmailAttachments([]string{}), messaging.WithCreateEmailDraft(false), messaging.WithCreateEmailHtml(false), messaging.WithCreateEmailScheduledAt("2020-10-15T06:38:00.000+00:00"), diff --git a/examples/1.9.x/server-go/examples/messaging/create-fcm-provider.md b/examples/1.9.x/server-go/examples/messaging/create-fcm-provider.md index d2a5a8bbb..e22d8e9e8 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-fcm-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/create-fcm-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/create-mailgun-provider.md b/examples/1.9.x/server-go/examples/messaging/create-mailgun-provider.md index 11692ffc6..9ccbfa948 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-mailgun-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/create-mailgun-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/create-msg-91-provider.md b/examples/1.9.x/server-go/examples/messaging/create-msg-91-provider.md index f3029ffcb..9e6c33146 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-msg-91-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/create-msg-91-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/create-push.md b/examples/1.9.x/server-go/examples/messaging/create-push.md index 5d506d8a8..7a9f95818 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-push.md +++ b/examples/1.9.x/server-go/examples/messaging/create-push.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -19,9 +19,9 @@ response, error := service.CreatePush( "", messaging.WithCreatePushTitle(""), messaging.WithCreatePushBody("<BODY>"), - messaging.WithCreatePushTopics([]interface{}{}), - messaging.WithCreatePushUsers([]interface{}{}), - messaging.WithCreatePushTargets([]interface{}{}), + messaging.WithCreatePushTopics([]string{}), + messaging.WithCreatePushUsers([]string{}), + messaging.WithCreatePushTargets([]string{}), messaging.WithCreatePushData(map[string]interface{}{}), messaging.WithCreatePushAction("<ACTION>"), messaging.WithCreatePushImage("<ID1:ID2>"), diff --git a/examples/1.9.x/server-go/examples/messaging/create-resend-provider.md b/examples/1.9.x/server-go/examples/messaging/create-resend-provider.md index 693d9e321..1c3136f2e 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-resend-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/create-resend-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/create-sendgrid-provider.md b/examples/1.9.x/server-go/examples/messaging/create-sendgrid-provider.md index 25cdaa8e6..13feb8ee6 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-sendgrid-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/create-sendgrid-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/create-ses-provider.md b/examples/1.9.x/server-go/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..e625c8e0b --- /dev/null +++ b/examples/1.9.x/server-go/examples/messaging/create-ses-provider.md @@ -0,0 +1,30 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" +) + +client := client.New( + client.WithEndpoint("https://<REGION>.cloud.appwrite.io/v1") + client.WithProject("<YOUR_PROJECT_ID>") + client.WithKey("<YOUR_API_KEY>") +) + +service := messaging.New(client) + +response, error := service.CreateSesProvider( + "<PROVIDER_ID>", + "<NAME>", + messaging.WithCreateSesProviderAccessKey("<ACCESS_KEY>"), + messaging.WithCreateSesProviderSecretKey("<SECRET_KEY>"), + messaging.WithCreateSesProviderRegion("<REGION>"), + messaging.WithCreateSesProviderFromName("<FROM_NAME>"), + messaging.WithCreateSesProviderFromEmail("email@example.com"), + messaging.WithCreateSesProviderReplyToName("<REPLY_TO_NAME>"), + messaging.WithCreateSesProviderReplyToEmail("email@example.com"), + messaging.WithCreateSesProviderEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/messaging/create-sms.md b/examples/1.9.x/server-go/examples/messaging/create-sms.md index c84695016..063ea7a59 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-sms.md +++ b/examples/1.9.x/server-go/examples/messaging/create-sms.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -18,9 +18,9 @@ service := messaging.New(client) response, error := service.CreateSMS( "<MESSAGE_ID>", "<CONTENT>", - messaging.WithCreateSMSTopics([]interface{}{}), - messaging.WithCreateSMSUsers([]interface{}{}), - messaging.WithCreateSMSTargets([]interface{}{}), + messaging.WithCreateSMSTopics([]string{}), + messaging.WithCreateSMSUsers([]string{}), + messaging.WithCreateSMSTargets([]string{}), messaging.WithCreateSMSDraft(false), messaging.WithCreateSMSScheduledAt("2020-10-15T06:38:00.000+00:00"), ) diff --git a/examples/1.9.x/server-go/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-go/examples/messaging/create-smtp-provider.md index 0bb5f204e..e8d213b1b 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/create-smtp-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -21,7 +21,7 @@ response, error := service.CreateSMTPProvider( "<HOST>", messaging.WithCreateSMTPProviderPort(1), messaging.WithCreateSMTPProviderUsername("<USERNAME>"), - messaging.WithCreateSMTPProviderPassword("<PASSWORD>"), + messaging.WithCreateSMTPProviderPassword("password"), messaging.WithCreateSMTPProviderEncryption("none"), messaging.WithCreateSMTPProviderAutoTLS(false), messaging.WithCreateSMTPProviderMailer("<MAILER>"), diff --git a/examples/1.9.x/server-go/examples/messaging/create-subscriber.md b/examples/1.9.x/server-go/examples/messaging/create-subscriber.md index 823852319..98a607245 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-subscriber.md +++ b/examples/1.9.x/server-go/examples/messaging/create-subscriber.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/create-telesign-provider.md b/examples/1.9.x/server-go/examples/messaging/create-telesign-provider.md index 0c1b141f8..e47c2c1e4 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-telesign-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/create-telesign-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/create-textmagic-provider.md b/examples/1.9.x/server-go/examples/messaging/create-textmagic-provider.md index cec576338..2f7c52c3e 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-textmagic-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/create-textmagic-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/create-topic.md b/examples/1.9.x/server-go/examples/messaging/create-topic.md index d720638ba..da81e8068 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-topic.md +++ b/examples/1.9.x/server-go/examples/messaging/create-topic.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -18,6 +18,6 @@ service := messaging.New(client) response, error := service.CreateTopic( "<TOPIC_ID>", "<NAME>", - messaging.WithCreateTopicSubscribe(interface{}{"any"}), + messaging.WithCreateTopicSubscribe([]string{"any"}), ) ``` diff --git a/examples/1.9.x/server-go/examples/messaging/create-twilio-provider.md b/examples/1.9.x/server-go/examples/messaging/create-twilio-provider.md index b92dde7f9..46708cc0e 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-twilio-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/create-twilio-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/create-vonage-provider.md b/examples/1.9.x/server-go/examples/messaging/create-vonage-provider.md index 83d2ac1a0..22c59e0d4 100644 --- a/examples/1.9.x/server-go/examples/messaging/create-vonage-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/create-vonage-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/delete-provider.md b/examples/1.9.x/server-go/examples/messaging/delete-provider.md index b860db974..4c641a854 100644 --- a/examples/1.9.x/server-go/examples/messaging/delete-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/delete-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/delete-subscriber.md b/examples/1.9.x/server-go/examples/messaging/delete-subscriber.md index 2a7c80369..1914238f2 100644 --- a/examples/1.9.x/server-go/examples/messaging/delete-subscriber.md +++ b/examples/1.9.x/server-go/examples/messaging/delete-subscriber.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/delete-topic.md b/examples/1.9.x/server-go/examples/messaging/delete-topic.md index daf1d7649..a3b127ed2 100644 --- a/examples/1.9.x/server-go/examples/messaging/delete-topic.md +++ b/examples/1.9.x/server-go/examples/messaging/delete-topic.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/delete.md b/examples/1.9.x/server-go/examples/messaging/delete.md index 5f5f420ba..1cfe92516 100644 --- a/examples/1.9.x/server-go/examples/messaging/delete.md +++ b/examples/1.9.x/server-go/examples/messaging/delete.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/get-message.md b/examples/1.9.x/server-go/examples/messaging/get-message.md index 492368c88..c0153ed80 100644 --- a/examples/1.9.x/server-go/examples/messaging/get-message.md +++ b/examples/1.9.x/server-go/examples/messaging/get-message.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/get-provider.md b/examples/1.9.x/server-go/examples/messaging/get-provider.md index 7c1133725..ee59fb5ea 100644 --- a/examples/1.9.x/server-go/examples/messaging/get-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/get-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/get-subscriber.md b/examples/1.9.x/server-go/examples/messaging/get-subscriber.md index 7004b17c7..f00ea9e16 100644 --- a/examples/1.9.x/server-go/examples/messaging/get-subscriber.md +++ b/examples/1.9.x/server-go/examples/messaging/get-subscriber.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/get-topic.md b/examples/1.9.x/server-go/examples/messaging/get-topic.md index 3740b329d..83176c20e 100644 --- a/examples/1.9.x/server-go/examples/messaging/get-topic.md +++ b/examples/1.9.x/server-go/examples/messaging/get-topic.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/list-message-logs.md b/examples/1.9.x/server-go/examples/messaging/list-message-logs.md index 81a07d885..0f3d39558 100644 --- a/examples/1.9.x/server-go/examples/messaging/list-message-logs.md +++ b/examples/1.9.x/server-go/examples/messaging/list-message-logs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -17,7 +17,7 @@ service := messaging.New(client) response, error := service.ListMessageLogs( "<MESSAGE_ID>", - messaging.WithListMessageLogsQueries([]interface{}{}), + messaging.WithListMessageLogsQueries([]string{}), messaging.WithListMessageLogsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/messaging/list-messages.md b/examples/1.9.x/server-go/examples/messaging/list-messages.md index c3fddaf20..6648d751a 100644 --- a/examples/1.9.x/server-go/examples/messaging/list-messages.md +++ b/examples/1.9.x/server-go/examples/messaging/list-messages.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := messaging.New(client) response, error := service.ListMessages( - messaging.WithListMessagesQueries([]interface{}{}), + messaging.WithListMessagesQueries([]string{}), messaging.WithListMessagesSearch("<SEARCH>"), messaging.WithListMessagesTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/messaging/list-provider-logs.md b/examples/1.9.x/server-go/examples/messaging/list-provider-logs.md index 75b22f11a..72fd8f2d7 100644 --- a/examples/1.9.x/server-go/examples/messaging/list-provider-logs.md +++ b/examples/1.9.x/server-go/examples/messaging/list-provider-logs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -17,7 +17,7 @@ service := messaging.New(client) response, error := service.ListProviderLogs( "<PROVIDER_ID>", - messaging.WithListProviderLogsQueries([]interface{}{}), + messaging.WithListProviderLogsQueries([]string{}), messaging.WithListProviderLogsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/messaging/list-providers.md b/examples/1.9.x/server-go/examples/messaging/list-providers.md index 6c754591f..155c4a389 100644 --- a/examples/1.9.x/server-go/examples/messaging/list-providers.md +++ b/examples/1.9.x/server-go/examples/messaging/list-providers.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := messaging.New(client) response, error := service.ListProviders( - messaging.WithListProvidersQueries([]interface{}{}), + messaging.WithListProvidersQueries([]string{}), messaging.WithListProvidersSearch("<SEARCH>"), messaging.WithListProvidersTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/messaging/list-subscriber-logs.md b/examples/1.9.x/server-go/examples/messaging/list-subscriber-logs.md index 050a7a2d5..11d60a9e3 100644 --- a/examples/1.9.x/server-go/examples/messaging/list-subscriber-logs.md +++ b/examples/1.9.x/server-go/examples/messaging/list-subscriber-logs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -17,7 +17,7 @@ service := messaging.New(client) response, error := service.ListSubscriberLogs( "<SUBSCRIBER_ID>", - messaging.WithListSubscriberLogsQueries([]interface{}{}), + messaging.WithListSubscriberLogsQueries([]string{}), messaging.WithListSubscriberLogsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/messaging/list-subscribers.md b/examples/1.9.x/server-go/examples/messaging/list-subscribers.md index 0dc215880..bba7f4fad 100644 --- a/examples/1.9.x/server-go/examples/messaging/list-subscribers.md +++ b/examples/1.9.x/server-go/examples/messaging/list-subscribers.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -17,7 +17,7 @@ service := messaging.New(client) response, error := service.ListSubscribers( "<TOPIC_ID>", - messaging.WithListSubscribersQueries([]interface{}{}), + messaging.WithListSubscribersQueries([]string{}), messaging.WithListSubscribersSearch("<SEARCH>"), messaging.WithListSubscribersTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/messaging/list-targets.md b/examples/1.9.x/server-go/examples/messaging/list-targets.md index 38a9a1b7f..e59036ee3 100644 --- a/examples/1.9.x/server-go/examples/messaging/list-targets.md +++ b/examples/1.9.x/server-go/examples/messaging/list-targets.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -17,7 +17,7 @@ service := messaging.New(client) response, error := service.ListTargets( "<MESSAGE_ID>", - messaging.WithListTargetsQueries([]interface{}{}), + messaging.WithListTargetsQueries([]string{}), messaging.WithListTargetsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/messaging/list-topic-logs.md b/examples/1.9.x/server-go/examples/messaging/list-topic-logs.md index 6785f62fe..1978c3d8a 100644 --- a/examples/1.9.x/server-go/examples/messaging/list-topic-logs.md +++ b/examples/1.9.x/server-go/examples/messaging/list-topic-logs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -17,7 +17,7 @@ service := messaging.New(client) response, error := service.ListTopicLogs( "<TOPIC_ID>", - messaging.WithListTopicLogsQueries([]interface{}{}), + messaging.WithListTopicLogsQueries([]string{}), messaging.WithListTopicLogsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/messaging/list-topics.md b/examples/1.9.x/server-go/examples/messaging/list-topics.md index 7c5e22384..9d3ec3cf1 100644 --- a/examples/1.9.x/server-go/examples/messaging/list-topics.md +++ b/examples/1.9.x/server-go/examples/messaging/list-topics.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := messaging.New(client) response, error := service.ListTopics( - messaging.WithListTopicsQueries([]interface{}{}), + messaging.WithListTopicsQueries([]string{}), messaging.WithListTopicsSearch("<SEARCH>"), messaging.WithListTopicsTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/messaging/update-apns-provider.md b/examples/1.9.x/server-go/examples/messaging/update-apns-provider.md index ce95fdd84..06f2e56db 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-apns-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/update-apns-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/update-email.md b/examples/1.9.x/server-go/examples/messaging/update-email.md index 3d9a7b8b2..44557b17e 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-email.md +++ b/examples/1.9.x/server-go/examples/messaging/update-email.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -17,16 +17,16 @@ service := messaging.New(client) response, error := service.UpdateEmail( "<MESSAGE_ID>", - messaging.WithUpdateEmailTopics([]interface{}{}), - messaging.WithUpdateEmailUsers([]interface{}{}), - messaging.WithUpdateEmailTargets([]interface{}{}), + messaging.WithUpdateEmailTopics([]string{}), + messaging.WithUpdateEmailUsers([]string{}), + messaging.WithUpdateEmailTargets([]string{}), messaging.WithUpdateEmailSubject("<SUBJECT>"), messaging.WithUpdateEmailContent("<CONTENT>"), messaging.WithUpdateEmailDraft(false), messaging.WithUpdateEmailHtml(false), - messaging.WithUpdateEmailCc([]interface{}{}), - messaging.WithUpdateEmailBcc([]interface{}{}), + messaging.WithUpdateEmailCc([]string{}), + messaging.WithUpdateEmailBcc([]string{}), messaging.WithUpdateEmailScheduledAt("2020-10-15T06:38:00.000+00:00"), - messaging.WithUpdateEmailAttachments([]interface{}{}), + messaging.WithUpdateEmailAttachments([]string{}), ) ``` diff --git a/examples/1.9.x/server-go/examples/messaging/update-fcm-provider.md b/examples/1.9.x/server-go/examples/messaging/update-fcm-provider.md index c24cc651e..ec6d62b91 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-fcm-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/update-fcm-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/update-mailgun-provider.md b/examples/1.9.x/server-go/examples/messaging/update-mailgun-provider.md index 3f0f76806..7a4e3854c 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-mailgun-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/update-mailgun-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/update-msg-91-provider.md b/examples/1.9.x/server-go/examples/messaging/update-msg-91-provider.md index ea38ebce8..055153817 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-msg-91-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/update-msg-91-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/update-push.md b/examples/1.9.x/server-go/examples/messaging/update-push.md index 2bb138153..522766329 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-push.md +++ b/examples/1.9.x/server-go/examples/messaging/update-push.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -17,9 +17,9 @@ service := messaging.New(client) response, error := service.UpdatePush( "<MESSAGE_ID>", - messaging.WithUpdatePushTopics([]interface{}{}), - messaging.WithUpdatePushUsers([]interface{}{}), - messaging.WithUpdatePushTargets([]interface{}{}), + messaging.WithUpdatePushTopics([]string{}), + messaging.WithUpdatePushUsers([]string{}), + messaging.WithUpdatePushTargets([]string{}), messaging.WithUpdatePushTitle("<TITLE>"), messaging.WithUpdatePushBody("<BODY>"), messaging.WithUpdatePushData(map[string]interface{}{}), diff --git a/examples/1.9.x/server-go/examples/messaging/update-resend-provider.md b/examples/1.9.x/server-go/examples/messaging/update-resend-provider.md index 02de53dad..9e4fb6976 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-resend-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/update-resend-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/update-sendgrid-provider.md b/examples/1.9.x/server-go/examples/messaging/update-sendgrid-provider.md index d8b3e22c4..d8f1bf327 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-sendgrid-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/update-sendgrid-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/update-ses-provider.md b/examples/1.9.x/server-go/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..49847ca7f --- /dev/null +++ b/examples/1.9.x/server-go/examples/messaging/update-ses-provider.md @@ -0,0 +1,30 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" +) + +client := client.New( + client.WithEndpoint("https://<REGION>.cloud.appwrite.io/v1") + client.WithProject("<YOUR_PROJECT_ID>") + client.WithKey("<YOUR_API_KEY>") +) + +service := messaging.New(client) + +response, error := service.UpdateSesProvider( + "<PROVIDER_ID>", + messaging.WithUpdateSesProviderName("<NAME>"), + messaging.WithUpdateSesProviderEnabled(false), + messaging.WithUpdateSesProviderAccessKey("<ACCESS_KEY>"), + messaging.WithUpdateSesProviderSecretKey("<SECRET_KEY>"), + messaging.WithUpdateSesProviderRegion("<REGION>"), + messaging.WithUpdateSesProviderFromName("<FROM_NAME>"), + messaging.WithUpdateSesProviderFromEmail("email@example.com"), + messaging.WithUpdateSesProviderReplyToName("<REPLY_TO_NAME>"), + messaging.WithUpdateSesProviderReplyToEmail("<REPLY_TO_EMAIL>"), +) +``` diff --git a/examples/1.9.x/server-go/examples/messaging/update-sms.md b/examples/1.9.x/server-go/examples/messaging/update-sms.md index baa181af0..066d9ae09 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-sms.md +++ b/examples/1.9.x/server-go/examples/messaging/update-sms.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -17,9 +17,9 @@ service := messaging.New(client) response, error := service.UpdateSMS( "<MESSAGE_ID>", - messaging.WithUpdateSMSTopics([]interface{}{}), - messaging.WithUpdateSMSUsers([]interface{}{}), - messaging.WithUpdateSMSTargets([]interface{}{}), + messaging.WithUpdateSMSTopics([]string{}), + messaging.WithUpdateSMSUsers([]string{}), + messaging.WithUpdateSMSTargets([]string{}), messaging.WithUpdateSMSContent("<CONTENT>"), messaging.WithUpdateSMSDraft(false), messaging.WithUpdateSMSScheduledAt("2020-10-15T06:38:00.000+00:00"), diff --git a/examples/1.9.x/server-go/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-go/examples/messaging/update-smtp-provider.md index a08b688f4..477e558e0 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/update-smtp-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -21,7 +21,7 @@ response, error := service.UpdateSMTPProvider( messaging.WithUpdateSMTPProviderHost("<HOST>"), messaging.WithUpdateSMTPProviderPort(1), messaging.WithUpdateSMTPProviderUsername("<USERNAME>"), - messaging.WithUpdateSMTPProviderPassword("<PASSWORD>"), + messaging.WithUpdateSMTPProviderPassword("password"), messaging.WithUpdateSMTPProviderEncryption("none"), messaging.WithUpdateSMTPProviderAutoTLS(false), messaging.WithUpdateSMTPProviderMailer("<MAILER>"), diff --git a/examples/1.9.x/server-go/examples/messaging/update-telesign-provider.md b/examples/1.9.x/server-go/examples/messaging/update-telesign-provider.md index 31373616d..2c4089c9b 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-telesign-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/update-telesign-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/update-textmagic-provider.md b/examples/1.9.x/server-go/examples/messaging/update-textmagic-provider.md index c500201d7..d631180e8 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-textmagic-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/update-textmagic-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/update-topic.md b/examples/1.9.x/server-go/examples/messaging/update-topic.md index 9c5c572f7..109e26584 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-topic.md +++ b/examples/1.9.x/server-go/examples/messaging/update-topic.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( @@ -18,6 +18,6 @@ service := messaging.New(client) response, error := service.UpdateTopic( "<TOPIC_ID>", messaging.WithUpdateTopicName("<NAME>"), - messaging.WithUpdateTopicSubscribe(interface{}{"any"}), + messaging.WithUpdateTopicSubscribe([]string{"any"}), ) ``` diff --git a/examples/1.9.x/server-go/examples/messaging/update-twilio-provider.md b/examples/1.9.x/server-go/examples/messaging/update-twilio-provider.md index 050c067f0..7c079f44f 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-twilio-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/update-twilio-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/messaging/update-vonage-provider.md b/examples/1.9.x/server-go/examples/messaging/update-vonage-provider.md index 1fa2e8c59..32edfacda 100644 --- a/examples/1.9.x/server-go/examples/messaging/update-vonage-provider.md +++ b/examples/1.9.x/server-go/examples/messaging/update-vonage-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/messaging" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/messaging" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/organization/create-key.md b/examples/1.9.x/server-go/examples/organization/create-key.md index 0cbe50668..667627b66 100644 --- a/examples/1.9.x/server-go/examples/organization/create-key.md +++ b/examples/1.9.x/server-go/examples/organization/create-key.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/organization" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/organization" ) client := client.New( @@ -18,7 +18,7 @@ service := organization.New(client) response, error := service.CreateKey( "<KEY_ID>", "<NAME>", - []interface{}{}, + []string{}, organization.WithCreateKeyExpire("2020-10-15T06:38:00.000+00:00"), ) ``` diff --git a/examples/1.9.x/server-go/examples/organization/create-project.md b/examples/1.9.x/server-go/examples/organization/create-project.md index 6b9dcf971..fc59725b6 100644 --- a/examples/1.9.x/server-go/examples/organization/create-project.md +++ b/examples/1.9.x/server-go/examples/organization/create-project.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/organization" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/organization" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/organization/delete-key.md b/examples/1.9.x/server-go/examples/organization/delete-key.md index 8bd60278c..7d81d6e93 100644 --- a/examples/1.9.x/server-go/examples/organization/delete-key.md +++ b/examples/1.9.x/server-go/examples/organization/delete-key.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/organization" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/organization" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/organization/delete-project.md b/examples/1.9.x/server-go/examples/organization/delete-project.md index 5ba15b879..3a8c9341c 100644 --- a/examples/1.9.x/server-go/examples/organization/delete-project.md +++ b/examples/1.9.x/server-go/examples/organization/delete-project.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/organization" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/organization" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/organization/get-key.md b/examples/1.9.x/server-go/examples/organization/get-key.md index 603b622aa..903ab3612 100644 --- a/examples/1.9.x/server-go/examples/organization/get-key.md +++ b/examples/1.9.x/server-go/examples/organization/get-key.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/organization" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/organization" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/organization/get-project.md b/examples/1.9.x/server-go/examples/organization/get-project.md index 6a8760151..65165500f 100644 --- a/examples/1.9.x/server-go/examples/organization/get-project.md +++ b/examples/1.9.x/server-go/examples/organization/get-project.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/organization" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/organization" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/organization/list-keys.md b/examples/1.9.x/server-go/examples/organization/list-keys.md index 3fb5b98d0..50aa6adc6 100644 --- a/examples/1.9.x/server-go/examples/organization/list-keys.md +++ b/examples/1.9.x/server-go/examples/organization/list-keys.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/organization" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/organization" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := organization.New(client) response, error := service.ListKeys( - organization.WithListKeysQueries([]interface{}{}), + organization.WithListKeysQueries([]string{}), organization.WithListKeysTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/organization/list-projects.md b/examples/1.9.x/server-go/examples/organization/list-projects.md index 8296d96c1..d22173aab 100644 --- a/examples/1.9.x/server-go/examples/organization/list-projects.md +++ b/examples/1.9.x/server-go/examples/organization/list-projects.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/organization" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/organization" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := organization.New(client) response, error := service.ListProjects( - organization.WithListProjectsQueries([]interface{}{}), + organization.WithListProjectsQueries([]string{}), organization.WithListProjectsSearch("<SEARCH>"), organization.WithListProjectsTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/organization/update-key.md b/examples/1.9.x/server-go/examples/organization/update-key.md index 791a554ad..52794c5ed 100644 --- a/examples/1.9.x/server-go/examples/organization/update-key.md +++ b/examples/1.9.x/server-go/examples/organization/update-key.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/organization" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/organization" ) client := client.New( @@ -18,7 +18,7 @@ service := organization.New(client) response, error := service.UpdateKey( "<KEY_ID>", "<NAME>", - []interface{}{}, + []string{}, organization.WithUpdateKeyExpire("2020-10-15T06:38:00.000+00:00"), ) ``` diff --git a/examples/1.9.x/server-go/examples/organization/update-project.md b/examples/1.9.x/server-go/examples/organization/update-project.md index a945dc4ed..7c9d0567f 100644 --- a/examples/1.9.x/server-go/examples/organization/update-project.md +++ b/examples/1.9.x/server-go/examples/organization/update-project.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/organization" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/organization" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/presences/delete.md b/examples/1.9.x/server-go/examples/presences/delete.md index 8a2818a2b..1b32e0fb2 100644 --- a/examples/1.9.x/server-go/examples/presences/delete.md +++ b/examples/1.9.x/server-go/examples/presences/delete.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/presences" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/presences" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/presences/get.md b/examples/1.9.x/server-go/examples/presences/get.md index 04f95ab6e..e21b74f2e 100644 --- a/examples/1.9.x/server-go/examples/presences/get.md +++ b/examples/1.9.x/server-go/examples/presences/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/presences" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/presences" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/presences/list.md b/examples/1.9.x/server-go/examples/presences/list.md index 71a52ec4a..49bde40f0 100644 --- a/examples/1.9.x/server-go/examples/presences/list.md +++ b/examples/1.9.x/server-go/examples/presences/list.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/presences" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/presences" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := presences.New(client) response, error := service.List( - presences.WithListQueries([]interface{}{}), + presences.WithListQueries([]string{}), presences.WithListTotal(false), presences.WithListTtl(0), ) diff --git a/examples/1.9.x/server-go/examples/presences/update.md b/examples/1.9.x/server-go/examples/presences/update.md index 6ae7455d6..870651882 100644 --- a/examples/1.9.x/server-go/examples/presences/update.md +++ b/examples/1.9.x/server-go/examples/presences/update.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/presences" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/presences" ) client := client.New( @@ -21,7 +21,7 @@ response, error := service.Update( presences.WithUpdateStatus("<STATUS>"), presences.WithUpdateExpiresAt("2020-10-15T06:38:00.000+00:00"), presences.WithUpdateMetadata(map[string]interface{}{}), - presences.WithUpdatePermissions(interface{}{"read("any")"}), + presences.WithUpdatePermissions([]string{"read("any")"}), presences.WithUpdatePurge(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/presences/upsert.md b/examples/1.9.x/server-go/examples/presences/upsert.md index d2bd78371..7da7a9a72 100644 --- a/examples/1.9.x/server-go/examples/presences/upsert.md +++ b/examples/1.9.x/server-go/examples/presences/upsert.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/presences" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/presences" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.Upsert( "<PRESENCE_ID>", "<USER_ID>", "<STATUS>", - presences.WithUpsertPermissions(interface{}{"read("any")"}), + presences.WithUpsertPermissions([]string{"read("any")"}), presences.WithUpsertExpiresAt("2020-10-15T06:38:00.000+00:00"), presences.WithUpsertMetadata(map[string]interface{}{}), ) diff --git a/examples/1.9.x/server-go/examples/project/create-android-platform.md b/examples/1.9.x/server-go/examples/project/create-android-platform.md index 3c4c310f2..746371025 100644 --- a/examples/1.9.x/server-go/examples/project/create-android-platform.md +++ b/examples/1.9.x/server-go/examples/project/create-android-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/create-apple-platform.md b/examples/1.9.x/server-go/examples/project/create-apple-platform.md index ef6df3927..4ad2d2ec6 100644 --- a/examples/1.9.x/server-go/examples/project/create-apple-platform.md +++ b/examples/1.9.x/server-go/examples/project/create-apple-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-go/examples/project/create-ephemeral-key.md index 036f67720..55d192181 100644 --- a/examples/1.9.x/server-go/examples/project/create-ephemeral-key.md +++ b/examples/1.9.x/server-go/examples/project/create-ephemeral-key.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := project.New(client) response, error := service.CreateEphemeralKey( - []interface{}{}, + []string{}, 600, ) ``` diff --git a/examples/1.9.x/server-go/examples/project/create-key.md b/examples/1.9.x/server-go/examples/project/create-key.md index 47fc9f83c..595bd1dba 100644 --- a/examples/1.9.x/server-go/examples/project/create-key.md +++ b/examples/1.9.x/server-go/examples/project/create-key.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -18,7 +18,7 @@ service := project.New(client) response, error := service.CreateKey( "<KEY_ID>", "<NAME>", - []interface{}{}, + []string{}, project.WithCreateKeyExpire("2020-10-15T06:38:00.000+00:00"), ) ``` diff --git a/examples/1.9.x/server-go/examples/project/create-linux-platform.md b/examples/1.9.x/server-go/examples/project/create-linux-platform.md index 4673feef7..167711594 100644 --- a/examples/1.9.x/server-go/examples/project/create-linux-platform.md +++ b/examples/1.9.x/server-go/examples/project/create-linux-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/create-mock-phone.md b/examples/1.9.x/server-go/examples/project/create-mock-phone.md index c1e956698..5d7b81b9e 100644 --- a/examples/1.9.x/server-go/examples/project/create-mock-phone.md +++ b/examples/1.9.x/server-go/examples/project/create-mock-phone.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/create-smtp-test.md b/examples/1.9.x/server-go/examples/project/create-smtp-test.md index 9f074ddab..d0a684207 100644 --- a/examples/1.9.x/server-go/examples/project/create-smtp-test.md +++ b/examples/1.9.x/server-go/examples/project/create-smtp-test.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -16,6 +16,6 @@ client := client.New( service := project.New(client) response, error := service.CreateSMTPTest( - []interface{}{}, + []string{}, ) ``` diff --git a/examples/1.9.x/server-go/examples/project/create-variable.md b/examples/1.9.x/server-go/examples/project/create-variable.md index 1bfe49f8c..5e895efc0 100644 --- a/examples/1.9.x/server-go/examples/project/create-variable.md +++ b/examples/1.9.x/server-go/examples/project/create-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/create-web-platform.md b/examples/1.9.x/server-go/examples/project/create-web-platform.md index 8b829c078..84386bc4a 100644 --- a/examples/1.9.x/server-go/examples/project/create-web-platform.md +++ b/examples/1.9.x/server-go/examples/project/create-web-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/create-windows-platform.md b/examples/1.9.x/server-go/examples/project/create-windows-platform.md index b4516cab6..84aae5132 100644 --- a/examples/1.9.x/server-go/examples/project/create-windows-platform.md +++ b/examples/1.9.x/server-go/examples/project/create-windows-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/delete-key.md b/examples/1.9.x/server-go/examples/project/delete-key.md index 29f20650c..b36afc43d 100644 --- a/examples/1.9.x/server-go/examples/project/delete-key.md +++ b/examples/1.9.x/server-go/examples/project/delete-key.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/delete-mock-phone.md b/examples/1.9.x/server-go/examples/project/delete-mock-phone.md index 099d85e0c..8ba1c0a7e 100644 --- a/examples/1.9.x/server-go/examples/project/delete-mock-phone.md +++ b/examples/1.9.x/server-go/examples/project/delete-mock-phone.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/delete-platform.md b/examples/1.9.x/server-go/examples/project/delete-platform.md index cd0b71814..c7a645134 100644 --- a/examples/1.9.x/server-go/examples/project/delete-platform.md +++ b/examples/1.9.x/server-go/examples/project/delete-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/delete-variable.md b/examples/1.9.x/server-go/examples/project/delete-variable.md index ef7a44f26..f8f12c28a 100644 --- a/examples/1.9.x/server-go/examples/project/delete-variable.md +++ b/examples/1.9.x/server-go/examples/project/delete-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/delete.md b/examples/1.9.x/server-go/examples/project/delete.md index 6f48c4f7d..c415f96b4 100644 --- a/examples/1.9.x/server-go/examples/project/delete.md +++ b/examples/1.9.x/server-go/examples/project/delete.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/get-email-template.md b/examples/1.9.x/server-go/examples/project/get-email-template.md index bb8dd3de4..6abf87f38 100644 --- a/examples/1.9.x/server-go/examples/project/get-email-template.md +++ b/examples/1.9.x/server-go/examples/project/get-email-template.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/get-key.md b/examples/1.9.x/server-go/examples/project/get-key.md index 84ad54ec6..65b525482 100644 --- a/examples/1.9.x/server-go/examples/project/get-key.md +++ b/examples/1.9.x/server-go/examples/project/get-key.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/get-mock-phone.md b/examples/1.9.x/server-go/examples/project/get-mock-phone.md index 3115e4f89..56a41c0ac 100644 --- a/examples/1.9.x/server-go/examples/project/get-mock-phone.md +++ b/examples/1.9.x/server-go/examples/project/get-mock-phone.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-go/examples/project/get-o-auth-2-provider.md index ad07a73c8..cc0f0b25c 100644 --- a/examples/1.9.x/server-go/examples/project/get-o-auth-2-provider.md +++ b/examples/1.9.x/server-go/examples/project/get-o-auth-2-provider.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/get-platform.md b/examples/1.9.x/server-go/examples/project/get-platform.md index cdd6cc03d..72dc615b2 100644 --- a/examples/1.9.x/server-go/examples/project/get-platform.md +++ b/examples/1.9.x/server-go/examples/project/get-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/get-policy.md b/examples/1.9.x/server-go/examples/project/get-policy.md index 15f1fee4a..79bb30e10 100644 --- a/examples/1.9.x/server-go/examples/project/get-policy.md +++ b/examples/1.9.x/server-go/examples/project/get-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/get-variable.md b/examples/1.9.x/server-go/examples/project/get-variable.md index ba9f0c0cc..e5c9ebecd 100644 --- a/examples/1.9.x/server-go/examples/project/get-variable.md +++ b/examples/1.9.x/server-go/examples/project/get-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/get.md b/examples/1.9.x/server-go/examples/project/get.md index cc21ee853..a7e79b2e1 100644 --- a/examples/1.9.x/server-go/examples/project/get.md +++ b/examples/1.9.x/server-go/examples/project/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/list-email-templates.md b/examples/1.9.x/server-go/examples/project/list-email-templates.md index 10979860e..2cdce7440 100644 --- a/examples/1.9.x/server-go/examples/project/list-email-templates.md +++ b/examples/1.9.x/server-go/examples/project/list-email-templates.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := project.New(client) response, error := service.ListEmailTemplates( - project.WithListEmailTemplatesQueries([]interface{}{}), + project.WithListEmailTemplatesQueries([]string{}), project.WithListEmailTemplatesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/project/list-keys.md b/examples/1.9.x/server-go/examples/project/list-keys.md index c3dd64db8..19072e66b 100644 --- a/examples/1.9.x/server-go/examples/project/list-keys.md +++ b/examples/1.9.x/server-go/examples/project/list-keys.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := project.New(client) response, error := service.ListKeys( - project.WithListKeysQueries([]interface{}{}), + project.WithListKeysQueries([]string{}), project.WithListKeysTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/project/list-mock-phones.md b/examples/1.9.x/server-go/examples/project/list-mock-phones.md index a105a5b3b..80bbc669f 100644 --- a/examples/1.9.x/server-go/examples/project/list-mock-phones.md +++ b/examples/1.9.x/server-go/examples/project/list-mock-phones.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := project.New(client) response, error := service.ListMockPhones( - project.WithListMockPhonesQueries([]interface{}{}), + project.WithListMockPhonesQueries([]string{}), project.WithListMockPhonesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-go/examples/project/list-o-auth-2-providers.md index 4cc50d25a..7c4f287fe 100644 --- a/examples/1.9.x/server-go/examples/project/list-o-auth-2-providers.md +++ b/examples/1.9.x/server-go/examples/project/list-o-auth-2-providers.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := project.New(client) response, error := service.ListOAuth2Providers( - project.WithListOAuth2ProvidersQueries([]interface{}{}), + project.WithListOAuth2ProvidersQueries([]string{}), project.WithListOAuth2ProvidersTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/project/list-platforms.md b/examples/1.9.x/server-go/examples/project/list-platforms.md index c9e3eb1fb..fd2295e01 100644 --- a/examples/1.9.x/server-go/examples/project/list-platforms.md +++ b/examples/1.9.x/server-go/examples/project/list-platforms.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := project.New(client) response, error := service.ListPlatforms( - project.WithListPlatformsQueries([]interface{}{}), + project.WithListPlatformsQueries([]string{}), project.WithListPlatformsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/project/list-policies.md b/examples/1.9.x/server-go/examples/project/list-policies.md index 0cc4f0804..eb96e2178 100644 --- a/examples/1.9.x/server-go/examples/project/list-policies.md +++ b/examples/1.9.x/server-go/examples/project/list-policies.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := project.New(client) response, error := service.ListPolicies( - project.WithListPoliciesQueries([]interface{}{}), + project.WithListPoliciesQueries([]string{}), project.WithListPoliciesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/project/list-variables.md b/examples/1.9.x/server-go/examples/project/list-variables.md index 406023492..2cd1929dd 100644 --- a/examples/1.9.x/server-go/examples/project/list-variables.md +++ b/examples/1.9.x/server-go/examples/project/list-variables.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := project.New(client) response, error := service.ListVariables( - project.WithListVariablesQueries([]interface{}{}), + project.WithListVariablesQueries([]string{}), project.WithListVariablesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/project/update-android-platform.md b/examples/1.9.x/server-go/examples/project/update-android-platform.md index 5d4b523a6..cda7e27a5 100644 --- a/examples/1.9.x/server-go/examples/project/update-android-platform.md +++ b/examples/1.9.x/server-go/examples/project/update-android-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-apple-platform.md b/examples/1.9.x/server-go/examples/project/update-apple-platform.md index 9758be972..02e26b3ef 100644 --- a/examples/1.9.x/server-go/examples/project/update-apple-platform.md +++ b/examples/1.9.x/server-go/examples/project/update-apple-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-auth-method.md b/examples/1.9.x/server-go/examples/project/update-auth-method.md index 2f37d3afd..d9e456dd8 100644 --- a/examples/1.9.x/server-go/examples/project/update-auth-method.md +++ b/examples/1.9.x/server-go/examples/project/update-auth-method.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-deny-aliased-email-policy.md b/examples/1.9.x/server-go/examples/project/update-deny-aliased-email-policy.md index 52e26c8ad..029f61d84 100644 --- a/examples/1.9.x/server-go/examples/project/update-deny-aliased-email-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-deny-aliased-email-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-deny-disposable-email-policy.md b/examples/1.9.x/server-go/examples/project/update-deny-disposable-email-policy.md index 64ca2e518..283459c1f 100644 --- a/examples/1.9.x/server-go/examples/project/update-deny-disposable-email-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-deny-disposable-email-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-deny-free-email-policy.md b/examples/1.9.x/server-go/examples/project/update-deny-free-email-policy.md index 7598819bd..3ccb8f9ef 100644 --- a/examples/1.9.x/server-go/examples/project/update-deny-free-email-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-deny-free-email-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-email-template.md b/examples/1.9.x/server-go/examples/project/update-email-template.md index ad2e3a425..7f4830230 100644 --- a/examples/1.9.x/server-go/examples/project/update-email-template.md +++ b/examples/1.9.x/server-go/examples/project/update-email-template.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-key.md b/examples/1.9.x/server-go/examples/project/update-key.md index 047055ffc..d476714dd 100644 --- a/examples/1.9.x/server-go/examples/project/update-key.md +++ b/examples/1.9.x/server-go/examples/project/update-key.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -18,7 +18,7 @@ service := project.New(client) response, error := service.UpdateKey( "<KEY_ID>", "<NAME>", - []interface{}{}, + []string{}, project.WithUpdateKeyExpire("2020-10-15T06:38:00.000+00:00"), ) ``` diff --git a/examples/1.9.x/server-go/examples/project/update-labels.md b/examples/1.9.x/server-go/examples/project/update-labels.md index 48e441d1b..4275c4778 100644 --- a/examples/1.9.x/server-go/examples/project/update-labels.md +++ b/examples/1.9.x/server-go/examples/project/update-labels.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -16,6 +16,6 @@ client := client.New( service := project.New(client) response, error := service.UpdateLabels( - []interface{}{}, + []string{}, ) ``` diff --git a/examples/1.9.x/server-go/examples/project/update-linux-platform.md b/examples/1.9.x/server-go/examples/project/update-linux-platform.md index 9ecd4188d..e11b27606 100644 --- a/examples/1.9.x/server-go/examples/project/update-linux-platform.md +++ b/examples/1.9.x/server-go/examples/project/update-linux-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-go/examples/project/update-membership-privacy-policy.md index 34c215528..17ee8c5da 100644 --- a/examples/1.9.x/server-go/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-membership-privacy-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -21,5 +21,6 @@ response, error := service.UpdateMembershipPrivacyPolicy( project.WithUpdateMembershipPrivacyPolicyUserPhone(false), project.WithUpdateMembershipPrivacyPolicyUserName(false), project.WithUpdateMembershipPrivacyPolicyUserMFA(false), + project.WithUpdateMembershipPrivacyPolicyUserAccessedAt(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/project/update-mock-phone.md b/examples/1.9.x/server-go/examples/project/update-mock-phone.md index d18c54fb7..9cc678bd6 100644 --- a/examples/1.9.x/server-go/examples/project/update-mock-phone.md +++ b/examples/1.9.x/server-go/examples/project/update-mock-phone.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-amazon.md index 1addc081a..70adefb31 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-amazon.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-amazon.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-apple.md index de68fbcff..0bc54a810 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-apple.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-apple.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-auth-0.md index eb60aa004..031d3d538 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-auth-0.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-auth-0.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-authentik.md index 1003fc100..ad97d4987 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-authentik.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-authentik.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-autodesk.md index ed0604a26..c4d8ece14 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-autodesk.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-autodesk.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitbucket.md index 689e6f31d..466142538 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitbucket.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitbucket.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitly.md index 6d89fc350..cdf76e504 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitly.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitly.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-box.md index d4f9445a9..f9708e728 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-box.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-box.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-dailymotion.md index f5576bbeb..33ff0f996 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-dailymotion.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-dailymotion.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-discord.md index 3e63e7961..09f5e13fe 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-discord.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-discord.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-disqus.md index 1f600f70d..99c6989a6 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-disqus.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-disqus.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-dropbox.md index 9409e8c81..5e8d3e3d6 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-dropbox.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-dropbox.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-etsy.md index 1ab7e1be2..fe909ef58 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-etsy.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-etsy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-facebook.md index 9a48bf5df..bb61b0f33 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-facebook.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-facebook.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-figma.md index 03e35052d..b99b5fda8 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-figma.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-figma.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-fusion-auth.md index 028a84941..83f3a8752 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-fusion-auth.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-fusion-auth.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-git-hub.md index b2b788b89..0134dda80 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-git-hub.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-git-hub.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-gitlab.md index a3650809a..83673d6f3 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-gitlab.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-gitlab.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-google.md index 77e32a7ff..f56254c8a 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-google.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-google.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -18,7 +18,7 @@ service := project.New(client) response, error := service.UpdateOAuth2Google( project.WithUpdateOAuth2GoogleClientId("<CLIENT_ID>"), project.WithUpdateOAuth2GoogleClientSecret("<CLIENT_SECRET>"), - project.WithUpdateOAuth2GooglePrompt([]interface{}{}), + project.WithUpdateOAuth2GooglePrompt([]string{}), project.WithUpdateOAuth2GoogleEnabled(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-keycloak.md index 426fbc95c..504e0cc77 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-keycloak.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-keycloak.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-kick.md index 8af994434..4c5337559 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-kick.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-kick.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-linkedin.md index 2b149735e..d439d5a91 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-linkedin.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-linkedin.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-microsoft.md index bf8a63045..eb54b79b7 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-microsoft.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-microsoft.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-notion.md index e0e2a4136..1b3d7b89e 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-notion.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-notion.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-oidc.md index 5baf5f371..f9e8fa2dd 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-oidc.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-oidc.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-okta.md index ccb282f75..2f04beaf7 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-okta.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-okta.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal-sandbox.md index 2d03deda2..362baea8a 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal-sandbox.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal-sandbox.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal.md index 6c57a5514..35111390e 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-podio.md index e99af1282..ab360f9dd 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-podio.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-podio.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-salesforce.md index e82bbbeee..4bc650239 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-salesforce.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-salesforce.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-server.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..dcce77db2 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-server.md @@ -0,0 +1,33 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" +) + +client := client.New( + client.WithEndpoint("https://<REGION>.cloud.appwrite.io/v1") + client.WithProject("<YOUR_PROJECT_ID>") + client.WithKey("<YOUR_API_KEY>") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Server( + false, + "https://example.com", + project.WithUpdateOAuth2ServerScopes([]string{}), + project.WithUpdateOAuth2ServerAuthorizationDetailsTypes([]string{}), + project.WithUpdateOAuth2ServerAccessTokenDuration(60), + project.WithUpdateOAuth2ServerRefreshTokenDuration(60), + project.WithUpdateOAuth2ServerPublicAccessTokenDuration(60), + project.WithUpdateOAuth2ServerPublicRefreshTokenDuration(60), + project.WithUpdateOAuth2ServerConfidentialPkce(false), + project.WithUpdateOAuth2ServerVerificationUrl("https://example.com"), + project.WithUpdateOAuth2ServerUserCodeLength(6), + project.WithUpdateOAuth2ServerUserCodeFormat("numeric"), + project.WithUpdateOAuth2ServerDeviceCodeDuration(60), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-slack.md index ba8b6135a..91ab0862a 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-slack.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-slack.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-spotify.md index b46637a30..6507cbb52 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-spotify.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-spotify.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-stripe.md index 194a52f02..a7c95f437 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-stripe.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-stripe.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift-sandbox.md index 1d39ba7d8..d26051d1e 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift-sandbox.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift.md index e141b7f37..500a5610f 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-twitch.md index 90ec75172..4c5d20dc5 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-twitch.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-twitch.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-word-press.md index 2c6009e20..0e7ec6356 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-word-press.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-word-press.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-yahoo.md index dc6d19a7b..9a74961e2 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-yahoo.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-yahoo.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-yandex.md index 8f140b659..230e83881 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-yandex.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-yandex.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoho.md index 7fa111c7f..30077b184 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoho.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoho.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoom.md index 5345d25b7..3970c253f 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoom.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoom.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2x.md index 605d22f49..ea9c0befe 100644 --- a/examples/1.9.x/server-go/examples/project/update-o-auth-2x.md +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2x.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-password-dictionary-policy.md b/examples/1.9.x/server-go/examples/project/update-password-dictionary-policy.md index 70c7cdfb1..41903ee84 100644 --- a/examples/1.9.x/server-go/examples/project/update-password-dictionary-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-password-dictionary-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-password-history-policy.md b/examples/1.9.x/server-go/examples/project/update-password-history-policy.md index 11e7eacec..73e1ae237 100644 --- a/examples/1.9.x/server-go/examples/project/update-password-history-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-password-history-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-password-personal-data-policy.md b/examples/1.9.x/server-go/examples/project/update-password-personal-data-policy.md index 8059b224a..da77edf9d 100644 --- a/examples/1.9.x/server-go/examples/project/update-password-personal-data-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-password-personal-data-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-password-strength-policy.md b/examples/1.9.x/server-go/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..39b6de6c5 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-password-strength-policy.md @@ -0,0 +1,25 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" +) + +client := client.New( + client.WithEndpoint("https://<REGION>.cloud.appwrite.io/v1") + client.WithProject("<YOUR_PROJECT_ID>") + client.WithKey("<YOUR_API_KEY>") +) + +service := project.New(client) + +response, error := service.UpdatePasswordStrengthPolicy( + project.WithUpdatePasswordStrengthPolicyMin(8), + project.WithUpdatePasswordStrengthPolicyUppercase(false), + project.WithUpdatePasswordStrengthPolicyLowercase(false), + project.WithUpdatePasswordStrengthPolicyNumber(false), + project.WithUpdatePasswordStrengthPolicySymbols(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-protocol.md b/examples/1.9.x/server-go/examples/project/update-protocol.md index 6b74ddf4e..ecc39dc44 100644 --- a/examples/1.9.x/server-go/examples/project/update-protocol.md +++ b/examples/1.9.x/server-go/examples/project/update-protocol.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-service.md b/examples/1.9.x/server-go/examples/project/update-service.md index 156906547..f67721c30 100644 --- a/examples/1.9.x/server-go/examples/project/update-service.md +++ b/examples/1.9.x/server-go/examples/project/update-service.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-session-alert-policy.md b/examples/1.9.x/server-go/examples/project/update-session-alert-policy.md index cfba3c159..3b8609542 100644 --- a/examples/1.9.x/server-go/examples/project/update-session-alert-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-session-alert-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-session-duration-policy.md b/examples/1.9.x/server-go/examples/project/update-session-duration-policy.md index 5cc7c9d3d..b738799b3 100644 --- a/examples/1.9.x/server-go/examples/project/update-session-duration-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-session-duration-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-session-invalidation-policy.md b/examples/1.9.x/server-go/examples/project/update-session-invalidation-policy.md index 76764188a..0aaf5d041 100644 --- a/examples/1.9.x/server-go/examples/project/update-session-invalidation-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-session-invalidation-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-session-limit-policy.md b/examples/1.9.x/server-go/examples/project/update-session-limit-policy.md index ccde70542..87bc546a9 100644 --- a/examples/1.9.x/server-go/examples/project/update-session-limit-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-session-limit-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-smtp.md b/examples/1.9.x/server-go/examples/project/update-smtp.md index e3948a65a..81f99800f 100644 --- a/examples/1.9.x/server-go/examples/project/update-smtp.md +++ b/examples/1.9.x/server-go/examples/project/update-smtp.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.UpdateSMTP( project.WithUpdateSMTPHost(""), project.WithUpdateSMTPPort(0), project.WithUpdateSMTPUsername("<USERNAME>"), - project.WithUpdateSMTPPassword("<PASSWORD>"), + project.WithUpdateSMTPPassword("password"), project.WithUpdateSMTPSenderEmail("email@example.com"), project.WithUpdateSMTPSenderName("<SENDER_NAME>"), project.WithUpdateSMTPReplyToEmail("email@example.com"), diff --git a/examples/1.9.x/server-go/examples/project/update-user-limit-policy.md b/examples/1.9.x/server-go/examples/project/update-user-limit-policy.md index e146e59b2..38ccd7e49 100644 --- a/examples/1.9.x/server-go/examples/project/update-user-limit-policy.md +++ b/examples/1.9.x/server-go/examples/project/update-user-limit-policy.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-variable.md b/examples/1.9.x/server-go/examples/project/update-variable.md index 507f9b76c..361302a17 100644 --- a/examples/1.9.x/server-go/examples/project/update-variable.md +++ b/examples/1.9.x/server-go/examples/project/update-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-web-platform.md b/examples/1.9.x/server-go/examples/project/update-web-platform.md index df7a8be2a..6a1f34645 100644 --- a/examples/1.9.x/server-go/examples/project/update-web-platform.md +++ b/examples/1.9.x/server-go/examples/project/update-web-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/project/update-windows-platform.md b/examples/1.9.x/server-go/examples/project/update-windows-platform.md index 96b64d986..5cedddff0 100644 --- a/examples/1.9.x/server-go/examples/project/update-windows-platform.md +++ b/examples/1.9.x/server-go/examples/project/update-windows-platform.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/project" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/project" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/proxy/create-api-rule.md b/examples/1.9.x/server-go/examples/proxy/create-api-rule.md index 632895c01..6b917b32b 100644 --- a/examples/1.9.x/server-go/examples/proxy/create-api-rule.md +++ b/examples/1.9.x/server-go/examples/proxy/create-api-rule.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/proxy" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/proxy" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/proxy/create-function-rule.md b/examples/1.9.x/server-go/examples/proxy/create-function-rule.md index 8e1102dba..d5cce6712 100644 --- a/examples/1.9.x/server-go/examples/proxy/create-function-rule.md +++ b/examples/1.9.x/server-go/examples/proxy/create-function-rule.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/proxy" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/proxy" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/proxy/create-redirect-rule.md b/examples/1.9.x/server-go/examples/proxy/create-redirect-rule.md index 5e5b11feb..3b682ecc1 100644 --- a/examples/1.9.x/server-go/examples/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-go/examples/proxy/create-redirect-rule.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/proxy" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/proxy" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/proxy/create-site-rule.md b/examples/1.9.x/server-go/examples/proxy/create-site-rule.md index 9894b37c6..dd7f0d489 100644 --- a/examples/1.9.x/server-go/examples/proxy/create-site-rule.md +++ b/examples/1.9.x/server-go/examples/proxy/create-site-rule.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/proxy" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/proxy" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/proxy/delete-rule.md b/examples/1.9.x/server-go/examples/proxy/delete-rule.md index 3423da0c9..6b22c350f 100644 --- a/examples/1.9.x/server-go/examples/proxy/delete-rule.md +++ b/examples/1.9.x/server-go/examples/proxy/delete-rule.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/proxy" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/proxy" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/proxy/get-rule.md b/examples/1.9.x/server-go/examples/proxy/get-rule.md index 45d932386..dc0049aff 100644 --- a/examples/1.9.x/server-go/examples/proxy/get-rule.md +++ b/examples/1.9.x/server-go/examples/proxy/get-rule.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/proxy" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/proxy" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/proxy/list-rules.md b/examples/1.9.x/server-go/examples/proxy/list-rules.md index d10cac509..b1790d331 100644 --- a/examples/1.9.x/server-go/examples/proxy/list-rules.md +++ b/examples/1.9.x/server-go/examples/proxy/list-rules.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/proxy" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/proxy" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := proxy.New(client) response, error := service.ListRules( - proxy.WithListRulesQueries([]interface{}{}), + proxy.WithListRulesQueries([]string{}), proxy.WithListRulesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/proxy/update-rule-status.md b/examples/1.9.x/server-go/examples/proxy/update-rule-status.md index 21546810c..a93bd9ab0 100644 --- a/examples/1.9.x/server-go/examples/proxy/update-rule-status.md +++ b/examples/1.9.x/server-go/examples/proxy/update-rule-status.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/proxy" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/proxy" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/create-deployment.md b/examples/1.9.x/server-go/examples/sites/create-deployment.md index 6d1cc83e9..71d451256 100644 --- a/examples/1.9.x/server-go/examples/sites/create-deployment.md +++ b/examples/1.9.x/server-go/examples/sites/create-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/create-duplicate-deployment.md b/examples/1.9.x/server-go/examples/sites/create-duplicate-deployment.md index b159facd1..c7da97680 100644 --- a/examples/1.9.x/server-go/examples/sites/create-duplicate-deployment.md +++ b/examples/1.9.x/server-go/examples/sites/create-duplicate-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/create-template-deployment.md b/examples/1.9.x/server-go/examples/sites/create-template-deployment.md index e067ea5a4..fdc6094f7 100644 --- a/examples/1.9.x/server-go/examples/sites/create-template-deployment.md +++ b/examples/1.9.x/server-go/examples/sites/create-template-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/create-variable.md b/examples/1.9.x/server-go/examples/sites/create-variable.md index 63824637c..81ded728b 100644 --- a/examples/1.9.x/server-go/examples/sites/create-variable.md +++ b/examples/1.9.x/server-go/examples/sites/create-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/create-vcs-deployment.md b/examples/1.9.x/server-go/examples/sites/create-vcs-deployment.md index c76608292..6d898ee8a 100644 --- a/examples/1.9.x/server-go/examples/sites/create-vcs-deployment.md +++ b/examples/1.9.x/server-go/examples/sites/create-vcs-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/create.md b/examples/1.9.x/server-go/examples/sites/create.md index 63fbf41fc..a3d1891e6 100644 --- a/examples/1.9.x/server-go/examples/sites/create.md +++ b/examples/1.9.x/server-go/examples/sites/create.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( @@ -34,8 +34,8 @@ response, error := service.Create( sites.WithCreateProviderBranch("<PROVIDER_BRANCH>"), sites.WithCreateProviderSilentMode(false), sites.WithCreateProviderRootDirectory("<PROVIDER_ROOT_DIRECTORY>"), - sites.WithCreateProviderBranches([]interface{}{}), - sites.WithCreateProviderPaths([]interface{}{}), + sites.WithCreateProviderBranches([]string{}), + sites.WithCreateProviderPaths([]string{}), sites.WithCreateBuildSpecification(""), sites.WithCreateRuntimeSpecification(""), sites.WithCreateDeploymentRetention(0), diff --git a/examples/1.9.x/server-go/examples/sites/delete-deployment.md b/examples/1.9.x/server-go/examples/sites/delete-deployment.md index 053be7f11..39b1adefe 100644 --- a/examples/1.9.x/server-go/examples/sites/delete-deployment.md +++ b/examples/1.9.x/server-go/examples/sites/delete-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/delete-log.md b/examples/1.9.x/server-go/examples/sites/delete-log.md index 748dde4aa..5349e3f0b 100644 --- a/examples/1.9.x/server-go/examples/sites/delete-log.md +++ b/examples/1.9.x/server-go/examples/sites/delete-log.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/delete-variable.md b/examples/1.9.x/server-go/examples/sites/delete-variable.md index 84588a351..c52661787 100644 --- a/examples/1.9.x/server-go/examples/sites/delete-variable.md +++ b/examples/1.9.x/server-go/examples/sites/delete-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/delete.md b/examples/1.9.x/server-go/examples/sites/delete.md index 33dc9ad66..3ea10378b 100644 --- a/examples/1.9.x/server-go/examples/sites/delete.md +++ b/examples/1.9.x/server-go/examples/sites/delete.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/get-deployment-download.md b/examples/1.9.x/server-go/examples/sites/get-deployment-download.md index d6d66a868..86f1d7d9e 100644 --- a/examples/1.9.x/server-go/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-go/examples/sites/get-deployment-download.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( client.WithEndpoint("https://<REGION>.cloud.appwrite.io/v1") client.WithProject("<YOUR_PROJECT_ID>") client.WithKey("<YOUR_API_KEY>") + client.WithImpersonateUserId("") ) service := sites.New(client) diff --git a/examples/1.9.x/server-go/examples/sites/get-deployment.md b/examples/1.9.x/server-go/examples/sites/get-deployment.md index eebff4610..bebeb36cd 100644 --- a/examples/1.9.x/server-go/examples/sites/get-deployment.md +++ b/examples/1.9.x/server-go/examples/sites/get-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/get-log.md b/examples/1.9.x/server-go/examples/sites/get-log.md index 6fe5eb82d..4d9ab19ab 100644 --- a/examples/1.9.x/server-go/examples/sites/get-log.md +++ b/examples/1.9.x/server-go/examples/sites/get-log.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/get-variable.md b/examples/1.9.x/server-go/examples/sites/get-variable.md index c396f358a..966d9a93a 100644 --- a/examples/1.9.x/server-go/examples/sites/get-variable.md +++ b/examples/1.9.x/server-go/examples/sites/get-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/get.md b/examples/1.9.x/server-go/examples/sites/get.md index ad107acf9..838654abc 100644 --- a/examples/1.9.x/server-go/examples/sites/get.md +++ b/examples/1.9.x/server-go/examples/sites/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/list-deployments.md b/examples/1.9.x/server-go/examples/sites/list-deployments.md index 6379f059d..123f82011 100644 --- a/examples/1.9.x/server-go/examples/sites/list-deployments.md +++ b/examples/1.9.x/server-go/examples/sites/list-deployments.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( @@ -17,7 +17,7 @@ service := sites.New(client) response, error := service.ListDeployments( "<SITE_ID>", - sites.WithListDeploymentsQueries([]interface{}{}), + sites.WithListDeploymentsQueries([]string{}), sites.WithListDeploymentsSearch("<SEARCH>"), sites.WithListDeploymentsTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/sites/list-frameworks.md b/examples/1.9.x/server-go/examples/sites/list-frameworks.md index 01e5a8391..dbd77a245 100644 --- a/examples/1.9.x/server-go/examples/sites/list-frameworks.md +++ b/examples/1.9.x/server-go/examples/sites/list-frameworks.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/list-logs.md b/examples/1.9.x/server-go/examples/sites/list-logs.md index e6cacb6a1..1c67a0c1a 100644 --- a/examples/1.9.x/server-go/examples/sites/list-logs.md +++ b/examples/1.9.x/server-go/examples/sites/list-logs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( @@ -17,7 +17,7 @@ service := sites.New(client) response, error := service.ListLogs( "<SITE_ID>", - sites.WithListLogsQueries([]interface{}{}), + sites.WithListLogsQueries([]string{}), sites.WithListLogsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/sites/list-specifications.md b/examples/1.9.x/server-go/examples/sites/list-specifications.md index 31ecc5440..8168c2cd8 100644 --- a/examples/1.9.x/server-go/examples/sites/list-specifications.md +++ b/examples/1.9.x/server-go/examples/sites/list-specifications.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/list-variables.md b/examples/1.9.x/server-go/examples/sites/list-variables.md index 658bc9825..a5a0fa066 100644 --- a/examples/1.9.x/server-go/examples/sites/list-variables.md +++ b/examples/1.9.x/server-go/examples/sites/list-variables.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( @@ -17,7 +17,7 @@ service := sites.New(client) response, error := service.ListVariables( "<SITE_ID>", - sites.WithListVariablesQueries([]interface{}{}), + sites.WithListVariablesQueries([]string{}), sites.WithListVariablesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/sites/list.md b/examples/1.9.x/server-go/examples/sites/list.md index ab859cb8b..26bb4494c 100644 --- a/examples/1.9.x/server-go/examples/sites/list.md +++ b/examples/1.9.x/server-go/examples/sites/list.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := sites.New(client) response, error := service.List( - sites.WithListQueries([]interface{}{}), + sites.WithListQueries([]string{}), sites.WithListSearch("<SEARCH>"), sites.WithListTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/sites/update-deployment-status.md b/examples/1.9.x/server-go/examples/sites/update-deployment-status.md index 33ac8b760..cf5f311fb 100644 --- a/examples/1.9.x/server-go/examples/sites/update-deployment-status.md +++ b/examples/1.9.x/server-go/examples/sites/update-deployment-status.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/update-site-deployment.md b/examples/1.9.x/server-go/examples/sites/update-site-deployment.md index eb2453269..3cc2929f3 100644 --- a/examples/1.9.x/server-go/examples/sites/update-site-deployment.md +++ b/examples/1.9.x/server-go/examples/sites/update-site-deployment.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/update-variable.md b/examples/1.9.x/server-go/examples/sites/update-variable.md index 64c41320a..b7d388b2a 100644 --- a/examples/1.9.x/server-go/examples/sites/update-variable.md +++ b/examples/1.9.x/server-go/examples/sites/update-variable.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/sites/update.md b/examples/1.9.x/server-go/examples/sites/update.md index 450e65089..54f1d344f 100644 --- a/examples/1.9.x/server-go/examples/sites/update.md +++ b/examples/1.9.x/server-go/examples/sites/update.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/sites" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/sites" ) client := client.New( @@ -34,8 +34,8 @@ response, error := service.Update( sites.WithUpdateProviderBranch("<PROVIDER_BRANCH>"), sites.WithUpdateProviderSilentMode(false), sites.WithUpdateProviderRootDirectory("<PROVIDER_ROOT_DIRECTORY>"), - sites.WithUpdateProviderBranches([]interface{}{}), - sites.WithUpdateProviderPaths([]interface{}{}), + sites.WithUpdateProviderBranches([]string{}), + sites.WithUpdateProviderPaths([]string{}), sites.WithUpdateBuildSpecification(""), sites.WithUpdateRuntimeSpecification(""), sites.WithUpdateDeploymentRetention(0), diff --git a/examples/1.9.x/server-go/examples/storage/create-bucket.md b/examples/1.9.x/server-go/examples/storage/create-bucket.md index f1f846243..14118bcb3 100644 --- a/examples/1.9.x/server-go/examples/storage/create-bucket.md +++ b/examples/1.9.x/server-go/examples/storage/create-bucket.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( @@ -18,11 +18,11 @@ service := storage.New(client) response, error := service.CreateBucket( "<BUCKET_ID>", "<NAME>", - storage.WithCreateBucketPermissions(interface{}{"read("any")"}), + storage.WithCreateBucketPermissions([]string{"read("any")"}), storage.WithCreateBucketFileSecurity(false), storage.WithCreateBucketEnabled(false), storage.WithCreateBucketMaximumFileSize(1), - storage.WithCreateBucketAllowedFileExtensions([]interface{}{}), + storage.WithCreateBucketAllowedFileExtensions([]string{}), storage.WithCreateBucketCompression("none"), storage.WithCreateBucketEncryption(false), storage.WithCreateBucketAntivirus(false), diff --git a/examples/1.9.x/server-go/examples/storage/create-file.md b/examples/1.9.x/server-go/examples/storage/create-file.md index 275825e0d..8dc065283 100644 --- a/examples/1.9.x/server-go/examples/storage/create-file.md +++ b/examples/1.9.x/server-go/examples/storage/create-file.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( @@ -19,6 +19,6 @@ response, error := service.CreateFile( "<BUCKET_ID>", "<FILE_ID>", file.NewInputFile("/path/to/file.png", "file.png"), - storage.WithCreateFilePermissions(interface{}{"read("any")"}), + storage.WithCreateFilePermissions([]string{"read("any")"}), ) ``` diff --git a/examples/1.9.x/server-go/examples/storage/delete-bucket.md b/examples/1.9.x/server-go/examples/storage/delete-bucket.md index 8347ac285..72b032164 100644 --- a/examples/1.9.x/server-go/examples/storage/delete-bucket.md +++ b/examples/1.9.x/server-go/examples/storage/delete-bucket.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/storage/delete-file.md b/examples/1.9.x/server-go/examples/storage/delete-file.md index 4fc1c441e..6c7f79b46 100644 --- a/examples/1.9.x/server-go/examples/storage/delete-file.md +++ b/examples/1.9.x/server-go/examples/storage/delete-file.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/storage/get-bucket.md b/examples/1.9.x/server-go/examples/storage/get-bucket.md index 2e909d588..642bb3a58 100644 --- a/examples/1.9.x/server-go/examples/storage/get-bucket.md +++ b/examples/1.9.x/server-go/examples/storage/get-bucket.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/storage/get-file-download.md b/examples/1.9.x/server-go/examples/storage/get-file-download.md index 928e91752..27b0e932b 100644 --- a/examples/1.9.x/server-go/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-go/examples/storage/get-file-download.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( client.WithEndpoint("https://<REGION>.cloud.appwrite.io/v1") client.WithProject("<YOUR_PROJECT_ID>") client.WithSession("") + client.WithImpersonateUserId("") ) service := storage.New(client) diff --git a/examples/1.9.x/server-go/examples/storage/get-file-preview.md b/examples/1.9.x/server-go/examples/storage/get-file-preview.md index f700549be..8daee7a6a 100644 --- a/examples/1.9.x/server-go/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-go/examples/storage/get-file-preview.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( client.WithEndpoint("https://<REGION>.cloud.appwrite.io/v1") client.WithProject("<YOUR_PROJECT_ID>") client.WithSession("") + client.WithImpersonateUserId("") ) service := storage.New(client) diff --git a/examples/1.9.x/server-go/examples/storage/get-file-view.md b/examples/1.9.x/server-go/examples/storage/get-file-view.md index 489839fe3..fdb84c08d 100644 --- a/examples/1.9.x/server-go/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-go/examples/storage/get-file-view.md @@ -3,14 +3,15 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( client.WithEndpoint("https://<REGION>.cloud.appwrite.io/v1") client.WithProject("<YOUR_PROJECT_ID>") client.WithSession("") + client.WithImpersonateUserId("") ) service := storage.New(client) diff --git a/examples/1.9.x/server-go/examples/storage/get-file.md b/examples/1.9.x/server-go/examples/storage/get-file.md index f70008613..5692d44f4 100644 --- a/examples/1.9.x/server-go/examples/storage/get-file.md +++ b/examples/1.9.x/server-go/examples/storage/get-file.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/storage/list-buckets.md b/examples/1.9.x/server-go/examples/storage/list-buckets.md index 1d4605166..ef80c0964 100644 --- a/examples/1.9.x/server-go/examples/storage/list-buckets.md +++ b/examples/1.9.x/server-go/examples/storage/list-buckets.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := storage.New(client) response, error := service.ListBuckets( - storage.WithListBucketsQueries([]interface{}{}), + storage.WithListBucketsQueries([]string{}), storage.WithListBucketsSearch("<SEARCH>"), storage.WithListBucketsTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/storage/list-files.md b/examples/1.9.x/server-go/examples/storage/list-files.md index 963e6c38d..563d5ff3c 100644 --- a/examples/1.9.x/server-go/examples/storage/list-files.md +++ b/examples/1.9.x/server-go/examples/storage/list-files.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( @@ -17,7 +17,7 @@ service := storage.New(client) response, error := service.ListFiles( "<BUCKET_ID>", - storage.WithListFilesQueries([]interface{}{}), + storage.WithListFilesQueries([]string{}), storage.WithListFilesSearch("<SEARCH>"), storage.WithListFilesTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/storage/update-bucket.md b/examples/1.9.x/server-go/examples/storage/update-bucket.md index a8592efa0..1134db6f8 100644 --- a/examples/1.9.x/server-go/examples/storage/update-bucket.md +++ b/examples/1.9.x/server-go/examples/storage/update-bucket.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( @@ -18,11 +18,11 @@ service := storage.New(client) response, error := service.UpdateBucket( "<BUCKET_ID>", "<NAME>", - storage.WithUpdateBucketPermissions(interface{}{"read("any")"}), + storage.WithUpdateBucketPermissions([]string{"read("any")"}), storage.WithUpdateBucketFileSecurity(false), storage.WithUpdateBucketEnabled(false), storage.WithUpdateBucketMaximumFileSize(1), - storage.WithUpdateBucketAllowedFileExtensions([]interface{}{}), + storage.WithUpdateBucketAllowedFileExtensions([]string{}), storage.WithUpdateBucketCompression("none"), storage.WithUpdateBucketEncryption(false), storage.WithUpdateBucketAntivirus(false), diff --git a/examples/1.9.x/server-go/examples/storage/update-file.md b/examples/1.9.x/server-go/examples/storage/update-file.md index 45bb46f4e..43901c52d 100644 --- a/examples/1.9.x/server-go/examples/storage/update-file.md +++ b/examples/1.9.x/server-go/examples/storage/update-file.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/storage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/storage" ) client := client.New( @@ -19,6 +19,6 @@ response, error := service.UpdateFile( "<BUCKET_ID>", "<FILE_ID>", storage.WithUpdateFileName("<NAME>"), - storage.WithUpdateFilePermissions(interface{}{"read("any")"}), + storage.WithUpdateFilePermissions([]string{"read("any")"}), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-big-int-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-big-int-column.md index b3212a658..d764ee7a1 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-big-int-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-big-int-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-boolean-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-boolean-column.md index 59a31c8f2..7b349c643 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-boolean-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-boolean-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-datetime-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-datetime-column.md index 6c7c370ff..0883250b8 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-datetime-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-datetime-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-email-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-email-column.md index 8f1a5c367..0f138a65d 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-email-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-email-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-enum-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-enum-column.md index 0639681b4..d665f4614 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-enum-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-enum-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.CreateEnumColumn( "<DATABASE_ID>", "<TABLE_ID>", "", - []interface{}{}, + []string{}, false, tablesdb.WithCreateEnumColumnDefault("<DEFAULT>"), tablesdb.WithCreateEnumColumnArray(false), diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-float-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-float-column.md index a4a76cd5f..89b64c074 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-float-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-float-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-index.md b/examples/1.9.x/server-go/examples/tablesdb/create-index.md index 19b8ca677..387f66215 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-index.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-index.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -20,8 +20,8 @@ response, error := service.CreateIndex( "<TABLE_ID>", "", "key", - []interface{}{}, - tablesdb.WithCreateIndexOrders([]interface{}{}), - tablesdb.WithCreateIndexLengths([]interface{}{}), + []string{}, + tablesdb.WithCreateIndexOrders([]string{}), + tablesdb.WithCreateIndexLengths([]int{}), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-integer-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-integer-column.md index 6fa978994..9a17c7dfa 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-integer-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-integer-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-ip-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-ip-column.md index d985d74a5..e1c8e4485 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-ip-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-ip-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-line-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-line-column.md index 4cb475d38..ec15a1ed4 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-line-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-line-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -20,6 +20,6 @@ response, error := service.CreateLineColumn( "<TABLE_ID>", "", false, - tablesdb.WithCreateLineColumnDefault(interface{}{[1, 2], [3, 4], [5, 6]}), + tablesdb.WithCreateLineColumnDefault([]interface{}{[1, 2], [3, 4], [5, 6]}), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-longtext-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-longtext-column.md index 0bda2405c..a4cf1c42c 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-longtext-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-longtext-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-mediumtext-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-mediumtext-column.md index a3121d327..c528fc2cf 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-mediumtext-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-mediumtext-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-operations.md b/examples/1.9.x/server-go/examples/tablesdb/create-operations.md index 01c07c29d..d3811259b 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-operations.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-operations.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -17,7 +17,7 @@ service := tablesdb.New(client) response, error := service.CreateOperations( "<TRANSACTION_ID>", - tablesdb.WithCreateOperationsOperations(interface{}{ + tablesdb.WithCreateOperationsOperations([]interface{}{ { "action": "create", "databaseId": "<DATABASE_ID>", diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-point-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-point-column.md index 5dfaa7258..18c1c62f4 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-point-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-point-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -20,6 +20,6 @@ response, error := service.CreatePointColumn( "<TABLE_ID>", "", false, - tablesdb.WithCreatePointColumnDefault(interface{}{1, 2}), + tablesdb.WithCreatePointColumnDefault([]interface{}{1, 2}), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-polygon-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-polygon-column.md index a1c78408c..305a8403d 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-polygon-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-polygon-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -20,6 +20,6 @@ response, error := service.CreatePolygonColumn( "<TABLE_ID>", "", false, - tablesdb.WithCreatePolygonColumnDefault(interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), + tablesdb.WithCreatePolygonColumnDefault([]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-relationship-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-relationship-column.md index 980746288..fa33f0a8e 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-relationship-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-relationship-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-row.md b/examples/1.9.x/server-go/examples/tablesdb/create-row.md index 85cb5a72b..13280ce5d 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-row.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-row.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -26,7 +26,7 @@ response, error := service.CreateRow( "age": 30, "isAdmin": false }, - tablesdb.WithCreateRowPermissions(interface{}{"read("any")"}), + tablesdb.WithCreateRowPermissions([]string{"read("any")"}), tablesdb.WithCreateRowTransactionId("<TRANSACTION_ID>"), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-rows.md b/examples/1.9.x/server-go/examples/tablesdb/create-rows.md index e7bc66265..d771a9237 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-rows.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-rows.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-string-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-string-column.md index 52b5c7277..efa4e2cfa 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-string-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-string-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-table.md b/examples/1.9.x/server-go/examples/tablesdb/create-table.md index bb52de8cd..576d280ec 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-table.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-table.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.CreateTable( "<DATABASE_ID>", "<TABLE_ID>", "<NAME>", - tablesdb.WithCreateTablePermissions(interface{}{"read("any")"}), + tablesdb.WithCreateTablePermissions([]string{"read("any")"}), tablesdb.WithCreateTableRowSecurity(false), tablesdb.WithCreateTableEnabled(false), tablesdb.WithCreateTableColumns([]interface{}{}), diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-text-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-text-column.md index 6a1beb8f1..8f6a238f7 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-text-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-text-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-transaction.md b/examples/1.9.x/server-go/examples/tablesdb/create-transaction.md index 5ccea9577..e320713cf 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-transaction.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-transaction.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-url-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-url-column.md index af68adc4b..039ec3442 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-url-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-url-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-varchar-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-varchar-column.md index d0a370897..06b547065 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-varchar-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-varchar-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/create.md b/examples/1.9.x/server-go/examples/tablesdb/create.md index ffe3632bd..c44f118ae 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/decrement-row-column.md b/examples/1.9.x/server-go/examples/tablesdb/decrement-row-column.md index e9dbd21f2..da7dab464 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/decrement-row-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/decrement-row-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/delete-column.md b/examples/1.9.x/server-go/examples/tablesdb/delete-column.md index 131ab9615..51c936225 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/delete-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/delete-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/delete-index.md b/examples/1.9.x/server-go/examples/tablesdb/delete-index.md index b17785de0..050950b3c 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/delete-index.md +++ b/examples/1.9.x/server-go/examples/tablesdb/delete-index.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/delete-row.md b/examples/1.9.x/server-go/examples/tablesdb/delete-row.md index 6a365c5a7..39c15f5be 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/delete-row.md +++ b/examples/1.9.x/server-go/examples/tablesdb/delete-row.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/delete-rows.md b/examples/1.9.x/server-go/examples/tablesdb/delete-rows.md index e282e991a..9f094e510 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/delete-rows.md +++ b/examples/1.9.x/server-go/examples/tablesdb/delete-rows.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -18,7 +18,7 @@ service := tablesdb.New(client) response, error := service.DeleteRows( "<DATABASE_ID>", "<TABLE_ID>", - tablesdb.WithDeleteRowsQueries([]interface{}{}), + tablesdb.WithDeleteRowsQueries([]string{}), tablesdb.WithDeleteRowsTransactionId("<TRANSACTION_ID>"), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/delete-table.md b/examples/1.9.x/server-go/examples/tablesdb/delete-table.md index af8b11e24..74f5f7168 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/delete-table.md +++ b/examples/1.9.x/server-go/examples/tablesdb/delete-table.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/delete-transaction.md b/examples/1.9.x/server-go/examples/tablesdb/delete-transaction.md index 82eb7b59e..14c514028 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/delete-transaction.md +++ b/examples/1.9.x/server-go/examples/tablesdb/delete-transaction.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/delete.md b/examples/1.9.x/server-go/examples/tablesdb/delete.md index cdb8d0038..638759c52 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/delete.md +++ b/examples/1.9.x/server-go/examples/tablesdb/delete.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/get-column.md b/examples/1.9.x/server-go/examples/tablesdb/get-column.md index 5c611d474..219b97174 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/get-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/get-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/get-index.md b/examples/1.9.x/server-go/examples/tablesdb/get-index.md index dc5472e7b..f65947ff0 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/get-index.md +++ b/examples/1.9.x/server-go/examples/tablesdb/get-index.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/get-row.md b/examples/1.9.x/server-go/examples/tablesdb/get-row.md index 227944067..cc3c3b8a6 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/get-row.md +++ b/examples/1.9.x/server-go/examples/tablesdb/get-row.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.GetRow( "<DATABASE_ID>", "<TABLE_ID>", "<ROW_ID>", - tablesdb.WithGetRowQueries([]interface{}{}), + tablesdb.WithGetRowQueries([]string{}), tablesdb.WithGetRowTransactionId("<TRANSACTION_ID>"), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/get-table.md b/examples/1.9.x/server-go/examples/tablesdb/get-table.md index 4d4a09365..7d34e8bb3 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/get-table.md +++ b/examples/1.9.x/server-go/examples/tablesdb/get-table.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/get-transaction.md b/examples/1.9.x/server-go/examples/tablesdb/get-transaction.md index 545adecc2..620b21d9d 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/get-transaction.md +++ b/examples/1.9.x/server-go/examples/tablesdb/get-transaction.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/get.md b/examples/1.9.x/server-go/examples/tablesdb/get.md index d8b5b1d24..4df23f724 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/get.md +++ b/examples/1.9.x/server-go/examples/tablesdb/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/increment-row-column.md b/examples/1.9.x/server-go/examples/tablesdb/increment-row-column.md index 5281dd108..39a443b2f 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/increment-row-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/increment-row-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/list-columns.md b/examples/1.9.x/server-go/examples/tablesdb/list-columns.md index b33a50a70..4377fe626 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/list-columns.md +++ b/examples/1.9.x/server-go/examples/tablesdb/list-columns.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -18,7 +18,7 @@ service := tablesdb.New(client) response, error := service.ListColumns( "<DATABASE_ID>", "<TABLE_ID>", - tablesdb.WithListColumnsQueries([]interface{}{}), + tablesdb.WithListColumnsQueries([]string{}), tablesdb.WithListColumnsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/list-indexes.md b/examples/1.9.x/server-go/examples/tablesdb/list-indexes.md index ec6a03b60..c97a33a57 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/list-indexes.md +++ b/examples/1.9.x/server-go/examples/tablesdb/list-indexes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -18,7 +18,7 @@ service := tablesdb.New(client) response, error := service.ListIndexes( "<DATABASE_ID>", "<TABLE_ID>", - tablesdb.WithListIndexesQueries([]interface{}{}), + tablesdb.WithListIndexesQueries([]string{}), tablesdb.WithListIndexesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/list-rows.md b/examples/1.9.x/server-go/examples/tablesdb/list-rows.md index 5f6e16311..f15b10bee 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/list-rows.md +++ b/examples/1.9.x/server-go/examples/tablesdb/list-rows.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -18,7 +18,7 @@ service := tablesdb.New(client) response, error := service.ListRows( "<DATABASE_ID>", "<TABLE_ID>", - tablesdb.WithListRowsQueries([]interface{}{}), + tablesdb.WithListRowsQueries([]string{}), tablesdb.WithListRowsTransactionId("<TRANSACTION_ID>"), tablesdb.WithListRowsTotal(false), tablesdb.WithListRowsTtl(0), diff --git a/examples/1.9.x/server-go/examples/tablesdb/list-tables.md b/examples/1.9.x/server-go/examples/tablesdb/list-tables.md index a580af26d..d36e3c2e1 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/list-tables.md +++ b/examples/1.9.x/server-go/examples/tablesdb/list-tables.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -17,7 +17,7 @@ service := tablesdb.New(client) response, error := service.ListTables( "<DATABASE_ID>", - tablesdb.WithListTablesQueries([]interface{}{}), + tablesdb.WithListTablesQueries([]string{}), tablesdb.WithListTablesSearch("<SEARCH>"), tablesdb.WithListTablesTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/tablesdb/list-transactions.md b/examples/1.9.x/server-go/examples/tablesdb/list-transactions.md index 6212155dc..d1be6ee5f 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/list-transactions.md +++ b/examples/1.9.x/server-go/examples/tablesdb/list-transactions.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -16,6 +16,6 @@ client := client.New( service := tablesdb.New(client) response, error := service.ListTransactions( - tablesdb.WithListTransactionsQueries([]interface{}{}), + tablesdb.WithListTransactionsQueries([]string{}), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/list.md b/examples/1.9.x/server-go/examples/tablesdb/list.md index 6fbd3abd1..886b6069f 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/list.md +++ b/examples/1.9.x/server-go/examples/tablesdb/list.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := tablesdb.New(client) response, error := service.List( - tablesdb.WithListQueries([]interface{}{}), + tablesdb.WithListQueries([]string{}), tablesdb.WithListSearch("<SEARCH>"), tablesdb.WithListTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-big-int-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-big-int-column.md index 85f0c166d..f96c3ceb4 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-big-int-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-big-int-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-boolean-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-boolean-column.md index ec82db5c6..2d9f712e9 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-boolean-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-boolean-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-datetime-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-datetime-column.md index b9300f5ab..49547775b 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-datetime-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-datetime-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-email-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-email-column.md index 46db0f906..caadab457 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-email-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-email-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-enum-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-enum-column.md index 5563caf18..cf3c2f3e7 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-enum-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-enum-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.UpdateEnumColumn( "<DATABASE_ID>", "<TABLE_ID>", "", - []interface{}{}, + []string{}, false, "<DEFAULT>", tablesdb.WithUpdateEnumColumnNewKey(""), diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-float-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-float-column.md index a304f1b60..10bd20b46 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-float-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-float-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-integer-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-integer-column.md index 5f016d3f7..ab19734c5 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-integer-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-integer-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-ip-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-ip-column.md index f67a968c5..b4ecdd873 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-ip-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-ip-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-line-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-line-column.md index 58ef19e31..78653fbda 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-line-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-line-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -20,7 +20,7 @@ response, error := service.UpdateLineColumn( "<TABLE_ID>", "", false, - tablesdb.WithUpdateLineColumnDefault(interface{}{[1, 2], [3, 4], [5, 6]}), + tablesdb.WithUpdateLineColumnDefault([]interface{}{[1, 2], [3, 4], [5, 6]}), tablesdb.WithUpdateLineColumnNewKey(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-longtext-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-longtext-column.md index 325275b77..01b1bf93a 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-longtext-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-longtext-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-mediumtext-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-mediumtext-column.md index 704828d0d..6e8f45740 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-mediumtext-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-mediumtext-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-point-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-point-column.md index dde212bfc..3b128bd76 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-point-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-point-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -20,7 +20,7 @@ response, error := service.UpdatePointColumn( "<TABLE_ID>", "", false, - tablesdb.WithUpdatePointColumnDefault(interface{}{1, 2}), + tablesdb.WithUpdatePointColumnDefault([]interface{}{1, 2}), tablesdb.WithUpdatePointColumnNewKey(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-polygon-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-polygon-column.md index b49520acd..d0c81adba 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-polygon-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-polygon-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -20,7 +20,7 @@ response, error := service.UpdatePolygonColumn( "<TABLE_ID>", "", false, - tablesdb.WithUpdatePolygonColumnDefault(interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), + tablesdb.WithUpdatePolygonColumnDefault([]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), tablesdb.WithUpdatePolygonColumnNewKey(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-relationship-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-relationship-column.md index 1bc8ee264..226e6c834 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-relationship-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-relationship-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-row.md b/examples/1.9.x/server-go/examples/tablesdb/update-row.md index 30a2d644f..9bad72b63 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-row.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-row.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -26,7 +26,7 @@ response, error := service.UpdateRow( "age": 33, "isAdmin": false }), - tablesdb.WithUpdateRowPermissions(interface{}{"read("any")"}), + tablesdb.WithUpdateRowPermissions([]string{"read("any")"}), tablesdb.WithUpdateRowTransactionId("<TRANSACTION_ID>"), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-rows.md b/examples/1.9.x/server-go/examples/tablesdb/update-rows.md index d0bf880dd..2ac9bddb0 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-rows.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-rows.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -25,7 +25,7 @@ response, error := service.UpdateRows( "age": 33, "isAdmin": false }), - tablesdb.WithUpdateRowsQueries([]interface{}{}), + tablesdb.WithUpdateRowsQueries([]string{}), tablesdb.WithUpdateRowsTransactionId("<TRANSACTION_ID>"), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-string-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-string-column.md index 8a5ab0e88..1293b40ae 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-string-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-string-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-table.md b/examples/1.9.x/server-go/examples/tablesdb/update-table.md index dff249d0b..081291815 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-table.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-table.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.UpdateTable( "<DATABASE_ID>", "<TABLE_ID>", tablesdb.WithUpdateTableName("<NAME>"), - tablesdb.WithUpdateTablePermissions(interface{}{"read("any")"}), + tablesdb.WithUpdateTablePermissions([]string{"read("any")"}), tablesdb.WithUpdateTableRowSecurity(false), tablesdb.WithUpdateTableEnabled(false), tablesdb.WithUpdateTablePurge(false), diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-text-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-text-column.md index 2b21c83aa..fca652ecf 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-text-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-text-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-transaction.md b/examples/1.9.x/server-go/examples/tablesdb/update-transaction.md index ab86872bb..3d815df37 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-transaction.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-transaction.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-url-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-url-column.md index fec3ebcf5..587c72a86 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-url-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-url-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-varchar-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-varchar-column.md index 58cd03d6f..5ef89c2a2 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-varchar-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-varchar-column.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/update.md b/examples/1.9.x/server-go/examples/tablesdb/update.md index 31f077c8e..d6b36d9c6 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tablesdb/upsert-row.md b/examples/1.9.x/server-go/examples/tablesdb/upsert-row.md index 12362a102..af6f4e2df 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/upsert-row.md +++ b/examples/1.9.x/server-go/examples/tablesdb/upsert-row.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( @@ -26,7 +26,7 @@ response, error := service.UpsertRow( "age": 33, "isAdmin": false }), - tablesdb.WithUpsertRowPermissions(interface{}{"read("any")"}), + tablesdb.WithUpsertRowPermissions([]string{"read("any")"}), tablesdb.WithUpsertRowTransactionId("<TRANSACTION_ID>"), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/upsert-rows.md b/examples/1.9.x/server-go/examples/tablesdb/upsert-rows.md index 18e1f1497..52cb7d4bb 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/upsert-rows.md +++ b/examples/1.9.x/server-go/examples/tablesdb/upsert-rows.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tablesdb" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tablesdb" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/teams/create-membership.md b/examples/1.9.x/server-go/examples/teams/create-membership.md index 943305ee3..c6ac8928f 100644 --- a/examples/1.9.x/server-go/examples/teams/create-membership.md +++ b/examples/1.9.x/server-go/examples/teams/create-membership.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( @@ -17,7 +17,7 @@ service := teams.New(client) response, error := service.CreateMembership( "<TEAM_ID>", - []interface{}{}, + []string{}, teams.WithCreateMembershipEmail("email@example.com"), teams.WithCreateMembershipUserId("<USER_ID>"), teams.WithCreateMembershipPhone("+12065550100"), diff --git a/examples/1.9.x/server-go/examples/teams/create.md b/examples/1.9.x/server-go/examples/teams/create.md index a461e14c5..d24a5ed3f 100644 --- a/examples/1.9.x/server-go/examples/teams/create.md +++ b/examples/1.9.x/server-go/examples/teams/create.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( @@ -18,6 +18,6 @@ service := teams.New(client) response, error := service.Create( "<TEAM_ID>", "<NAME>", - teams.WithCreateRoles([]interface{}{}), + teams.WithCreateRoles([]string{}), ) ``` diff --git a/examples/1.9.x/server-go/examples/teams/delete-membership.md b/examples/1.9.x/server-go/examples/teams/delete-membership.md index a3f0fd7f3..33fd607e5 100644 --- a/examples/1.9.x/server-go/examples/teams/delete-membership.md +++ b/examples/1.9.x/server-go/examples/teams/delete-membership.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/teams/delete.md b/examples/1.9.x/server-go/examples/teams/delete.md index 2b3cdc695..bd7e7cefc 100644 --- a/examples/1.9.x/server-go/examples/teams/delete.md +++ b/examples/1.9.x/server-go/examples/teams/delete.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/teams/get-membership.md b/examples/1.9.x/server-go/examples/teams/get-membership.md index ab1b9b9a3..0e58ec265 100644 --- a/examples/1.9.x/server-go/examples/teams/get-membership.md +++ b/examples/1.9.x/server-go/examples/teams/get-membership.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/teams/get-prefs.md b/examples/1.9.x/server-go/examples/teams/get-prefs.md index bdfc49d12..07a694feb 100644 --- a/examples/1.9.x/server-go/examples/teams/get-prefs.md +++ b/examples/1.9.x/server-go/examples/teams/get-prefs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/teams/get.md b/examples/1.9.x/server-go/examples/teams/get.md index 647279826..aad11cc0d 100644 --- a/examples/1.9.x/server-go/examples/teams/get.md +++ b/examples/1.9.x/server-go/examples/teams/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/teams/list-memberships.md b/examples/1.9.x/server-go/examples/teams/list-memberships.md index 443b8a991..a5fce4375 100644 --- a/examples/1.9.x/server-go/examples/teams/list-memberships.md +++ b/examples/1.9.x/server-go/examples/teams/list-memberships.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( @@ -17,7 +17,7 @@ service := teams.New(client) response, error := service.ListMemberships( "<TEAM_ID>", - teams.WithListMembershipsQueries([]interface{}{}), + teams.WithListMembershipsQueries([]string{}), teams.WithListMembershipsSearch("<SEARCH>"), teams.WithListMembershipsTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/teams/list.md b/examples/1.9.x/server-go/examples/teams/list.md index 9ba7fdeab..394f7f76f 100644 --- a/examples/1.9.x/server-go/examples/teams/list.md +++ b/examples/1.9.x/server-go/examples/teams/list.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := teams.New(client) response, error := service.List( - teams.WithListQueries([]interface{}{}), + teams.WithListQueries([]string{}), teams.WithListSearch("<SEARCH>"), teams.WithListTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/teams/update-membership-status.md b/examples/1.9.x/server-go/examples/teams/update-membership-status.md index 91d47cbef..d39e54f2c 100644 --- a/examples/1.9.x/server-go/examples/teams/update-membership-status.md +++ b/examples/1.9.x/server-go/examples/teams/update-membership-status.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/teams/update-membership.md b/examples/1.9.x/server-go/examples/teams/update-membership.md index 9769fff22..71bd6b80d 100644 --- a/examples/1.9.x/server-go/examples/teams/update-membership.md +++ b/examples/1.9.x/server-go/examples/teams/update-membership.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( @@ -18,6 +18,6 @@ service := teams.New(client) response, error := service.UpdateMembership( "<TEAM_ID>", "<MEMBERSHIP_ID>", - []interface{}{}, + []string{}, ) ``` diff --git a/examples/1.9.x/server-go/examples/teams/update-name.md b/examples/1.9.x/server-go/examples/teams/update-name.md index 11d37ecca..d010097f9 100644 --- a/examples/1.9.x/server-go/examples/teams/update-name.md +++ b/examples/1.9.x/server-go/examples/teams/update-name.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/teams/update-prefs.md b/examples/1.9.x/server-go/examples/teams/update-prefs.md index 694acd952..da3d47a23 100644 --- a/examples/1.9.x/server-go/examples/teams/update-prefs.md +++ b/examples/1.9.x/server-go/examples/teams/update-prefs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/teams" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/teams" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tokens/create-file-token.md b/examples/1.9.x/server-go/examples/tokens/create-file-token.md index 2b4baa1af..7df82dd73 100644 --- a/examples/1.9.x/server-go/examples/tokens/create-file-token.md +++ b/examples/1.9.x/server-go/examples/tokens/create-file-token.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tokens" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tokens" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tokens/delete.md b/examples/1.9.x/server-go/examples/tokens/delete.md index 981412d5a..363f22a0d 100644 --- a/examples/1.9.x/server-go/examples/tokens/delete.md +++ b/examples/1.9.x/server-go/examples/tokens/delete.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tokens" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tokens" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tokens/get.md b/examples/1.9.x/server-go/examples/tokens/get.md index bca1fce4a..245099a4f 100644 --- a/examples/1.9.x/server-go/examples/tokens/get.md +++ b/examples/1.9.x/server-go/examples/tokens/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tokens" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tokens" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/tokens/list.md b/examples/1.9.x/server-go/examples/tokens/list.md index 625251f18..88f5b9b14 100644 --- a/examples/1.9.x/server-go/examples/tokens/list.md +++ b/examples/1.9.x/server-go/examples/tokens/list.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tokens" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tokens" ) client := client.New( @@ -18,7 +18,7 @@ service := tokens.New(client) response, error := service.List( "<BUCKET_ID>", "<FILE_ID>", - tokens.WithListQueries([]interface{}{}), + tokens.WithListQueries([]string{}), tokens.WithListTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/tokens/update.md b/examples/1.9.x/server-go/examples/tokens/update.md index d32aec1b8..5614aaadd 100644 --- a/examples/1.9.x/server-go/examples/tokens/update.md +++ b/examples/1.9.x/server-go/examples/tokens/update.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/tokens" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/tokens" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/usage/list-events.md b/examples/1.9.x/server-go/examples/usage/list-events.md index 31a95a53c..f685606e8 100644 --- a/examples/1.9.x/server-go/examples/usage/list-events.md +++ b/examples/1.9.x/server-go/examples/usage/list-events.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/usage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/usage" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := usage.New(client) response, error := service.ListEvents( - usage.WithListEventsQueries([]interface{}{}), + usage.WithListEventsQueries([]string{}), usage.WithListEventsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/usage/list-gauges.md b/examples/1.9.x/server-go/examples/usage/list-gauges.md index ddfc62983..a4d47e188 100644 --- a/examples/1.9.x/server-go/examples/usage/list-gauges.md +++ b/examples/1.9.x/server-go/examples/usage/list-gauges.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/usage" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/usage" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := usage.New(client) response, error := service.ListGauges( - usage.WithListGaugesQueries([]interface{}{}), + usage.WithListGaugesQueries([]string{}), usage.WithListGaugesTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/users/create-argon-2-user.md b/examples/1.9.x/server-go/examples/users/create-argon-2-user.md index 07cfb6b3f..b6b54872a 100644 --- a/examples/1.9.x/server-go/examples/users/create-argon-2-user.md +++ b/examples/1.9.x/server-go/examples/users/create-argon-2-user.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create-bcrypt-user.md b/examples/1.9.x/server-go/examples/users/create-bcrypt-user.md index 108224cd0..218246098 100644 --- a/examples/1.9.x/server-go/examples/users/create-bcrypt-user.md +++ b/examples/1.9.x/server-go/examples/users/create-bcrypt-user.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create-jwt.md b/examples/1.9.x/server-go/examples/users/create-jwt.md index d8909ebe4..4b702bdc0 100644 --- a/examples/1.9.x/server-go/examples/users/create-jwt.md +++ b/examples/1.9.x/server-go/examples/users/create-jwt.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create-md-5-user.md b/examples/1.9.x/server-go/examples/users/create-md-5-user.md index 33fdbb6f0..b0bd748c4 100644 --- a/examples/1.9.x/server-go/examples/users/create-md-5-user.md +++ b/examples/1.9.x/server-go/examples/users/create-md-5-user.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create-mfa-recovery-codes.md b/examples/1.9.x/server-go/examples/users/create-mfa-recovery-codes.md index 0a259ae19..47090f89d 100644 --- a/examples/1.9.x/server-go/examples/users/create-mfa-recovery-codes.md +++ b/examples/1.9.x/server-go/examples/users/create-mfa-recovery-codes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create-ph-pass-user.md b/examples/1.9.x/server-go/examples/users/create-ph-pass-user.md index a5e8a4125..58cf9a3c7 100644 --- a/examples/1.9.x/server-go/examples/users/create-ph-pass-user.md +++ b/examples/1.9.x/server-go/examples/users/create-ph-pass-user.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create-scrypt-modified-user.md b/examples/1.9.x/server-go/examples/users/create-scrypt-modified-user.md index 6afa4f8e2..227ce8792 100644 --- a/examples/1.9.x/server-go/examples/users/create-scrypt-modified-user.md +++ b/examples/1.9.x/server-go/examples/users/create-scrypt-modified-user.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create-scrypt-user.md b/examples/1.9.x/server-go/examples/users/create-scrypt-user.md index 60c07a15d..6db686966 100644 --- a/examples/1.9.x/server-go/examples/users/create-scrypt-user.md +++ b/examples/1.9.x/server-go/examples/users/create-scrypt-user.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create-session.md b/examples/1.9.x/server-go/examples/users/create-session.md index 7b807863d..207805957 100644 --- a/examples/1.9.x/server-go/examples/users/create-session.md +++ b/examples/1.9.x/server-go/examples/users/create-session.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create-sha-user.md b/examples/1.9.x/server-go/examples/users/create-sha-user.md index d8df83383..8ee60369b 100644 --- a/examples/1.9.x/server-go/examples/users/create-sha-user.md +++ b/examples/1.9.x/server-go/examples/users/create-sha-user.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create-target.md b/examples/1.9.x/server-go/examples/users/create-target.md index 14926a165..1dc3e2bc5 100644 --- a/examples/1.9.x/server-go/examples/users/create-target.md +++ b/examples/1.9.x/server-go/examples/users/create-target.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create-token.md b/examples/1.9.x/server-go/examples/users/create-token.md index 6e5bdd3d9..9f404bc71 100644 --- a/examples/1.9.x/server-go/examples/users/create-token.md +++ b/examples/1.9.x/server-go/examples/users/create-token.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/create.md b/examples/1.9.x/server-go/examples/users/create.md index cd65e5d85..548440952 100644 --- a/examples/1.9.x/server-go/examples/users/create.md +++ b/examples/1.9.x/server-go/examples/users/create.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( @@ -19,7 +19,7 @@ response, error := service.Create( "<USER_ID>", users.WithCreateEmail("email@example.com"), users.WithCreatePhone("+12065550100"), - users.WithCreatePassword(""), + users.WithCreatePassword("password"), users.WithCreateName("<NAME>"), ) ``` diff --git a/examples/1.9.x/server-go/examples/users/delete-identity.md b/examples/1.9.x/server-go/examples/users/delete-identity.md index d50912663..691433d3f 100644 --- a/examples/1.9.x/server-go/examples/users/delete-identity.md +++ b/examples/1.9.x/server-go/examples/users/delete-identity.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/delete-mfa-authenticator.md b/examples/1.9.x/server-go/examples/users/delete-mfa-authenticator.md index da7213db4..da4cfd869 100644 --- a/examples/1.9.x/server-go/examples/users/delete-mfa-authenticator.md +++ b/examples/1.9.x/server-go/examples/users/delete-mfa-authenticator.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/delete-session.md b/examples/1.9.x/server-go/examples/users/delete-session.md index 2f9b23bef..388c9816c 100644 --- a/examples/1.9.x/server-go/examples/users/delete-session.md +++ b/examples/1.9.x/server-go/examples/users/delete-session.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/delete-sessions.md b/examples/1.9.x/server-go/examples/users/delete-sessions.md index 7ff72df4f..e2c473dbe 100644 --- a/examples/1.9.x/server-go/examples/users/delete-sessions.md +++ b/examples/1.9.x/server-go/examples/users/delete-sessions.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/delete-target.md b/examples/1.9.x/server-go/examples/users/delete-target.md index 55ab0813c..5deef7220 100644 --- a/examples/1.9.x/server-go/examples/users/delete-target.md +++ b/examples/1.9.x/server-go/examples/users/delete-target.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/delete.md b/examples/1.9.x/server-go/examples/users/delete.md index 247266a05..c2ee373d9 100644 --- a/examples/1.9.x/server-go/examples/users/delete.md +++ b/examples/1.9.x/server-go/examples/users/delete.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/get-mfa-recovery-codes.md b/examples/1.9.x/server-go/examples/users/get-mfa-recovery-codes.md index e017e452b..5ee2645fa 100644 --- a/examples/1.9.x/server-go/examples/users/get-mfa-recovery-codes.md +++ b/examples/1.9.x/server-go/examples/users/get-mfa-recovery-codes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/get-prefs.md b/examples/1.9.x/server-go/examples/users/get-prefs.md index e6367519c..b0836ee87 100644 --- a/examples/1.9.x/server-go/examples/users/get-prefs.md +++ b/examples/1.9.x/server-go/examples/users/get-prefs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/get-target.md b/examples/1.9.x/server-go/examples/users/get-target.md index 9a90efdcd..a364d0a3c 100644 --- a/examples/1.9.x/server-go/examples/users/get-target.md +++ b/examples/1.9.x/server-go/examples/users/get-target.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/get.md b/examples/1.9.x/server-go/examples/users/get.md index 9ed504ee1..8a9db7e4a 100644 --- a/examples/1.9.x/server-go/examples/users/get.md +++ b/examples/1.9.x/server-go/examples/users/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/list-identities.md b/examples/1.9.x/server-go/examples/users/list-identities.md index 9a3be96a0..39c2f9a4b 100644 --- a/examples/1.9.x/server-go/examples/users/list-identities.md +++ b/examples/1.9.x/server-go/examples/users/list-identities.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := users.New(client) response, error := service.ListIdentities( - users.WithListIdentitiesQueries([]interface{}{}), + users.WithListIdentitiesQueries([]string{}), users.WithListIdentitiesSearch("<SEARCH>"), users.WithListIdentitiesTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/users/list-logs.md b/examples/1.9.x/server-go/examples/users/list-logs.md index 004a9c2fe..f3f39a8f4 100644 --- a/examples/1.9.x/server-go/examples/users/list-logs.md +++ b/examples/1.9.x/server-go/examples/users/list-logs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( @@ -17,7 +17,7 @@ service := users.New(client) response, error := service.ListLogs( "<USER_ID>", - users.WithListLogsQueries([]interface{}{}), + users.WithListLogsQueries([]string{}), users.WithListLogsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/users/list-memberships.md b/examples/1.9.x/server-go/examples/users/list-memberships.md index 5fce1161f..f3d313499 100644 --- a/examples/1.9.x/server-go/examples/users/list-memberships.md +++ b/examples/1.9.x/server-go/examples/users/list-memberships.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( @@ -17,7 +17,7 @@ service := users.New(client) response, error := service.ListMemberships( "<USER_ID>", - users.WithListMembershipsQueries([]interface{}{}), + users.WithListMembershipsQueries([]string{}), users.WithListMembershipsSearch("<SEARCH>"), users.WithListMembershipsTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/users/list-mfa-factors.md b/examples/1.9.x/server-go/examples/users/list-mfa-factors.md index 9fe69902b..bd6e8bbd7 100644 --- a/examples/1.9.x/server-go/examples/users/list-mfa-factors.md +++ b/examples/1.9.x/server-go/examples/users/list-mfa-factors.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/list-sessions.md b/examples/1.9.x/server-go/examples/users/list-sessions.md index 7dc577ff9..cd4287ffb 100644 --- a/examples/1.9.x/server-go/examples/users/list-sessions.md +++ b/examples/1.9.x/server-go/examples/users/list-sessions.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/list-targets.md b/examples/1.9.x/server-go/examples/users/list-targets.md index 9cd72f40a..db42a08d5 100644 --- a/examples/1.9.x/server-go/examples/users/list-targets.md +++ b/examples/1.9.x/server-go/examples/users/list-targets.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( @@ -17,7 +17,7 @@ service := users.New(client) response, error := service.ListTargets( "<USER_ID>", - users.WithListTargetsQueries([]interface{}{}), + users.WithListTargetsQueries([]string{}), users.WithListTargetsTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/users/list.md b/examples/1.9.x/server-go/examples/users/list.md index 3aee17e35..33911d75a 100644 --- a/examples/1.9.x/server-go/examples/users/list.md +++ b/examples/1.9.x/server-go/examples/users/list.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := users.New(client) response, error := service.List( - users.WithListQueries([]interface{}{}), + users.WithListQueries([]string{}), users.WithListSearch("<SEARCH>"), users.WithListTotal(false), ) diff --git a/examples/1.9.x/server-go/examples/users/update-email-verification.md b/examples/1.9.x/server-go/examples/users/update-email-verification.md index 93daf5204..3aee3c73c 100644 --- a/examples/1.9.x/server-go/examples/users/update-email-verification.md +++ b/examples/1.9.x/server-go/examples/users/update-email-verification.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/update-email.md b/examples/1.9.x/server-go/examples/users/update-email.md index 1e5faf60b..28acdfd8f 100644 --- a/examples/1.9.x/server-go/examples/users/update-email.md +++ b/examples/1.9.x/server-go/examples/users/update-email.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/update-impersonator.md b/examples/1.9.x/server-go/examples/users/update-impersonator.md index 799c1c448..80597b345 100644 --- a/examples/1.9.x/server-go/examples/users/update-impersonator.md +++ b/examples/1.9.x/server-go/examples/users/update-impersonator.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/update-labels.md b/examples/1.9.x/server-go/examples/users/update-labels.md index 7152c40f1..0f8c95d17 100644 --- a/examples/1.9.x/server-go/examples/users/update-labels.md +++ b/examples/1.9.x/server-go/examples/users/update-labels.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( @@ -17,6 +17,6 @@ service := users.New(client) response, error := service.UpdateLabels( "<USER_ID>", - []interface{}{}, + []string{}, ) ``` diff --git a/examples/1.9.x/server-go/examples/users/update-mfa-recovery-codes.md b/examples/1.9.x/server-go/examples/users/update-mfa-recovery-codes.md index 531e88be3..008d8ee24 100644 --- a/examples/1.9.x/server-go/examples/users/update-mfa-recovery-codes.md +++ b/examples/1.9.x/server-go/examples/users/update-mfa-recovery-codes.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/update-mfa.md b/examples/1.9.x/server-go/examples/users/update-mfa.md index ea1653f0c..4016861d3 100644 --- a/examples/1.9.x/server-go/examples/users/update-mfa.md +++ b/examples/1.9.x/server-go/examples/users/update-mfa.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/update-name.md b/examples/1.9.x/server-go/examples/users/update-name.md index 79d069b11..e6bb9f5ae 100644 --- a/examples/1.9.x/server-go/examples/users/update-name.md +++ b/examples/1.9.x/server-go/examples/users/update-name.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/update-password.md b/examples/1.9.x/server-go/examples/users/update-password.md index 4f8f32261..9578a4f55 100644 --- a/examples/1.9.x/server-go/examples/users/update-password.md +++ b/examples/1.9.x/server-go/examples/users/update-password.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( @@ -17,6 +17,6 @@ service := users.New(client) response, error := service.UpdatePassword( "<USER_ID>", - "", + "password", ) ``` diff --git a/examples/1.9.x/server-go/examples/users/update-phone-verification.md b/examples/1.9.x/server-go/examples/users/update-phone-verification.md index 7dee18dca..2c776f093 100644 --- a/examples/1.9.x/server-go/examples/users/update-phone-verification.md +++ b/examples/1.9.x/server-go/examples/users/update-phone-verification.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/update-phone.md b/examples/1.9.x/server-go/examples/users/update-phone.md index 13ff326d5..dfa8e31e8 100644 --- a/examples/1.9.x/server-go/examples/users/update-phone.md +++ b/examples/1.9.x/server-go/examples/users/update-phone.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/update-prefs.md b/examples/1.9.x/server-go/examples/users/update-prefs.md index 28f9d48f6..a79a8f363 100644 --- a/examples/1.9.x/server-go/examples/users/update-prefs.md +++ b/examples/1.9.x/server-go/examples/users/update-prefs.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/update-status.md b/examples/1.9.x/server-go/examples/users/update-status.md index 3a8c0983e..1716adb1c 100644 --- a/examples/1.9.x/server-go/examples/users/update-status.md +++ b/examples/1.9.x/server-go/examples/users/update-status.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/users/update-target.md b/examples/1.9.x/server-go/examples/users/update-target.md index 752f58203..fff4d15b2 100644 --- a/examples/1.9.x/server-go/examples/users/update-target.md +++ b/examples/1.9.x/server-go/examples/users/update-target.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/users" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/users" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/webhooks/create.md b/examples/1.9.x/server-go/examples/webhooks/create.md index afa8e4950..aedf39205 100644 --- a/examples/1.9.x/server-go/examples/webhooks/create.md +++ b/examples/1.9.x/server-go/examples/webhooks/create.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/webhooks" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/webhooks" ) client := client.New( @@ -19,11 +19,11 @@ response, error := service.Create( "<WEBHOOK_ID>", "", "<NAME>", - []interface{}{}, + []string{}, webhooks.WithCreateEnabled(false), webhooks.WithCreateTls(false), webhooks.WithCreateAuthUsername("<AUTH_USERNAME>"), - webhooks.WithCreateAuthPassword("<AUTH_PASSWORD>"), + webhooks.WithCreateAuthPassword("password"), webhooks.WithCreateSecret("<SECRET>"), ) ``` diff --git a/examples/1.9.x/server-go/examples/webhooks/delete.md b/examples/1.9.x/server-go/examples/webhooks/delete.md index c47a589d3..adfcab6d3 100644 --- a/examples/1.9.x/server-go/examples/webhooks/delete.md +++ b/examples/1.9.x/server-go/examples/webhooks/delete.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/webhooks" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/webhooks" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/webhooks/get.md b/examples/1.9.x/server-go/examples/webhooks/get.md index 88771987b..cb0fe72a8 100644 --- a/examples/1.9.x/server-go/examples/webhooks/get.md +++ b/examples/1.9.x/server-go/examples/webhooks/get.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/webhooks" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/webhooks" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/webhooks/list.md b/examples/1.9.x/server-go/examples/webhooks/list.md index 693430671..a0f97568e 100644 --- a/examples/1.9.x/server-go/examples/webhooks/list.md +++ b/examples/1.9.x/server-go/examples/webhooks/list.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/webhooks" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/webhooks" ) client := client.New( @@ -16,7 +16,7 @@ client := client.New( service := webhooks.New(client) response, error := service.List( - webhooks.WithListQueries([]interface{}{}), + webhooks.WithListQueries([]string{}), webhooks.WithListTotal(false), ) ``` diff --git a/examples/1.9.x/server-go/examples/webhooks/update-secret.md b/examples/1.9.x/server-go/examples/webhooks/update-secret.md index 5f63c2630..10140ff62 100644 --- a/examples/1.9.x/server-go/examples/webhooks/update-secret.md +++ b/examples/1.9.x/server-go/examples/webhooks/update-secret.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/webhooks" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/webhooks" ) client := client.New( diff --git a/examples/1.9.x/server-go/examples/webhooks/update.md b/examples/1.9.x/server-go/examples/webhooks/update.md index 7b0b25099..92f47161a 100644 --- a/examples/1.9.x/server-go/examples/webhooks/update.md +++ b/examples/1.9.x/server-go/examples/webhooks/update.md @@ -3,8 +3,8 @@ package main import ( "fmt" - "github.com/appwrite/sdk-for-go/v4/client" - "github.com/appwrite/sdk-for-go/v4/webhooks" + "github.com/appwrite/sdk-for-go/v5/client" + "github.com/appwrite/sdk-for-go/v5/webhooks" ) client := client.New( @@ -19,10 +19,10 @@ response, error := service.Update( "<WEBHOOK_ID>", "<NAME>", "", - []interface{}{}, + []string{}, webhooks.WithUpdateEnabled(false), webhooks.WithUpdateTls(false), webhooks.WithUpdateAuthUsername("<AUTH_USERNAME>"), - webhooks.WithUpdateAuthPassword("<AUTH_PASSWORD>"), + webhooks.WithUpdateAuthPassword("password"), ) ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-anonymous-session.md b/examples/1.9.x/server-graphql/examples/account/create-anonymous-session.md index c040efb8c..f771acf4e 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-anonymous-session.md +++ b/examples/1.9.x/server-graphql/examples/account/create-anonymous-session.md @@ -32,4 +32,37 @@ mutation { mfaUpdatedAt } } +mutation { + accountCreateAnonymousSession { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-email-password-session.md b/examples/1.9.x/server-graphql/examples/account/create-email-password-session.md index c68a4feb2..682c540d6 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-email-password-session.md +++ b/examples/1.9.x/server-graphql/examples/account/create-email-password-session.md @@ -35,4 +35,40 @@ mutation { mfaUpdatedAt } } +mutation { + accountCreateEmailPasswordSession( + email: "email@example.com", + password: "password" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-email-token.md b/examples/1.9.x/server-graphql/examples/account/create-email-token.md index f9db2e2cc..29d694a22 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-email-token.md +++ b/examples/1.9.x/server-graphql/examples/account/create-email-token.md @@ -13,4 +13,18 @@ mutation { phrase } } +mutation { + accountCreateEmailToken( + userId: "<USER_ID>", + email: "email@example.com", + phrase: false + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-email-verification.md b/examples/1.9.x/server-graphql/examples/account/create-email-verification.md index 3a4c559b2..d36352a4e 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-email-verification.md +++ b/examples/1.9.x/server-graphql/examples/account/create-email-verification.md @@ -11,4 +11,16 @@ mutation { phrase } } +mutation { + accountCreateEmailVerification( + url: "https://example.com" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-jwt.md b/examples/1.9.x/server-graphql/examples/account/create-jwt.md index 8bc8f9acd..fab58b5a0 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-jwt.md +++ b/examples/1.9.x/server-graphql/examples/account/create-jwt.md @@ -6,4 +6,11 @@ mutation { jwt } } +mutation { + accountCreateJWT( + duration: 0 + ) { + jwt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-magic-url-token.md b/examples/1.9.x/server-graphql/examples/account/create-magic-url-token.md index 59b2c94f2..619f5f5b3 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-magic-url-token.md +++ b/examples/1.9.x/server-graphql/examples/account/create-magic-url-token.md @@ -14,4 +14,19 @@ mutation { phrase } } +mutation { + accountCreateMagicURLToken( + userId: "<USER_ID>", + email: "email@example.com", + url: "https://example.com", + phrase: false + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-mfa-authenticator.md b/examples/1.9.x/server-graphql/examples/account/create-mfa-authenticator.md index a3920a197..8259085b3 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-mfa-authenticator.md +++ b/examples/1.9.x/server-graphql/examples/account/create-mfa-authenticator.md @@ -7,4 +7,12 @@ mutation { uri } } +mutation { + accountCreateMFAAuthenticator( + type: "totp" + ) { + secret + uri + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-mfa-challenge.md b/examples/1.9.x/server-graphql/examples/account/create-mfa-challenge.md index 3da400f67..e255dfdda 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-mfa-challenge.md +++ b/examples/1.9.x/server-graphql/examples/account/create-mfa-challenge.md @@ -9,4 +9,14 @@ mutation { expire } } +mutation { + accountCreateMFAChallenge( + factor: "email" + ) { + _id + _createdAt + userId + expire + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-mfa-recovery-codes.md b/examples/1.9.x/server-graphql/examples/account/create-mfa-recovery-codes.md index 9f1c3596e..de6cb59fe 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-mfa-recovery-codes.md +++ b/examples/1.9.x/server-graphql/examples/account/create-mfa-recovery-codes.md @@ -4,4 +4,9 @@ mutation { recoveryCodes } } +mutation { + accountCreateMFARecoveryCodes { + recoveryCodes + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-phone-token.md b/examples/1.9.x/server-graphql/examples/account/create-phone-token.md index e382df55c..5fa32b750 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-phone-token.md +++ b/examples/1.9.x/server-graphql/examples/account/create-phone-token.md @@ -12,4 +12,17 @@ mutation { phrase } } +mutation { + accountCreatePhoneToken( + userId: "<USER_ID>", + phone: "+12065550100" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-phone-verification.md b/examples/1.9.x/server-graphql/examples/account/create-phone-verification.md index 88ce51a14..9247f2bd5 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-phone-verification.md +++ b/examples/1.9.x/server-graphql/examples/account/create-phone-verification.md @@ -9,4 +9,14 @@ mutation { phrase } } +mutation { + accountCreatePhoneVerification { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-recovery.md b/examples/1.9.x/server-graphql/examples/account/create-recovery.md index f72f5a653..ac7640295 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-recovery.md +++ b/examples/1.9.x/server-graphql/examples/account/create-recovery.md @@ -12,4 +12,17 @@ mutation { phrase } } +mutation { + accountCreateRecovery( + email: "email@example.com", + url: "https://example.com" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-session.md b/examples/1.9.x/server-graphql/examples/account/create-session.md index b5dda77e1..f7cc421ce 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-session.md +++ b/examples/1.9.x/server-graphql/examples/account/create-session.md @@ -35,4 +35,40 @@ mutation { mfaUpdatedAt } } +mutation { + accountCreateSession( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create-verification.md b/examples/1.9.x/server-graphql/examples/account/create-verification.md index 818efe4dd..1aeeb7d4b 100644 --- a/examples/1.9.x/server-graphql/examples/account/create-verification.md +++ b/examples/1.9.x/server-graphql/examples/account/create-verification.md @@ -11,4 +11,16 @@ mutation { phrase } } +mutation { + accountCreateVerification( + url: "https://example.com" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/create.md b/examples/1.9.x/server-graphql/examples/account/create.md index 290b738cb..bf76897a2 100644 --- a/examples/1.9.x/server-graphql/examples/account/create.md +++ b/examples/1.9.x/server-graphql/examples/account/create.md @@ -3,7 +3,7 @@ mutation { accountCreate( userId: "<USER_ID>", email: "email@example.com", - password: "", + password: "password", name: "<NAME>" ) { _id @@ -20,6 +20,58 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountCreate( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/account/get-mfa-recovery-codes.md b/examples/1.9.x/server-graphql/examples/account/get-mfa-recovery-codes.md index d7962b96e..430d5f42c 100644 --- a/examples/1.9.x/server-graphql/examples/account/get-mfa-recovery-codes.md +++ b/examples/1.9.x/server-graphql/examples/account/get-mfa-recovery-codes.md @@ -1,2 +1,7 @@ ```graphql +query { + accountGetMFARecoveryCodes { + recoveryCodes + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/get-prefs.md b/examples/1.9.x/server-graphql/examples/account/get-prefs.md index d7962b96e..f7920fc2e 100644 --- a/examples/1.9.x/server-graphql/examples/account/get-prefs.md +++ b/examples/1.9.x/server-graphql/examples/account/get-prefs.md @@ -1,2 +1,7 @@ ```graphql +query { + accountGetPrefs { + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/get-session.md b/examples/1.9.x/server-graphql/examples/account/get-session.md index d7962b96e..0ff57c396 100644 --- a/examples/1.9.x/server-graphql/examples/account/get-session.md +++ b/examples/1.9.x/server-graphql/examples/account/get-session.md @@ -1,2 +1,37 @@ ```graphql +query { + accountGetSession( + sessionId: "<SESSION_ID>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/get.md b/examples/1.9.x/server-graphql/examples/account/get.md index d7962b96e..0a4a636d5 100644 --- a/examples/1.9.x/server-graphql/examples/account/get.md +++ b/examples/1.9.x/server-graphql/examples/account/get.md @@ -1,2 +1,44 @@ ```graphql +query { + accountGet { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/list-identities.md b/examples/1.9.x/server-graphql/examples/account/list-identities.md index d7962b96e..237e67175 100644 --- a/examples/1.9.x/server-graphql/examples/account/list-identities.md +++ b/examples/1.9.x/server-graphql/examples/account/list-identities.md @@ -1,2 +1,22 @@ ```graphql +query { + accountListIdentities( + queries: [], + total: false + ) { + total + identities { + _id + _createdAt + _updatedAt + userId + provider + providerUid + providerEmail + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/list-logs.md b/examples/1.9.x/server-graphql/examples/account/list-logs.md index d7962b96e..f7511ee73 100644 --- a/examples/1.9.x/server-graphql/examples/account/list-logs.md +++ b/examples/1.9.x/server-graphql/examples/account/list-logs.md @@ -1,2 +1,34 @@ ```graphql +query { + accountListLogs( + queries: [], + total: false + ) { + total + logs { + event + userId + userEmail + userName + mode + userType + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/list-mfa-factors.md b/examples/1.9.x/server-graphql/examples/account/list-mfa-factors.md index d7962b96e..983822381 100644 --- a/examples/1.9.x/server-graphql/examples/account/list-mfa-factors.md +++ b/examples/1.9.x/server-graphql/examples/account/list-mfa-factors.md @@ -1,2 +1,10 @@ ```graphql +query { + accountListMFAFactors { + totp + phone + email + recoveryCode + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/list-sessions.md b/examples/1.9.x/server-graphql/examples/account/list-sessions.md index d7962b96e..106419a76 100644 --- a/examples/1.9.x/server-graphql/examples/account/list-sessions.md +++ b/examples/1.9.x/server-graphql/examples/account/list-sessions.md @@ -1,2 +1,38 @@ ```graphql +query { + accountListSessions { + total + sessions { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/update-email-verification.md b/examples/1.9.x/server-graphql/examples/account/update-email-verification.md index 9a045dd80..085a14f52 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-email-verification.md +++ b/examples/1.9.x/server-graphql/examples/account/update-email-verification.md @@ -12,4 +12,17 @@ mutation { phrase } } +mutation { + accountUpdateEmailVerification( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/update-email.md b/examples/1.9.x/server-graphql/examples/account/update-email.md index bf4acbad7..7c33c5bff 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-email.md +++ b/examples/1.9.x/server-graphql/examples/account/update-email.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdateEmail( + email: "email@example.com", + password: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/account/update-magic-url-session.md b/examples/1.9.x/server-graphql/examples/account/update-magic-url-session.md index 92ad9693d..5f6fd6643 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-magic-url-session.md +++ b/examples/1.9.x/server-graphql/examples/account/update-magic-url-session.md @@ -35,4 +35,40 @@ mutation { mfaUpdatedAt } } +mutation { + accountUpdateMagicURLSession( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/update-mfa-authenticator.md b/examples/1.9.x/server-graphql/examples/account/update-mfa-authenticator.md index 3d7047ffd..0fbe94edd 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-mfa-authenticator.md +++ b/examples/1.9.x/server-graphql/examples/account/update-mfa-authenticator.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdateMFAAuthenticator( + type: "totp", + otp: "<OTP>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/account/update-mfa-challenge.md b/examples/1.9.x/server-graphql/examples/account/update-mfa-challenge.md index d3a438cf0..f6b1ba366 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-mfa-challenge.md +++ b/examples/1.9.x/server-graphql/examples/account/update-mfa-challenge.md @@ -35,4 +35,40 @@ mutation { mfaUpdatedAt } } +mutation { + accountUpdateMFAChallenge( + challengeId: "<CHALLENGE_ID>", + otp: "<OTP>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/update-mfa-recovery-codes.md b/examples/1.9.x/server-graphql/examples/account/update-mfa-recovery-codes.md index 5f0c5c2d6..185fd26e4 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-mfa-recovery-codes.md +++ b/examples/1.9.x/server-graphql/examples/account/update-mfa-recovery-codes.md @@ -4,4 +4,9 @@ mutation { recoveryCodes } } +mutation { + accountUpdateMFARecoveryCodes { + recoveryCodes + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/update-mfa.md b/examples/1.9.x/server-graphql/examples/account/update-mfa.md index 8b6aa027a..49dda9773 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-mfa.md +++ b/examples/1.9.x/server-graphql/examples/account/update-mfa.md @@ -17,6 +17,55 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdateMFA( + mfa: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/account/update-name.md b/examples/1.9.x/server-graphql/examples/account/update-name.md index 17ec78ab5..2c6ca434c 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-name.md +++ b/examples/1.9.x/server-graphql/examples/account/update-name.md @@ -17,6 +17,55 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdateName( + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/account/update-password.md b/examples/1.9.x/server-graphql/examples/account/update-password.md index 3bd5a356f..fefd26ac2 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-password.md +++ b/examples/1.9.x/server-graphql/examples/account/update-password.md @@ -1,7 +1,7 @@ ```graphql mutation { accountUpdatePassword( - password: "", + password: "password", oldPassword: "password" ) { _id @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdatePassword( + password: "password", + oldPassword: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/account/update-phone-session.md b/examples/1.9.x/server-graphql/examples/account/update-phone-session.md index aa054709d..15dfeb4b1 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-phone-session.md +++ b/examples/1.9.x/server-graphql/examples/account/update-phone-session.md @@ -35,4 +35,40 @@ mutation { mfaUpdatedAt } } +mutation { + accountUpdatePhoneSession( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/update-phone-verification.md b/examples/1.9.x/server-graphql/examples/account/update-phone-verification.md index 2122d41be..405af168f 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-phone-verification.md +++ b/examples/1.9.x/server-graphql/examples/account/update-phone-verification.md @@ -12,4 +12,17 @@ mutation { phrase } } +mutation { + accountUpdatePhoneVerification( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/update-phone.md b/examples/1.9.x/server-graphql/examples/account/update-phone.md index 68806aeef..3bc44ceec 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-phone.md +++ b/examples/1.9.x/server-graphql/examples/account/update-phone.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdatePhone( + phone: "+12065550100", + password: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/account/update-prefs.md b/examples/1.9.x/server-graphql/examples/account/update-prefs.md index b22bbf67e..676eca1e2 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-prefs.md +++ b/examples/1.9.x/server-graphql/examples/account/update-prefs.md @@ -17,6 +17,55 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdatePrefs( + prefs: "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/account/update-recovery.md b/examples/1.9.x/server-graphql/examples/account/update-recovery.md index 90933c165..26b363ec2 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-recovery.md +++ b/examples/1.9.x/server-graphql/examples/account/update-recovery.md @@ -3,7 +3,21 @@ mutation { accountUpdateRecovery( userId: "<USER_ID>", secret: "<SECRET>", - password: "" + password: "password" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} +mutation { + accountUpdateRecovery( + userId: "<USER_ID>", + secret: "<SECRET>", + password: "password" ) { _id _createdAt diff --git a/examples/1.9.x/server-graphql/examples/account/update-session.md b/examples/1.9.x/server-graphql/examples/account/update-session.md index c045df3c1..9958b225a 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-session.md +++ b/examples/1.9.x/server-graphql/examples/account/update-session.md @@ -34,4 +34,39 @@ mutation { mfaUpdatedAt } } +mutation { + accountUpdateSession( + sessionId: "<SESSION_ID>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/account/update-status.md b/examples/1.9.x/server-graphql/examples/account/update-status.md index 13b0d7cec..cd86da7f4 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-status.md +++ b/examples/1.9.x/server-graphql/examples/account/update-status.md @@ -15,6 +15,53 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + accountUpdateStatus { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/account/update-verification.md b/examples/1.9.x/server-graphql/examples/account/update-verification.md index 927ce4953..4af24939b 100644 --- a/examples/1.9.x/server-graphql/examples/account/update-verification.md +++ b/examples/1.9.x/server-graphql/examples/account/update-verification.md @@ -12,4 +12,17 @@ mutation { phrase } } +mutation { + accountUpdateVerification( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/activities/get-event.md b/examples/1.9.x/server-graphql/examples/activities/get-event.md index d7962b96e..be398853b 100644 --- a/examples/1.9.x/server-graphql/examples/activities/get-event.md +++ b/examples/1.9.x/server-graphql/examples/activities/get-event.md @@ -1,2 +1,28 @@ ```graphql +query { + activitiesGetEvent( + eventId: "<EVENT_ID>" + ) { + _id + actorType + actorId + actorEmail + actorName + resourceParent + resourceType + resourceId + resource + event + userAgent + ip + mode + country + time + projectId + teamId + hostname + countryCode + countryName + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/activities/list-events.md b/examples/1.9.x/server-graphql/examples/activities/list-events.md index d7962b96e..f2cd4c135 100644 --- a/examples/1.9.x/server-graphql/examples/activities/list-events.md +++ b/examples/1.9.x/server-graphql/examples/activities/list-events.md @@ -1,2 +1,31 @@ ```graphql +query { + activitiesListEvents( + queries: "" + ) { + total + events { + _id + actorType + actorId + actorEmail + actorName + resourceParent + resourceType + resourceId + resource + event + userAgent + ip + mode + country + time + projectId + teamId + hostname + countryCode + countryName + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/advisor/get-insight.md b/examples/1.9.x/server-graphql/examples/advisor/get-insight.md index d7962b96e..17316e591 100644 --- a/examples/1.9.x/server-graphql/examples/advisor/get-insight.md +++ b/examples/1.9.x/server-graphql/examples/advisor/get-insight.md @@ -1,2 +1,31 @@ ```graphql +query { + advisorGetInsight( + reportId: "<REPORT_ID>", + insightId: "<INSIGHT_ID>" + ) { + _id + _createdAt + _updatedAt + reportId + type + severity + status + resourceType + resourceId + parentResourceType + parentResourceId + title + summary + ctas { + label + service + method + params + } + analyzedAt + dismissedAt + dismissedBy + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/advisor/get-report.md b/examples/1.9.x/server-graphql/examples/advisor/get-report.md index d7962b96e..0078ee661 100644 --- a/examples/1.9.x/server-graphql/examples/advisor/get-report.md +++ b/examples/1.9.x/server-graphql/examples/advisor/get-report.md @@ -1,2 +1,43 @@ ```graphql +query { + advisorGetReport( + reportId: "<REPORT_ID>" + ) { + _id + _createdAt + _updatedAt + appId + type + title + summary + targetType + target + categories + insights { + _id + _createdAt + _updatedAt + reportId + type + severity + status + resourceType + resourceId + parentResourceType + parentResourceId + title + summary + ctas { + label + service + method + params + } + analyzedAt + dismissedAt + dismissedBy + } + analyzedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/advisor/list-insights.md b/examples/1.9.x/server-graphql/examples/advisor/list-insights.md index d7962b96e..15d57638d 100644 --- a/examples/1.9.x/server-graphql/examples/advisor/list-insights.md +++ b/examples/1.9.x/server-graphql/examples/advisor/list-insights.md @@ -1,2 +1,35 @@ ```graphql +query { + advisorListInsights( + reportId: "<REPORT_ID>", + queries: [], + total: false + ) { + total + insights { + _id + _createdAt + _updatedAt + reportId + type + severity + status + resourceType + resourceId + parentResourceType + parentResourceId + title + summary + ctas { + label + service + method + params + } + analyzedAt + dismissedAt + dismissedBy + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/advisor/list-reports.md b/examples/1.9.x/server-graphql/examples/advisor/list-reports.md index d7962b96e..a33af1167 100644 --- a/examples/1.9.x/server-graphql/examples/advisor/list-reports.md +++ b/examples/1.9.x/server-graphql/examples/advisor/list-reports.md @@ -1,2 +1,47 @@ ```graphql +query { + advisorListReports( + queries: [], + total: false + ) { + total + reports { + _id + _createdAt + _updatedAt + appId + type + title + summary + targetType + target + categories + insights { + _id + _createdAt + _updatedAt + reportId + type + severity + status + resourceType + resourceId + parentResourceType + parentResourceId + title + summary + ctas { + label + service + method + params + } + analyzedAt + dismissedAt + dismissedBy + } + analyzedAt + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/avatars/get-browser.md b/examples/1.9.x/server-graphql/examples/avatars/get-browser.md index d7962b96e..2f432681b 100644 --- a/examples/1.9.x/server-graphql/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-graphql/examples/avatars/get-browser.md @@ -1,2 +1,12 @@ ```graphql +query { + avatarsGetBrowser( + code: "aa", + width: 0, + height: 0, + quality: -1 + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/avatars/get-credit-card.md b/examples/1.9.x/server-graphql/examples/avatars/get-credit-card.md index d7962b96e..952c23021 100644 --- a/examples/1.9.x/server-graphql/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-graphql/examples/avatars/get-credit-card.md @@ -1,2 +1,12 @@ ```graphql +query { + avatarsGetCreditCard( + code: "amex", + width: 0, + height: 0, + quality: -1 + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/avatars/get-favicon.md b/examples/1.9.x/server-graphql/examples/avatars/get-favicon.md index d7962b96e..22653ab58 100644 --- a/examples/1.9.x/server-graphql/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-graphql/examples/avatars/get-favicon.md @@ -1,2 +1,9 @@ ```graphql +query { + avatarsGetFavicon( + url: "https://example.com" + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/avatars/get-flag.md b/examples/1.9.x/server-graphql/examples/avatars/get-flag.md index d7962b96e..6444e6988 100644 --- a/examples/1.9.x/server-graphql/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-graphql/examples/avatars/get-flag.md @@ -1,2 +1,12 @@ ```graphql +query { + avatarsGetFlag( + code: "af", + width: 0, + height: 0, + quality: -1 + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/avatars/get-image.md b/examples/1.9.x/server-graphql/examples/avatars/get-image.md index d7962b96e..8acc02134 100644 --- a/examples/1.9.x/server-graphql/examples/avatars/get-image.md +++ b/examples/1.9.x/server-graphql/examples/avatars/get-image.md @@ -1,2 +1,11 @@ ```graphql +query { + avatarsGetImage( + url: "https://example.com", + width: 0, + height: 0 + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/avatars/get-initials.md b/examples/1.9.x/server-graphql/examples/avatars/get-initials.md index d7962b96e..f848f5522 100644 --- a/examples/1.9.x/server-graphql/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-graphql/examples/avatars/get-initials.md @@ -1,2 +1,12 @@ ```graphql +query { + avatarsGetInitials( + name: "<NAME>", + width: 0, + height: 0, + background: "" + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/avatars/get-qr.md b/examples/1.9.x/server-graphql/examples/avatars/get-qr.md index d7962b96e..9206b404e 100644 --- a/examples/1.9.x/server-graphql/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-graphql/examples/avatars/get-qr.md @@ -1,2 +1,12 @@ ```graphql +query { + avatarsGetQR( + text: "<TEXT>", + size: 1, + margin: 0, + download: false + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/avatars/get-screenshot.md b/examples/1.9.x/server-graphql/examples/avatars/get-screenshot.md index d7962b96e..c6ca96301 100644 --- a/examples/1.9.x/server-graphql/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-graphql/examples/avatars/get-screenshot.md @@ -1,2 +1,28 @@ ```graphql +query { + avatarsGetScreenshot( + url: "https://example.com", + headers: "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}", + viewportWidth: 1920, + viewportHeight: 1080, + scale: 2, + theme: "dark", + userAgent: "Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15", + fullpage: true, + locale: "en-US", + timezone: "America/New_York", + latitude: 37.7749, + longitude: -122.4194, + accuracy: 100, + touch: true, + permissions: ["geolocation","notifications"], + sleep: 3, + width: 800, + height: 600, + quality: 85, + output: "jpeg" + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/create-archive.md b/examples/1.9.x/server-graphql/examples/backups/create-archive.md index 1187cd0a6..5cbc7960b 100644 --- a/examples/1.9.x/server-graphql/examples/backups/create-archive.md +++ b/examples/1.9.x/server-graphql/examples/backups/create-archive.md @@ -18,4 +18,23 @@ mutation { resourceType } } +mutation { + backupsCreateArchive( + services: [], + resourceId: "<RESOURCE_ID>" + ) { + _id + _createdAt + _updatedAt + policyId + size + status + startedAt + migrationId + services + resources + resourceId + resourceType + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/create-policy.md b/examples/1.9.x/server-graphql/examples/backups/create-policy.md index 19caed7be..7c84b13b1 100644 --- a/examples/1.9.x/server-graphql/examples/backups/create-policy.md +++ b/examples/1.9.x/server-graphql/examples/backups/create-policy.md @@ -22,4 +22,27 @@ mutation { enabled } } +mutation { + backupsCreatePolicy( + policyId: "<POLICY_ID>", + services: [], + retention: 1, + schedule: "", + name: "<NAME>", + resourceId: "<RESOURCE_ID>", + enabled: false + ) { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/create-restoration.md b/examples/1.9.x/server-graphql/examples/backups/create-restoration.md index 3ad263c6c..133676c63 100644 --- a/examples/1.9.x/server-graphql/examples/backups/create-restoration.md +++ b/examples/1.9.x/server-graphql/examples/backups/create-restoration.md @@ -19,4 +19,24 @@ mutation { options } } +mutation { + backupsCreateRestoration( + archiveId: "<ARCHIVE_ID>", + services: [], + newResourceId: "<NEW_RESOURCE_ID>", + newResourceName: "<NEW_RESOURCE_NAME>" + ) { + _id + _createdAt + _updatedAt + archiveId + policyId + status + startedAt + migrationId + services + resources + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/delete-archive.md b/examples/1.9.x/server-graphql/examples/backups/delete-archive.md index be1cd1bae..2d207bb60 100644 --- a/examples/1.9.x/server-graphql/examples/backups/delete-archive.md +++ b/examples/1.9.x/server-graphql/examples/backups/delete-archive.md @@ -6,4 +6,11 @@ mutation { status } } +mutation { + backupsDeleteArchive( + archiveId: "<ARCHIVE_ID>" + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/delete-policy.md b/examples/1.9.x/server-graphql/examples/backups/delete-policy.md index 7a897aae6..86d452df7 100644 --- a/examples/1.9.x/server-graphql/examples/backups/delete-policy.md +++ b/examples/1.9.x/server-graphql/examples/backups/delete-policy.md @@ -6,4 +6,11 @@ mutation { status } } +mutation { + backupsDeletePolicy( + policyId: "<POLICY_ID>" + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/get-archive.md b/examples/1.9.x/server-graphql/examples/backups/get-archive.md index d7962b96e..f6a74a4ca 100644 --- a/examples/1.9.x/server-graphql/examples/backups/get-archive.md +++ b/examples/1.9.x/server-graphql/examples/backups/get-archive.md @@ -1,2 +1,20 @@ ```graphql +query { + backupsGetArchive( + archiveId: "<ARCHIVE_ID>" + ) { + _id + _createdAt + _updatedAt + policyId + size + status + startedAt + migrationId + services + resources + resourceId + resourceType + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/get-policy.md b/examples/1.9.x/server-graphql/examples/backups/get-policy.md index d7962b96e..f5b45ea2b 100644 --- a/examples/1.9.x/server-graphql/examples/backups/get-policy.md +++ b/examples/1.9.x/server-graphql/examples/backups/get-policy.md @@ -1,2 +1,19 @@ ```graphql +query { + backupsGetPolicy( + policyId: "<POLICY_ID>" + ) { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/get-restoration.md b/examples/1.9.x/server-graphql/examples/backups/get-restoration.md index d7962b96e..d55bc4843 100644 --- a/examples/1.9.x/server-graphql/examples/backups/get-restoration.md +++ b/examples/1.9.x/server-graphql/examples/backups/get-restoration.md @@ -1,2 +1,19 @@ ```graphql +query { + backupsGetRestoration( + restorationId: "<RESTORATION_ID>" + ) { + _id + _createdAt + _updatedAt + archiveId + policyId + status + startedAt + migrationId + services + resources + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/list-archives.md b/examples/1.9.x/server-graphql/examples/backups/list-archives.md index d7962b96e..756317a70 100644 --- a/examples/1.9.x/server-graphql/examples/backups/list-archives.md +++ b/examples/1.9.x/server-graphql/examples/backups/list-archives.md @@ -1,2 +1,23 @@ ```graphql +query { + backupsListArchives( + queries: [] + ) { + total + archives { + _id + _createdAt + _updatedAt + policyId + size + status + startedAt + migrationId + services + resources + resourceId + resourceType + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/list-policies.md b/examples/1.9.x/server-graphql/examples/backups/list-policies.md index d7962b96e..a10dceb35 100644 --- a/examples/1.9.x/server-graphql/examples/backups/list-policies.md +++ b/examples/1.9.x/server-graphql/examples/backups/list-policies.md @@ -1,2 +1,22 @@ ```graphql +query { + backupsListPolicies( + queries: [] + ) { + total + policies { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/list-restorations.md b/examples/1.9.x/server-graphql/examples/backups/list-restorations.md index d7962b96e..31fcb99ad 100644 --- a/examples/1.9.x/server-graphql/examples/backups/list-restorations.md +++ b/examples/1.9.x/server-graphql/examples/backups/list-restorations.md @@ -1,2 +1,22 @@ ```graphql +query { + backupsListRestorations( + queries: [] + ) { + total + restorations { + _id + _createdAt + _updatedAt + archiveId + policyId + status + startedAt + migrationId + services + resources + options + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/update-policy.md b/examples/1.9.x/server-graphql/examples/backups/update-policy.md index f1485b2b1..c15935837 100644 --- a/examples/1.9.x/server-graphql/examples/backups/update-policy.md +++ b/examples/1.9.x/server-graphql/examples/backups/update-policy.md @@ -20,4 +20,25 @@ mutation { enabled } } +mutation { + backupsUpdatePolicy( + policyId: "<POLICY_ID>", + name: "<NAME>", + retention: 1, + schedule: "", + enabled: false + ) { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-big-int-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-big-int-attribute.md index a5f567e5a..478235cee 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-big-int-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-big-int-attribute.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + databasesCreateBigIntAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0, + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-boolean-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-boolean-attribute.md index a75e61bc1..4e9e22c13 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-boolean-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-boolean-attribute.md @@ -19,4 +19,24 @@ mutation { default } } +mutation { + databasesCreateBooleanAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: false, + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-collection.md b/examples/1.9.x/server-graphql/examples/databases/create-collection.md index d63c4cb88..384764785 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-collection.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-collection.md @@ -35,4 +35,40 @@ mutation { bytesUsed } } +mutation { + databasesCreateCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + name: "<NAME>", + permissions: ["read("any")"], + documentSecurity: false, + enabled: false, + attributes: [], + indexes: [] + ) { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + documentSecurity + attributes + indexes { + _id + _createdAt + _updatedAt + key + type + status + error + attributes + lengths + orders + } + bytesMax + bytesUsed + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-datetime-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-datetime-attribute.md index 768e6e0b5..57b2a9600 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-datetime-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-datetime-attribute.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + databasesCreateDatetimeAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "2020-10-15T06:38:00.000+00:00", + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-document.md b/examples/1.9.x/server-graphql/examples/databases/create-document.md index a4a363b97..c5ce65ab3 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-document.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-document.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + databasesCreateDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-documents.md b/examples/1.9.x/server-graphql/examples/databases/create-documents.md index 67d038e93..98774df31 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-documents.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-documents.md @@ -19,4 +19,24 @@ mutation { } } } +mutation { + databasesCreateDocuments( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documents: [], + transactionId: "<TRANSACTION_ID>" + ) { + total + documents { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-email-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-email-attribute.md index 12586b17a..b8e076fe5 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-email-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-email-attribute.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + databasesCreateEmailAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "email@example.com", + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-enum-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-enum-attribute.md index cc0dda3be..e4a608442 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-enum-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-enum-attribute.md @@ -22,4 +22,27 @@ mutation { default } } +mutation { + databasesCreateEnumAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + elements: [], + required: false, + default: "<DEFAULT>", + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + elements + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-float-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-float-attribute.md index 062eaacb6..6b54d97de 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-float-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-float-attribute.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + databasesCreateFloatAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0, + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-index.md b/examples/1.9.x/server-graphql/examples/databases/create-index.md index 78bb8ac69..a6446a7b7 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-index.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-index.md @@ -21,4 +21,26 @@ mutation { orders } } +mutation { + databasesCreateIndex( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + type: "key", + attributes: [], + orders: [], + lengths: [] + ) { + _id + _createdAt + _updatedAt + key + type + status + error + attributes + lengths + orders + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-integer-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-integer-attribute.md index 9782ca044..6b447cb19 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-integer-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-integer-attribute.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + databasesCreateIntegerAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0, + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-ip-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-ip-attribute.md index 330f4cb06..15739e3e9 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-ip-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-ip-attribute.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + databasesCreateIpAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "", + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-line-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-line-attribute.md index 8a5acc52b..dc2d2da8d 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-line-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-line-attribute.md @@ -18,4 +18,23 @@ mutation { default } } +mutation { + databasesCreateLineAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: [[1, 2], [3, 4], [5, 6]] + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-longtext-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-longtext-attribute.md index d7da3177d..828c8af8f 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-longtext-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-longtext-attribute.md @@ -21,4 +21,26 @@ mutation { encrypt } } +mutation { + databasesCreateLongtextAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "<DEFAULT>", + array: false, + encrypt: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-mediumtext-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-mediumtext-attribute.md index 14bd2124b..0a7f0bf10 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-mediumtext-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-mediumtext-attribute.md @@ -21,4 +21,26 @@ mutation { encrypt } } +mutation { + databasesCreateMediumtextAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "<DEFAULT>", + array: false, + encrypt: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-operations.md b/examples/1.9.x/server-graphql/examples/databases/create-operations.md index 7fa29cf3f..cada6c2d6 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-operations.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-operations.md @@ -22,4 +22,27 @@ mutation { expiresAt } } +mutation { + databasesCreateOperations( + transactionId: "<TRANSACTION_ID>", + operations: [ + { + "action": "create", + "databaseId": "<DATABASE_ID>", + "collectionId": "<COLLECTION_ID>", + "documentId": "<DOCUMENT_ID>", + "data": { + "name": "Walter O'Brien" + } + } + ] + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-point-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-point-attribute.md index 72cd57c90..f3c49a1d5 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-point-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-point-attribute.md @@ -18,4 +18,23 @@ mutation { default } } +mutation { + databasesCreatePointAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: [1, 2] + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-polygon-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-polygon-attribute.md index 620002d4b..fe189f407 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-polygon-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-polygon-attribute.md @@ -18,4 +18,23 @@ mutation { default } } +mutation { + databasesCreatePolygonAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: [[[1, 2], [3, 4], [5, 6], [1, 2]]] + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-relationship-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-relationship-attribute.md index 6e9dbaf32..ed1a13033 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-relationship-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-relationship-attribute.md @@ -26,4 +26,31 @@ mutation { side } } +mutation { + databasesCreateRelationshipAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + relatedCollectionId: "<RELATED_COLLECTION_ID>", + type: "oneToOne", + twoWay: false, + key: "", + twoWayKey: "", + onDelete: "cascade" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + relatedCollection + relationType + twoWay + twoWayKey + onDelete + side + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-string-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-string-attribute.md index 53d5225e7..0515dddbd 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-string-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-string-attribute.md @@ -23,4 +23,28 @@ mutation { encrypt } } +mutation { + databasesCreateStringAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + size: 1, + required: false, + default: "<DEFAULT>", + array: false, + encrypt: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + size + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-text-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-text-attribute.md index 99886f759..e0dce0d83 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-text-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-text-attribute.md @@ -21,4 +21,26 @@ mutation { encrypt } } +mutation { + databasesCreateTextAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "<DEFAULT>", + array: false, + encrypt: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-transaction.md b/examples/1.9.x/server-graphql/examples/databases/create-transaction.md index d28f2eadc..6d2952505 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-transaction.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-transaction.md @@ -11,4 +11,16 @@ mutation { expiresAt } } +mutation { + databasesCreateTransaction( + ttl: 60 + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-url-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-url-attribute.md index 84d914378..6ddc4b6f9 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-url-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-url-attribute.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + databasesCreateUrlAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "https://example.com", + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create-varchar-attribute.md b/examples/1.9.x/server-graphql/examples/databases/create-varchar-attribute.md index 1ef50d0e0..8ab470a3f 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create-varchar-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/create-varchar-attribute.md @@ -23,4 +23,28 @@ mutation { encrypt } } +mutation { + databasesCreateVarcharAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + size: 1, + required: false, + default: "<DEFAULT>", + array: false, + encrypt: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + size + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/create.md b/examples/1.9.x/server-graphql/examples/databases/create.md index 33c40ae14..7e1b86cb3 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create.md +++ b/examples/1.9.x/server-graphql/examples/databases/create.md @@ -40,4 +40,45 @@ mutation { } } } +mutation { + databasesCreate( + databaseId: "<DATABASE_ID>", + name: "<NAME>", + enabled: false + ) { + _id + name + _createdAt + _updatedAt + enabled + type + policies { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } + archives { + _id + _createdAt + _updatedAt + policyId + size + status + startedAt + migrationId + services + resources + resourceId + resourceType + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/decrement-document-attribute.md b/examples/1.9.x/server-graphql/examples/databases/decrement-document-attribute.md index 4db00c0ae..e07463054 100644 --- a/examples/1.9.x/server-graphql/examples/databases/decrement-document-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/decrement-document-attribute.md @@ -19,4 +19,24 @@ mutation { data } } +mutation { + databasesDecrementDocumentAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + attribute: "", + value: 0, + min: 0, + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/delete-documents.md b/examples/1.9.x/server-graphql/examples/databases/delete-documents.md index 6cf4405ca..57b3e8f4c 100644 --- a/examples/1.9.x/server-graphql/examples/databases/delete-documents.md +++ b/examples/1.9.x/server-graphql/examples/databases/delete-documents.md @@ -19,4 +19,24 @@ mutation { } } } +mutation { + databasesDeleteDocuments( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [], + transactionId: "<TRANSACTION_ID>" + ) { + total + documents { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/get-attribute.md b/examples/1.9.x/server-graphql/examples/databases/get-attribute.md index d7962b96e..fad7189fc 100644 --- a/examples/1.9.x/server-graphql/examples/databases/get-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/get-attribute.md @@ -1,2 +1,19 @@ ```graphql +query { + databasesGetAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/get-collection.md b/examples/1.9.x/server-graphql/examples/databases/get-collection.md index d7962b96e..2e83ac46d 100644 --- a/examples/1.9.x/server-graphql/examples/databases/get-collection.md +++ b/examples/1.9.x/server-graphql/examples/databases/get-collection.md @@ -1,2 +1,32 @@ ```graphql +query { + databasesGetCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>" + ) { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + documentSecurity + attributes + indexes { + _id + _createdAt + _updatedAt + key + type + status + error + attributes + lengths + orders + } + bytesMax + bytesUsed + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/get-document.md b/examples/1.9.x/server-graphql/examples/databases/get-document.md index d7962b96e..e188dee38 100644 --- a/examples/1.9.x/server-graphql/examples/databases/get-document.md +++ b/examples/1.9.x/server-graphql/examples/databases/get-document.md @@ -1,2 +1,20 @@ ```graphql +query { + databasesGetDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + queries: [], + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/get-index.md b/examples/1.9.x/server-graphql/examples/databases/get-index.md index d7962b96e..9456e7ee1 100644 --- a/examples/1.9.x/server-graphql/examples/databases/get-index.md +++ b/examples/1.9.x/server-graphql/examples/databases/get-index.md @@ -1,2 +1,20 @@ ```graphql +query { + databasesGetIndex( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" + ) { + _id + _createdAt + _updatedAt + key + type + status + error + attributes + lengths + orders + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/get-transaction.md b/examples/1.9.x/server-graphql/examples/databases/get-transaction.md index d7962b96e..001554140 100644 --- a/examples/1.9.x/server-graphql/examples/databases/get-transaction.md +++ b/examples/1.9.x/server-graphql/examples/databases/get-transaction.md @@ -1,2 +1,14 @@ ```graphql +query { + databasesGetTransaction( + transactionId: "<TRANSACTION_ID>" + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/get.md b/examples/1.9.x/server-graphql/examples/databases/get.md index d7962b96e..31c3a4d64 100644 --- a/examples/1.9.x/server-graphql/examples/databases/get.md +++ b/examples/1.9.x/server-graphql/examples/databases/get.md @@ -1,2 +1,41 @@ ```graphql +query { + databasesGet( + databaseId: "<DATABASE_ID>" + ) { + _id + name + _createdAt + _updatedAt + enabled + type + policies { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } + archives { + _id + _createdAt + _updatedAt + policyId + size + status + startedAt + migrationId + services + resources + resourceId + resourceType + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/increment-document-attribute.md b/examples/1.9.x/server-graphql/examples/databases/increment-document-attribute.md index 58e462f58..7873727fa 100644 --- a/examples/1.9.x/server-graphql/examples/databases/increment-document-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/increment-document-attribute.md @@ -19,4 +19,24 @@ mutation { data } } +mutation { + databasesIncrementDocumentAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + attribute: "", + value: 0, + max: 0, + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/list-attributes.md b/examples/1.9.x/server-graphql/examples/databases/list-attributes.md index d7962b96e..c8a93ecb8 100644 --- a/examples/1.9.x/server-graphql/examples/databases/list-attributes.md +++ b/examples/1.9.x/server-graphql/examples/databases/list-attributes.md @@ -1,2 +1,13 @@ ```graphql +query { + databasesListAttributes( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [], + total: false + ) { + total + attributes + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/list-collections.md b/examples/1.9.x/server-graphql/examples/databases/list-collections.md index d7962b96e..804545134 100644 --- a/examples/1.9.x/server-graphql/examples/databases/list-collections.md +++ b/examples/1.9.x/server-graphql/examples/databases/list-collections.md @@ -1,2 +1,37 @@ ```graphql +query { + databasesListCollections( + databaseId: "<DATABASE_ID>", + queries: [], + search: "<SEARCH>", + total: false + ) { + total + collections { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + documentSecurity + attributes + indexes { + _id + _createdAt + _updatedAt + key + type + status + error + attributes + lengths + orders + } + bytesMax + bytesUsed + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/list-documents.md b/examples/1.9.x/server-graphql/examples/databases/list-documents.md index d7962b96e..d0e331d0e 100644 --- a/examples/1.9.x/server-graphql/examples/databases/list-documents.md +++ b/examples/1.9.x/server-graphql/examples/databases/list-documents.md @@ -1,2 +1,24 @@ ```graphql +query { + databasesListDocuments( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [], + transactionId: "<TRANSACTION_ID>", + total: false, + ttl: 0 + ) { + total + documents { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/list-indexes.md b/examples/1.9.x/server-graphql/examples/databases/list-indexes.md index d7962b96e..a6ab75e12 100644 --- a/examples/1.9.x/server-graphql/examples/databases/list-indexes.md +++ b/examples/1.9.x/server-graphql/examples/databases/list-indexes.md @@ -1,2 +1,24 @@ ```graphql +query { + databasesListIndexes( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [], + total: false + ) { + total + indexes { + _id + _createdAt + _updatedAt + key + type + status + error + attributes + lengths + orders + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/list-transactions.md b/examples/1.9.x/server-graphql/examples/databases/list-transactions.md index d7962b96e..2fc18db35 100644 --- a/examples/1.9.x/server-graphql/examples/databases/list-transactions.md +++ b/examples/1.9.x/server-graphql/examples/databases/list-transactions.md @@ -1,2 +1,17 @@ ```graphql +query { + databasesListTransactions( + queries: [] + ) { + total + transactions { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/list.md b/examples/1.9.x/server-graphql/examples/databases/list.md index d7962b96e..f9e43f5dc 100644 --- a/examples/1.9.x/server-graphql/examples/databases/list.md +++ b/examples/1.9.x/server-graphql/examples/databases/list.md @@ -1,2 +1,46 @@ ```graphql +query { + databasesList( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + databases { + _id + name + _createdAt + _updatedAt + enabled + type + policies { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } + archives { + _id + _createdAt + _updatedAt + policyId + size + status + startedAt + migrationId + services + resources + resourceId + resourceType + } + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-big-int-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-big-int-attribute.md index c82da0b44..23aa6118e 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-big-int-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-big-int-attribute.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + databasesUpdateBigIntAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: 0, + min: 0, + max: 0, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-boolean-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-boolean-attribute.md index 7992c1b40..60e68ad8a 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-boolean-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-boolean-attribute.md @@ -19,4 +19,24 @@ mutation { default } } +mutation { + databasesUpdateBooleanAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: false, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-collection.md b/examples/1.9.x/server-graphql/examples/databases/update-collection.md index e318ff696..82dfbb746 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-collection.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-collection.md @@ -34,4 +34,39 @@ mutation { bytesUsed } } +mutation { + databasesUpdateCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + name: "<NAME>", + permissions: ["read("any")"], + documentSecurity: false, + enabled: false, + purge: false + ) { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + documentSecurity + attributes + indexes { + _id + _createdAt + _updatedAt + key + type + status + error + attributes + lengths + orders + } + bytesMax + bytesUsed + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-datetime-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-datetime-attribute.md index 2c12f2c20..49c12f19e 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-datetime-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-datetime-attribute.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + databasesUpdateDatetimeAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "2020-10-15T06:38:00.000+00:00", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-document.md b/examples/1.9.x/server-graphql/examples/databases/update-document.md index fc1ce5cb1..7d2308817 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-document.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-document.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + databasesUpdateDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-documents.md b/examples/1.9.x/server-graphql/examples/databases/update-documents.md index b9773fce2..f0ed26444 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-documents.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-documents.md @@ -20,4 +20,25 @@ mutation { } } } +mutation { + databasesUpdateDocuments( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}", + queries: [], + transactionId: "<TRANSACTION_ID>" + ) { + total + documents { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-email-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-email-attribute.md index 8c4c012a4..ee95443ce 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-email-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-email-attribute.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + databasesUpdateEmailAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "email@example.com", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-enum-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-enum-attribute.md index ed85916ab..803bf30d8 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-enum-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-enum-attribute.md @@ -22,4 +22,27 @@ mutation { default } } +mutation { + databasesUpdateEnumAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + elements: [], + required: false, + default: "<DEFAULT>", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + elements + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-float-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-float-attribute.md index 58a159664..6e6e08d15 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-float-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-float-attribute.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + databasesUpdateFloatAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: 0, + min: 0, + max: 0, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-integer-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-integer-attribute.md index fb4fe9c45..5bd6e0f56 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-integer-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-integer-attribute.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + databasesUpdateIntegerAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: 0, + min: 0, + max: 0, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-ip-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-ip-attribute.md index e47961103..b1cd24fa4 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-ip-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-ip-attribute.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + databasesUpdateIpAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-line-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-line-attribute.md index 9553f8e28..49f089cff 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-line-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-line-attribute.md @@ -19,4 +19,24 @@ mutation { default } } +mutation { + databasesUpdateLineAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: [[1, 2], [3, 4], [5, 6]], + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-longtext-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-longtext-attribute.md index c1dcb6bd4..7fdf7290d 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-longtext-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-longtext-attribute.md @@ -20,4 +20,25 @@ mutation { encrypt } } +mutation { + databasesUpdateLongtextAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "<DEFAULT>", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-mediumtext-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-mediumtext-attribute.md index aa15b6526..f1c30dfe4 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-mediumtext-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-mediumtext-attribute.md @@ -20,4 +20,25 @@ mutation { encrypt } } +mutation { + databasesUpdateMediumtextAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "<DEFAULT>", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-point-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-point-attribute.md index c1cda34f5..1d4979425 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-point-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-point-attribute.md @@ -19,4 +19,24 @@ mutation { default } } +mutation { + databasesUpdatePointAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: [1, 2], + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-polygon-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-polygon-attribute.md index eecd7d3a5..057d99d6d 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-polygon-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-polygon-attribute.md @@ -19,4 +19,24 @@ mutation { default } } +mutation { + databasesUpdatePolygonAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: [[[1, 2], [3, 4], [5, 6], [1, 2]]], + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-relationship-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-relationship-attribute.md index 9a8515029..c871f5017 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-relationship-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-relationship-attribute.md @@ -23,4 +23,28 @@ mutation { side } } +mutation { + databasesUpdateRelationshipAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + onDelete: "cascade", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + relatedCollection + relationType + twoWay + twoWayKey + onDelete + side + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-string-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-string-attribute.md index ff3151f9c..8cd435050 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-string-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-string-attribute.md @@ -22,4 +22,27 @@ mutation { encrypt } } +mutation { + databasesUpdateStringAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "<DEFAULT>", + size: 1, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + size + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-text-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-text-attribute.md index ef7c63642..105289f70 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-text-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-text-attribute.md @@ -20,4 +20,25 @@ mutation { encrypt } } +mutation { + databasesUpdateTextAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "<DEFAULT>", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-transaction.md b/examples/1.9.x/server-graphql/examples/databases/update-transaction.md index a2d8cb145..866cdb4d5 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-transaction.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-transaction.md @@ -13,4 +13,18 @@ mutation { expiresAt } } +mutation { + databasesUpdateTransaction( + transactionId: "<TRANSACTION_ID>", + commit: false, + rollback: false + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-url-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-url-attribute.md index 7b8c47092..27a6d3d85 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-url-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-url-attribute.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + databasesUpdateUrlAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "https://example.com", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update-varchar-attribute.md b/examples/1.9.x/server-graphql/examples/databases/update-varchar-attribute.md index a64950d9d..00b068255 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update-varchar-attribute.md +++ b/examples/1.9.x/server-graphql/examples/databases/update-varchar-attribute.md @@ -22,4 +22,27 @@ mutation { encrypt } } +mutation { + databasesUpdateVarcharAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "<DEFAULT>", + size: 1, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + size + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/update.md b/examples/1.9.x/server-graphql/examples/databases/update.md index 5e15c5d20..8aa2da86f 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update.md +++ b/examples/1.9.x/server-graphql/examples/databases/update.md @@ -40,4 +40,45 @@ mutation { } } } +mutation { + databasesUpdate( + databaseId: "<DATABASE_ID>", + name: "<NAME>", + enabled: false + ) { + _id + name + _createdAt + _updatedAt + enabled + type + policies { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } + archives { + _id + _createdAt + _updatedAt + policyId + size + status + startedAt + migrationId + services + resources + resourceId + resourceType + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/upsert-document.md b/examples/1.9.x/server-graphql/examples/databases/upsert-document.md index 5d095baa9..a25f8416f 100644 --- a/examples/1.9.x/server-graphql/examples/databases/upsert-document.md +++ b/examples/1.9.x/server-graphql/examples/databases/upsert-document.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + databasesUpsertDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/databases/upsert-documents.md b/examples/1.9.x/server-graphql/examples/databases/upsert-documents.md index eb0573545..161311e93 100644 --- a/examples/1.9.x/server-graphql/examples/databases/upsert-documents.md +++ b/examples/1.9.x/server-graphql/examples/databases/upsert-documents.md @@ -19,4 +19,24 @@ mutation { } } } +mutation { + databasesUpsertDocuments( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documents: [], + transactionId: "<TRANSACTION_ID>" + ) { + total + documents { + _id + _sequence + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/create-deployment.md b/examples/1.9.x/server-graphql/examples/functions/create-deployment.md index 00b843a8e..2809545f0 100644 --- a/examples/1.9.x/server-graphql/examples/functions/create-deployment.md +++ b/examples/1.9.x/server-graphql/examples/functions/create-deployment.md @@ -2,9 +2,9 @@ POST /v1/functions/{functionId}/deployments HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> Content-Length: *Length of your entity body in bytes* --cec8e8123c05ba25 @@ -23,4 +23,41 @@ Content-Disposition: form-data; name="0"; filename="code.ext" File contents --cec8e8123c05ba25-- +mutation { + functionsCreateDeployment( + functionId: "<FUNCTION_ID>", + code: null, + activate: false, + entrypoint: "<ENTRYPOINT>", + commands: "<COMMANDS>" + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/create-duplicate-deployment.md b/examples/1.9.x/server-graphql/examples/functions/create-duplicate-deployment.md index 4838d0403..d4f537c7c 100644 --- a/examples/1.9.x/server-graphql/examples/functions/create-duplicate-deployment.md +++ b/examples/1.9.x/server-graphql/examples/functions/create-duplicate-deployment.md @@ -34,4 +34,39 @@ mutation { providerBranchUrl } } +mutation { + functionsCreateDuplicateDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>", + buildId: "<BUILD_ID>" + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/create-execution.md b/examples/1.9.x/server-graphql/examples/functions/create-execution.md index 88a157599..8024fba09 100644 --- a/examples/1.9.x/server-graphql/examples/functions/create-execution.md +++ b/examples/1.9.x/server-graphql/examples/functions/create-execution.md @@ -35,4 +35,40 @@ mutation { scheduledAt } } +mutation { + functionsCreateExecution( + functionId: "<FUNCTION_ID>", + body: "<BODY>", + async: false, + path: "<PATH>", + method: "GET", + headers: "{}", + scheduledAt: "<SCHEDULED_AT>" + ) { + _id + _createdAt + _updatedAt + _permissions + functionId + deploymentId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + scheduledAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/create-template-deployment.md b/examples/1.9.x/server-graphql/examples/functions/create-template-deployment.md index 57a0cf475..19c3d6065 100644 --- a/examples/1.9.x/server-graphql/examples/functions/create-template-deployment.md +++ b/examples/1.9.x/server-graphql/examples/functions/create-template-deployment.md @@ -38,4 +38,43 @@ mutation { providerBranchUrl } } +mutation { + functionsCreateTemplateDeployment( + functionId: "<FUNCTION_ID>", + repository: "<REPOSITORY>", + owner: "<OWNER>", + rootDirectory: "<ROOT_DIRECTORY>", + type: "commit", + reference: "<REFERENCE>", + activate: false + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/create-variable.md b/examples/1.9.x/server-graphql/examples/functions/create-variable.md index 0747cb110..daa52c734 100644 --- a/examples/1.9.x/server-graphql/examples/functions/create-variable.md +++ b/examples/1.9.x/server-graphql/examples/functions/create-variable.md @@ -17,4 +17,22 @@ mutation { resourceId } } +mutation { + functionsCreateVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>", + key: "<KEY>", + value: "<VALUE>", + secret: false + ) { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/create-vcs-deployment.md b/examples/1.9.x/server-graphql/examples/functions/create-vcs-deployment.md index 3bedd7a85..d4280bf4c 100644 --- a/examples/1.9.x/server-graphql/examples/functions/create-vcs-deployment.md +++ b/examples/1.9.x/server-graphql/examples/functions/create-vcs-deployment.md @@ -35,4 +35,40 @@ mutation { providerBranchUrl } } +mutation { + functionsCreateVcsDeployment( + functionId: "<FUNCTION_ID>", + type: "branch", + reference: "<REFERENCE>", + activate: false + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/create.md b/examples/1.9.x/server-graphql/examples/functions/create.md index ebfd782d8..f7b71f493 100644 --- a/examples/1.9.x/server-graphql/examples/functions/create.md +++ b/examples/1.9.x/server-graphql/examples/functions/create.md @@ -67,4 +67,72 @@ mutation { runtimeSpecification } } +mutation { + functionsCreate( + functionId: "<FUNCTION_ID>", + name: "<NAME>", + runtime: "node-14.5", + execute: ["any"], + events: [], + schedule: "", + timeout: 1, + enabled: false, + logging: false, + entrypoint: "<ENTRYPOINT>", + commands: "<COMMANDS>", + scopes: [], + installationId: "<INSTALLATION_ID>", + providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", + providerBranch: "<PROVIDER_BRANCH>", + providerSilentMode: false, + providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", + providerBranches: [], + providerPaths: [], + buildSpecification: "", + runtimeSpecification: "", + deploymentRetention: 0 + ) { + _id + _createdAt + _updatedAt + execute + name + enabled + live + logging + runtime + deploymentRetention + deploymentId + deploymentCreatedAt + latestDeploymentId + latestDeploymentCreatedAt + latestDeploymentStatus + scopes + vars { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + events + schedule + timeout + entrypoint + commands + version + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + providerBranches + providerPaths + buildSpecification + runtimeSpecification + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/get-deployment-download.md b/examples/1.9.x/server-graphql/examples/functions/get-deployment-download.md index d7962b96e..cf6e14545 100644 --- a/examples/1.9.x/server-graphql/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-graphql/examples/functions/get-deployment-download.md @@ -1,2 +1,11 @@ ```graphql +query { + functionsGetDeploymentDownload( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>", + type: "source" + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/get-deployment.md b/examples/1.9.x/server-graphql/examples/functions/get-deployment.md index d7962b96e..0c72d44b9 100644 --- a/examples/1.9.x/server-graphql/examples/functions/get-deployment.md +++ b/examples/1.9.x/server-graphql/examples/functions/get-deployment.md @@ -1,2 +1,36 @@ ```graphql +query { + functionsGetDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/get-execution.md b/examples/1.9.x/server-graphql/examples/functions/get-execution.md index d7962b96e..082d3e401 100644 --- a/examples/1.9.x/server-graphql/examples/functions/get-execution.md +++ b/examples/1.9.x/server-graphql/examples/functions/get-execution.md @@ -1,2 +1,33 @@ ```graphql +query { + functionsGetExecution( + functionId: "<FUNCTION_ID>", + executionId: "<EXECUTION_ID>" + ) { + _id + _createdAt + _updatedAt + _permissions + functionId + deploymentId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + scheduledAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/get-variable.md b/examples/1.9.x/server-graphql/examples/functions/get-variable.md index d7962b96e..198acbdde 100644 --- a/examples/1.9.x/server-graphql/examples/functions/get-variable.md +++ b/examples/1.9.x/server-graphql/examples/functions/get-variable.md @@ -1,2 +1,17 @@ ```graphql +query { + functionsGetVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>" + ) { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/get.md b/examples/1.9.x/server-graphql/examples/functions/get.md index d7962b96e..ac9557147 100644 --- a/examples/1.9.x/server-graphql/examples/functions/get.md +++ b/examples/1.9.x/server-graphql/examples/functions/get.md @@ -1,2 +1,49 @@ ```graphql +query { + functionsGet( + functionId: "<FUNCTION_ID>" + ) { + _id + _createdAt + _updatedAt + execute + name + enabled + live + logging + runtime + deploymentRetention + deploymentId + deploymentCreatedAt + latestDeploymentId + latestDeploymentCreatedAt + latestDeploymentStatus + scopes + vars { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + events + schedule + timeout + entrypoint + commands + version + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + providerBranches + providerPaths + buildSpecification + runtimeSpecification + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/list-deployments.md b/examples/1.9.x/server-graphql/examples/functions/list-deployments.md index d7962b96e..8ba4d3d9d 100644 --- a/examples/1.9.x/server-graphql/examples/functions/list-deployments.md +++ b/examples/1.9.x/server-graphql/examples/functions/list-deployments.md @@ -1,2 +1,41 @@ ```graphql +query { + functionsListDeployments( + functionId: "<FUNCTION_ID>", + queries: [], + search: "<SEARCH>", + total: false + ) { + total + deployments { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/list-executions.md b/examples/1.9.x/server-graphql/examples/functions/list-executions.md index d7962b96e..5f8f3e826 100644 --- a/examples/1.9.x/server-graphql/examples/functions/list-executions.md +++ b/examples/1.9.x/server-graphql/examples/functions/list-executions.md @@ -1,2 +1,37 @@ ```graphql +query { + functionsListExecutions( + functionId: "<FUNCTION_ID>", + queries: [], + total: false + ) { + total + executions { + _id + _createdAt + _updatedAt + _permissions + functionId + deploymentId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + scheduledAt + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/list-runtimes.md b/examples/1.9.x/server-graphql/examples/functions/list-runtimes.md index d7962b96e..ef88ce307 100644 --- a/examples/1.9.x/server-graphql/examples/functions/list-runtimes.md +++ b/examples/1.9.x/server-graphql/examples/functions/list-runtimes.md @@ -1,2 +1,17 @@ ```graphql +query { + functionsListRuntimes { + total + runtimes { + _id + key + name + version + base + image + logo + supports + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/list-specifications.md b/examples/1.9.x/server-graphql/examples/functions/list-specifications.md index d7962b96e..d6f4ce946 100644 --- a/examples/1.9.x/server-graphql/examples/functions/list-specifications.md +++ b/examples/1.9.x/server-graphql/examples/functions/list-specifications.md @@ -1,2 +1,13 @@ ```graphql +query { + functionsListSpecifications { + total + specifications { + memory + cpus + enabled + slug + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/list-variables.md b/examples/1.9.x/server-graphql/examples/functions/list-variables.md index d7962b96e..f58181d9a 100644 --- a/examples/1.9.x/server-graphql/examples/functions/list-variables.md +++ b/examples/1.9.x/server-graphql/examples/functions/list-variables.md @@ -1,2 +1,21 @@ ```graphql +query { + functionsListVariables( + functionId: "<FUNCTION_ID>", + queries: [], + total: false + ) { + total + variables { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/list.md b/examples/1.9.x/server-graphql/examples/functions/list.md index d7962b96e..188b81043 100644 --- a/examples/1.9.x/server-graphql/examples/functions/list.md +++ b/examples/1.9.x/server-graphql/examples/functions/list.md @@ -1,2 +1,54 @@ ```graphql +query { + functionsList( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + functions { + _id + _createdAt + _updatedAt + execute + name + enabled + live + logging + runtime + deploymentRetention + deploymentId + deploymentCreatedAt + latestDeploymentId + latestDeploymentCreatedAt + latestDeploymentStatus + scopes + vars { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + events + schedule + timeout + entrypoint + commands + version + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + providerBranches + providerPaths + buildSpecification + runtimeSpecification + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/update-deployment-status.md b/examples/1.9.x/server-graphql/examples/functions/update-deployment-status.md index 2097e1201..7a8fb24c7 100644 --- a/examples/1.9.x/server-graphql/examples/functions/update-deployment-status.md +++ b/examples/1.9.x/server-graphql/examples/functions/update-deployment-status.md @@ -33,4 +33,38 @@ mutation { providerBranchUrl } } +mutation { + functionsUpdateDeploymentStatus( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/update-function-deployment.md b/examples/1.9.x/server-graphql/examples/functions/update-function-deployment.md index d97150d4a..c7f1b0ec0 100644 --- a/examples/1.9.x/server-graphql/examples/functions/update-function-deployment.md +++ b/examples/1.9.x/server-graphql/examples/functions/update-function-deployment.md @@ -47,4 +47,52 @@ mutation { runtimeSpecification } } +mutation { + functionsUpdateFunctionDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + _id + _createdAt + _updatedAt + execute + name + enabled + live + logging + runtime + deploymentRetention + deploymentId + deploymentCreatedAt + latestDeploymentId + latestDeploymentCreatedAt + latestDeploymentStatus + scopes + vars { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + events + schedule + timeout + entrypoint + commands + version + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + providerBranches + providerPaths + buildSpecification + runtimeSpecification + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/update-variable.md b/examples/1.9.x/server-graphql/examples/functions/update-variable.md index a1eededb9..acd5de5ef 100644 --- a/examples/1.9.x/server-graphql/examples/functions/update-variable.md +++ b/examples/1.9.x/server-graphql/examples/functions/update-variable.md @@ -17,4 +17,22 @@ mutation { resourceId } } +mutation { + functionsUpdateVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>", + key: "<KEY>", + value: "<VALUE>", + secret: false + ) { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/functions/update.md b/examples/1.9.x/server-graphql/examples/functions/update.md index 88f6c30ca..8f8da89fe 100644 --- a/examples/1.9.x/server-graphql/examples/functions/update.md +++ b/examples/1.9.x/server-graphql/examples/functions/update.md @@ -67,4 +67,72 @@ mutation { runtimeSpecification } } +mutation { + functionsUpdate( + functionId: "<FUNCTION_ID>", + name: "<NAME>", + runtime: "node-14.5", + execute: ["any"], + events: [], + schedule: "", + timeout: 1, + enabled: false, + logging: false, + entrypoint: "<ENTRYPOINT>", + commands: "<COMMANDS>", + scopes: [], + installationId: "<INSTALLATION_ID>", + providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", + providerBranch: "<PROVIDER_BRANCH>", + providerSilentMode: false, + providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", + providerBranches: [], + providerPaths: [], + buildSpecification: "", + runtimeSpecification: "", + deploymentRetention: 0 + ) { + _id + _createdAt + _updatedAt + execute + name + enabled + live + logging + runtime + deploymentRetention + deploymentId + deploymentCreatedAt + latestDeploymentId + latestDeploymentCreatedAt + latestDeploymentStatus + scopes + vars { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + events + schedule + timeout + entrypoint + commands + version + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + providerBranches + providerPaths + buildSpecification + runtimeSpecification + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-antivirus.md b/examples/1.9.x/server-graphql/examples/health/get-antivirus.md index d7962b96e..98d35c128 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-antivirus.md +++ b/examples/1.9.x/server-graphql/examples/health/get-antivirus.md @@ -1,2 +1,8 @@ ```graphql +query { + healthGetAntivirus { + version + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-audits-db.md b/examples/1.9.x/server-graphql/examples/health/get-audits-db.md new file mode 100644 index 000000000..410547f67 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/health/get-audits-db.md @@ -0,0 +1,12 @@ +```graphql +query { + healthGetAuditsDB { + total + statuses { + name + ping + status + } + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-cache.md b/examples/1.9.x/server-graphql/examples/health/get-cache.md index d7962b96e..5bf8d86c8 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-cache.md +++ b/examples/1.9.x/server-graphql/examples/health/get-cache.md @@ -1,2 +1,12 @@ ```graphql +query { + healthGetCache { + total + statuses { + name + ping + status + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-certificate.md b/examples/1.9.x/server-graphql/examples/health/get-certificate.md index d7962b96e..612249eee 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-certificate.md +++ b/examples/1.9.x/server-graphql/examples/health/get-certificate.md @@ -1,2 +1,14 @@ ```graphql +query { + healthGetCertificate( + domain: "" + ) { + name + subjectSN + issuerOrganisation + validFrom + validTo + signatureTypeSN + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-console-pausing.md b/examples/1.9.x/server-graphql/examples/health/get-console-pausing.md index d7962b96e..2c677ee2c 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-console-pausing.md +++ b/examples/1.9.x/server-graphql/examples/health/get-console-pausing.md @@ -1,2 +1,12 @@ ```graphql +query { + healthGetConsolePausing( + threshold: 0, + inactivityDays: 0 + ) { + name + ping + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-db.md b/examples/1.9.x/server-graphql/examples/health/get-db.md index d7962b96e..ddf2f6b80 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-db.md +++ b/examples/1.9.x/server-graphql/examples/health/get-db.md @@ -1,2 +1,12 @@ ```graphql +query { + healthGetDB { + total + statuses { + name + ping + status + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-failed-jobs.md b/examples/1.9.x/server-graphql/examples/health/get-failed-jobs.md index d7962b96e..359d19245 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-failed-jobs.md +++ b/examples/1.9.x/server-graphql/examples/health/get-failed-jobs.md @@ -1,2 +1,10 @@ ```graphql +query { + healthGetFailedJobs( + name: "v1-database", + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-pub-sub.md b/examples/1.9.x/server-graphql/examples/health/get-pub-sub.md index d7962b96e..b76979ced 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-pub-sub.md +++ b/examples/1.9.x/server-graphql/examples/health/get-pub-sub.md @@ -1,2 +1,12 @@ ```graphql +query { + healthGetPubSub { + total + statuses { + name + ping + status + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-audits.md b/examples/1.9.x/server-graphql/examples/health/get-queue-audits.md index d7962b96e..476b1937c 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-audits.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-audits.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueAudits( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-builds.md b/examples/1.9.x/server-graphql/examples/health/get-queue-builds.md index d7962b96e..050f52995 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-builds.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-builds.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueBuilds( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-certificates.md b/examples/1.9.x/server-graphql/examples/health/get-queue-certificates.md index d7962b96e..f63c3b71c 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-certificates.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-certificates.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueCertificates( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-databases.md b/examples/1.9.x/server-graphql/examples/health/get-queue-databases.md index d7962b96e..1412cef47 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-databases.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-databases.md @@ -1,2 +1,10 @@ ```graphql +query { + healthGetQueueDatabases( + name: "<NAME>", + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-deletes.md b/examples/1.9.x/server-graphql/examples/health/get-queue-deletes.md index d7962b96e..17fcbaa00 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-deletes.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-deletes.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueDeletes( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-functions.md b/examples/1.9.x/server-graphql/examples/health/get-queue-functions.md index d7962b96e..56f390f61 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-functions.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-functions.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueFunctions( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-logs.md b/examples/1.9.x/server-graphql/examples/health/get-queue-logs.md index d7962b96e..d1e137985 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-logs.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-logs.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueLogs( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-mails.md b/examples/1.9.x/server-graphql/examples/health/get-queue-mails.md index d7962b96e..1bd417ebe 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-mails.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-mails.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueMails( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-messaging.md b/examples/1.9.x/server-graphql/examples/health/get-queue-messaging.md index d7962b96e..fbd141377 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-messaging.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-messaging.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueMessaging( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-migrations.md b/examples/1.9.x/server-graphql/examples/health/get-queue-migrations.md index d7962b96e..d6a2150a7 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-migrations.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-migrations.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueMigrations( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-stats-resources.md b/examples/1.9.x/server-graphql/examples/health/get-queue-stats-resources.md index d7962b96e..3a041f45a 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-stats-resources.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-stats-resources.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueStatsResources( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-usage.md b/examples/1.9.x/server-graphql/examples/health/get-queue-usage.md index d7962b96e..214107245 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-usage.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-usage.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueUsage( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-queue-webhooks.md b/examples/1.9.x/server-graphql/examples/health/get-queue-webhooks.md index d7962b96e..6617ae9fc 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-queue-webhooks.md +++ b/examples/1.9.x/server-graphql/examples/health/get-queue-webhooks.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetQueueWebhooks( + threshold: 0 + ) { + size + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-storage-local.md b/examples/1.9.x/server-graphql/examples/health/get-storage-local.md index d7962b96e..f6206cdc5 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-storage-local.md +++ b/examples/1.9.x/server-graphql/examples/health/get-storage-local.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetStorageLocal { + name + ping + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-storage.md b/examples/1.9.x/server-graphql/examples/health/get-storage.md index d7962b96e..90bf2b7c7 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-storage.md +++ b/examples/1.9.x/server-graphql/examples/health/get-storage.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetStorage { + name + ping + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get-time.md b/examples/1.9.x/server-graphql/examples/health/get-time.md index d7962b96e..86e20ec67 100644 --- a/examples/1.9.x/server-graphql/examples/health/get-time.md +++ b/examples/1.9.x/server-graphql/examples/health/get-time.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGetTime { + remoteTime + localTime + diff + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/health/get.md b/examples/1.9.x/server-graphql/examples/health/get.md index d7962b96e..1b132c7ac 100644 --- a/examples/1.9.x/server-graphql/examples/health/get.md +++ b/examples/1.9.x/server-graphql/examples/health/get.md @@ -1,2 +1,9 @@ ```graphql +query { + healthGet { + name + ping + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/locale/get.md b/examples/1.9.x/server-graphql/examples/locale/get.md index d7962b96e..c591b694c 100644 --- a/examples/1.9.x/server-graphql/examples/locale/get.md +++ b/examples/1.9.x/server-graphql/examples/locale/get.md @@ -1,2 +1,13 @@ ```graphql +query { + localeGet { + ip + countryCode + country + continentCode + continent + eu + currency + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/locale/list-codes.md b/examples/1.9.x/server-graphql/examples/locale/list-codes.md index d7962b96e..0e3967246 100644 --- a/examples/1.9.x/server-graphql/examples/locale/list-codes.md +++ b/examples/1.9.x/server-graphql/examples/locale/list-codes.md @@ -1,2 +1,11 @@ ```graphql +query { + localeListCodes { + total + localeCodes { + code + name + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/locale/list-continents.md b/examples/1.9.x/server-graphql/examples/locale/list-continents.md index d7962b96e..16ad0fd94 100644 --- a/examples/1.9.x/server-graphql/examples/locale/list-continents.md +++ b/examples/1.9.x/server-graphql/examples/locale/list-continents.md @@ -1,2 +1,11 @@ ```graphql +query { + localeListContinents { + total + continents { + name + code + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/locale/list-countries-eu.md b/examples/1.9.x/server-graphql/examples/locale/list-countries-eu.md index d7962b96e..293d32c9c 100644 --- a/examples/1.9.x/server-graphql/examples/locale/list-countries-eu.md +++ b/examples/1.9.x/server-graphql/examples/locale/list-countries-eu.md @@ -1,2 +1,11 @@ ```graphql +query { + localeListCountriesEU { + total + countries { + name + code + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/locale/list-countries-phones.md b/examples/1.9.x/server-graphql/examples/locale/list-countries-phones.md index d7962b96e..b17b065e3 100644 --- a/examples/1.9.x/server-graphql/examples/locale/list-countries-phones.md +++ b/examples/1.9.x/server-graphql/examples/locale/list-countries-phones.md @@ -1,2 +1,12 @@ ```graphql +query { + localeListCountriesPhones { + total + phones { + code + countryCode + countryName + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/locale/list-countries.md b/examples/1.9.x/server-graphql/examples/locale/list-countries.md index d7962b96e..15f566af0 100644 --- a/examples/1.9.x/server-graphql/examples/locale/list-countries.md +++ b/examples/1.9.x/server-graphql/examples/locale/list-countries.md @@ -1,2 +1,11 @@ ```graphql +query { + localeListCountries { + total + countries { + name + code + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/locale/list-currencies.md b/examples/1.9.x/server-graphql/examples/locale/list-currencies.md index d7962b96e..374d67126 100644 --- a/examples/1.9.x/server-graphql/examples/locale/list-currencies.md +++ b/examples/1.9.x/server-graphql/examples/locale/list-currencies.md @@ -1,2 +1,16 @@ ```graphql +query { + localeListCurrencies { + total + currencies { + symbol + name + symbolNative + decimalDigits + rounding + code + namePlural + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/locale/list-languages.md b/examples/1.9.x/server-graphql/examples/locale/list-languages.md index d7962b96e..ed108f5a4 100644 --- a/examples/1.9.x/server-graphql/examples/locale/list-languages.md +++ b/examples/1.9.x/server-graphql/examples/locale/list-languages.md @@ -1,2 +1,12 @@ ```graphql +query { + localeListLanguages { + total + languages { + name + code + nativeName + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-apns-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-apns-provider.md index 851a80154..fb5de591d 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-apns-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-apns-provider.md @@ -21,4 +21,26 @@ mutation { options } } +mutation { + messagingCreateAPNSProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + authKey: "<AUTH_KEY>", + authKeyId: "<AUTH_KEY_ID>", + teamId: "<TEAM_ID>", + bundleId: "<BUNDLE_ID>", + sandbox: false, + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-email.md b/examples/1.9.x/server-graphql/examples/messaging/create-email.md index 2b0d1fea7..1e55efaef 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-email.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-email.md @@ -29,4 +29,34 @@ mutation { status } } +mutation { + messagingCreateEmail( + messageId: "<MESSAGE_ID>", + subject: "<SUBJECT>", + content: "<CONTENT>", + topics: [], + users: [], + targets: [], + cc: [], + bcc: [], + attachments: [], + draft: false, + html: false, + scheduledAt: "2020-10-15T06:38:00.000+00:00" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-fcm-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-fcm-provider.md index d531a2d6d..db0f7b5d1 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-fcm-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-fcm-provider.md @@ -17,4 +17,22 @@ mutation { options } } +mutation { + messagingCreateFCMProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + serviceAccountJSON: "{}", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-mailgun-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-mailgun-provider.md index 7bed67d7e..3b424316a 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-mailgun-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-mailgun-provider.md @@ -23,4 +23,28 @@ mutation { options } } +mutation { + messagingCreateMailgunProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + apiKey: "<API_KEY>", + domain: "<DOMAIN>", + isEuRegion: false, + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "email@example.com", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-msg-91-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-msg-91-provider.md index 130aa6e6f..1f3b24891 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-msg-91-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-msg-91-provider.md @@ -19,4 +19,24 @@ mutation { options } } +mutation { + messagingCreateMsg91Provider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + templateId: "<TEMPLATE_ID>", + senderId: "<SENDER_ID>", + authKey: "<AUTH_KEY>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-push.md b/examples/1.9.x/server-graphql/examples/messaging/create-push.md index 9206bcc2f..3d45227ed 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-push.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-push.md @@ -36,4 +36,41 @@ mutation { status } } +mutation { + messagingCreatePush( + messageId: "<MESSAGE_ID>", + title: "<TITLE>", + body: "<BODY>", + topics: [], + users: [], + targets: [], + data: "{}", + action: "<ACTION>", + image: "<ID1:ID2>", + icon: "<ICON>", + sound: "<SOUND>", + color: "<COLOR>", + tag: "<TAG>", + badge: 0, + draft: false, + scheduledAt: "2020-10-15T06:38:00.000+00:00", + contentAvailable: false, + critical: false, + priority: "normal" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-resend-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-resend-provider.md index afb9a56b9..564c32289 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-resend-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-resend-provider.md @@ -21,4 +21,26 @@ mutation { options } } +mutation { + messagingCreateResendProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + apiKey: "<API_KEY>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "email@example.com", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-sendgrid-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-sendgrid-provider.md index 709e17e69..695dc5e1b 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-sendgrid-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-sendgrid-provider.md @@ -21,4 +21,26 @@ mutation { options } } +mutation { + messagingCreateSendgridProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + apiKey: "<API_KEY>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "email@example.com", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-ses-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..74d3d3223 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/messaging/create-ses-provider.md @@ -0,0 +1,50 @@ +```graphql +mutation { + messagingCreateSesProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + accessKey: "<ACCESS_KEY>", + secretKey: "<SECRET_KEY>", + region: "<REGION>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "email@example.com", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} +mutation { + messagingCreateSesProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + accessKey: "<ACCESS_KEY>", + secretKey: "<SECRET_KEY>", + region: "<REGION>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "email@example.com", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-sms.md b/examples/1.9.x/server-graphql/examples/messaging/create-sms.md index d193ef9de..c5be75351 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-sms.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-sms.md @@ -24,4 +24,29 @@ mutation { status } } +mutation { + messagingCreateSMS( + messageId: "<MESSAGE_ID>", + content: "<CONTENT>", + topics: [], + users: [], + targets: [], + draft: false, + scheduledAt: "2020-10-15T06:38:00.000+00:00" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-smtp-provider.md index f8f944ccf..341b38f77 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-smtp-provider.md @@ -6,7 +6,35 @@ mutation { host: "<HOST>", port: 1, username: "<USERNAME>", - password: "<PASSWORD>", + password: "password", + encryption: "none", + autoTLS: false, + mailer: "<MAILER>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "email@example.com", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} +mutation { + messagingCreateSMTPProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + host: "<HOST>", + port: 1, + username: "<USERNAME>", + password: "password", encryption: "none", autoTLS: false, mailer: "<MAILER>", diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-subscriber.md b/examples/1.9.x/server-graphql/examples/messaging/create-subscriber.md index 50d67e14f..8a7cd1f57 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-subscriber.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-subscriber.md @@ -26,4 +26,31 @@ mutation { providerType } } +mutation { + messagingCreateSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>", + targetId: "<TARGET_ID>" + ) { + _id + _createdAt + _updatedAt + targetId + target { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + userId + userName + topicId + providerType + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-telesign-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-telesign-provider.md index cffc2d92a..96086d7d9 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-telesign-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-telesign-provider.md @@ -19,4 +19,24 @@ mutation { options } } +mutation { + messagingCreateTelesignProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", + customerId: "<CUSTOMER_ID>", + apiKey: "<API_KEY>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-textmagic-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-textmagic-provider.md index 5456ed54c..e3e8cec95 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-textmagic-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-textmagic-provider.md @@ -19,4 +19,24 @@ mutation { options } } +mutation { + messagingCreateTextmagicProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", + username: "<USERNAME>", + apiKey: "<API_KEY>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-topic.md b/examples/1.9.x/server-graphql/examples/messaging/create-topic.md index cb4c07fb2..0906c2931 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-topic.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-topic.md @@ -15,4 +15,20 @@ mutation { subscribe } } +mutation { + messagingCreateTopic( + topicId: "<TOPIC_ID>", + name: "<NAME>", + subscribe: ["any"] + ) { + _id + _createdAt + _updatedAt + name + emailTotal + smsTotal + pushTotal + subscribe + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-twilio-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-twilio-provider.md index ee0dee81a..7a6087fcf 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-twilio-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-twilio-provider.md @@ -19,4 +19,24 @@ mutation { options } } +mutation { + messagingCreateTwilioProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", + accountSid: "<ACCOUNT_SID>", + authToken: "<AUTH_TOKEN>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/create-vonage-provider.md b/examples/1.9.x/server-graphql/examples/messaging/create-vonage-provider.md index 73604b737..528602e2b 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/create-vonage-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/create-vonage-provider.md @@ -19,4 +19,24 @@ mutation { options } } +mutation { + messagingCreateVonageProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", + apiKey: "<API_KEY>", + apiSecret: "<API_SECRET>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/get-message.md b/examples/1.9.x/server-graphql/examples/messaging/get-message.md index d7962b96e..d899f2e2f 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/get-message.md +++ b/examples/1.9.x/server-graphql/examples/messaging/get-message.md @@ -1,2 +1,21 @@ ```graphql +query { + messagingGetMessage( + messageId: "<MESSAGE_ID>" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/get-provider.md b/examples/1.9.x/server-graphql/examples/messaging/get-provider.md index d7962b96e..531f98fbf 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/get-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/get-provider.md @@ -1,2 +1,17 @@ ```graphql +query { + messagingGetProvider( + providerId: "<PROVIDER_ID>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/get-subscriber.md b/examples/1.9.x/server-graphql/examples/messaging/get-subscriber.md index d7962b96e..78d9c8693 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/get-subscriber.md +++ b/examples/1.9.x/server-graphql/examples/messaging/get-subscriber.md @@ -1,2 +1,28 @@ ```graphql +query { + messagingGetSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>" + ) { + _id + _createdAt + _updatedAt + targetId + target { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + userId + userName + topicId + providerType + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/get-topic.md b/examples/1.9.x/server-graphql/examples/messaging/get-topic.md index d7962b96e..a275cc8d3 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/get-topic.md +++ b/examples/1.9.x/server-graphql/examples/messaging/get-topic.md @@ -1,2 +1,16 @@ ```graphql +query { + messagingGetTopic( + topicId: "<TOPIC_ID>" + ) { + _id + _createdAt + _updatedAt + name + emailTotal + smsTotal + pushTotal + subscribe + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/list-message-logs.md b/examples/1.9.x/server-graphql/examples/messaging/list-message-logs.md index d7962b96e..51fefd18a 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/list-message-logs.md +++ b/examples/1.9.x/server-graphql/examples/messaging/list-message-logs.md @@ -1,2 +1,35 @@ ```graphql +query { + messagingListMessageLogs( + messageId: "<MESSAGE_ID>", + queries: [], + total: false + ) { + total + logs { + event + userId + userEmail + userName + mode + userType + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/list-messages.md b/examples/1.9.x/server-graphql/examples/messaging/list-messages.md index d7962b96e..c7cc2806c 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/list-messages.md +++ b/examples/1.9.x/server-graphql/examples/messaging/list-messages.md @@ -1,2 +1,26 @@ ```graphql +query { + messagingListMessages( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + messages { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/list-provider-logs.md b/examples/1.9.x/server-graphql/examples/messaging/list-provider-logs.md index d7962b96e..fe7f7eb34 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/list-provider-logs.md +++ b/examples/1.9.x/server-graphql/examples/messaging/list-provider-logs.md @@ -1,2 +1,35 @@ ```graphql +query { + messagingListProviderLogs( + providerId: "<PROVIDER_ID>", + queries: [], + total: false + ) { + total + logs { + event + userId + userEmail + userName + mode + userType + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/list-providers.md b/examples/1.9.x/server-graphql/examples/messaging/list-providers.md index d7962b96e..279564060 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/list-providers.md +++ b/examples/1.9.x/server-graphql/examples/messaging/list-providers.md @@ -1,2 +1,22 @@ ```graphql +query { + messagingListProviders( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + providers { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/list-subscriber-logs.md b/examples/1.9.x/server-graphql/examples/messaging/list-subscriber-logs.md index d7962b96e..61528e8d8 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/list-subscriber-logs.md +++ b/examples/1.9.x/server-graphql/examples/messaging/list-subscriber-logs.md @@ -1,2 +1,35 @@ ```graphql +query { + messagingListSubscriberLogs( + subscriberId: "<SUBSCRIBER_ID>", + queries: [], + total: false + ) { + total + logs { + event + userId + userEmail + userName + mode + userType + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/list-subscribers.md b/examples/1.9.x/server-graphql/examples/messaging/list-subscribers.md index d7962b96e..13e3e6e8f 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/list-subscribers.md +++ b/examples/1.9.x/server-graphql/examples/messaging/list-subscribers.md @@ -1,2 +1,33 @@ ```graphql +query { + messagingListSubscribers( + topicId: "<TOPIC_ID>", + queries: [], + search: "<SEARCH>", + total: false + ) { + total + subscribers { + _id + _createdAt + _updatedAt + targetId + target { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + userId + userName + topicId + providerType + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/list-targets.md b/examples/1.9.x/server-graphql/examples/messaging/list-targets.md index d7962b96e..d3f2886a2 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/list-targets.md +++ b/examples/1.9.x/server-graphql/examples/messaging/list-targets.md @@ -1,2 +1,22 @@ ```graphql +query { + messagingListTargets( + messageId: "<MESSAGE_ID>", + queries: [], + total: false + ) { + total + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/list-topic-logs.md b/examples/1.9.x/server-graphql/examples/messaging/list-topic-logs.md index d7962b96e..96fd4f606 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/list-topic-logs.md +++ b/examples/1.9.x/server-graphql/examples/messaging/list-topic-logs.md @@ -1,2 +1,35 @@ ```graphql +query { + messagingListTopicLogs( + topicId: "<TOPIC_ID>", + queries: [], + total: false + ) { + total + logs { + event + userId + userEmail + userName + mode + userType + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/list-topics.md b/examples/1.9.x/server-graphql/examples/messaging/list-topics.md index d7962b96e..6d4b72b9c 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/list-topics.md +++ b/examples/1.9.x/server-graphql/examples/messaging/list-topics.md @@ -1,2 +1,21 @@ ```graphql +query { + messagingListTopics( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + topics { + _id + _createdAt + _updatedAt + name + emailTotal + smsTotal + pushTotal + subscribe + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-apns-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-apns-provider.md index 7659ce2bc..d144b2da3 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-apns-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-apns-provider.md @@ -21,4 +21,26 @@ mutation { options } } +mutation { + messagingUpdateAPNSProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + authKey: "<AUTH_KEY>", + authKeyId: "<AUTH_KEY_ID>", + teamId: "<TEAM_ID>", + bundleId: "<BUNDLE_ID>", + sandbox: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-email.md b/examples/1.9.x/server-graphql/examples/messaging/update-email.md index 28f409bf7..d3db83297 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-email.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-email.md @@ -29,4 +29,34 @@ mutation { status } } +mutation { + messagingUpdateEmail( + messageId: "<MESSAGE_ID>", + topics: [], + users: [], + targets: [], + subject: "<SUBJECT>", + content: "<CONTENT>", + draft: false, + html: false, + cc: [], + bcc: [], + scheduledAt: "2020-10-15T06:38:00.000+00:00", + attachments: [] + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-fcm-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-fcm-provider.md index a2f640717..88d328d63 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-fcm-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-fcm-provider.md @@ -17,4 +17,22 @@ mutation { options } } +mutation { + messagingUpdateFCMProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + serviceAccountJSON: "{}" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-mailgun-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-mailgun-provider.md index a7842eb81..80d10ab59 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-mailgun-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-mailgun-provider.md @@ -23,4 +23,28 @@ mutation { options } } +mutation { + messagingUpdateMailgunProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + apiKey: "<API_KEY>", + domain: "<DOMAIN>", + isEuRegion: false, + enabled: false, + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "<REPLY_TO_EMAIL>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-msg-91-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-msg-91-provider.md index 433051f58..78de2911a 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-msg-91-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-msg-91-provider.md @@ -19,4 +19,24 @@ mutation { options } } +mutation { + messagingUpdateMsg91Provider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + templateId: "<TEMPLATE_ID>", + senderId: "<SENDER_ID>", + authKey: "<AUTH_KEY>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-push.md b/examples/1.9.x/server-graphql/examples/messaging/update-push.md index 66b5078f8..5d6d3a266 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-push.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-push.md @@ -36,4 +36,41 @@ mutation { status } } +mutation { + messagingUpdatePush( + messageId: "<MESSAGE_ID>", + topics: [], + users: [], + targets: [], + title: "<TITLE>", + body: "<BODY>", + data: "{}", + action: "<ACTION>", + image: "<ID1:ID2>", + icon: "<ICON>", + sound: "<SOUND>", + color: "<COLOR>", + tag: "<TAG>", + badge: 0, + draft: false, + scheduledAt: "2020-10-15T06:38:00.000+00:00", + contentAvailable: false, + critical: false, + priority: "normal" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-resend-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-resend-provider.md index 153c0239c..8973844fb 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-resend-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-resend-provider.md @@ -21,4 +21,26 @@ mutation { options } } +mutation { + messagingUpdateResendProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + apiKey: "<API_KEY>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "<REPLY_TO_EMAIL>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-sendgrid-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-sendgrid-provider.md index 79b4a5c6f..6e60a5f11 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-sendgrid-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-sendgrid-provider.md @@ -21,4 +21,26 @@ mutation { options } } +mutation { + messagingUpdateSendgridProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + apiKey: "<API_KEY>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "<REPLY_TO_EMAIL>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-ses-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..3bb4a96e4 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/messaging/update-ses-provider.md @@ -0,0 +1,50 @@ +```graphql +mutation { + messagingUpdateSesProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + accessKey: "<ACCESS_KEY>", + secretKey: "<SECRET_KEY>", + region: "<REGION>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "<REPLY_TO_EMAIL>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} +mutation { + messagingUpdateSesProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + accessKey: "<ACCESS_KEY>", + secretKey: "<SECRET_KEY>", + region: "<REGION>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "<REPLY_TO_EMAIL>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-sms.md b/examples/1.9.x/server-graphql/examples/messaging/update-sms.md index 4f02a8256..9873d6a30 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-sms.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-sms.md @@ -24,4 +24,29 @@ mutation { status } } +mutation { + messagingUpdateSMS( + messageId: "<MESSAGE_ID>", + topics: [], + users: [], + targets: [], + content: "<CONTENT>", + draft: false, + scheduledAt: "2020-10-15T06:38:00.000+00:00" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-smtp-provider.md index c56c012b3..f459e69de 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-smtp-provider.md @@ -6,7 +6,35 @@ mutation { host: "<HOST>", port: 1, username: "<USERNAME>", - password: "<PASSWORD>", + password: "password", + encryption: "none", + autoTLS: false, + mailer: "<MAILER>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "<REPLY_TO_EMAIL>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} +mutation { + messagingUpdateSMTPProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + host: "<HOST>", + port: 1, + username: "<USERNAME>", + password: "password", encryption: "none", autoTLS: false, mailer: "<MAILER>", diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-telesign-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-telesign-provider.md index d442b6280..3ce9c3da5 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-telesign-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-telesign-provider.md @@ -19,4 +19,24 @@ mutation { options } } +mutation { + messagingUpdateTelesignProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + customerId: "<CUSTOMER_ID>", + apiKey: "<API_KEY>", + from: "<FROM>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-textmagic-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-textmagic-provider.md index 7754889bb..138259f04 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-textmagic-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-textmagic-provider.md @@ -19,4 +19,24 @@ mutation { options } } +mutation { + messagingUpdateTextmagicProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + username: "<USERNAME>", + apiKey: "<API_KEY>", + from: "<FROM>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-topic.md b/examples/1.9.x/server-graphql/examples/messaging/update-topic.md index 8a9121399..3908ca73e 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-topic.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-topic.md @@ -15,4 +15,20 @@ mutation { subscribe } } +mutation { + messagingUpdateTopic( + topicId: "<TOPIC_ID>", + name: "<NAME>", + subscribe: ["any"] + ) { + _id + _createdAt + _updatedAt + name + emailTotal + smsTotal + pushTotal + subscribe + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-twilio-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-twilio-provider.md index 3069e78bc..1d0e48694 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-twilio-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-twilio-provider.md @@ -19,4 +19,24 @@ mutation { options } } +mutation { + messagingUpdateTwilioProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + accountSid: "<ACCOUNT_SID>", + authToken: "<AUTH_TOKEN>", + from: "<FROM>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/messaging/update-vonage-provider.md b/examples/1.9.x/server-graphql/examples/messaging/update-vonage-provider.md index 0dce8721b..c32b0e19a 100644 --- a/examples/1.9.x/server-graphql/examples/messaging/update-vonage-provider.md +++ b/examples/1.9.x/server-graphql/examples/messaging/update-vonage-provider.md @@ -19,4 +19,24 @@ mutation { options } } +mutation { + messagingUpdateVonageProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + apiKey: "<API_KEY>", + apiSecret: "<API_SECRET>", + from: "<FROM>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/organization/create-key.md b/examples/1.9.x/server-graphql/examples/organization/create-key.md index 4ee477f61..426f500c4 100644 --- a/examples/1.9.x/server-graphql/examples/organization/create-key.md +++ b/examples/1.9.x/server-graphql/examples/organization/create-key.md @@ -17,4 +17,22 @@ mutation { sdks } } +mutation { + organizationCreateKey( + keyId: "<KEY_ID>", + name: "<NAME>", + scopes: [], + expire: "2020-10-15T06:38:00.000+00:00" + ) { + _id + _createdAt + _updatedAt + name + expire + scopes + secret + accessedAt + sdks + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/organization/create-project.md b/examples/1.9.x/server-graphql/examples/organization/create-project.md index 5debc5c7e..963175151 100644 --- a/examples/1.9.x/server-graphql/examples/organization/create-project.md +++ b/examples/1.9.x/server-graphql/examples/organization/create-project.md @@ -10,6 +10,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -46,7 +47,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -57,6 +70,70 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + organizationCreateProject( + projectId: "", + name: "<NAME>", + region: "fra" + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -70,6 +147,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/organization/get-key.md b/examples/1.9.x/server-graphql/examples/organization/get-key.md index d7962b96e..0e3ca9832 100644 --- a/examples/1.9.x/server-graphql/examples/organization/get-key.md +++ b/examples/1.9.x/server-graphql/examples/organization/get-key.md @@ -1,2 +1,17 @@ ```graphql +query { + organizationGetKey( + keyId: "<KEY_ID>" + ) { + _id + _createdAt + _updatedAt + name + expire + scopes + secret + accessedAt + sdks + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/organization/list-keys.md b/examples/1.9.x/server-graphql/examples/organization/list-keys.md index d7962b96e..85d2eb78d 100644 --- a/examples/1.9.x/server-graphql/examples/organization/list-keys.md +++ b/examples/1.9.x/server-graphql/examples/organization/list-keys.md @@ -1,2 +1,21 @@ ```graphql +query { + organizationListKeys( + queries: [], + total: false + ) { + total + keys { + _id + _createdAt + _updatedAt + name + expire + scopes + secret + accessedAt + sdks + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/organization/list-projects.md b/examples/1.9.x/server-graphql/examples/organization/list-projects.md index d7962b96e..c68ed4fa3 100644 --- a/examples/1.9.x/server-graphql/examples/organization/list-projects.md +++ b/examples/1.9.x/server-graphql/examples/organization/list-projects.md @@ -1,2 +1,92 @@ ```graphql +query { + organizationListProjects( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + projects { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/organization/update-key.md b/examples/1.9.x/server-graphql/examples/organization/update-key.md index 827808058..951f6a4fa 100644 --- a/examples/1.9.x/server-graphql/examples/organization/update-key.md +++ b/examples/1.9.x/server-graphql/examples/organization/update-key.md @@ -17,4 +17,22 @@ mutation { sdks } } +mutation { + organizationUpdateKey( + keyId: "<KEY_ID>", + name: "<NAME>", + scopes: [], + expire: "2020-10-15T06:38:00.000+00:00" + ) { + _id + _createdAt + _updatedAt + name + expire + scopes + secret + accessedAt + sdks + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/organization/update-project.md b/examples/1.9.x/server-graphql/examples/organization/update-project.md index eb48d83fa..c1bd738ac 100644 --- a/examples/1.9.x/server-graphql/examples/organization/update-project.md +++ b/examples/1.9.x/server-graphql/examples/organization/update-project.md @@ -9,6 +9,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -45,7 +46,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -56,6 +69,69 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + organizationUpdateProject( + projectId: "<PROJECT_ID>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -69,6 +145,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/presences/get.md b/examples/1.9.x/server-graphql/examples/presences/get.md index d7962b96e..c7c9da818 100644 --- a/examples/1.9.x/server-graphql/examples/presences/get.md +++ b/examples/1.9.x/server-graphql/examples/presences/get.md @@ -1,2 +1,17 @@ ```graphql +query { + presencesGet( + presenceId: "<PRESENCE_ID>" + ) { + _id + _createdAt + _updatedAt + _permissions + userId + status + source + expiresAt + metadata + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/presences/list.md b/examples/1.9.x/server-graphql/examples/presences/list.md index d7962b96e..ff95bbd1c 100644 --- a/examples/1.9.x/server-graphql/examples/presences/list.md +++ b/examples/1.9.x/server-graphql/examples/presences/list.md @@ -1,2 +1,22 @@ ```graphql +query { + presencesList( + queries: [], + total: false, + ttl: 0 + ) { + total + presences { + _id + _createdAt + _updatedAt + _permissions + userId + status + source + expiresAt + metadata + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/presences/update.md b/examples/1.9.x/server-graphql/examples/presences/update.md index c375c5826..7e57eb814 100644 --- a/examples/1.9.x/server-graphql/examples/presences/update.md +++ b/examples/1.9.x/server-graphql/examples/presences/update.md @@ -20,4 +20,25 @@ mutation { metadata } } +mutation { + presencesUpdate( + presenceId: "<PRESENCE_ID>", + userId: "<USER_ID>", + status: "<STATUS>", + expiresAt: "2020-10-15T06:38:00.000+00:00", + metadata: "{}", + permissions: ["read("any")"], + purge: false + ) { + _id + _createdAt + _updatedAt + _permissions + userId + status + source + expiresAt + metadata + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/presences/upsert.md b/examples/1.9.x/server-graphql/examples/presences/upsert.md index 3452a7d76..15771f426 100644 --- a/examples/1.9.x/server-graphql/examples/presences/upsert.md +++ b/examples/1.9.x/server-graphql/examples/presences/upsert.md @@ -19,4 +19,24 @@ mutation { metadata } } +mutation { + presencesUpsert( + presenceId: "<PRESENCE_ID>", + userId: "<USER_ID>", + status: "<STATUS>", + permissions: ["read("any")"], + expiresAt: "2020-10-15T06:38:00.000+00:00", + metadata: "{}" + ) { + _id + _createdAt + _updatedAt + _permissions + userId + status + source + expiresAt + metadata + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/create-android-platform.md b/examples/1.9.x/server-graphql/examples/project/create-android-platform.md index 1f53067c1..fd4db13a3 100644 --- a/examples/1.9.x/server-graphql/examples/project/create-android-platform.md +++ b/examples/1.9.x/server-graphql/examples/project/create-android-platform.md @@ -13,4 +13,18 @@ mutation { applicationId } } +mutation { + projectCreateAndroidPlatform( + platformId: "<PLATFORM_ID>", + name: "<NAME>", + applicationId: "<APPLICATION_ID>" + ) { + _id + _createdAt + _updatedAt + name + type + applicationId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/create-apple-platform.md b/examples/1.9.x/server-graphql/examples/project/create-apple-platform.md index f1afeae02..330c1c3f7 100644 --- a/examples/1.9.x/server-graphql/examples/project/create-apple-platform.md +++ b/examples/1.9.x/server-graphql/examples/project/create-apple-platform.md @@ -13,4 +13,18 @@ mutation { bundleIdentifier } } +mutation { + projectCreateApplePlatform( + platformId: "<PLATFORM_ID>", + name: "<NAME>", + bundleIdentifier: "<BUNDLE_IDENTIFIER>" + ) { + _id + _createdAt + _updatedAt + name + type + bundleIdentifier + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-graphql/examples/project/create-ephemeral-key.md index c4b996d3d..2be2bdb24 100644 --- a/examples/1.9.x/server-graphql/examples/project/create-ephemeral-key.md +++ b/examples/1.9.x/server-graphql/examples/project/create-ephemeral-key.md @@ -15,4 +15,20 @@ mutation { sdks } } +mutation { + projectCreateEphemeralKey( + scopes: [], + duration: 600 + ) { + _id + _createdAt + _updatedAt + name + expire + scopes + secret + accessedAt + sdks + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/create-key.md b/examples/1.9.x/server-graphql/examples/project/create-key.md index df6f48e10..b5b0c4a7d 100644 --- a/examples/1.9.x/server-graphql/examples/project/create-key.md +++ b/examples/1.9.x/server-graphql/examples/project/create-key.md @@ -17,4 +17,22 @@ mutation { sdks } } +mutation { + projectCreateKey( + keyId: "<KEY_ID>", + name: "<NAME>", + scopes: [], + expire: "2020-10-15T06:38:00.000+00:00" + ) { + _id + _createdAt + _updatedAt + name + expire + scopes + secret + accessedAt + sdks + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/create-linux-platform.md b/examples/1.9.x/server-graphql/examples/project/create-linux-platform.md index 045381c30..5b71245e4 100644 --- a/examples/1.9.x/server-graphql/examples/project/create-linux-platform.md +++ b/examples/1.9.x/server-graphql/examples/project/create-linux-platform.md @@ -13,4 +13,18 @@ mutation { packageName } } +mutation { + projectCreateLinuxPlatform( + platformId: "<PLATFORM_ID>", + name: "<NAME>", + packageName: "<PACKAGE_NAME>" + ) { + _id + _createdAt + _updatedAt + name + type + packageName + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/create-mock-phone.md b/examples/1.9.x/server-graphql/examples/project/create-mock-phone.md index 4c46c01bd..8e3dbe17e 100644 --- a/examples/1.9.x/server-graphql/examples/project/create-mock-phone.md +++ b/examples/1.9.x/server-graphql/examples/project/create-mock-phone.md @@ -10,4 +10,15 @@ mutation { _updatedAt } } +mutation { + projectCreateMockPhone( + number: "+12065550100", + otp: "<OTP>" + ) { + number + otp + _createdAt + _updatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/create-variable.md b/examples/1.9.x/server-graphql/examples/project/create-variable.md index feffcdada..57904f22a 100644 --- a/examples/1.9.x/server-graphql/examples/project/create-variable.md +++ b/examples/1.9.x/server-graphql/examples/project/create-variable.md @@ -16,4 +16,21 @@ mutation { resourceId } } +mutation { + projectCreateVariable( + variableId: "<VARIABLE_ID>", + key: "<KEY>", + value: "<VALUE>", + secret: false + ) { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/create-web-platform.md b/examples/1.9.x/server-graphql/examples/project/create-web-platform.md index 9e5030ea8..a3bae0f60 100644 --- a/examples/1.9.x/server-graphql/examples/project/create-web-platform.md +++ b/examples/1.9.x/server-graphql/examples/project/create-web-platform.md @@ -13,4 +13,18 @@ mutation { hostname } } +mutation { + projectCreateWebPlatform( + platformId: "<PLATFORM_ID>", + name: "<NAME>", + hostname: "app.example.com" + ) { + _id + _createdAt + _updatedAt + name + type + hostname + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/create-windows-platform.md b/examples/1.9.x/server-graphql/examples/project/create-windows-platform.md index 2f58d6a1f..02039180d 100644 --- a/examples/1.9.x/server-graphql/examples/project/create-windows-platform.md +++ b/examples/1.9.x/server-graphql/examples/project/create-windows-platform.md @@ -13,4 +13,18 @@ mutation { packageIdentifierName } } +mutation { + projectCreateWindowsPlatform( + platformId: "<PLATFORM_ID>", + name: "<NAME>", + packageIdentifierName: "<PACKAGE_IDENTIFIER_NAME>" + ) { + _id + _createdAt + _updatedAt + name + type + packageIdentifierName + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/get-email-template.md b/examples/1.9.x/server-graphql/examples/project/get-email-template.md index d7962b96e..2030912c3 100644 --- a/examples/1.9.x/server-graphql/examples/project/get-email-template.md +++ b/examples/1.9.x/server-graphql/examples/project/get-email-template.md @@ -1,2 +1,17 @@ ```graphql +query { + projectGetEmailTemplate( + templateId: "verification", + locale: "af" + ) { + templateId + locale + message + senderName + senderEmail + replyToEmail + replyToName + subject + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/get-key.md b/examples/1.9.x/server-graphql/examples/project/get-key.md index d7962b96e..04f990ebc 100644 --- a/examples/1.9.x/server-graphql/examples/project/get-key.md +++ b/examples/1.9.x/server-graphql/examples/project/get-key.md @@ -1,2 +1,17 @@ ```graphql +query { + projectGetKey( + keyId: "<KEY_ID>" + ) { + _id + _createdAt + _updatedAt + name + expire + scopes + secret + accessedAt + sdks + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/get-mock-phone.md b/examples/1.9.x/server-graphql/examples/project/get-mock-phone.md index d7962b96e..9110f327c 100644 --- a/examples/1.9.x/server-graphql/examples/project/get-mock-phone.md +++ b/examples/1.9.x/server-graphql/examples/project/get-mock-phone.md @@ -1,2 +1,12 @@ ```graphql +query { + projectGetMockPhone( + number: "+12065550100" + ) { + number + otp + _createdAt + _updatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-graphql/examples/project/get-o-auth-2-provider.md index d7962b96e..5e49dccd6 100644 --- a/examples/1.9.x/server-graphql/examples/project/get-o-auth-2-provider.md +++ b/examples/1.9.x/server-graphql/examples/project/get-o-auth-2-provider.md @@ -1,2 +1,12 @@ ```graphql +query { + projectGetOAuth2Provider( + providerId: "amazon" + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/get-platform.md b/examples/1.9.x/server-graphql/examples/project/get-platform.md index d7962b96e..bcb956cbd 100644 --- a/examples/1.9.x/server-graphql/examples/project/get-platform.md +++ b/examples/1.9.x/server-graphql/examples/project/get-platform.md @@ -1,2 +1,14 @@ ```graphql +query { + projectGetPlatform( + platformId: "<PLATFORM_ID>" + ) { + _id + _createdAt + _updatedAt + name + type + hostname + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/get-policy.md b/examples/1.9.x/server-graphql/examples/project/get-policy.md index d7962b96e..ed8e29654 100644 --- a/examples/1.9.x/server-graphql/examples/project/get-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/get-policy.md @@ -1,2 +1,10 @@ ```graphql +query { + projectGetPolicy( + policyId: "password-dictionary" + ) { + _id + enabled + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/get-variable.md b/examples/1.9.x/server-graphql/examples/project/get-variable.md index d7962b96e..7455044ef 100644 --- a/examples/1.9.x/server-graphql/examples/project/get-variable.md +++ b/examples/1.9.x/server-graphql/examples/project/get-variable.md @@ -1,2 +1,16 @@ ```graphql +query { + projectGetVariable( + variableId: "<VARIABLE_ID>" + ) { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/list-email-templates.md b/examples/1.9.x/server-graphql/examples/project/list-email-templates.md index d7962b96e..637f3206d 100644 --- a/examples/1.9.x/server-graphql/examples/project/list-email-templates.md +++ b/examples/1.9.x/server-graphql/examples/project/list-email-templates.md @@ -1,2 +1,20 @@ ```graphql +query { + projectListEmailTemplates( + queries: [], + total: false + ) { + total + templates { + templateId + locale + message + senderName + senderEmail + replyToEmail + replyToName + subject + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/list-keys.md b/examples/1.9.x/server-graphql/examples/project/list-keys.md index d7962b96e..d23c0804e 100644 --- a/examples/1.9.x/server-graphql/examples/project/list-keys.md +++ b/examples/1.9.x/server-graphql/examples/project/list-keys.md @@ -1,2 +1,21 @@ ```graphql +query { + projectListKeys( + queries: [], + total: false + ) { + total + keys { + _id + _createdAt + _updatedAt + name + expire + scopes + secret + accessedAt + sdks + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/list-mock-phones.md b/examples/1.9.x/server-graphql/examples/project/list-mock-phones.md index d7962b96e..8ce0c6f36 100644 --- a/examples/1.9.x/server-graphql/examples/project/list-mock-phones.md +++ b/examples/1.9.x/server-graphql/examples/project/list-mock-phones.md @@ -1,2 +1,16 @@ ```graphql +query { + projectListMockPhones( + queries: [], + total: false + ) { + total + mockNumbers { + number + otp + _createdAt + _updatedAt + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-graphql/examples/project/list-o-auth-2-providers.md index d7962b96e..666bbd8af 100644 --- a/examples/1.9.x/server-graphql/examples/project/list-o-auth-2-providers.md +++ b/examples/1.9.x/server-graphql/examples/project/list-o-auth-2-providers.md @@ -1,2 +1,11 @@ ```graphql +query { + projectListOAuth2Providers( + queries: [], + total: false + ) { + total + providers + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/list-platforms.md b/examples/1.9.x/server-graphql/examples/project/list-platforms.md index d7962b96e..6e5ba0f23 100644 --- a/examples/1.9.x/server-graphql/examples/project/list-platforms.md +++ b/examples/1.9.x/server-graphql/examples/project/list-platforms.md @@ -1,2 +1,11 @@ ```graphql +query { + projectListPlatforms( + queries: [], + total: false + ) { + total + platforms + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/list-policies.md b/examples/1.9.x/server-graphql/examples/project/list-policies.md index d7962b96e..e0590c3e5 100644 --- a/examples/1.9.x/server-graphql/examples/project/list-policies.md +++ b/examples/1.9.x/server-graphql/examples/project/list-policies.md @@ -1,2 +1,11 @@ ```graphql +query { + projectListPolicies( + queries: [], + total: false + ) { + total + policies + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/list-variables.md b/examples/1.9.x/server-graphql/examples/project/list-variables.md index d7962b96e..a4c950a8f 100644 --- a/examples/1.9.x/server-graphql/examples/project/list-variables.md +++ b/examples/1.9.x/server-graphql/examples/project/list-variables.md @@ -1,2 +1,20 @@ ```graphql +query { + projectListVariables( + queries: [], + total: false + ) { + total + variables { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-android-platform.md b/examples/1.9.x/server-graphql/examples/project/update-android-platform.md index 0b33ee8b1..7b924580c 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-android-platform.md +++ b/examples/1.9.x/server-graphql/examples/project/update-android-platform.md @@ -13,4 +13,18 @@ mutation { applicationId } } +mutation { + projectUpdateAndroidPlatform( + platformId: "<PLATFORM_ID>", + name: "<NAME>", + applicationId: "<APPLICATION_ID>" + ) { + _id + _createdAt + _updatedAt + name + type + applicationId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-apple-platform.md b/examples/1.9.x/server-graphql/examples/project/update-apple-platform.md index 53e2cf536..9d920a7ee 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-apple-platform.md +++ b/examples/1.9.x/server-graphql/examples/project/update-apple-platform.md @@ -13,4 +13,18 @@ mutation { bundleIdentifier } } +mutation { + projectUpdateApplePlatform( + platformId: "<PLATFORM_ID>", + name: "<NAME>", + bundleIdentifier: "<BUNDLE_IDENTIFIER>" + ) { + _id + _createdAt + _updatedAt + name + type + bundleIdentifier + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-auth-method.md b/examples/1.9.x/server-graphql/examples/project/update-auth-method.md index 4ba633622..931462dc4 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-auth-method.md +++ b/examples/1.9.x/server-graphql/examples/project/update-auth-method.md @@ -9,6 +9,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -45,7 +46,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -56,6 +69,69 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateAuthMethod( + methodId: "email-password", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -69,6 +145,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-deny-aliased-email-policy.md b/examples/1.9.x/server-graphql/examples/project/update-deny-aliased-email-policy.md index a1c0cb758..cc12873da 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-deny-aliased-email-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-deny-aliased-email-policy.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateDenyAliasedEmailPolicy( + enabled: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-deny-disposable-email-policy.md b/examples/1.9.x/server-graphql/examples/project/update-deny-disposable-email-policy.md index 29b1218ce..4f4d326ce 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-deny-disposable-email-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-deny-disposable-email-policy.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateDenyDisposableEmailPolicy( + enabled: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-deny-free-email-policy.md b/examples/1.9.x/server-graphql/examples/project/update-deny-free-email-policy.md index e0ca3340f..565c62e41 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-deny-free-email-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-deny-free-email-policy.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateDenyFreeEmailPolicy( + enabled: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-email-template.md b/examples/1.9.x/server-graphql/examples/project/update-email-template.md index cbb98d86b..c1a4daeb9 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-email-template.md +++ b/examples/1.9.x/server-graphql/examples/project/update-email-template.md @@ -20,4 +20,25 @@ mutation { subject } } +mutation { + projectUpdateEmailTemplate( + templateId: "verification", + locale: "af", + subject: "<SUBJECT>", + message: "<MESSAGE>", + senderName: "<SENDER_NAME>", + senderEmail: "email@example.com", + replyToEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>" + ) { + templateId + locale + message + senderName + senderEmail + replyToEmail + replyToName + subject + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-key.md b/examples/1.9.x/server-graphql/examples/project/update-key.md index a981941eb..a3fadb90b 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-key.md +++ b/examples/1.9.x/server-graphql/examples/project/update-key.md @@ -17,4 +17,22 @@ mutation { sdks } } +mutation { + projectUpdateKey( + keyId: "<KEY_ID>", + name: "<NAME>", + scopes: [], + expire: "2020-10-15T06:38:00.000+00:00" + ) { + _id + _createdAt + _updatedAt + name + expire + scopes + secret + accessedAt + sdks + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-labels.md b/examples/1.9.x/server-graphql/examples/project/update-labels.md index c9767d3c0..2102c7113 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-labels.md +++ b/examples/1.9.x/server-graphql/examples/project/update-labels.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateLabels( + labels: [] + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-linux-platform.md b/examples/1.9.x/server-graphql/examples/project/update-linux-platform.md index 141398304..4d14cd6f2 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-linux-platform.md +++ b/examples/1.9.x/server-graphql/examples/project/update-linux-platform.md @@ -13,4 +13,18 @@ mutation { packageName } } +mutation { + projectUpdateLinuxPlatform( + platformId: "<PLATFORM_ID>", + name: "<NAME>", + packageName: "<PACKAGE_NAME>" + ) { + _id + _createdAt + _updatedAt + name + type + packageName + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-graphql/examples/project/update-membership-privacy-policy.md index eca7b54ff..28619ab92 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-membership-privacy-policy.md @@ -5,13 +5,15 @@ mutation { userEmail: false, userPhone: false, userName: false, - userMFA: false + userMFA: false, + userAccessedAt: false ) { _id _createdAt _updatedAt name teamId + region devKeys { _id _createdAt @@ -48,7 +50,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -59,6 +73,73 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateMembershipPrivacyPolicy( + userId: false, + userEmail: false, + userPhone: false, + userName: false, + userMFA: false, + userAccessedAt: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -72,6 +153,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-mock-phone.md b/examples/1.9.x/server-graphql/examples/project/update-mock-phone.md index 4194a6bb2..7661ae055 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-mock-phone.md +++ b/examples/1.9.x/server-graphql/examples/project/update-mock-phone.md @@ -10,4 +10,15 @@ mutation { _updatedAt } } +mutation { + projectUpdateMockPhone( + number: "+12065550100", + otp: "<OTP>" + ) { + number + otp + _createdAt + _updatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-amazon.md index 96cfe2796..391de86ee 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-amazon.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-amazon.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Amazon( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-apple.md index 3d9c6f1a9..b0da606cf 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-apple.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-apple.md @@ -15,4 +15,20 @@ mutation { p8File } } +mutation { + projectUpdateOAuth2Apple( + serviceId: "<SERVICE_ID>", + keyId: "<KEY_ID>", + teamId: "<TEAM_ID>", + p8File: "<P8_FILE>", + enabled: false + ) { + _id + enabled + serviceId + keyId + teamId + p8File + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-auth-0.md index 746d0517f..d03942f30 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-auth-0.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-auth-0.md @@ -13,4 +13,18 @@ mutation { endpoint } } +mutation { + projectUpdateOAuth2Auth0( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + endpoint: "<ENDPOINT>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + endpoint + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-authentik.md index bee04673c..27a943db1 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-authentik.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-authentik.md @@ -13,4 +13,18 @@ mutation { endpoint } } +mutation { + projectUpdateOAuth2Authentik( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + endpoint: "<ENDPOINT>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + endpoint + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-autodesk.md index d238ce1a0..dd5fe9dec 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-autodesk.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-autodesk.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Autodesk( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitbucket.md index 41139c2e1..45fc7a938 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitbucket.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitbucket.md @@ -11,4 +11,16 @@ mutation { secret } } +mutation { + projectUpdateOAuth2Bitbucket( + key: "<KEY>", + secret: "<SECRET>", + enabled: false + ) { + _id + enabled + key + secret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitly.md index 72c7707a1..abe9b16c8 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitly.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitly.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Bitly( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-box.md index faa83fc35..83de58d55 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-box.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-box.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Box( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dailymotion.md index dad14b649..936c97896 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dailymotion.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dailymotion.md @@ -11,4 +11,16 @@ mutation { apiSecret } } +mutation { + projectUpdateOAuth2Dailymotion( + apiKey: "<API_KEY>", + apiSecret: "<API_SECRET>", + enabled: false + ) { + _id + enabled + apiKey + apiSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-discord.md index 0b3ed71c6..d17d2c3ae 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-discord.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-discord.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Discord( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-disqus.md index 34890edfa..74f4f1485 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-disqus.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-disqus.md @@ -11,4 +11,16 @@ mutation { secretKey } } +mutation { + projectUpdateOAuth2Disqus( + publicKey: "<PUBLIC_KEY>", + secretKey: "<SECRET_KEY>", + enabled: false + ) { + _id + enabled + publicKey + secretKey + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dropbox.md index 1a78a1ffd..8b9cd539f 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dropbox.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dropbox.md @@ -11,4 +11,16 @@ mutation { appSecret } } +mutation { + projectUpdateOAuth2Dropbox( + appKey: "<APP_KEY>", + appSecret: "<APP_SECRET>", + enabled: false + ) { + _id + enabled + appKey + appSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-etsy.md index 70ca5c82f..33283deeb 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-etsy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-etsy.md @@ -11,4 +11,16 @@ mutation { sharedSecret } } +mutation { + projectUpdateOAuth2Etsy( + keyString: "<KEY_STRING>", + sharedSecret: "<SHARED_SECRET>", + enabled: false + ) { + _id + enabled + keyString + sharedSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-facebook.md index e282290d1..d059ac4ab 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-facebook.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-facebook.md @@ -11,4 +11,16 @@ mutation { appSecret } } +mutation { + projectUpdateOAuth2Facebook( + appId: "<APP_ID>", + appSecret: "<APP_SECRET>", + enabled: false + ) { + _id + enabled + appId + appSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-figma.md index 17d332abc..0334f58ac 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-figma.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-figma.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Figma( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-fusion-auth.md index e7447d1c8..29815c7bd 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-fusion-auth.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-fusion-auth.md @@ -13,4 +13,18 @@ mutation { endpoint } } +mutation { + projectUpdateOAuth2FusionAuth( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + endpoint: "<ENDPOINT>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + endpoint + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-git-hub.md index f5a3880bd..068fcf21c 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-git-hub.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-git-hub.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2GitHub( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-gitlab.md index 7ff242b8e..9f132e27f 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-gitlab.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-gitlab.md @@ -13,4 +13,18 @@ mutation { endpoint } } +mutation { + projectUpdateOAuth2Gitlab( + applicationId: "<APPLICATION_ID>", + secret: "<SECRET>", + endpoint: "https://example.com", + enabled: false + ) { + _id + enabled + applicationId + secret + endpoint + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-google.md index 35e74ee9f..0f4d10e01 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-google.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-google.md @@ -13,4 +13,18 @@ mutation { prompt } } +mutation { + projectUpdateOAuth2Google( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + prompt: [], + enabled: false + ) { + _id + enabled + clientId + clientSecret + prompt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-keycloak.md index 881cb1d5c..e64653656 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-keycloak.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-keycloak.md @@ -15,4 +15,20 @@ mutation { realmName } } +mutation { + projectUpdateOAuth2Keycloak( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + endpoint: "<ENDPOINT>", + realmName: "<REALM_NAME>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + endpoint + realmName + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-kick.md index 09d6779e1..86e98e977 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-kick.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-kick.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Kick( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-linkedin.md index 50f56f116..1f5f0db37 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-linkedin.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-linkedin.md @@ -11,4 +11,16 @@ mutation { primaryClientSecret } } +mutation { + projectUpdateOAuth2Linkedin( + clientId: "<CLIENT_ID>", + primaryClientSecret: "<PRIMARY_CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + primaryClientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-microsoft.md index b80848c01..f33228ae6 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-microsoft.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-microsoft.md @@ -13,4 +13,18 @@ mutation { tenant } } +mutation { + projectUpdateOAuth2Microsoft( + applicationId: "<APPLICATION_ID>", + applicationSecret: "<APPLICATION_SECRET>", + tenant: "<TENANT>", + enabled: false + ) { + _id + enabled + applicationId + applicationSecret + tenant + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-notion.md index be481aecd..2f140502c 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-notion.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-notion.md @@ -11,4 +11,16 @@ mutation { oauthClientSecret } } +mutation { + projectUpdateOAuth2Notion( + oauthClientId: "<OAUTH_CLIENT_ID>", + oauthClientSecret: "<OAUTH_CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + oauthClientId + oauthClientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-oidc.md index 2dcac741b..e3f156b64 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-oidc.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-oidc.md @@ -19,4 +19,24 @@ mutation { userInfoURL } } +mutation { + projectUpdateOAuth2Oidc( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + wellKnownURL: "https://example.com", + authorizationURL: "https://example.com", + tokenURL: "https://example.com", + userInfoURL: "https://example.com", + enabled: false + ) { + _id + enabled + clientId + clientSecret + wellKnownURL + authorizationURL + tokenURL + userInfoURL + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-okta.md index 0ce37992c..6d02834a7 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-okta.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-okta.md @@ -15,4 +15,20 @@ mutation { authorizationServerId } } +mutation { + projectUpdateOAuth2Okta( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + domain: "", + authorizationServerId: "<AUTHORIZATION_SERVER_ID>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + domain + authorizationServerId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal-sandbox.md index 9d22e49be..bbdf41334 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal-sandbox.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal-sandbox.md @@ -11,4 +11,16 @@ mutation { secretKey } } +mutation { + projectUpdateOAuth2PaypalSandbox( + clientId: "<CLIENT_ID>", + secretKey: "<SECRET_KEY>", + enabled: false + ) { + _id + enabled + clientId + secretKey + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal.md index d106a4ddb..6b88931cc 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal.md @@ -11,4 +11,16 @@ mutation { secretKey } } +mutation { + projectUpdateOAuth2Paypal( + clientId: "<CLIENT_ID>", + secretKey: "<SECRET_KEY>", + enabled: false + ) { + _id + enabled + clientId + secretKey + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-podio.md index 41847a43f..fd1722d00 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-podio.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-podio.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Podio( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-salesforce.md index ab63ff525..daad79601 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-salesforce.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-salesforce.md @@ -11,4 +11,16 @@ mutation { customerSecret } } +mutation { + projectUpdateOAuth2Salesforce( + customerKey: "<CUSTOMER_KEY>", + customerSecret: "<CUSTOMER_SECRET>", + enabled: false + ) { + _id + enabled + customerKey + customerSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-server.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..4a1a72099 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-server.md @@ -0,0 +1,196 @@ +```graphql +mutation { + projectUpdateOAuth2Server( + enabled: false, + authorizationUrl: "https://example.com", + scopes: [], + authorizationDetailsTypes: [], + accessTokenDuration: 60, + refreshTokenDuration: 60, + publicAccessTokenDuration: 60, + publicRefreshTokenDuration: 60, + confidentialPkce: false, + verificationUrl: "https://example.com", + userCodeLength: 6, + userCodeFormat: "numeric", + deviceCodeDuration: 60 + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateOAuth2Server( + enabled: false, + authorizationUrl: "https://example.com", + scopes: [], + authorizationDetailsTypes: [], + accessTokenDuration: 60, + refreshTokenDuration: 60, + publicAccessTokenDuration: 60, + publicRefreshTokenDuration: 60, + confidentialPkce: false, + verificationUrl: "https://example.com", + userCodeLength: 6, + userCodeFormat: "numeric", + deviceCodeDuration: 60 + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-slack.md index cdee16942..2e5e9d833 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-slack.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-slack.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Slack( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-spotify.md index cd0b342ae..55af86e6a 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-spotify.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-spotify.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Spotify( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-stripe.md index c34176870..46de3ec70 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-stripe.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-stripe.md @@ -11,4 +11,16 @@ mutation { apiSecretKey } } +mutation { + projectUpdateOAuth2Stripe( + clientId: "<CLIENT_ID>", + apiSecretKey: "<API_SECRET_KEY>", + enabled: false + ) { + _id + enabled + clientId + apiSecretKey + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift-sandbox.md index 6bcf5dc9b..82663b8bd 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift-sandbox.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -11,4 +11,16 @@ mutation { oauth2ClientSecret } } +mutation { + projectUpdateOAuth2TradeshiftSandbox( + oauth2ClientId: "<OAUTH2_CLIENT_ID>", + oauth2ClientSecret: "<OAUTH2_CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + oauth2ClientId + oauth2ClientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift.md index dda26edc9..895761545 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift.md @@ -11,4 +11,16 @@ mutation { oauth2ClientSecret } } +mutation { + projectUpdateOAuth2Tradeshift( + oauth2ClientId: "<OAUTH2_CLIENT_ID>", + oauth2ClientSecret: "<OAUTH2_CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + oauth2ClientId + oauth2ClientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-twitch.md index 60893d37a..7f81833ed 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-twitch.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-twitch.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Twitch( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-word-press.md index 2c1a90d4b..e317249c9 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-word-press.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-word-press.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2WordPress( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yahoo.md index 0cebeb3bb..f72a72ac1 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yahoo.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yahoo.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Yahoo( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yandex.md index e26e2c344..864c9ecf0 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yandex.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yandex.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Yandex( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoho.md index b71bd18d5..f4b18834e 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoho.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoho.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Zoho( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoom.md index 3ef225a46..195d456bc 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoom.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoom.md @@ -11,4 +11,16 @@ mutation { clientSecret } } +mutation { + projectUpdateOAuth2Zoom( + clientId: "<CLIENT_ID>", + clientSecret: "<CLIENT_SECRET>", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2x.md index 79bb52c9a..53ab96b84 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2x.md +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2x.md @@ -11,4 +11,16 @@ mutation { secretKey } } +mutation { + projectUpdateOAuth2X( + customerKey: "<CUSTOMER_KEY>", + secretKey: "<SECRET_KEY>", + enabled: false + ) { + _id + enabled + customerKey + secretKey + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-password-dictionary-policy.md b/examples/1.9.x/server-graphql/examples/project/update-password-dictionary-policy.md index de2f5051a..547b637a9 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-password-dictionary-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-password-dictionary-policy.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdatePasswordDictionaryPolicy( + enabled: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-password-history-policy.md b/examples/1.9.x/server-graphql/examples/project/update-password-history-policy.md index f79823599..db2151e53 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-password-history-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-password-history-policy.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdatePasswordHistoryPolicy( + total: 1 + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-password-personal-data-policy.md b/examples/1.9.x/server-graphql/examples/project/update-password-personal-data-policy.md index 19f72992f..5c09813c3 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-password-personal-data-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-password-personal-data-policy.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdatePasswordPersonalDataPolicy( + enabled: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-password-strength-policy.md b/examples/1.9.x/server-graphql/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..8b558ae85 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-password-strength-policy.md @@ -0,0 +1,34 @@ +```graphql +mutation { + projectUpdatePasswordStrengthPolicy( + min: 8, + uppercase: false, + lowercase: false, + number: false, + symbols: false + ) { + _id + min + uppercase + lowercase + number + symbols + } +} +mutation { + projectUpdatePasswordStrengthPolicy( + min: 8, + uppercase: false, + lowercase: false, + number: false, + symbols: false + ) { + _id + min + uppercase + lowercase + number + symbols + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-protocol.md b/examples/1.9.x/server-graphql/examples/project/update-protocol.md index 9db28ed9e..f2b7e8493 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-protocol.md +++ b/examples/1.9.x/server-graphql/examples/project/update-protocol.md @@ -9,6 +9,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -45,7 +46,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -56,6 +69,69 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateProtocol( + protocolId: "rest", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -69,6 +145,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-service.md b/examples/1.9.x/server-graphql/examples/project/update-service.md index b91981d74..093d0db75 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-service.md +++ b/examples/1.9.x/server-graphql/examples/project/update-service.md @@ -9,6 +9,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -45,7 +46,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -56,6 +69,69 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateService( + serviceId: "account", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -69,6 +145,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-session-alert-policy.md b/examples/1.9.x/server-graphql/examples/project/update-session-alert-policy.md index 2c849f228..a852f9352 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-session-alert-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-session-alert-policy.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateSessionAlertPolicy( + enabled: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-session-duration-policy.md b/examples/1.9.x/server-graphql/examples/project/update-session-duration-policy.md index c7cd3a3b5..f3920aa38 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-session-duration-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-session-duration-policy.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateSessionDurationPolicy( + duration: 5 + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-session-invalidation-policy.md b/examples/1.9.x/server-graphql/examples/project/update-session-invalidation-policy.md index cd6b26a31..cdf8bd619 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-session-invalidation-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-session-invalidation-policy.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateSessionInvalidationPolicy( + enabled: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-session-limit-policy.md b/examples/1.9.x/server-graphql/examples/project/update-session-limit-policy.md index 8ed540e0a..e274f3a87 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-session-limit-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-session-limit-policy.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateSessionLimitPolicy( + total: 1 + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-smtp.md b/examples/1.9.x/server-graphql/examples/project/update-smtp.md index 4395957cc..1db2ad59a 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-smtp.md +++ b/examples/1.9.x/server-graphql/examples/project/update-smtp.md @@ -4,7 +4,7 @@ mutation { host: "", port: 0, username: "<USERNAME>", - password: "<PASSWORD>", + password: "password", senderEmail: "email@example.com", senderName: "<SENDER_NAME>", replyToEmail: "email@example.com", @@ -17,6 +17,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -53,7 +54,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -64,6 +77,77 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateSMTP( + host: "", + port: 0, + username: "<USERNAME>", + password: "password", + senderEmail: "email@example.com", + senderName: "<SENDER_NAME>", + replyToEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + secure: "tls", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -77,6 +161,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-user-limit-policy.md b/examples/1.9.x/server-graphql/examples/project/update-user-limit-policy.md index 2b84387d6..8b3112b0e 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-user-limit-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-user-limit-policy.md @@ -8,6 +8,7 @@ mutation { _updatedAt name teamId + region devKeys { _id _createdAt @@ -44,7 +45,19 @@ mutation { _id enabled } - region + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt billingLimits { bandwidth storage @@ -55,6 +68,68 @@ mutation { authPhone budgetLimit } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl + } +} +mutation { + projectUpdateUserLimitPolicy( + total: 1 + ) { + _id + _createdAt + _updatedAt + name + teamId + region + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authMethods { + _id + enabled + } + services { + _id + enabled + } + protocols { + _id + enabled + } blocks { _createdAt resourceType @@ -68,6 +143,30 @@ mutation { billingPlan } consoleAccessedAt + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + oAuth2ServerEnabled + oAuth2ServerAuthorizationUrl + oAuth2ServerScopes + oAuth2ServerAuthorizationDetailsTypes + oAuth2ServerAccessTokenDuration + oAuth2ServerRefreshTokenDuration + oAuth2ServerPublicAccessTokenDuration + oAuth2ServerPublicRefreshTokenDuration + oAuth2ServerConfidentialPkce + oAuth2ServerVerificationUrl + oAuth2ServerUserCodeLength + oAuth2ServerUserCodeFormat + oAuth2ServerDeviceCodeDuration + oAuth2ServerDiscoveryUrl } } ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-variable.md b/examples/1.9.x/server-graphql/examples/project/update-variable.md index aed16928b..a0aa5d3a7 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-variable.md +++ b/examples/1.9.x/server-graphql/examples/project/update-variable.md @@ -16,4 +16,21 @@ mutation { resourceId } } +mutation { + projectUpdateVariable( + variableId: "<VARIABLE_ID>", + key: "<KEY>", + value: "<VALUE>", + secret: false + ) { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-web-platform.md b/examples/1.9.x/server-graphql/examples/project/update-web-platform.md index afca13f00..7cde89726 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-web-platform.md +++ b/examples/1.9.x/server-graphql/examples/project/update-web-platform.md @@ -13,4 +13,18 @@ mutation { hostname } } +mutation { + projectUpdateWebPlatform( + platformId: "<PLATFORM_ID>", + name: "<NAME>", + hostname: "app.example.com" + ) { + _id + _createdAt + _updatedAt + name + type + hostname + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-windows-platform.md b/examples/1.9.x/server-graphql/examples/project/update-windows-platform.md index f0142c5bb..3b6618ada 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-windows-platform.md +++ b/examples/1.9.x/server-graphql/examples/project/update-windows-platform.md @@ -13,4 +13,18 @@ mutation { packageIdentifierName } } +mutation { + projectUpdateWindowsPlatform( + platformId: "<PLATFORM_ID>", + name: "<NAME>", + packageIdentifierName: "<PACKAGE_IDENTIFIER_NAME>" + ) { + _id + _createdAt + _updatedAt + name + type + packageIdentifierName + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/proxy/create-api-rule.md b/examples/1.9.x/server-graphql/examples/proxy/create-api-rule.md index 24560f05a..3b54693a9 100644 --- a/examples/1.9.x/server-graphql/examples/proxy/create-api-rule.md +++ b/examples/1.9.x/server-graphql/examples/proxy/create-api-rule.md @@ -20,4 +20,25 @@ mutation { renewAt } } +mutation { + proxyCreateAPIRule( + domain: "" + ) { + _id + _createdAt + _updatedAt + domain + type + trigger + redirectUrl + redirectStatusCode + deploymentId + deploymentResourceType + deploymentResourceId + deploymentVcsProviderBranch + status + logs + renewAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/proxy/create-function-rule.md b/examples/1.9.x/server-graphql/examples/proxy/create-function-rule.md index 1d6feba16..5fde24796 100644 --- a/examples/1.9.x/server-graphql/examples/proxy/create-function-rule.md +++ b/examples/1.9.x/server-graphql/examples/proxy/create-function-rule.md @@ -22,4 +22,27 @@ mutation { renewAt } } +mutation { + proxyCreateFunctionRule( + domain: "", + functionId: "<FUNCTION_ID>", + branch: "<BRANCH>" + ) { + _id + _createdAt + _updatedAt + domain + type + trigger + redirectUrl + redirectStatusCode + deploymentId + deploymentResourceType + deploymentResourceId + deploymentVcsProviderBranch + status + logs + renewAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/proxy/create-redirect-rule.md b/examples/1.9.x/server-graphql/examples/proxy/create-redirect-rule.md index 6e5b8a67c..0606ecad3 100644 --- a/examples/1.9.x/server-graphql/examples/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-graphql/examples/proxy/create-redirect-rule.md @@ -24,4 +24,29 @@ mutation { renewAt } } +mutation { + proxyCreateRedirectRule( + domain: "", + url: "https://example.com", + statusCode: "301", + resourceId: "<RESOURCE_ID>", + resourceType: "site" + ) { + _id + _createdAt + _updatedAt + domain + type + trigger + redirectUrl + redirectStatusCode + deploymentId + deploymentResourceType + deploymentResourceId + deploymentVcsProviderBranch + status + logs + renewAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/proxy/create-site-rule.md b/examples/1.9.x/server-graphql/examples/proxy/create-site-rule.md index c47cd1908..a976a4757 100644 --- a/examples/1.9.x/server-graphql/examples/proxy/create-site-rule.md +++ b/examples/1.9.x/server-graphql/examples/proxy/create-site-rule.md @@ -22,4 +22,27 @@ mutation { renewAt } } +mutation { + proxyCreateSiteRule( + domain: "", + siteId: "<SITE_ID>", + branch: "<BRANCH>" + ) { + _id + _createdAt + _updatedAt + domain + type + trigger + redirectUrl + redirectStatusCode + deploymentId + deploymentResourceType + deploymentResourceId + deploymentVcsProviderBranch + status + logs + renewAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/proxy/get-rule.md b/examples/1.9.x/server-graphql/examples/proxy/get-rule.md index d7962b96e..2e921ebbd 100644 --- a/examples/1.9.x/server-graphql/examples/proxy/get-rule.md +++ b/examples/1.9.x/server-graphql/examples/proxy/get-rule.md @@ -1,2 +1,23 @@ ```graphql +query { + proxyGetRule( + ruleId: "<RULE_ID>" + ) { + _id + _createdAt + _updatedAt + domain + type + trigger + redirectUrl + redirectStatusCode + deploymentId + deploymentResourceType + deploymentResourceId + deploymentVcsProviderBranch + status + logs + renewAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/proxy/list-rules.md b/examples/1.9.x/server-graphql/examples/proxy/list-rules.md index d7962b96e..984f3e8db 100644 --- a/examples/1.9.x/server-graphql/examples/proxy/list-rules.md +++ b/examples/1.9.x/server-graphql/examples/proxy/list-rules.md @@ -1,2 +1,27 @@ ```graphql +query { + proxyListRules( + queries: [], + total: false + ) { + total + rules { + _id + _createdAt + _updatedAt + domain + type + trigger + redirectUrl + redirectStatusCode + deploymentId + deploymentResourceType + deploymentResourceId + deploymentVcsProviderBranch + status + logs + renewAt + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/proxy/update-rule-status.md b/examples/1.9.x/server-graphql/examples/proxy/update-rule-status.md index dd9fbf67e..3ba0faefc 100644 --- a/examples/1.9.x/server-graphql/examples/proxy/update-rule-status.md +++ b/examples/1.9.x/server-graphql/examples/proxy/update-rule-status.md @@ -20,4 +20,25 @@ mutation { renewAt } } +mutation { + proxyUpdateRuleStatus( + ruleId: "<RULE_ID>" + ) { + _id + _createdAt + _updatedAt + domain + type + trigger + redirectUrl + redirectStatusCode + deploymentId + deploymentResourceType + deploymentResourceId + deploymentVcsProviderBranch + status + logs + renewAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/create-deployment.md b/examples/1.9.x/server-graphql/examples/sites/create-deployment.md index f936e7b95..61a89bece 100644 --- a/examples/1.9.x/server-graphql/examples/sites/create-deployment.md +++ b/examples/1.9.x/server-graphql/examples/sites/create-deployment.md @@ -2,9 +2,9 @@ POST /v1/sites/{siteId}/deployments HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> Content-Length: *Length of your entity body in bytes* --cec8e8123c05ba25 @@ -23,4 +23,42 @@ Content-Disposition: form-data; name="0"; filename="code.ext" File contents --cec8e8123c05ba25-- +mutation { + sitesCreateDeployment( + siteId: "<SITE_ID>", + code: null, + installCommand: "<INSTALL_COMMAND>", + buildCommand: "<BUILD_COMMAND>", + outputDirectory: "<OUTPUT_DIRECTORY>", + activate: false + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/create-duplicate-deployment.md b/examples/1.9.x/server-graphql/examples/sites/create-duplicate-deployment.md index 598ed8c4a..151c2d44b 100644 --- a/examples/1.9.x/server-graphql/examples/sites/create-duplicate-deployment.md +++ b/examples/1.9.x/server-graphql/examples/sites/create-duplicate-deployment.md @@ -33,4 +33,38 @@ mutation { providerBranchUrl } } +mutation { + sitesCreateDuplicateDeployment( + siteId: "<SITE_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/create-template-deployment.md b/examples/1.9.x/server-graphql/examples/sites/create-template-deployment.md index 8c449e086..9fad8589d 100644 --- a/examples/1.9.x/server-graphql/examples/sites/create-template-deployment.md +++ b/examples/1.9.x/server-graphql/examples/sites/create-template-deployment.md @@ -38,4 +38,43 @@ mutation { providerBranchUrl } } +mutation { + sitesCreateTemplateDeployment( + siteId: "<SITE_ID>", + repository: "<REPOSITORY>", + owner: "<OWNER>", + rootDirectory: "<ROOT_DIRECTORY>", + type: "branch", + reference: "<REFERENCE>", + activate: false + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/create-variable.md b/examples/1.9.x/server-graphql/examples/sites/create-variable.md index 6c66d109d..8a30dc9d4 100644 --- a/examples/1.9.x/server-graphql/examples/sites/create-variable.md +++ b/examples/1.9.x/server-graphql/examples/sites/create-variable.md @@ -17,4 +17,22 @@ mutation { resourceId } } +mutation { + sitesCreateVariable( + siteId: "<SITE_ID>", + variableId: "<VARIABLE_ID>", + key: "<KEY>", + value: "<VALUE>", + secret: false + ) { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/create-vcs-deployment.md b/examples/1.9.x/server-graphql/examples/sites/create-vcs-deployment.md index ef9b8aeb2..d0a7b0f20 100644 --- a/examples/1.9.x/server-graphql/examples/sites/create-vcs-deployment.md +++ b/examples/1.9.x/server-graphql/examples/sites/create-vcs-deployment.md @@ -35,4 +35,40 @@ mutation { providerBranchUrl } } +mutation { + sitesCreateVcsDeployment( + siteId: "<SITE_ID>", + type: "branch", + reference: "<REFERENCE>", + activate: false + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/create.md b/examples/1.9.x/server-graphql/examples/sites/create.md index ca011eab2..7a1569d2b 100644 --- a/examples/1.9.x/server-graphql/examples/sites/create.md +++ b/examples/1.9.x/server-graphql/examples/sites/create.md @@ -70,4 +70,75 @@ mutation { fallbackFile } } +mutation { + sitesCreate( + siteId: "<SITE_ID>", + name: "<NAME>", + framework: "analog", + buildRuntime: "node-14.5", + enabled: false, + logging: false, + timeout: 1, + installCommand: "<INSTALL_COMMAND>", + buildCommand: "<BUILD_COMMAND>", + startCommand: "<START_COMMAND>", + outputDirectory: "<OUTPUT_DIRECTORY>", + adapter: "static", + installationId: "<INSTALLATION_ID>", + fallbackFile: "<FALLBACK_FILE>", + providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", + providerBranch: "<PROVIDER_BRANCH>", + providerSilentMode: false, + providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", + providerBranches: [], + providerPaths: [], + buildSpecification: "", + runtimeSpecification: "", + deploymentRetention: 0 + ) { + _id + _createdAt + _updatedAt + name + enabled + live + logging + framework + deploymentRetention + deploymentId + deploymentCreatedAt + deploymentScreenshotLight + deploymentScreenshotDark + latestDeploymentId + latestDeploymentCreatedAt + latestDeploymentStatus + vars { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + timeout + installCommand + buildCommand + startCommand + outputDirectory + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + providerBranches + providerPaths + buildSpecification + runtimeSpecification + buildRuntime + adapter + fallbackFile + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/delete-log.md b/examples/1.9.x/server-graphql/examples/sites/delete-log.md index b10099edc..0084c657e 100644 --- a/examples/1.9.x/server-graphql/examples/sites/delete-log.md +++ b/examples/1.9.x/server-graphql/examples/sites/delete-log.md @@ -7,4 +7,12 @@ mutation { status } } +mutation { + sitesDeleteLog( + siteId: "<SITE_ID>", + logId: "<LOG_ID>" + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/get-deployment-download.md b/examples/1.9.x/server-graphql/examples/sites/get-deployment-download.md index d7962b96e..38b471a10 100644 --- a/examples/1.9.x/server-graphql/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-graphql/examples/sites/get-deployment-download.md @@ -1,2 +1,11 @@ ```graphql +query { + sitesGetDeploymentDownload( + siteId: "<SITE_ID>", + deploymentId: "<DEPLOYMENT_ID>", + type: "source" + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/get-deployment.md b/examples/1.9.x/server-graphql/examples/sites/get-deployment.md index d7962b96e..1a05a08fa 100644 --- a/examples/1.9.x/server-graphql/examples/sites/get-deployment.md +++ b/examples/1.9.x/server-graphql/examples/sites/get-deployment.md @@ -1,2 +1,36 @@ ```graphql +query { + sitesGetDeployment( + siteId: "<SITE_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/get-log.md b/examples/1.9.x/server-graphql/examples/sites/get-log.md index d7962b96e..f518d1f3e 100644 --- a/examples/1.9.x/server-graphql/examples/sites/get-log.md +++ b/examples/1.9.x/server-graphql/examples/sites/get-log.md @@ -1,2 +1,33 @@ ```graphql +query { + sitesGetLog( + siteId: "<SITE_ID>", + logId: "<LOG_ID>" + ) { + _id + _createdAt + _updatedAt + _permissions + functionId + deploymentId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + scheduledAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/get-variable.md b/examples/1.9.x/server-graphql/examples/sites/get-variable.md index d7962b96e..bb8500f84 100644 --- a/examples/1.9.x/server-graphql/examples/sites/get-variable.md +++ b/examples/1.9.x/server-graphql/examples/sites/get-variable.md @@ -1,2 +1,17 @@ ```graphql +query { + sitesGetVariable( + siteId: "<SITE_ID>", + variableId: "<VARIABLE_ID>" + ) { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/get.md b/examples/1.9.x/server-graphql/examples/sites/get.md index d7962b96e..4ba2e0242 100644 --- a/examples/1.9.x/server-graphql/examples/sites/get.md +++ b/examples/1.9.x/server-graphql/examples/sites/get.md @@ -1,2 +1,51 @@ ```graphql +query { + sitesGet( + siteId: "<SITE_ID>" + ) { + _id + _createdAt + _updatedAt + name + enabled + live + logging + framework + deploymentRetention + deploymentId + deploymentCreatedAt + deploymentScreenshotLight + deploymentScreenshotDark + latestDeploymentId + latestDeploymentCreatedAt + latestDeploymentStatus + vars { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + timeout + installCommand + buildCommand + startCommand + outputDirectory + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + providerBranches + providerPaths + buildSpecification + runtimeSpecification + buildRuntime + adapter + fallbackFile + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/list-deployments.md b/examples/1.9.x/server-graphql/examples/sites/list-deployments.md index d7962b96e..385bff80d 100644 --- a/examples/1.9.x/server-graphql/examples/sites/list-deployments.md +++ b/examples/1.9.x/server-graphql/examples/sites/list-deployments.md @@ -1,2 +1,41 @@ ```graphql +query { + sitesListDeployments( + siteId: "<SITE_ID>", + queries: [], + search: "<SEARCH>", + total: false + ) { + total + deployments { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/list-frameworks.md b/examples/1.9.x/server-graphql/examples/sites/list-frameworks.md index d7962b96e..1faf1fd83 100644 --- a/examples/1.9.x/server-graphql/examples/sites/list-frameworks.md +++ b/examples/1.9.x/server-graphql/examples/sites/list-frameworks.md @@ -1,2 +1,20 @@ ```graphql +query { + sitesListFrameworks { + total + frameworks { + key + name + buildRuntime + runtimes + adapters { + key + installCommand + buildCommand + outputDirectory + fallbackFile + } + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/list-logs.md b/examples/1.9.x/server-graphql/examples/sites/list-logs.md index d7962b96e..28aafd67f 100644 --- a/examples/1.9.x/server-graphql/examples/sites/list-logs.md +++ b/examples/1.9.x/server-graphql/examples/sites/list-logs.md @@ -1,2 +1,37 @@ ```graphql +query { + sitesListLogs( + siteId: "<SITE_ID>", + queries: [], + total: false + ) { + total + executions { + _id + _createdAt + _updatedAt + _permissions + functionId + deploymentId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + scheduledAt + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/list-specifications.md b/examples/1.9.x/server-graphql/examples/sites/list-specifications.md index d7962b96e..980467e49 100644 --- a/examples/1.9.x/server-graphql/examples/sites/list-specifications.md +++ b/examples/1.9.x/server-graphql/examples/sites/list-specifications.md @@ -1,2 +1,13 @@ ```graphql +query { + sitesListSpecifications { + total + specifications { + memory + cpus + enabled + slug + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/list-variables.md b/examples/1.9.x/server-graphql/examples/sites/list-variables.md index d7962b96e..dddd1ae55 100644 --- a/examples/1.9.x/server-graphql/examples/sites/list-variables.md +++ b/examples/1.9.x/server-graphql/examples/sites/list-variables.md @@ -1,2 +1,21 @@ ```graphql +query { + sitesListVariables( + siteId: "<SITE_ID>", + queries: [], + total: false + ) { + total + variables { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/list.md b/examples/1.9.x/server-graphql/examples/sites/list.md index d7962b96e..235f208e6 100644 --- a/examples/1.9.x/server-graphql/examples/sites/list.md +++ b/examples/1.9.x/server-graphql/examples/sites/list.md @@ -1,2 +1,56 @@ ```graphql +query { + sitesList( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + sites { + _id + _createdAt + _updatedAt + name + enabled + live + logging + framework + deploymentRetention + deploymentId + deploymentCreatedAt + deploymentScreenshotLight + deploymentScreenshotDark + latestDeploymentId + latestDeploymentCreatedAt + latestDeploymentStatus + vars { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + timeout + installCommand + buildCommand + startCommand + outputDirectory + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + providerBranches + providerPaths + buildSpecification + runtimeSpecification + buildRuntime + adapter + fallbackFile + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/update-deployment-status.md b/examples/1.9.x/server-graphql/examples/sites/update-deployment-status.md index 4bb5c5977..63497cab9 100644 --- a/examples/1.9.x/server-graphql/examples/sites/update-deployment-status.md +++ b/examples/1.9.x/server-graphql/examples/sites/update-deployment-status.md @@ -33,4 +33,38 @@ mutation { providerBranchUrl } } +mutation { + sitesUpdateDeploymentStatus( + siteId: "<SITE_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + sourceSize + buildSize + totalSize + buildId + activate + screenshotLight + screenshotDark + status + buildLogs + buildDuration + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranch + providerBranchUrl + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/update-site-deployment.md b/examples/1.9.x/server-graphql/examples/sites/update-site-deployment.md index d5c3dcb2a..4a1312959 100644 --- a/examples/1.9.x/server-graphql/examples/sites/update-site-deployment.md +++ b/examples/1.9.x/server-graphql/examples/sites/update-site-deployment.md @@ -49,4 +49,54 @@ mutation { fallbackFile } } +mutation { + sitesUpdateSiteDeployment( + siteId: "<SITE_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + _id + _createdAt + _updatedAt + name + enabled + live + logging + framework + deploymentRetention + deploymentId + deploymentCreatedAt + deploymentScreenshotLight + deploymentScreenshotDark + latestDeploymentId + latestDeploymentCreatedAt + latestDeploymentStatus + vars { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + timeout + installCommand + buildCommand + startCommand + outputDirectory + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + providerBranches + providerPaths + buildSpecification + runtimeSpecification + buildRuntime + adapter + fallbackFile + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/update-variable.md b/examples/1.9.x/server-graphql/examples/sites/update-variable.md index 05a8a186c..ef403f11d 100644 --- a/examples/1.9.x/server-graphql/examples/sites/update-variable.md +++ b/examples/1.9.x/server-graphql/examples/sites/update-variable.md @@ -17,4 +17,22 @@ mutation { resourceId } } +mutation { + sitesUpdateVariable( + siteId: "<SITE_ID>", + variableId: "<VARIABLE_ID>", + key: "<KEY>", + value: "<VALUE>", + secret: false + ) { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/sites/update.md b/examples/1.9.x/server-graphql/examples/sites/update.md index 51deb90d0..887777786 100644 --- a/examples/1.9.x/server-graphql/examples/sites/update.md +++ b/examples/1.9.x/server-graphql/examples/sites/update.md @@ -70,4 +70,75 @@ mutation { fallbackFile } } +mutation { + sitesUpdate( + siteId: "<SITE_ID>", + name: "<NAME>", + framework: "analog", + enabled: false, + logging: false, + timeout: 1, + installCommand: "<INSTALL_COMMAND>", + buildCommand: "<BUILD_COMMAND>", + startCommand: "<START_COMMAND>", + outputDirectory: "<OUTPUT_DIRECTORY>", + buildRuntime: "node-14.5", + adapter: "static", + fallbackFile: "<FALLBACK_FILE>", + installationId: "<INSTALLATION_ID>", + providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", + providerBranch: "<PROVIDER_BRANCH>", + providerSilentMode: false, + providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", + providerBranches: [], + providerPaths: [], + buildSpecification: "", + runtimeSpecification: "", + deploymentRetention: 0 + ) { + _id + _createdAt + _updatedAt + name + enabled + live + logging + framework + deploymentRetention + deploymentId + deploymentCreatedAt + deploymentScreenshotLight + deploymentScreenshotDark + latestDeploymentId + latestDeploymentCreatedAt + latestDeploymentStatus + vars { + _id + _createdAt + _updatedAt + key + value + secret + resourceType + resourceId + } + timeout + installCommand + buildCommand + startCommand + outputDirectory + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + providerBranches + providerPaths + buildSpecification + runtimeSpecification + buildRuntime + adapter + fallbackFile + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/storage/create-bucket.md b/examples/1.9.x/server-graphql/examples/storage/create-bucket.md index ef644aebd..75fd7dce3 100644 --- a/examples/1.9.x/server-graphql/examples/storage/create-bucket.md +++ b/examples/1.9.x/server-graphql/examples/storage/create-bucket.md @@ -29,4 +29,34 @@ mutation { totalSize } } +mutation { + storageCreateBucket( + bucketId: "<BUCKET_ID>", + name: "<NAME>", + permissions: ["read("any")"], + fileSecurity: false, + enabled: false, + maximumFileSize: 1, + allowedFileExtensions: [], + compression: "none", + encryption: false, + antivirus: false, + transformations: false + ) { + _id + _createdAt + _updatedAt + _permissions + fileSecurity + name + enabled + maximumFileSize + allowedFileExtensions + compression + encryption + antivirus + transformations + totalSize + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/storage/create-file.md b/examples/1.9.x/server-graphql/examples/storage/create-file.md index ff9bab69e..58e0a56a2 100644 --- a/examples/1.9.x/server-graphql/examples/storage/create-file.md +++ b/examples/1.9.x/server-graphql/examples/storage/create-file.md @@ -2,11 +2,9 @@ POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> Content-Length: *Length of your entity body in bytes* --cec8e8123c05ba25 @@ -25,4 +23,27 @@ Content-Disposition: form-data; name="0"; filename="file.ext" File contents --cec8e8123c05ba25-- +mutation { + storageCreateFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + file: null, + permissions: ["read("any")"] + ) { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + sizeActual + chunksTotal + chunksUploaded + encryption + compression + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/storage/get-bucket.md b/examples/1.9.x/server-graphql/examples/storage/get-bucket.md index d7962b96e..fe4b523b8 100644 --- a/examples/1.9.x/server-graphql/examples/storage/get-bucket.md +++ b/examples/1.9.x/server-graphql/examples/storage/get-bucket.md @@ -1,2 +1,22 @@ ```graphql +query { + storageGetBucket( + bucketId: "<BUCKET_ID>" + ) { + _id + _createdAt + _updatedAt + _permissions + fileSecurity + name + enabled + maximumFileSize + allowedFileExtensions + compression + encryption + antivirus + transformations + totalSize + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/storage/get-file-download.md b/examples/1.9.x/server-graphql/examples/storage/get-file-download.md index d7962b96e..f323f21e2 100644 --- a/examples/1.9.x/server-graphql/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-graphql/examples/storage/get-file-download.md @@ -1,2 +1,11 @@ ```graphql +query { + storageGetFileDownload( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + token: "<TOKEN>" + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/storage/get-file-preview.md b/examples/1.9.x/server-graphql/examples/storage/get-file-preview.md index d7962b96e..9435ad116 100644 --- a/examples/1.9.x/server-graphql/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-graphql/examples/storage/get-file-preview.md @@ -1,2 +1,22 @@ ```graphql +query { + storageGetFilePreview( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + width: 0, + height: 0, + gravity: "center", + quality: -1, + borderWidth: 0, + borderColor: "", + borderRadius: 0, + opacity: 0, + rotation: -360, + background: "", + output: "jpg", + token: "<TOKEN>" + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/storage/get-file-view.md b/examples/1.9.x/server-graphql/examples/storage/get-file-view.md index d7962b96e..7871a3111 100644 --- a/examples/1.9.x/server-graphql/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-graphql/examples/storage/get-file-view.md @@ -1,2 +1,11 @@ ```graphql +query { + storageGetFileView( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + token: "<TOKEN>" + ) { + status + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/storage/get-file.md b/examples/1.9.x/server-graphql/examples/storage/get-file.md index d7962b96e..2614d069f 100644 --- a/examples/1.9.x/server-graphql/examples/storage/get-file.md +++ b/examples/1.9.x/server-graphql/examples/storage/get-file.md @@ -1,2 +1,23 @@ ```graphql +query { + storageGetFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" + ) { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + sizeActual + chunksTotal + chunksUploaded + encryption + compression + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/storage/list-buckets.md b/examples/1.9.x/server-graphql/examples/storage/list-buckets.md index d7962b96e..96d6ed47d 100644 --- a/examples/1.9.x/server-graphql/examples/storage/list-buckets.md +++ b/examples/1.9.x/server-graphql/examples/storage/list-buckets.md @@ -1,2 +1,27 @@ ```graphql +query { + storageListBuckets( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + buckets { + _id + _createdAt + _updatedAt + _permissions + fileSecurity + name + enabled + maximumFileSize + allowedFileExtensions + compression + encryption + antivirus + transformations + totalSize + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/storage/list-files.md b/examples/1.9.x/server-graphql/examples/storage/list-files.md index d7962b96e..54bafc6ff 100644 --- a/examples/1.9.x/server-graphql/examples/storage/list-files.md +++ b/examples/1.9.x/server-graphql/examples/storage/list-files.md @@ -1,2 +1,28 @@ ```graphql +query { + storageListFiles( + bucketId: "<BUCKET_ID>", + queries: [], + search: "<SEARCH>", + total: false + ) { + total + files { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + sizeActual + chunksTotal + chunksUploaded + encryption + compression + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/storage/update-bucket.md b/examples/1.9.x/server-graphql/examples/storage/update-bucket.md index 471b3a80b..c0f7d9342 100644 --- a/examples/1.9.x/server-graphql/examples/storage/update-bucket.md +++ b/examples/1.9.x/server-graphql/examples/storage/update-bucket.md @@ -29,4 +29,34 @@ mutation { totalSize } } +mutation { + storageUpdateBucket( + bucketId: "<BUCKET_ID>", + name: "<NAME>", + permissions: ["read("any")"], + fileSecurity: false, + enabled: false, + maximumFileSize: 1, + allowedFileExtensions: [], + compression: "none", + encryption: false, + antivirus: false, + transformations: false + ) { + _id + _createdAt + _updatedAt + _permissions + fileSecurity + name + enabled + maximumFileSize + allowedFileExtensions + compression + encryption + antivirus + transformations + totalSize + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/storage/update-file.md b/examples/1.9.x/server-graphql/examples/storage/update-file.md index 3442c043d..858be546a 100644 --- a/examples/1.9.x/server-graphql/examples/storage/update-file.md +++ b/examples/1.9.x/server-graphql/examples/storage/update-file.md @@ -22,4 +22,27 @@ mutation { compression } } +mutation { + storageUpdateFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + name: "<NAME>", + permissions: ["read("any")"] + ) { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + sizeActual + chunksTotal + chunksUploaded + encryption + compression + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-big-int-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-big-int-column.md index ea915eab5..53ef15c7c 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-big-int-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-big-int-column.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + tablesDBCreateBigIntColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0, + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-boolean-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-boolean-column.md index 1a213224c..c870cb6ca 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-boolean-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-boolean-column.md @@ -19,4 +19,24 @@ mutation { default } } +mutation { + tablesDBCreateBooleanColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: false, + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-datetime-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-datetime-column.md index 56cb3ba1b..6daeeb60b 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-datetime-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-datetime-column.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + tablesDBCreateDatetimeColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "2020-10-15T06:38:00.000+00:00", + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-email-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-email-column.md index bef3c65ba..619abddff 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-email-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-email-column.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + tablesDBCreateEmailColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "email@example.com", + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-enum-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-enum-column.md index 99e1c261d..2ad2f35fd 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-enum-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-enum-column.md @@ -22,4 +22,27 @@ mutation { default } } +mutation { + tablesDBCreateEnumColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + elements: [], + required: false, + default: "<DEFAULT>", + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + elements + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-float-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-float-column.md index fa997684f..4427f640a 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-float-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-float-column.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + tablesDBCreateFloatColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0, + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-index.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-index.md index 3762cec57..b1934d9aa 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-index.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-index.md @@ -21,4 +21,26 @@ mutation { orders } } +mutation { + tablesDBCreateIndex( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + type: "key", + columns: [], + orders: [], + lengths: [] + ) { + _id + _createdAt + _updatedAt + key + type + status + error + columns + lengths + orders + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-integer-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-integer-column.md index 15b00e0d6..684bca805 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-integer-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-integer-column.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + tablesDBCreateIntegerColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0, + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-ip-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-ip-column.md index 4687ab38c..980d20c9d 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-ip-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-ip-column.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + tablesDBCreateIpColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "", + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-line-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-line-column.md index 8946781cb..a152bef35 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-line-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-line-column.md @@ -18,4 +18,23 @@ mutation { default } } +mutation { + tablesDBCreateLineColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: [[1, 2], [3, 4], [5, 6]] + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-longtext-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-longtext-column.md index 10cf29c4f..ff5206766 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-longtext-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-longtext-column.md @@ -21,4 +21,26 @@ mutation { encrypt } } +mutation { + tablesDBCreateLongtextColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "<DEFAULT>", + array: false, + encrypt: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-mediumtext-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-mediumtext-column.md index d24c3738d..47b3eeb50 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-mediumtext-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-mediumtext-column.md @@ -21,4 +21,26 @@ mutation { encrypt } } +mutation { + tablesDBCreateMediumtextColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "<DEFAULT>", + array: false, + encrypt: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-operations.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-operations.md index f5721ece9..e0651eece 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-operations.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-operations.md @@ -22,4 +22,27 @@ mutation { expiresAt } } +mutation { + tablesDBCreateOperations( + transactionId: "<TRANSACTION_ID>", + operations: [ + { + "action": "create", + "databaseId": "<DATABASE_ID>", + "tableId": "<TABLE_ID>", + "rowId": "<ROW_ID>", + "data": { + "name": "Walter O'Brien" + } + } + ] + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-point-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-point-column.md index c735aa6eb..e80f8cd4a 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-point-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-point-column.md @@ -18,4 +18,23 @@ mutation { default } } +mutation { + tablesDBCreatePointColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: [1, 2] + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-polygon-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-polygon-column.md index 1ace48d21..e11424413 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-polygon-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-polygon-column.md @@ -18,4 +18,23 @@ mutation { default } } +mutation { + tablesDBCreatePolygonColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: [[[1, 2], [3, 4], [5, 6], [1, 2]]] + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-relationship-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-relationship-column.md index 4dcc34120..3c961f419 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-relationship-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-relationship-column.md @@ -26,4 +26,31 @@ mutation { side } } +mutation { + tablesDBCreateRelationshipColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + relatedTableId: "<RELATED_TABLE_ID>", + type: "oneToOne", + twoWay: false, + key: "", + twoWayKey: "", + onDelete: "cascade" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + relatedTable + relationType + twoWay + twoWayKey + onDelete + side + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-row.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-row.md index 2de9bda39..a35a68e76 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-row.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-row.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + tablesDBCreateRow( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + rowId: "<ROW_ID>", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-rows.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-rows.md index 9a93b02fa..4c14d8d92 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-rows.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-rows.md @@ -19,4 +19,24 @@ mutation { } } } +mutation { + tablesDBCreateRows( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + rows: [], + transactionId: "<TRANSACTION_ID>" + ) { + total + rows { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-string-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-string-column.md index a5f21275d..7690d308e 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-string-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-string-column.md @@ -23,4 +23,28 @@ mutation { encrypt } } +mutation { + tablesDBCreateStringColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + size: 1, + required: false, + default: "<DEFAULT>", + array: false, + encrypt: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + size + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-table.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-table.md index a4cf28445..43d1c2b13 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-table.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-table.md @@ -35,4 +35,40 @@ mutation { bytesUsed } } +mutation { + tablesDBCreateTable( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + name: "<NAME>", + permissions: ["read("any")"], + rowSecurity: false, + enabled: false, + columns: [], + indexes: [] + ) { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + rowSecurity + columns + indexes { + _id + _createdAt + _updatedAt + key + type + status + error + columns + lengths + orders + } + bytesMax + bytesUsed + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-text-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-text-column.md index 73f91f71e..454ad4b87 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-text-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-text-column.md @@ -21,4 +21,26 @@ mutation { encrypt } } +mutation { + tablesDBCreateTextColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "<DEFAULT>", + array: false, + encrypt: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-transaction.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-transaction.md index 2ecb30310..d66891e15 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-transaction.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-transaction.md @@ -11,4 +11,16 @@ mutation { expiresAt } } +mutation { + tablesDBCreateTransaction( + ttl: 60 + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-url-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-url-column.md index 96e24f294..d9e13115d 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-url-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-url-column.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + tablesDBCreateUrlColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "https://example.com", + array: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create-varchar-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/create-varchar-column.md index ed7521101..7594d7642 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create-varchar-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create-varchar-column.md @@ -23,4 +23,28 @@ mutation { encrypt } } +mutation { + tablesDBCreateVarcharColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + size: 1, + required: false, + default: "<DEFAULT>", + array: false, + encrypt: false + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + size + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create.md b/examples/1.9.x/server-graphql/examples/tablesdb/create.md index 872b53bd4..ce124f560 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create.md @@ -40,4 +40,45 @@ mutation { } } } +mutation { + tablesDBCreate( + databaseId: "<DATABASE_ID>", + name: "<NAME>", + enabled: false + ) { + _id + name + _createdAt + _updatedAt + enabled + type + policies { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } + archives { + _id + _createdAt + _updatedAt + policyId + size + status + startedAt + migrationId + services + resources + resourceId + resourceType + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/decrement-row-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/decrement-row-column.md index 981013c72..63064823e 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/decrement-row-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/decrement-row-column.md @@ -19,4 +19,24 @@ mutation { data } } +mutation { + tablesDBDecrementRowColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + rowId: "<ROW_ID>", + column: "", + value: 0, + min: 0, + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/delete-rows.md b/examples/1.9.x/server-graphql/examples/tablesdb/delete-rows.md index 6fa0a40fd..67a7fe31e 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/delete-rows.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/delete-rows.md @@ -19,4 +19,24 @@ mutation { } } } +mutation { + tablesDBDeleteRows( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + queries: [], + transactionId: "<TRANSACTION_ID>" + ) { + total + rows { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/get-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/get-column.md index d7962b96e..57a636b2f 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/get-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/get-column.md @@ -1,2 +1,19 @@ ```graphql +query { + tablesDBGetColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/get-index.md b/examples/1.9.x/server-graphql/examples/tablesdb/get-index.md index d7962b96e..910be9a95 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/get-index.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/get-index.md @@ -1,2 +1,20 @@ ```graphql +query { + tablesDBGetIndex( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "" + ) { + _id + _createdAt + _updatedAt + key + type + status + error + columns + lengths + orders + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/get-row.md b/examples/1.9.x/server-graphql/examples/tablesdb/get-row.md index d7962b96e..354f847dc 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/get-row.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/get-row.md @@ -1,2 +1,20 @@ ```graphql +query { + tablesDBGetRow( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + rowId: "<ROW_ID>", + queries: [], + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/get-table.md b/examples/1.9.x/server-graphql/examples/tablesdb/get-table.md index d7962b96e..284e864d7 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/get-table.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/get-table.md @@ -1,2 +1,32 @@ ```graphql +query { + tablesDBGetTable( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>" + ) { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + rowSecurity + columns + indexes { + _id + _createdAt + _updatedAt + key + type + status + error + columns + lengths + orders + } + bytesMax + bytesUsed + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/get-transaction.md b/examples/1.9.x/server-graphql/examples/tablesdb/get-transaction.md index d7962b96e..0c520f611 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/get-transaction.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/get-transaction.md @@ -1,2 +1,14 @@ ```graphql +query { + tablesDBGetTransaction( + transactionId: "<TRANSACTION_ID>" + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/get.md b/examples/1.9.x/server-graphql/examples/tablesdb/get.md index d7962b96e..3bad885e4 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/get.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/get.md @@ -1,2 +1,41 @@ ```graphql +query { + tablesDBGet( + databaseId: "<DATABASE_ID>" + ) { + _id + name + _createdAt + _updatedAt + enabled + type + policies { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } + archives { + _id + _createdAt + _updatedAt + policyId + size + status + startedAt + migrationId + services + resources + resourceId + resourceType + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/increment-row-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/increment-row-column.md index 6d2b7e47a..8a0e478cd 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/increment-row-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/increment-row-column.md @@ -19,4 +19,24 @@ mutation { data } } +mutation { + tablesDBIncrementRowColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + rowId: "<ROW_ID>", + column: "", + value: 0, + max: 0, + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/list-columns.md b/examples/1.9.x/server-graphql/examples/tablesdb/list-columns.md index d7962b96e..de893f696 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/list-columns.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/list-columns.md @@ -1,2 +1,13 @@ ```graphql +query { + tablesDBListColumns( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + queries: [], + total: false + ) { + total + columns + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/list-indexes.md b/examples/1.9.x/server-graphql/examples/tablesdb/list-indexes.md index d7962b96e..907ea571d 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/list-indexes.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/list-indexes.md @@ -1,2 +1,24 @@ ```graphql +query { + tablesDBListIndexes( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + queries: [], + total: false + ) { + total + indexes { + _id + _createdAt + _updatedAt + key + type + status + error + columns + lengths + orders + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/list-rows.md b/examples/1.9.x/server-graphql/examples/tablesdb/list-rows.md index d7962b96e..6927344f1 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/list-rows.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/list-rows.md @@ -1,2 +1,24 @@ ```graphql +query { + tablesDBListRows( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + queries: [], + transactionId: "<TRANSACTION_ID>", + total: false, + ttl: 0 + ) { + total + rows { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/list-tables.md b/examples/1.9.x/server-graphql/examples/tablesdb/list-tables.md index d7962b96e..7c10afcfd 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/list-tables.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/list-tables.md @@ -1,2 +1,37 @@ ```graphql +query { + tablesDBListTables( + databaseId: "<DATABASE_ID>", + queries: [], + search: "<SEARCH>", + total: false + ) { + total + tables { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + rowSecurity + columns + indexes { + _id + _createdAt + _updatedAt + key + type + status + error + columns + lengths + orders + } + bytesMax + bytesUsed + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/list-transactions.md b/examples/1.9.x/server-graphql/examples/tablesdb/list-transactions.md index d7962b96e..bc3663bec 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/list-transactions.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/list-transactions.md @@ -1,2 +1,17 @@ ```graphql +query { + tablesDBListTransactions( + queries: [] + ) { + total + transactions { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/list.md b/examples/1.9.x/server-graphql/examples/tablesdb/list.md index d7962b96e..4111a783d 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/list.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/list.md @@ -1,2 +1,46 @@ ```graphql +query { + tablesDBList( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + databases { + _id + name + _createdAt + _updatedAt + enabled + type + policies { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } + archives { + _id + _createdAt + _updatedAt + policyId + size + status + startedAt + migrationId + services + resources + resourceId + resourceType + } + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-big-int-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-big-int-column.md index 481253ced..0f2304fbd 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-big-int-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-big-int-column.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + tablesDBUpdateBigIntColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: 0, + min: 0, + max: 0, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-boolean-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-boolean-column.md index 1f6350d5b..05a5aef3e 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-boolean-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-boolean-column.md @@ -19,4 +19,24 @@ mutation { default } } +mutation { + tablesDBUpdateBooleanColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: false, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-datetime-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-datetime-column.md index 11a23674b..cd8195766 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-datetime-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-datetime-column.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + tablesDBUpdateDatetimeColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "2020-10-15T06:38:00.000+00:00", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-email-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-email-column.md index a582cacba..670e8bb0f 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-email-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-email-column.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + tablesDBUpdateEmailColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "email@example.com", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-enum-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-enum-column.md index d6b433f82..0b3f13fa8 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-enum-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-enum-column.md @@ -22,4 +22,27 @@ mutation { default } } +mutation { + tablesDBUpdateEnumColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + elements: [], + required: false, + default: "<DEFAULT>", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + elements + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-float-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-float-column.md index 85f31aa70..db6a6780d 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-float-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-float-column.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + tablesDBUpdateFloatColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: 0, + min: 0, + max: 0, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-integer-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-integer-column.md index 93e10604e..830b8f810 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-integer-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-integer-column.md @@ -23,4 +23,28 @@ mutation { default } } +mutation { + tablesDBUpdateIntegerColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: 0, + min: 0, + max: 0, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + min + max + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-ip-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-ip-column.md index 1db9349f5..76cf04595 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-ip-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-ip-column.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + tablesDBUpdateIpColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-line-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-line-column.md index 4e0285218..73ae670a3 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-line-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-line-column.md @@ -19,4 +19,24 @@ mutation { default } } +mutation { + tablesDBUpdateLineColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: [[1, 2], [3, 4], [5, 6]], + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-longtext-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-longtext-column.md index 54b0c610a..99ceaf36e 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-longtext-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-longtext-column.md @@ -20,4 +20,25 @@ mutation { encrypt } } +mutation { + tablesDBUpdateLongtextColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "<DEFAULT>", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-mediumtext-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-mediumtext-column.md index c61f59b1a..4c3f0ebe4 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-mediumtext-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-mediumtext-column.md @@ -20,4 +20,25 @@ mutation { encrypt } } +mutation { + tablesDBUpdateMediumtextColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "<DEFAULT>", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-point-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-point-column.md index 937342dd6..b189f8538 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-point-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-point-column.md @@ -19,4 +19,24 @@ mutation { default } } +mutation { + tablesDBUpdatePointColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: [1, 2], + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-polygon-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-polygon-column.md index f0994a8e8..b92621e06 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-polygon-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-polygon-column.md @@ -19,4 +19,24 @@ mutation { default } } +mutation { + tablesDBUpdatePolygonColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: [[[1, 2], [3, 4], [5, 6], [1, 2]]], + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-relationship-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-relationship-column.md index 3a99c8932..a6082fb5b 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-relationship-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-relationship-column.md @@ -23,4 +23,28 @@ mutation { side } } +mutation { + tablesDBUpdateRelationshipColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + onDelete: "cascade", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + relatedTable + relationType + twoWay + twoWayKey + onDelete + side + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-row.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-row.md index 5210f16e3..0a61504a9 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-row.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-row.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + tablesDBUpdateRow( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + rowId: "<ROW_ID>", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-rows.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-rows.md index 7fcae0620..3c61c14f5 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-rows.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-rows.md @@ -20,4 +20,25 @@ mutation { } } } +mutation { + tablesDBUpdateRows( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}", + queries: [], + transactionId: "<TRANSACTION_ID>" + ) { + total + rows { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-string-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-string-column.md index bf081cf7a..c47f03626 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-string-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-string-column.md @@ -22,4 +22,27 @@ mutation { encrypt } } +mutation { + tablesDBUpdateStringColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "<DEFAULT>", + size: 1, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + size + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-table.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-table.md index aa7f62980..69e6e7135 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-table.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-table.md @@ -34,4 +34,39 @@ mutation { bytesUsed } } +mutation { + tablesDBUpdateTable( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + name: "<NAME>", + permissions: ["read("any")"], + rowSecurity: false, + enabled: false, + purge: false + ) { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + rowSecurity + columns + indexes { + _id + _createdAt + _updatedAt + key + type + status + error + columns + lengths + orders + } + bytesMax + bytesUsed + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-text-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-text-column.md index 351da4bf5..2b5673909 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-text-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-text-column.md @@ -20,4 +20,25 @@ mutation { encrypt } } +mutation { + tablesDBUpdateTextColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "<DEFAULT>", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-transaction.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-transaction.md index 0d0986b85..8c198fa45 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-transaction.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-transaction.md @@ -13,4 +13,18 @@ mutation { expiresAt } } +mutation { + tablesDBUpdateTransaction( + transactionId: "<TRANSACTION_ID>", + commit: false, + rollback: false + ) { + _id + _createdAt + _updatedAt + status + operations + expiresAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-url-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-url-column.md index 93fca77d5..7a2664841 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-url-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-url-column.md @@ -20,4 +20,25 @@ mutation { default } } +mutation { + tablesDBUpdateUrlColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "https://example.com", + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + format + default + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update-varchar-column.md b/examples/1.9.x/server-graphql/examples/tablesdb/update-varchar-column.md index 769381e0f..081ea4a44 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update-varchar-column.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update-varchar-column.md @@ -22,4 +22,27 @@ mutation { encrypt } } +mutation { + tablesDBUpdateVarcharColumn( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + key: "", + required: false, + default: "<DEFAULT>", + size: 1, + newKey: "" + ) { + key + type + status + error + required + array + _createdAt + _updatedAt + size + default + encrypt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update.md b/examples/1.9.x/server-graphql/examples/tablesdb/update.md index da39d113a..e82d10ecf 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update.md @@ -40,4 +40,45 @@ mutation { } } } +mutation { + tablesDBUpdate( + databaseId: "<DATABASE_ID>", + name: "<NAME>", + enabled: false + ) { + _id + name + _createdAt + _updatedAt + enabled + type + policies { + _id + name + _createdAt + _updatedAt + services + resources + resourceId + resourceType + retention + schedule + enabled + } + archives { + _id + _createdAt + _updatedAt + policyId + size + status + startedAt + migrationId + services + resources + resourceId + resourceType + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/upsert-row.md b/examples/1.9.x/server-graphql/examples/tablesdb/upsert-row.md index 8b085a975..43f3e351f 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/upsert-row.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/upsert-row.md @@ -18,4 +18,23 @@ mutation { data } } +mutation { + tablesDBUpsertRow( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + rowId: "<ROW_ID>", + data: "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}", + permissions: ["read("any")"], + transactionId: "<TRANSACTION_ID>" + ) { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/upsert-rows.md b/examples/1.9.x/server-graphql/examples/tablesdb/upsert-rows.md index fe106a6d5..9864ddae1 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/upsert-rows.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/upsert-rows.md @@ -19,4 +19,24 @@ mutation { } } } +mutation { + tablesDBUpsertRows( + databaseId: "<DATABASE_ID>", + tableId: "<TABLE_ID>", + rows: [], + transactionId: "<TRANSACTION_ID>" + ) { + total + rows { + _id + _sequence + _tableId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/teams/create-membership.md b/examples/1.9.x/server-graphql/examples/teams/create-membership.md index 07b85b69e..fd578fee8 100644 --- a/examples/1.9.x/server-graphql/examples/teams/create-membership.md +++ b/examples/1.9.x/server-graphql/examples/teams/create-membership.md @@ -22,6 +22,34 @@ mutation { joined confirm mfa + userAccessedAt + roles + } +} +mutation { + teamsCreateMembership( + teamId: "<TEAM_ID>", + roles: [], + email: "email@example.com", + userId: "<USER_ID>", + phone: "+12065550100", + url: "https://example.com", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + userPhone + teamId + teamName + invited + joined + confirm + mfa + userAccessedAt roles } } diff --git a/examples/1.9.x/server-graphql/examples/teams/create.md b/examples/1.9.x/server-graphql/examples/teams/create.md index c31af8335..fd085d926 100644 --- a/examples/1.9.x/server-graphql/examples/teams/create.md +++ b/examples/1.9.x/server-graphql/examples/teams/create.md @@ -15,4 +15,20 @@ mutation { } } } +mutation { + teamsCreate( + teamId: "<TEAM_ID>", + name: "<NAME>", + roles: [] + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/teams/get-membership.md b/examples/1.9.x/server-graphql/examples/teams/get-membership.md index d7962b96e..cccc945b4 100644 --- a/examples/1.9.x/server-graphql/examples/teams/get-membership.md +++ b/examples/1.9.x/server-graphql/examples/teams/get-membership.md @@ -1,2 +1,24 @@ ```graphql +query { + teamsGetMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + userPhone + teamId + teamName + invited + joined + confirm + mfa + userAccessedAt + roles + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/teams/get-prefs.md b/examples/1.9.x/server-graphql/examples/teams/get-prefs.md index d7962b96e..182735730 100644 --- a/examples/1.9.x/server-graphql/examples/teams/get-prefs.md +++ b/examples/1.9.x/server-graphql/examples/teams/get-prefs.md @@ -1,2 +1,9 @@ ```graphql +query { + teamsGetPrefs( + teamId: "<TEAM_ID>" + ) { + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/teams/get.md b/examples/1.9.x/server-graphql/examples/teams/get.md index d7962b96e..17f4a5ee9 100644 --- a/examples/1.9.x/server-graphql/examples/teams/get.md +++ b/examples/1.9.x/server-graphql/examples/teams/get.md @@ -1,2 +1,16 @@ ```graphql +query { + teamsGet( + teamId: "<TEAM_ID>" + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/teams/list-memberships.md b/examples/1.9.x/server-graphql/examples/teams/list-memberships.md index d7962b96e..9f76ab1d5 100644 --- a/examples/1.9.x/server-graphql/examples/teams/list-memberships.md +++ b/examples/1.9.x/server-graphql/examples/teams/list-memberships.md @@ -1,2 +1,29 @@ ```graphql +query { + teamsListMemberships( + teamId: "<TEAM_ID>", + queries: [], + search: "<SEARCH>", + total: false + ) { + total + memberships { + _id + _createdAt + _updatedAt + userId + userName + userEmail + userPhone + teamId + teamName + invited + joined + confirm + mfa + userAccessedAt + roles + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/teams/list.md b/examples/1.9.x/server-graphql/examples/teams/list.md index d7962b96e..a714bd0bc 100644 --- a/examples/1.9.x/server-graphql/examples/teams/list.md +++ b/examples/1.9.x/server-graphql/examples/teams/list.md @@ -1,2 +1,21 @@ ```graphql +query { + teamsList( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + teams { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/teams/update-membership-status.md b/examples/1.9.x/server-graphql/examples/teams/update-membership-status.md index 58d25696e..06bbe8aef 100644 --- a/examples/1.9.x/server-graphql/examples/teams/update-membership-status.md +++ b/examples/1.9.x/server-graphql/examples/teams/update-membership-status.md @@ -19,6 +19,31 @@ mutation { joined confirm mfa + userAccessedAt + roles + } +} +mutation { + teamsUpdateMembershipStatus( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + userPhone + teamId + teamName + invited + joined + confirm + mfa + userAccessedAt roles } } diff --git a/examples/1.9.x/server-graphql/examples/teams/update-membership.md b/examples/1.9.x/server-graphql/examples/teams/update-membership.md index 4653e9bca..305b7b30f 100644 --- a/examples/1.9.x/server-graphql/examples/teams/update-membership.md +++ b/examples/1.9.x/server-graphql/examples/teams/update-membership.md @@ -18,6 +18,30 @@ mutation { joined confirm mfa + userAccessedAt + roles + } +} +mutation { + teamsUpdateMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + roles: [] + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + userPhone + teamId + teamName + invited + joined + confirm + mfa + userAccessedAt roles } } diff --git a/examples/1.9.x/server-graphql/examples/teams/update-name.md b/examples/1.9.x/server-graphql/examples/teams/update-name.md index a3ce2bd1f..a5fa8def0 100644 --- a/examples/1.9.x/server-graphql/examples/teams/update-name.md +++ b/examples/1.9.x/server-graphql/examples/teams/update-name.md @@ -14,4 +14,19 @@ mutation { } } } +mutation { + teamsUpdateName( + teamId: "<TEAM_ID>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/teams/update-prefs.md b/examples/1.9.x/server-graphql/examples/teams/update-prefs.md index 411431a12..0c63092a0 100644 --- a/examples/1.9.x/server-graphql/examples/teams/update-prefs.md +++ b/examples/1.9.x/server-graphql/examples/teams/update-prefs.md @@ -7,4 +7,12 @@ mutation { data } } +mutation { + teamsUpdatePrefs( + teamId: "<TEAM_ID>", + prefs: "{}" + ) { + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tokens/create-file-token.md b/examples/1.9.x/server-graphql/examples/tokens/create-file-token.md index 2d9501d7c..0489a598a 100644 --- a/examples/1.9.x/server-graphql/examples/tokens/create-file-token.md +++ b/examples/1.9.x/server-graphql/examples/tokens/create-file-token.md @@ -14,4 +14,19 @@ mutation { accessedAt } } +mutation { + tokensCreateFileToken( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + expire: "2020-10-15T06:38:00.000+00:00" + ) { + _id + _createdAt + resourceId + resourceType + expire + secret + accessedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tokens/get.md b/examples/1.9.x/server-graphql/examples/tokens/get.md index d7962b96e..35e1206dd 100644 --- a/examples/1.9.x/server-graphql/examples/tokens/get.md +++ b/examples/1.9.x/server-graphql/examples/tokens/get.md @@ -1,2 +1,15 @@ ```graphql +query { + tokensGet( + tokenId: "<TOKEN_ID>" + ) { + _id + _createdAt + resourceId + resourceType + expire + secret + accessedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tokens/list.md b/examples/1.9.x/server-graphql/examples/tokens/list.md index d7962b96e..ab80ac7b5 100644 --- a/examples/1.9.x/server-graphql/examples/tokens/list.md +++ b/examples/1.9.x/server-graphql/examples/tokens/list.md @@ -1,2 +1,21 @@ ```graphql +query { + tokensList( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + queries: [], + total: false + ) { + total + tokens { + _id + _createdAt + resourceId + resourceType + expire + secret + accessedAt + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/tokens/update.md b/examples/1.9.x/server-graphql/examples/tokens/update.md index 01d04bb30..207e4673b 100644 --- a/examples/1.9.x/server-graphql/examples/tokens/update.md +++ b/examples/1.9.x/server-graphql/examples/tokens/update.md @@ -13,4 +13,18 @@ mutation { accessedAt } } +mutation { + tokensUpdate( + tokenId: "<TOKEN_ID>", + expire: "2020-10-15T06:38:00.000+00:00" + ) { + _id + _createdAt + resourceId + resourceType + expire + secret + accessedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/usage/list-events.md b/examples/1.9.x/server-graphql/examples/usage/list-events.md index d7962b96e..e1584eef3 100644 --- a/examples/1.9.x/server-graphql/examples/usage/list-events.md +++ b/examples/1.9.x/server-graphql/examples/usage/list-events.md @@ -1,2 +1,22 @@ ```graphql +query { + usageListEvents( + queries: [], + total: false + ) { + total + events { + metric + value + time + path + method + status + resourceType + resourceId + countryCode + userAgent + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/usage/list-gauges.md b/examples/1.9.x/server-graphql/examples/usage/list-gauges.md index d7962b96e..2dba37f3f 100644 --- a/examples/1.9.x/server-graphql/examples/usage/list-gauges.md +++ b/examples/1.9.x/server-graphql/examples/usage/list-gauges.md @@ -1,2 +1,17 @@ ```graphql +query { + usageListGauges( + queries: [], + total: false + ) { + total + gauges { + metric + value + time + resourceType + resourceId + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/create-argon-2-user.md b/examples/1.9.x/server-graphql/examples/users/create-argon-2-user.md index 1d013c9ac..6dbb30e58 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-argon-2-user.md +++ b/examples/1.9.x/server-graphql/examples/users/create-argon-2-user.md @@ -20,6 +20,58 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersCreateArgon2User( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/create-bcrypt-user.md b/examples/1.9.x/server-graphql/examples/users/create-bcrypt-user.md index 7420b2114..1d53e3d97 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-bcrypt-user.md +++ b/examples/1.9.x/server-graphql/examples/users/create-bcrypt-user.md @@ -20,6 +20,58 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersCreateBcryptUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/create-jwt.md b/examples/1.9.x/server-graphql/examples/users/create-jwt.md index c7d374110..197dfe331 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-jwt.md +++ b/examples/1.9.x/server-graphql/examples/users/create-jwt.md @@ -8,4 +8,13 @@ mutation { jwt } } +mutation { + usersCreateJWT( + userId: "<USER_ID>", + sessionId: "<SESSION_ID>", + duration: 0 + ) { + jwt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/create-md-5-user.md b/examples/1.9.x/server-graphql/examples/users/create-md-5-user.md index e4ab89b2a..9bd0ada7c 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-md-5-user.md +++ b/examples/1.9.x/server-graphql/examples/users/create-md-5-user.md @@ -20,6 +20,58 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersCreateMD5User( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/create-mfa-recovery-codes.md b/examples/1.9.x/server-graphql/examples/users/create-mfa-recovery-codes.md index 787528eb0..3b220e8af 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-mfa-recovery-codes.md +++ b/examples/1.9.x/server-graphql/examples/users/create-mfa-recovery-codes.md @@ -6,4 +6,11 @@ mutation { recoveryCodes } } +mutation { + usersCreateMFARecoveryCodes( + userId: "<USER_ID>" + ) { + recoveryCodes + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/create-ph-pass-user.md b/examples/1.9.x/server-graphql/examples/users/create-ph-pass-user.md index 67ddb84ce..586b47fad 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-ph-pass-user.md +++ b/examples/1.9.x/server-graphql/examples/users/create-ph-pass-user.md @@ -20,6 +20,58 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersCreatePHPassUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/create-scrypt-modified-user.md b/examples/1.9.x/server-graphql/examples/users/create-scrypt-modified-user.md index d3dc875ba..1c8bf303b 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-scrypt-modified-user.md +++ b/examples/1.9.x/server-graphql/examples/users/create-scrypt-modified-user.md @@ -23,6 +23,61 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersCreateScryptModifiedUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordSalt: "<PASSWORD_SALT>", + passwordSaltSeparator: "<PASSWORD_SALT_SEPARATOR>", + passwordSignerKey: "<PASSWORD_SIGNER_KEY>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/create-scrypt-user.md b/examples/1.9.x/server-graphql/examples/users/create-scrypt-user.md index c60e540e3..8f0e6f1bf 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-scrypt-user.md +++ b/examples/1.9.x/server-graphql/examples/users/create-scrypt-user.md @@ -25,6 +25,63 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersCreateScryptUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordSalt: "<PASSWORD_SALT>", + passwordCpu: 0, + passwordMemory: 0, + passwordParallel: 0, + passwordLength: 0, + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/create-session.md b/examples/1.9.x/server-graphql/examples/users/create-session.md index 5e806de2c..2d9779606 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-session.md +++ b/examples/1.9.x/server-graphql/examples/users/create-session.md @@ -34,4 +34,39 @@ mutation { mfaUpdatedAt } } +mutation { + usersCreateSession( + userId: "<USER_ID>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/create-sha-user.md b/examples/1.9.x/server-graphql/examples/users/create-sha-user.md index 331ae82ae..b5326ed08 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-sha-user.md +++ b/examples/1.9.x/server-graphql/examples/users/create-sha-user.md @@ -21,6 +21,59 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersCreateSHAUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordVersion: "sha1", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/create-target.md b/examples/1.9.x/server-graphql/examples/users/create-target.md index b25a469dc..7a6c3509e 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-target.md +++ b/examples/1.9.x/server-graphql/examples/users/create-target.md @@ -19,4 +19,24 @@ mutation { expired } } +mutation { + usersCreateTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>", + providerType: "email", + identifier: "<IDENTIFIER>", + providerId: "<PROVIDER_ID>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/create-token.md b/examples/1.9.x/server-graphql/examples/users/create-token.md index 6d4ea54fe..9adc93e17 100644 --- a/examples/1.9.x/server-graphql/examples/users/create-token.md +++ b/examples/1.9.x/server-graphql/examples/users/create-token.md @@ -13,4 +13,18 @@ mutation { phrase } } +mutation { + usersCreateToken( + userId: "<USER_ID>", + length: 4, + expire: 60 + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/create.md b/examples/1.9.x/server-graphql/examples/users/create.md index e73159803..3f18a58c2 100644 --- a/examples/1.9.x/server-graphql/examples/users/create.md +++ b/examples/1.9.x/server-graphql/examples/users/create.md @@ -4,7 +4,7 @@ mutation { userId: "<USER_ID>", email: "email@example.com", phone: "+12065550100", - password: "", + password: "password", name: "<NAME>" ) { _id @@ -21,6 +21,59 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersCreate( + userId: "<USER_ID>", + email: "email@example.com", + phone: "+12065550100", + password: "password", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/get-mfa-recovery-codes.md b/examples/1.9.x/server-graphql/examples/users/get-mfa-recovery-codes.md index d7962b96e..2c86f0b31 100644 --- a/examples/1.9.x/server-graphql/examples/users/get-mfa-recovery-codes.md +++ b/examples/1.9.x/server-graphql/examples/users/get-mfa-recovery-codes.md @@ -1,2 +1,9 @@ ```graphql +query { + usersGetMFARecoveryCodes( + userId: "<USER_ID>" + ) { + recoveryCodes + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/get-prefs.md b/examples/1.9.x/server-graphql/examples/users/get-prefs.md index d7962b96e..e6c5d5284 100644 --- a/examples/1.9.x/server-graphql/examples/users/get-prefs.md +++ b/examples/1.9.x/server-graphql/examples/users/get-prefs.md @@ -1,2 +1,9 @@ ```graphql +query { + usersGetPrefs( + userId: "<USER_ID>" + ) { + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/get-target.md b/examples/1.9.x/server-graphql/examples/users/get-target.md index d7962b96e..c93658e35 100644 --- a/examples/1.9.x/server-graphql/examples/users/get-target.md +++ b/examples/1.9.x/server-graphql/examples/users/get-target.md @@ -1,2 +1,18 @@ ```graphql +query { + usersGetTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>" + ) { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/get.md b/examples/1.9.x/server-graphql/examples/users/get.md index d7962b96e..2fa8cd9d8 100644 --- a/examples/1.9.x/server-graphql/examples/users/get.md +++ b/examples/1.9.x/server-graphql/examples/users/get.md @@ -1,2 +1,46 @@ ```graphql +query { + usersGet( + userId: "<USER_ID>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/list-identities.md b/examples/1.9.x/server-graphql/examples/users/list-identities.md index d7962b96e..9b6424101 100644 --- a/examples/1.9.x/server-graphql/examples/users/list-identities.md +++ b/examples/1.9.x/server-graphql/examples/users/list-identities.md @@ -1,2 +1,23 @@ ```graphql +query { + usersListIdentities( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + identities { + _id + _createdAt + _updatedAt + userId + provider + providerUid + providerEmail + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/list-logs.md b/examples/1.9.x/server-graphql/examples/users/list-logs.md index d7962b96e..e949b5ccd 100644 --- a/examples/1.9.x/server-graphql/examples/users/list-logs.md +++ b/examples/1.9.x/server-graphql/examples/users/list-logs.md @@ -1,2 +1,35 @@ ```graphql +query { + usersListLogs( + userId: "<USER_ID>", + queries: [], + total: false + ) { + total + logs { + event + userId + userEmail + userName + mode + userType + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/list-memberships.md b/examples/1.9.x/server-graphql/examples/users/list-memberships.md index d7962b96e..bf2b9e010 100644 --- a/examples/1.9.x/server-graphql/examples/users/list-memberships.md +++ b/examples/1.9.x/server-graphql/examples/users/list-memberships.md @@ -1,2 +1,29 @@ ```graphql +query { + usersListMemberships( + userId: "<USER_ID>", + queries: [], + search: "<SEARCH>", + total: false + ) { + total + memberships { + _id + _createdAt + _updatedAt + userId + userName + userEmail + userPhone + teamId + teamName + invited + joined + confirm + mfa + userAccessedAt + roles + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/list-mfa-factors.md b/examples/1.9.x/server-graphql/examples/users/list-mfa-factors.md index d7962b96e..348b91a3f 100644 --- a/examples/1.9.x/server-graphql/examples/users/list-mfa-factors.md +++ b/examples/1.9.x/server-graphql/examples/users/list-mfa-factors.md @@ -1,2 +1,12 @@ ```graphql +query { + usersListMFAFactors( + userId: "<USER_ID>" + ) { + totp + phone + email + recoveryCode + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/list-sessions.md b/examples/1.9.x/server-graphql/examples/users/list-sessions.md index d7962b96e..1f9086d5d 100644 --- a/examples/1.9.x/server-graphql/examples/users/list-sessions.md +++ b/examples/1.9.x/server-graphql/examples/users/list-sessions.md @@ -1,2 +1,41 @@ ```graphql +query { + usersListSessions( + userId: "<USER_ID>", + total: false + ) { + total + sessions { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/list-targets.md b/examples/1.9.x/server-graphql/examples/users/list-targets.md index d7962b96e..f22b1c70d 100644 --- a/examples/1.9.x/server-graphql/examples/users/list-targets.md +++ b/examples/1.9.x/server-graphql/examples/users/list-targets.md @@ -1,2 +1,22 @@ ```graphql +query { + usersListTargets( + userId: "<USER_ID>", + queries: [], + total: false + ) { + total + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/list.md b/examples/1.9.x/server-graphql/examples/users/list.md index d7962b96e..fbcf19dc9 100644 --- a/examples/1.9.x/server-graphql/examples/users/list.md +++ b/examples/1.9.x/server-graphql/examples/users/list.md @@ -1,2 +1,51 @@ ```graphql +query { + usersList( + queries: [], + search: "<SEARCH>", + total: false + ) { + total + users { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/update-email-verification.md b/examples/1.9.x/server-graphql/examples/users/update-email-verification.md index 39395e0a7..f88eb86ee 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-email-verification.md +++ b/examples/1.9.x/server-graphql/examples/users/update-email-verification.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersUpdateEmailVerification( + userId: "<USER_ID>", + emailVerification: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/update-email.md b/examples/1.9.x/server-graphql/examples/users/update-email.md index dc8dfe3a8..9b83f200e 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-email.md +++ b/examples/1.9.x/server-graphql/examples/users/update-email.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersUpdateEmail( + userId: "<USER_ID>", + email: "email@example.com" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/update-impersonator.md b/examples/1.9.x/server-graphql/examples/users/update-impersonator.md index 23b833c0e..560ba9143 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-impersonator.md +++ b/examples/1.9.x/server-graphql/examples/users/update-impersonator.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersUpdateImpersonator( + userId: "<USER_ID>", + impersonator: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/update-labels.md b/examples/1.9.x/server-graphql/examples/users/update-labels.md index c5a7cfbd1..55e6d39b2 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-labels.md +++ b/examples/1.9.x/server-graphql/examples/users/update-labels.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersUpdateLabels( + userId: "<USER_ID>", + labels: [] + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/update-mfa-recovery-codes.md b/examples/1.9.x/server-graphql/examples/users/update-mfa-recovery-codes.md index f49db0ed5..8482752fd 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-mfa-recovery-codes.md +++ b/examples/1.9.x/server-graphql/examples/users/update-mfa-recovery-codes.md @@ -6,4 +6,11 @@ mutation { recoveryCodes } } +mutation { + usersUpdateMFARecoveryCodes( + userId: "<USER_ID>" + ) { + recoveryCodes + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/update-mfa.md b/examples/1.9.x/server-graphql/examples/users/update-mfa.md index 6880acfbf..a00c20524 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-mfa.md +++ b/examples/1.9.x/server-graphql/examples/users/update-mfa.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersUpdateMFA( + userId: "<USER_ID>", + mfa: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/update-name.md b/examples/1.9.x/server-graphql/examples/users/update-name.md index 183dfa72a..631ae070e 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-name.md +++ b/examples/1.9.x/server-graphql/examples/users/update-name.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersUpdateName( + userId: "<USER_ID>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/update-password.md b/examples/1.9.x/server-graphql/examples/users/update-password.md index eab3a3de2..96ce7c7db 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-password.md +++ b/examples/1.9.x/server-graphql/examples/users/update-password.md @@ -2,7 +2,7 @@ mutation { usersUpdatePassword( userId: "<USER_ID>", - password: "" + password: "password" ) { _id _createdAt @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersUpdatePassword( + userId: "<USER_ID>", + password: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/update-phone-verification.md b/examples/1.9.x/server-graphql/examples/users/update-phone-verification.md index fa2245b14..08017e8d1 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-phone-verification.md +++ b/examples/1.9.x/server-graphql/examples/users/update-phone-verification.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersUpdatePhoneVerification( + userId: "<USER_ID>", + phoneVerification: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/update-phone.md b/examples/1.9.x/server-graphql/examples/users/update-phone.md index 8f73fee54..d92a7677e 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-phone.md +++ b/examples/1.9.x/server-graphql/examples/users/update-phone.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersUpdatePhone( + userId: "<USER_ID>", + number: "+12065550100" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/update-prefs.md b/examples/1.9.x/server-graphql/examples/users/update-prefs.md index f636b511e..21c5ec9a9 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-prefs.md +++ b/examples/1.9.x/server-graphql/examples/users/update-prefs.md @@ -7,4 +7,12 @@ mutation { data } } +mutation { + usersUpdatePrefs( + userId: "<USER_ID>", + prefs: "{}" + ) { + data + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/users/update-status.md b/examples/1.9.x/server-graphql/examples/users/update-status.md index c0e3b16a8..118fe1141 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-status.md +++ b/examples/1.9.x/server-graphql/examples/users/update-status.md @@ -18,6 +18,56 @@ mutation { email phone emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } + accessedAt + impersonator + impersonatorUserId + } +} +mutation { + usersUpdateStatus( + userId: "<USER_ID>", + status: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + emailCanonical + emailIsFree + emailIsDisposable + emailIsCorporate + emailIsCanonical phoneVerification mfa prefs { diff --git a/examples/1.9.x/server-graphql/examples/users/update-target.md b/examples/1.9.x/server-graphql/examples/users/update-target.md index df1556e26..a9671a000 100644 --- a/examples/1.9.x/server-graphql/examples/users/update-target.md +++ b/examples/1.9.x/server-graphql/examples/users/update-target.md @@ -18,4 +18,23 @@ mutation { expired } } +mutation { + usersUpdateTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>", + identifier: "<IDENTIFIER>", + providerId: "<PROVIDER_ID>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + expired + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/webhooks/create.md b/examples/1.9.x/server-graphql/examples/webhooks/create.md index a47574a05..2c0a0643e 100644 --- a/examples/1.9.x/server-graphql/examples/webhooks/create.md +++ b/examples/1.9.x/server-graphql/examples/webhooks/create.md @@ -8,7 +8,34 @@ mutation { enabled: false, tls: false, authUsername: "<AUTH_USERNAME>", - authPassword: "<AUTH_PASSWORD>", + authPassword: "password", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + name + url + events + tls + authUsername + authPassword + secret + enabled + logs + attempts + } +} +mutation { + webhooksCreate( + webhookId: "<WEBHOOK_ID>", + url: "", + name: "<NAME>", + events: [], + enabled: false, + tls: false, + authUsername: "<AUTH_USERNAME>", + authPassword: "password", secret: "<SECRET>" ) { _id diff --git a/examples/1.9.x/server-graphql/examples/webhooks/get.md b/examples/1.9.x/server-graphql/examples/webhooks/get.md index d7962b96e..727d554d9 100644 --- a/examples/1.9.x/server-graphql/examples/webhooks/get.md +++ b/examples/1.9.x/server-graphql/examples/webhooks/get.md @@ -1,2 +1,21 @@ ```graphql +query { + webhooksGet( + webhookId: "<WEBHOOK_ID>" + ) { + _id + _createdAt + _updatedAt + name + url + events + tls + authUsername + authPassword + secret + enabled + logs + attempts + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/webhooks/list.md b/examples/1.9.x/server-graphql/examples/webhooks/list.md index d7962b96e..a500b2ee7 100644 --- a/examples/1.9.x/server-graphql/examples/webhooks/list.md +++ b/examples/1.9.x/server-graphql/examples/webhooks/list.md @@ -1,2 +1,25 @@ ```graphql +query { + webhooksList( + queries: [], + total: false + ) { + total + webhooks { + _id + _createdAt + _updatedAt + name + url + events + tls + authUsername + authPassword + secret + enabled + logs + attempts + } + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/webhooks/update-secret.md b/examples/1.9.x/server-graphql/examples/webhooks/update-secret.md index 278f8f8ed..c21c92933 100644 --- a/examples/1.9.x/server-graphql/examples/webhooks/update-secret.md +++ b/examples/1.9.x/server-graphql/examples/webhooks/update-secret.md @@ -19,4 +19,24 @@ mutation { attempts } } +mutation { + webhooksUpdateSecret( + webhookId: "<WEBHOOK_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + name + url + events + tls + authUsername + authPassword + secret + enabled + logs + attempts + } +} ``` diff --git a/examples/1.9.x/server-graphql/examples/webhooks/update.md b/examples/1.9.x/server-graphql/examples/webhooks/update.md index 1e2589133..e47669d9b 100644 --- a/examples/1.9.x/server-graphql/examples/webhooks/update.md +++ b/examples/1.9.x/server-graphql/examples/webhooks/update.md @@ -8,7 +8,33 @@ mutation { enabled: false, tls: false, authUsername: "<AUTH_USERNAME>", - authPassword: "<AUTH_PASSWORD>" + authPassword: "password" + ) { + _id + _createdAt + _updatedAt + name + url + events + tls + authUsername + authPassword + secret + enabled + logs + attempts + } +} +mutation { + webhooksUpdate( + webhookId: "<WEBHOOK_ID>", + name: "<NAME>", + url: "", + events: [], + enabled: false, + tls: false, + authUsername: "<AUTH_USERNAME>", + authPassword: "password" ) { _id _createdAt diff --git a/examples/1.9.x/server-kotlin/java/account/create.md b/examples/1.9.x/server-kotlin/java/account/create.md index 9acef5599..f7815f788 100644 --- a/examples/1.9.x/server-kotlin/java/account/create.md +++ b/examples/1.9.x/server-kotlin/java/account/create.md @@ -13,7 +13,7 @@ Account account = new Account(client); account.create( "<USER_ID>", // userId "email@example.com", // email - "", // password + "password", // password "<NAME>", // name (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { diff --git a/examples/1.9.x/server-kotlin/java/account/update-password.md b/examples/1.9.x/server-kotlin/java/account/update-password.md index 44a4ea09a..764aeb067 100644 --- a/examples/1.9.x/server-kotlin/java/account/update-password.md +++ b/examples/1.9.x/server-kotlin/java/account/update-password.md @@ -11,7 +11,7 @@ Client client = new Client() Account account = new Account(client); account.updatePassword( - "", // password + "password", // password "password", // oldPassword (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { diff --git a/examples/1.9.x/server-kotlin/java/account/update-recovery.md b/examples/1.9.x/server-kotlin/java/account/update-recovery.md index dc1b83c5e..542d13461 100644 --- a/examples/1.9.x/server-kotlin/java/account/update-recovery.md +++ b/examples/1.9.x/server-kotlin/java/account/update-recovery.md @@ -13,7 +13,7 @@ Account account = new Account(client); account.updateRecovery( "<USER_ID>", // userId "<SECRET>", // secret - "", // password + "password", // password new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.9.x/server-kotlin/java/avatars/get-browser.md b/examples/1.9.x/server-kotlin/java/avatars/get-browser.md index 72748afcb..5d11658bf 100644 --- a/examples/1.9.x/server-kotlin/java/avatars/get-browser.md +++ b/examples/1.9.x/server-kotlin/java/avatars/get-browser.md @@ -7,7 +7,8 @@ import io.appwrite.enums.Browser; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with + .setSession("") // The user session to authenticate with + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-kotlin/java/avatars/get-credit-card.md b/examples/1.9.x/server-kotlin/java/avatars/get-credit-card.md index 8f93da91a..99f09109b 100644 --- a/examples/1.9.x/server-kotlin/java/avatars/get-credit-card.md +++ b/examples/1.9.x/server-kotlin/java/avatars/get-credit-card.md @@ -7,7 +7,8 @@ import io.appwrite.enums.CreditCard; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with + .setSession("") // The user session to authenticate with + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-kotlin/java/avatars/get-favicon.md b/examples/1.9.x/server-kotlin/java/avatars/get-favicon.md index 6df13f5e8..4643a068b 100644 --- a/examples/1.9.x/server-kotlin/java/avatars/get-favicon.md +++ b/examples/1.9.x/server-kotlin/java/avatars/get-favicon.md @@ -6,7 +6,8 @@ import io.appwrite.services.Avatars; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with + .setSession("") // The user session to authenticate with + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-kotlin/java/avatars/get-flag.md b/examples/1.9.x/server-kotlin/java/avatars/get-flag.md index f66a872d3..02b56fbb3 100644 --- a/examples/1.9.x/server-kotlin/java/avatars/get-flag.md +++ b/examples/1.9.x/server-kotlin/java/avatars/get-flag.md @@ -7,7 +7,8 @@ import io.appwrite.enums.Flag; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with + .setSession("") // The user session to authenticate with + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-kotlin/java/avatars/get-image.md b/examples/1.9.x/server-kotlin/java/avatars/get-image.md index 7f93b9f9f..b76b89aed 100644 --- a/examples/1.9.x/server-kotlin/java/avatars/get-image.md +++ b/examples/1.9.x/server-kotlin/java/avatars/get-image.md @@ -6,7 +6,8 @@ import io.appwrite.services.Avatars; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with + .setSession("") // The user session to authenticate with + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-kotlin/java/avatars/get-initials.md b/examples/1.9.x/server-kotlin/java/avatars/get-initials.md index 31792b91f..1fc135d04 100644 --- a/examples/1.9.x/server-kotlin/java/avatars/get-initials.md +++ b/examples/1.9.x/server-kotlin/java/avatars/get-initials.md @@ -6,7 +6,8 @@ import io.appwrite.services.Avatars; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with + .setSession("") // The user session to authenticate with + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-kotlin/java/avatars/get-qr.md b/examples/1.9.x/server-kotlin/java/avatars/get-qr.md index 0e22f63f1..c6cb569b8 100644 --- a/examples/1.9.x/server-kotlin/java/avatars/get-qr.md +++ b/examples/1.9.x/server-kotlin/java/avatars/get-qr.md @@ -6,7 +6,8 @@ import io.appwrite.services.Avatars; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with + .setSession("") // The user session to authenticate with + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-kotlin/java/avatars/get-screenshot.md b/examples/1.9.x/server-kotlin/java/avatars/get-screenshot.md index c8b5966fe..6fdd3dd1a 100644 --- a/examples/1.9.x/server-kotlin/java/avatars/get-screenshot.md +++ b/examples/1.9.x/server-kotlin/java/avatars/get-screenshot.md @@ -10,7 +10,8 @@ import io.appwrite.enums.ImageFormat; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with + .setSession("") // The user session to authenticate with + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Avatars avatars = new Avatars(client); diff --git a/examples/1.9.x/server-kotlin/java/functions/create.md b/examples/1.9.x/server-kotlin/java/functions/create.md index d2cd0e44d..20cde0e98 100644 --- a/examples/1.9.x/server-kotlin/java/functions/create.md +++ b/examples/1.9.x/server-kotlin/java/functions/create.md @@ -2,7 +2,7 @@ import io.appwrite.Client; import io.appwrite.coroutines.CoroutineCallback; import io.appwrite.services.Functions; -import io.appwrite.enums.FunctionRuntime; +import io.appwrite.enums.Runtime; import io.appwrite.enums.ProjectKeyScopes; Client client = new Client() @@ -15,7 +15,7 @@ Functions functions = new Functions(client); functions.create( "<FUNCTION_ID>", // functionId "<NAME>", // name - FunctionRuntime.NODE_14_5, // runtime + Runtime.NODE_14_5, // runtime List.of("any"), // execute (optional) List.of(), // events (optional) "", // schedule (optional) diff --git a/examples/1.9.x/server-kotlin/java/functions/get-deployment-download.md b/examples/1.9.x/server-kotlin/java/functions/get-deployment-download.md index 59de9f04c..b8d9ee66c 100644 --- a/examples/1.9.x/server-kotlin/java/functions/get-deployment-download.md +++ b/examples/1.9.x/server-kotlin/java/functions/get-deployment-download.md @@ -7,7 +7,8 @@ import io.appwrite.enums.DeploymentDownloadType; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key + .setKey("<YOUR_API_KEY>") // Your secret API key + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Functions functions = new Functions(client); diff --git a/examples/1.9.x/server-kotlin/java/functions/update.md b/examples/1.9.x/server-kotlin/java/functions/update.md index b0c6a7fed..29b43174a 100644 --- a/examples/1.9.x/server-kotlin/java/functions/update.md +++ b/examples/1.9.x/server-kotlin/java/functions/update.md @@ -2,7 +2,7 @@ import io.appwrite.Client; import io.appwrite.coroutines.CoroutineCallback; import io.appwrite.services.Functions; -import io.appwrite.enums.FunctionRuntime; +import io.appwrite.enums.Runtime; import io.appwrite.enums.ProjectKeyScopes; Client client = new Client() @@ -15,7 +15,7 @@ Functions functions = new Functions(client); functions.update( "<FUNCTION_ID>", // functionId "<NAME>", // name - FunctionRuntime.NODE_14_5, // runtime (optional) + Runtime.NODE_14_5, // runtime (optional) List.of("any"), // execute (optional) List.of(), // events (optional) "", // schedule (optional) diff --git a/examples/1.9.x/server-kotlin/java/health/get-audits-db.md b/examples/1.9.x/server-kotlin/java/health/get-audits-db.md new file mode 100644 index 000000000..e4bc76ad1 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/health/get-audits-db.md @@ -0,0 +1,21 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getAuditsDB(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); +``` diff --git a/examples/1.9.x/server-kotlin/java/messaging/create-ses-provider.md b/examples/1.9.x/server-kotlin/java/messaging/create-ses-provider.md new file mode 100644 index 000000000..c8864661b --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/messaging/create-ses-provider.md @@ -0,0 +1,34 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createSesProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name + "<ACCESS_KEY>", // accessKey (optional) + "<SECRET_KEY>", // secretKey (optional) + "<REGION>", // region (optional) + "<FROM_NAME>", // fromName (optional) + "email@example.com", // fromEmail (optional) + "<REPLY_TO_NAME>", // replyToName (optional) + "email@example.com", // replyToEmail (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/messaging/create-smtp-provider.md b/examples/1.9.x/server-kotlin/java/messaging/create-smtp-provider.md index 2259babda..6752ef2c3 100644 --- a/examples/1.9.x/server-kotlin/java/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-kotlin/java/messaging/create-smtp-provider.md @@ -17,7 +17,7 @@ messaging.createSMTPProvider( "<HOST>", // host 1, // port (optional) "<USERNAME>", // username (optional) - "<PASSWORD>", // password (optional) + "password", // password (optional) SmtpEncryption.NONE, // encryption (optional) false, // autoTLS (optional) "<MAILER>", // mailer (optional) diff --git a/examples/1.9.x/server-kotlin/java/messaging/update-ses-provider.md b/examples/1.9.x/server-kotlin/java/messaging/update-ses-provider.md new file mode 100644 index 000000000..0d0fc5c01 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/messaging/update-ses-provider.md @@ -0,0 +1,34 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateSesProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name (optional) + false, // enabled (optional) + "<ACCESS_KEY>", // accessKey (optional) + "<SECRET_KEY>", // secretKey (optional) + "<REGION>", // region (optional) + "<FROM_NAME>", // fromName (optional) + "email@example.com", // fromEmail (optional) + "<REPLY_TO_NAME>", // replyToName (optional) + "<REPLY_TO_EMAIL>", // replyToEmail (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/messaging/update-smtp-provider.md b/examples/1.9.x/server-kotlin/java/messaging/update-smtp-provider.md index e68e2d80d..70a017c9b 100644 --- a/examples/1.9.x/server-kotlin/java/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-kotlin/java/messaging/update-smtp-provider.md @@ -17,7 +17,7 @@ messaging.updateSMTPProvider( "<HOST>", // host (optional) 1, // port (optional) "<USERNAME>", // username (optional) - "<PASSWORD>", // password (optional) + "password", // password (optional) SmtpEncryption.NONE, // encryption (optional) false, // autoTLS (optional) "<MAILER>", // mailer (optional) diff --git a/examples/1.9.x/server-kotlin/java/project/update-membership-privacy-policy.md b/examples/1.9.x/server-kotlin/java/project/update-membership-privacy-policy.md index a27bc2e90..04f9daab6 100644 --- a/examples/1.9.x/server-kotlin/java/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-kotlin/java/project/update-membership-privacy-policy.md @@ -16,6 +16,7 @@ project.updateMembershipPrivacyPolicy( false, // userPhone (optional) false, // userName (optional) false, // userMFA (optional) + false, // userAccessedAt (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-server.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-server.md new file mode 100644 index 000000000..0bb68a617 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-server.md @@ -0,0 +1,37 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Server( + false, // enabled + "https://example.com", // authorizationUrl + List.of(), // scopes (optional) + List.of(), // authorizationDetailsTypes (optional) + 60, // accessTokenDuration (optional) + 60, // refreshTokenDuration (optional) + 60, // publicAccessTokenDuration (optional) + 60, // publicRefreshTokenDuration (optional) + false, // confidentialPkce (optional) + "https://example.com", // verificationUrl (optional) + 6, // userCodeLength (optional) + "numeric", // userCodeFormat (optional) + 60, // deviceCodeDuration (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-password-strength-policy.md b/examples/1.9.x/server-kotlin/java/project/update-password-strength-policy.md new file mode 100644 index 000000000..a147d52d8 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-password-strength-policy.md @@ -0,0 +1,29 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Project project = new Project(client); + +project.updatePasswordStrengthPolicy( + 8, // min (optional) + false, // uppercase (optional) + false, // lowercase (optional) + false, // number (optional) + false, // symbols (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-smtp.md b/examples/1.9.x/server-kotlin/java/project/update-smtp.md index 77c02a3e4..bb3d6bd79 100644 --- a/examples/1.9.x/server-kotlin/java/project/update-smtp.md +++ b/examples/1.9.x/server-kotlin/java/project/update-smtp.md @@ -15,7 +15,7 @@ project.updateSMTP( "", // host (optional) 0, // port (optional) "<USERNAME>", // username (optional) - "<PASSWORD>", // password (optional) + "password", // password (optional) "email@example.com", // senderEmail (optional) "<SENDER_NAME>", // senderName (optional) "email@example.com", // replyToEmail (optional) diff --git a/examples/1.9.x/server-kotlin/java/proxy/create-redirect-rule.md b/examples/1.9.x/server-kotlin/java/proxy/create-redirect-rule.md index 3652a10e5..3b16146d8 100644 --- a/examples/1.9.x/server-kotlin/java/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-kotlin/java/proxy/create-redirect-rule.md @@ -2,7 +2,7 @@ import io.appwrite.Client; import io.appwrite.coroutines.CoroutineCallback; import io.appwrite.services.Proxy; -import io.appwrite.enums.RedirectStatusCode; +import io.appwrite.enums.StatusCode; import io.appwrite.enums.ProxyResourceType; Client client = new Client() @@ -15,7 +15,7 @@ Proxy proxy = new Proxy(client); proxy.createRedirectRule( "", // domain "https://example.com", // url - RedirectStatusCode.MOVEDPERMANENTLY, // statusCode + StatusCode.MOVEDPERMANENTLY, // statusCode "<RESOURCE_ID>", // resourceId ProxyResourceType.SITE, // resourceType new CoroutineCallback<>((result, error) -> { diff --git a/examples/1.9.x/server-kotlin/java/sites/create.md b/examples/1.9.x/server-kotlin/java/sites/create.md index 0e75d4122..509991f32 100644 --- a/examples/1.9.x/server-kotlin/java/sites/create.md +++ b/examples/1.9.x/server-kotlin/java/sites/create.md @@ -2,9 +2,9 @@ import io.appwrite.Client; import io.appwrite.coroutines.CoroutineCallback; import io.appwrite.services.Sites; -import io.appwrite.enums.SiteFramework; -import io.appwrite.enums.SiteBuildRuntime; -import io.appwrite.enums.SiteAdapter; +import io.appwrite.enums.Framework; +import io.appwrite.enums.BuildRuntime; +import io.appwrite.enums.Adapter; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint @@ -16,8 +16,8 @@ Sites sites = new Sites(client); sites.create( "<SITE_ID>", // siteId "<NAME>", // name - SiteFramework.ANALOG, // framework - SiteBuildRuntime.NODE_14_5, // buildRuntime + Framework.ANALOG, // framework + BuildRuntime.NODE_14_5, // buildRuntime false, // enabled (optional) false, // logging (optional) 1, // timeout (optional) @@ -25,7 +25,7 @@ sites.create( "<BUILD_COMMAND>", // buildCommand (optional) "<START_COMMAND>", // startCommand (optional) "<OUTPUT_DIRECTORY>", // outputDirectory (optional) - SiteAdapter.STATIC, // adapter (optional) + Adapter.STATIC, // adapter (optional) "<INSTALLATION_ID>", // installationId (optional) "<FALLBACK_FILE>", // fallbackFile (optional) "<PROVIDER_REPOSITORY_ID>", // providerRepositoryId (optional) diff --git a/examples/1.9.x/server-kotlin/java/sites/get-deployment-download.md b/examples/1.9.x/server-kotlin/java/sites/get-deployment-download.md index 3df75ba07..c2f8b11ad 100644 --- a/examples/1.9.x/server-kotlin/java/sites/get-deployment-download.md +++ b/examples/1.9.x/server-kotlin/java/sites/get-deployment-download.md @@ -7,7 +7,8 @@ import io.appwrite.enums.DeploymentDownloadType; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key + .setKey("<YOUR_API_KEY>") // Your secret API key + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Sites sites = new Sites(client); diff --git a/examples/1.9.x/server-kotlin/java/sites/update.md b/examples/1.9.x/server-kotlin/java/sites/update.md index 1f6068264..6c996cbdb 100644 --- a/examples/1.9.x/server-kotlin/java/sites/update.md +++ b/examples/1.9.x/server-kotlin/java/sites/update.md @@ -2,9 +2,9 @@ import io.appwrite.Client; import io.appwrite.coroutines.CoroutineCallback; import io.appwrite.services.Sites; -import io.appwrite.enums.SiteFramework; -import io.appwrite.enums.SiteBuildRuntime; -import io.appwrite.enums.SiteAdapter; +import io.appwrite.enums.Framework; +import io.appwrite.enums.BuildRuntime; +import io.appwrite.enums.Adapter; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint @@ -16,7 +16,7 @@ Sites sites = new Sites(client); sites.update( "<SITE_ID>", // siteId "<NAME>", // name - SiteFramework.ANALOG, // framework + Framework.ANALOG, // framework false, // enabled (optional) false, // logging (optional) 1, // timeout (optional) @@ -24,8 +24,8 @@ sites.update( "<BUILD_COMMAND>", // buildCommand (optional) "<START_COMMAND>", // startCommand (optional) "<OUTPUT_DIRECTORY>", // outputDirectory (optional) - SiteBuildRuntime.NODE_14_5, // buildRuntime (optional) - SiteAdapter.STATIC, // adapter (optional) + BuildRuntime.NODE_14_5, // buildRuntime (optional) + Adapter.STATIC, // adapter (optional) "<FALLBACK_FILE>", // fallbackFile (optional) "<INSTALLATION_ID>", // installationId (optional) "<PROVIDER_REPOSITORY_ID>", // providerRepositoryId (optional) diff --git a/examples/1.9.x/server-kotlin/java/storage/get-file-download.md b/examples/1.9.x/server-kotlin/java/storage/get-file-download.md index 9fa4df864..bd64bf5b0 100644 --- a/examples/1.9.x/server-kotlin/java/storage/get-file-download.md +++ b/examples/1.9.x/server-kotlin/java/storage/get-file-download.md @@ -6,7 +6,8 @@ import io.appwrite.services.Storage; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with + .setSession("") // The user session to authenticate with + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = new Storage(client); diff --git a/examples/1.9.x/server-kotlin/java/storage/get-file-preview.md b/examples/1.9.x/server-kotlin/java/storage/get-file-preview.md index 18093617c..fbb0643bf 100644 --- a/examples/1.9.x/server-kotlin/java/storage/get-file-preview.md +++ b/examples/1.9.x/server-kotlin/java/storage/get-file-preview.md @@ -8,7 +8,8 @@ import io.appwrite.enums.ImageFormat; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with + .setSession("") // The user session to authenticate with + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = new Storage(client); diff --git a/examples/1.9.x/server-kotlin/java/storage/get-file-view.md b/examples/1.9.x/server-kotlin/java/storage/get-file-view.md index 106884f0d..23c18c942 100644 --- a/examples/1.9.x/server-kotlin/java/storage/get-file-view.md +++ b/examples/1.9.x/server-kotlin/java/storage/get-file-view.md @@ -6,7 +6,8 @@ import io.appwrite.services.Storage; Client client = new Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with + .setSession("") // The user session to authenticate with + .setImpersonateUserId(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. Storage storage = new Storage(client); diff --git a/examples/1.9.x/server-kotlin/java/users/create.md b/examples/1.9.x/server-kotlin/java/users/create.md index ddf631a94..760849ab1 100644 --- a/examples/1.9.x/server-kotlin/java/users/create.md +++ b/examples/1.9.x/server-kotlin/java/users/create.md @@ -14,7 +14,7 @@ users.create( "<USER_ID>", // userId "email@example.com", // email (optional) "+12065550100", // phone (optional) - "", // password (optional) + "password", // password (optional) "<NAME>", // name (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { diff --git a/examples/1.9.x/server-kotlin/java/users/update-password.md b/examples/1.9.x/server-kotlin/java/users/update-password.md index 3e073ecf6..41924f0b4 100644 --- a/examples/1.9.x/server-kotlin/java/users/update-password.md +++ b/examples/1.9.x/server-kotlin/java/users/update-password.md @@ -12,7 +12,7 @@ Users users = new Users(client); users.updatePassword( "<USER_ID>", // userId - "", // password + "password", // password new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.9.x/server-kotlin/java/webhooks/create.md b/examples/1.9.x/server-kotlin/java/webhooks/create.md index 2c2dba732..9cae1c04b 100644 --- a/examples/1.9.x/server-kotlin/java/webhooks/create.md +++ b/examples/1.9.x/server-kotlin/java/webhooks/create.md @@ -18,7 +18,7 @@ webhooks.create( false, // enabled (optional) false, // tls (optional) "<AUTH_USERNAME>", // authUsername (optional) - "<AUTH_PASSWORD>", // authPassword (optional) + "password", // authPassword (optional) "<SECRET>", // secret (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { diff --git a/examples/1.9.x/server-kotlin/java/webhooks/update.md b/examples/1.9.x/server-kotlin/java/webhooks/update.md index c6a436c86..82ce22aab 100644 --- a/examples/1.9.x/server-kotlin/java/webhooks/update.md +++ b/examples/1.9.x/server-kotlin/java/webhooks/update.md @@ -18,7 +18,7 @@ webhooks.update( false, // enabled (optional) false, // tls (optional) "<AUTH_USERNAME>", // authUsername (optional) - "<AUTH_PASSWORD>", // authPassword (optional) + "password", // authPassword (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.9.x/server-kotlin/kotlin/account/create.md b/examples/1.9.x/server-kotlin/kotlin/account/create.md index 2b9cd5f4f..2cd564dd6 100644 --- a/examples/1.9.x/server-kotlin/kotlin/account/create.md +++ b/examples/1.9.x/server-kotlin/kotlin/account/create.md @@ -13,7 +13,7 @@ val account = Account(client) val response = account.create( userId = "<USER_ID>", email = "email@example.com", - password = "", + password = "password", name = "<NAME>" // optional ) ``` diff --git a/examples/1.9.x/server-kotlin/kotlin/account/update-password.md b/examples/1.9.x/server-kotlin/kotlin/account/update-password.md index 33b14a5c6..8d2fab101 100644 --- a/examples/1.9.x/server-kotlin/kotlin/account/update-password.md +++ b/examples/1.9.x/server-kotlin/kotlin/account/update-password.md @@ -11,7 +11,7 @@ val client = Client() val account = Account(client) val response = account.updatePassword( - password = "", + password = "password", oldPassword = "password" // optional ) ``` diff --git a/examples/1.9.x/server-kotlin/kotlin/account/update-recovery.md b/examples/1.9.x/server-kotlin/kotlin/account/update-recovery.md index 31387f9da..4b1869c61 100644 --- a/examples/1.9.x/server-kotlin/kotlin/account/update-recovery.md +++ b/examples/1.9.x/server-kotlin/kotlin/account/update-recovery.md @@ -13,6 +13,6 @@ val account = Account(client) val response = account.updateRecovery( userId = "<USER_ID>", secret = "<SECRET>", - password = "" + password = "password" ) ``` diff --git a/examples/1.9.x/server-kotlin/kotlin/avatars/get-browser.md b/examples/1.9.x/server-kotlin/kotlin/avatars/get-browser.md index 2565bd7cf..673bab7f9 100644 --- a/examples/1.9.x/server-kotlin/kotlin/avatars/get-browser.md +++ b/examples/1.9.x/server-kotlin/kotlin/avatars/get-browser.md @@ -8,6 +8,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/avatars/get-credit-card.md b/examples/1.9.x/server-kotlin/kotlin/avatars/get-credit-card.md index 08ce6f06c..81e9190b6 100644 --- a/examples/1.9.x/server-kotlin/kotlin/avatars/get-credit-card.md +++ b/examples/1.9.x/server-kotlin/kotlin/avatars/get-credit-card.md @@ -8,6 +8,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/avatars/get-favicon.md b/examples/1.9.x/server-kotlin/kotlin/avatars/get-favicon.md index b19ad3ffc..f78d61162 100644 --- a/examples/1.9.x/server-kotlin/kotlin/avatars/get-favicon.md +++ b/examples/1.9.x/server-kotlin/kotlin/avatars/get-favicon.md @@ -7,6 +7,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/avatars/get-flag.md b/examples/1.9.x/server-kotlin/kotlin/avatars/get-flag.md index 3f411c337..ce7ee05c5 100644 --- a/examples/1.9.x/server-kotlin/kotlin/avatars/get-flag.md +++ b/examples/1.9.x/server-kotlin/kotlin/avatars/get-flag.md @@ -8,6 +8,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/avatars/get-image.md b/examples/1.9.x/server-kotlin/kotlin/avatars/get-image.md index 5efffd328..78f64db97 100644 --- a/examples/1.9.x/server-kotlin/kotlin/avatars/get-image.md +++ b/examples/1.9.x/server-kotlin/kotlin/avatars/get-image.md @@ -7,6 +7,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/avatars/get-initials.md b/examples/1.9.x/server-kotlin/kotlin/avatars/get-initials.md index 731aaab41..d7d9cd8a1 100644 --- a/examples/1.9.x/server-kotlin/kotlin/avatars/get-initials.md +++ b/examples/1.9.x/server-kotlin/kotlin/avatars/get-initials.md @@ -7,6 +7,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/avatars/get-qr.md b/examples/1.9.x/server-kotlin/kotlin/avatars/get-qr.md index e9419fef5..d74d18579 100644 --- a/examples/1.9.x/server-kotlin/kotlin/avatars/get-qr.md +++ b/examples/1.9.x/server-kotlin/kotlin/avatars/get-qr.md @@ -7,6 +7,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/avatars/get-screenshot.md b/examples/1.9.x/server-kotlin/kotlin/avatars/get-screenshot.md index ea26656a8..5fdb090d6 100644 --- a/examples/1.9.x/server-kotlin/kotlin/avatars/get-screenshot.md +++ b/examples/1.9.x/server-kotlin/kotlin/avatars/get-screenshot.md @@ -11,6 +11,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val avatars = Avatars(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/functions/create.md b/examples/1.9.x/server-kotlin/kotlin/functions/create.md index 66adc158a..7f769481c 100644 --- a/examples/1.9.x/server-kotlin/kotlin/functions/create.md +++ b/examples/1.9.x/server-kotlin/kotlin/functions/create.md @@ -2,7 +2,7 @@ import io.appwrite.Client import io.appwrite.coroutines.CoroutineCallback import io.appwrite.services.Functions -import io.appwrite.enums.FunctionRuntime +import io.appwrite.enums.Runtime import io.appwrite.enums.ProjectKeyScopes val client = Client() @@ -15,7 +15,7 @@ val functions = Functions(client) val response = functions.create( functionId = "<FUNCTION_ID>", name = "<NAME>", - runtime = FunctionRuntime.NODE_14_5, + runtime = Runtime.NODE_14_5, execute = listOf("any"), // optional events = listOf(), // optional schedule = "", // optional diff --git a/examples/1.9.x/server-kotlin/kotlin/functions/get-deployment-download.md b/examples/1.9.x/server-kotlin/kotlin/functions/get-deployment-download.md index d6663d685..a1909fc9c 100644 --- a/examples/1.9.x/server-kotlin/kotlin/functions/get-deployment-download.md +++ b/examples/1.9.x/server-kotlin/kotlin/functions/get-deployment-download.md @@ -8,6 +8,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setKey("<YOUR_API_KEY>") // Your secret API key + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val functions = Functions(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/functions/update.md b/examples/1.9.x/server-kotlin/kotlin/functions/update.md index 1084ef5b5..a65edd671 100644 --- a/examples/1.9.x/server-kotlin/kotlin/functions/update.md +++ b/examples/1.9.x/server-kotlin/kotlin/functions/update.md @@ -2,7 +2,7 @@ import io.appwrite.Client import io.appwrite.coroutines.CoroutineCallback import io.appwrite.services.Functions -import io.appwrite.enums.FunctionRuntime +import io.appwrite.enums.Runtime import io.appwrite.enums.ProjectKeyScopes val client = Client() @@ -15,7 +15,7 @@ val functions = Functions(client) val response = functions.update( functionId = "<FUNCTION_ID>", name = "<NAME>", - runtime = FunctionRuntime.NODE_14_5, // optional + runtime = Runtime.NODE_14_5, // optional execute = listOf("any"), // optional events = listOf(), // optional schedule = "", // optional diff --git a/examples/1.9.x/server-kotlin/kotlin/health/get-audits-db.md b/examples/1.9.x/server-kotlin/kotlin/health/get-audits-db.md new file mode 100644 index 000000000..b7229917e --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/health/get-audits-db.md @@ -0,0 +1,14 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getAuditsDB() +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/messaging/create-ses-provider.md b/examples/1.9.x/server-kotlin/kotlin/messaging/create-ses-provider.md new file mode 100644 index 000000000..47f54967f --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/messaging/create-ses-provider.md @@ -0,0 +1,25 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createSesProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", + accessKey = "<ACCESS_KEY>", // optional + secretKey = "<SECRET_KEY>", // optional + region = "<REGION>", // optional + fromName = "<FROM_NAME>", // optional + fromEmail = "email@example.com", // optional + replyToName = "<REPLY_TO_NAME>", // optional + replyToEmail = "email@example.com", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/messaging/create-smtp-provider.md b/examples/1.9.x/server-kotlin/kotlin/messaging/create-smtp-provider.md index 64d55ed13..7b984004a 100644 --- a/examples/1.9.x/server-kotlin/kotlin/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-kotlin/kotlin/messaging/create-smtp-provider.md @@ -17,7 +17,7 @@ val response = messaging.createSMTPProvider( host = "<HOST>", port = 1, // optional username = "<USERNAME>", // optional - password = "<PASSWORD>", // optional + password = "password", // optional encryption = SmtpEncryption.NONE, // optional autoTLS = false, // optional mailer = "<MAILER>", // optional diff --git a/examples/1.9.x/server-kotlin/kotlin/messaging/update-ses-provider.md b/examples/1.9.x/server-kotlin/kotlin/messaging/update-ses-provider.md new file mode 100644 index 000000000..097b15e80 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/messaging/update-ses-provider.md @@ -0,0 +1,25 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateSesProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", // optional + enabled = false, // optional + accessKey = "<ACCESS_KEY>", // optional + secretKey = "<SECRET_KEY>", // optional + region = "<REGION>", // optional + fromName = "<FROM_NAME>", // optional + fromEmail = "email@example.com", // optional + replyToName = "<REPLY_TO_NAME>", // optional + replyToEmail = "<REPLY_TO_EMAIL>" // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/messaging/update-smtp-provider.md b/examples/1.9.x/server-kotlin/kotlin/messaging/update-smtp-provider.md index ff8ed34ea..581a95763 100644 --- a/examples/1.9.x/server-kotlin/kotlin/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-kotlin/kotlin/messaging/update-smtp-provider.md @@ -17,7 +17,7 @@ val response = messaging.updateSMTPProvider( host = "<HOST>", // optional port = 1, // optional username = "<USERNAME>", // optional - password = "<PASSWORD>", // optional + password = "password", // optional encryption = SmtpEncryption.NONE, // optional autoTLS = false, // optional mailer = "<MAILER>", // optional diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-membership-privacy-policy.md b/examples/1.9.x/server-kotlin/kotlin/project/update-membership-privacy-policy.md index 5d177b328..d3d90669b 100644 --- a/examples/1.9.x/server-kotlin/kotlin/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-membership-privacy-policy.md @@ -15,6 +15,7 @@ val response = project.updateMembershipPrivacyPolicy( userEmail = false, // optional userPhone = false, // optional userName = false, // optional - userMFA = false // optional + userMFA = false, // optional + userAccessedAt = false // optional ) ``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-server.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-server.md new file mode 100644 index 000000000..9be32177e --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-server.md @@ -0,0 +1,28 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Server( + enabled = false, + authorizationUrl = "https://example.com", + scopes = listOf(), // optional + authorizationDetailsTypes = listOf(), // optional + accessTokenDuration = 60, // optional + refreshTokenDuration = 60, // optional + publicAccessTokenDuration = 60, // optional + publicRefreshTokenDuration = 60, // optional + confidentialPkce = false, // optional + verificationUrl = "https://example.com", // optional + userCodeLength = 6, // optional + userCodeFormat = "numeric", // optional + deviceCodeDuration = 60 // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-password-strength-policy.md b/examples/1.9.x/server-kotlin/kotlin/project/update-password-strength-policy.md new file mode 100644 index 000000000..7f4019b17 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-password-strength-policy.md @@ -0,0 +1,20 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val project = Project(client) + +val response = project.updatePasswordStrengthPolicy( + min = 8, // optional + uppercase = false, // optional + lowercase = false, // optional + number = false, // optional + symbols = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-smtp.md b/examples/1.9.x/server-kotlin/kotlin/project/update-smtp.md index 56b1a667e..88f65a88b 100644 --- a/examples/1.9.x/server-kotlin/kotlin/project/update-smtp.md +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-smtp.md @@ -15,7 +15,7 @@ val response = project.updateSMTP( host = "", // optional port = 0, // optional username = "<USERNAME>", // optional - password = "<PASSWORD>", // optional + password = "password", // optional senderEmail = "email@example.com", // optional senderName = "<SENDER_NAME>", // optional replyToEmail = "email@example.com", // optional diff --git a/examples/1.9.x/server-kotlin/kotlin/proxy/create-redirect-rule.md b/examples/1.9.x/server-kotlin/kotlin/proxy/create-redirect-rule.md index fbe10b744..1b539787c 100644 --- a/examples/1.9.x/server-kotlin/kotlin/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-kotlin/kotlin/proxy/create-redirect-rule.md @@ -2,7 +2,7 @@ import io.appwrite.Client import io.appwrite.coroutines.CoroutineCallback import io.appwrite.services.Proxy -import io.appwrite.enums.RedirectStatusCode +import io.appwrite.enums.StatusCode import io.appwrite.enums.ProxyResourceType val client = Client() @@ -15,7 +15,7 @@ val proxy = Proxy(client) val response = proxy.createRedirectRule( domain = "", url = "https://example.com", - statusCode = RedirectStatusCode.MOVEDPERMANENTLY, + statusCode = StatusCode.MOVEDPERMANENTLY, resourceId = "<RESOURCE_ID>", resourceType = ProxyResourceType.SITE ) diff --git a/examples/1.9.x/server-kotlin/kotlin/sites/create.md b/examples/1.9.x/server-kotlin/kotlin/sites/create.md index 63bdf0618..89c04852a 100644 --- a/examples/1.9.x/server-kotlin/kotlin/sites/create.md +++ b/examples/1.9.x/server-kotlin/kotlin/sites/create.md @@ -2,9 +2,9 @@ import io.appwrite.Client import io.appwrite.coroutines.CoroutineCallback import io.appwrite.services.Sites -import io.appwrite.enums.SiteFramework -import io.appwrite.enums.SiteBuildRuntime -import io.appwrite.enums.SiteAdapter +import io.appwrite.enums.Framework +import io.appwrite.enums.BuildRuntime +import io.appwrite.enums.Adapter val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint @@ -16,8 +16,8 @@ val sites = Sites(client) val response = sites.create( siteId = "<SITE_ID>", name = "<NAME>", - framework = SiteFramework.ANALOG, - buildRuntime = SiteBuildRuntime.NODE_14_5, + framework = Framework.ANALOG, + buildRuntime = BuildRuntime.NODE_14_5, enabled = false, // optional logging = false, // optional timeout = 1, // optional @@ -25,7 +25,7 @@ val response = sites.create( buildCommand = "<BUILD_COMMAND>", // optional startCommand = "<START_COMMAND>", // optional outputDirectory = "<OUTPUT_DIRECTORY>", // optional - adapter = SiteAdapter.STATIC, // optional + adapter = Adapter.STATIC, // optional installationId = "<INSTALLATION_ID>", // optional fallbackFile = "<FALLBACK_FILE>", // optional providerRepositoryId = "<PROVIDER_REPOSITORY_ID>", // optional diff --git a/examples/1.9.x/server-kotlin/kotlin/sites/get-deployment-download.md b/examples/1.9.x/server-kotlin/kotlin/sites/get-deployment-download.md index e86ef015c..9d3e94f9f 100644 --- a/examples/1.9.x/server-kotlin/kotlin/sites/get-deployment-download.md +++ b/examples/1.9.x/server-kotlin/kotlin/sites/get-deployment-download.md @@ -8,6 +8,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setKey("<YOUR_API_KEY>") // Your secret API key + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val sites = Sites(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/sites/update.md b/examples/1.9.x/server-kotlin/kotlin/sites/update.md index bc90f0abc..0a483b9a9 100644 --- a/examples/1.9.x/server-kotlin/kotlin/sites/update.md +++ b/examples/1.9.x/server-kotlin/kotlin/sites/update.md @@ -2,9 +2,9 @@ import io.appwrite.Client import io.appwrite.coroutines.CoroutineCallback import io.appwrite.services.Sites -import io.appwrite.enums.SiteFramework -import io.appwrite.enums.SiteBuildRuntime -import io.appwrite.enums.SiteAdapter +import io.appwrite.enums.Framework +import io.appwrite.enums.BuildRuntime +import io.appwrite.enums.Adapter val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint @@ -16,7 +16,7 @@ val sites = Sites(client) val response = sites.update( siteId = "<SITE_ID>", name = "<NAME>", - framework = SiteFramework.ANALOG, + framework = Framework.ANALOG, enabled = false, // optional logging = false, // optional timeout = 1, // optional @@ -24,8 +24,8 @@ val response = sites.update( buildCommand = "<BUILD_COMMAND>", // optional startCommand = "<START_COMMAND>", // optional outputDirectory = "<OUTPUT_DIRECTORY>", // optional - buildRuntime = SiteBuildRuntime.NODE_14_5, // optional - adapter = SiteAdapter.STATIC, // optional + buildRuntime = BuildRuntime.NODE_14_5, // optional + adapter = Adapter.STATIC, // optional fallbackFile = "<FALLBACK_FILE>", // optional installationId = "<INSTALLATION_ID>", // optional providerRepositoryId = "<PROVIDER_REPOSITORY_ID>", // optional diff --git a/examples/1.9.x/server-kotlin/kotlin/storage/get-file-download.md b/examples/1.9.x/server-kotlin/kotlin/storage/get-file-download.md index ed3198dde..86f9f8aaa 100644 --- a/examples/1.9.x/server-kotlin/kotlin/storage/get-file-download.md +++ b/examples/1.9.x/server-kotlin/kotlin/storage/get-file-download.md @@ -7,6 +7,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val storage = Storage(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/storage/get-file-preview.md b/examples/1.9.x/server-kotlin/kotlin/storage/get-file-preview.md index 9f7f29240..c070c1f18 100644 --- a/examples/1.9.x/server-kotlin/kotlin/storage/get-file-preview.md +++ b/examples/1.9.x/server-kotlin/kotlin/storage/get-file-preview.md @@ -9,6 +9,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val storage = Storage(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/storage/get-file-view.md b/examples/1.9.x/server-kotlin/kotlin/storage/get-file-view.md index 141a8cd4f..f7ff66f40 100644 --- a/examples/1.9.x/server-kotlin/kotlin/storage/get-file-view.md +++ b/examples/1.9.x/server-kotlin/kotlin/storage/get-file-view.md @@ -7,6 +7,7 @@ val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. val storage = Storage(client) diff --git a/examples/1.9.x/server-kotlin/kotlin/users/create.md b/examples/1.9.x/server-kotlin/kotlin/users/create.md index 09d286233..f084a8c34 100644 --- a/examples/1.9.x/server-kotlin/kotlin/users/create.md +++ b/examples/1.9.x/server-kotlin/kotlin/users/create.md @@ -14,7 +14,7 @@ val response = users.create( userId = "<USER_ID>", email = "email@example.com", // optional phone = "+12065550100", // optional - password = "", // optional + password = "password", // optional name = "<NAME>" // optional ) ``` diff --git a/examples/1.9.x/server-kotlin/kotlin/users/update-password.md b/examples/1.9.x/server-kotlin/kotlin/users/update-password.md index 5930f5ebe..b0ed76a93 100644 --- a/examples/1.9.x/server-kotlin/kotlin/users/update-password.md +++ b/examples/1.9.x/server-kotlin/kotlin/users/update-password.md @@ -12,6 +12,6 @@ val users = Users(client) val response = users.updatePassword( userId = "<USER_ID>", - password = "" + password = "password" ) ``` diff --git a/examples/1.9.x/server-kotlin/kotlin/webhooks/create.md b/examples/1.9.x/server-kotlin/kotlin/webhooks/create.md index 989c5c1c7..58882e118 100644 --- a/examples/1.9.x/server-kotlin/kotlin/webhooks/create.md +++ b/examples/1.9.x/server-kotlin/kotlin/webhooks/create.md @@ -18,7 +18,7 @@ val response = webhooks.create( enabled = false, // optional tls = false, // optional authUsername = "<AUTH_USERNAME>", // optional - authPassword = "<AUTH_PASSWORD>", // optional + authPassword = "password", // optional secret = "<SECRET>" // optional ) ``` diff --git a/examples/1.9.x/server-kotlin/kotlin/webhooks/update.md b/examples/1.9.x/server-kotlin/kotlin/webhooks/update.md index 498cf6739..9a6e482f8 100644 --- a/examples/1.9.x/server-kotlin/kotlin/webhooks/update.md +++ b/examples/1.9.x/server-kotlin/kotlin/webhooks/update.md @@ -18,6 +18,6 @@ val response = webhooks.update( enabled = false, // optional tls = false, // optional authUsername = "<AUTH_USERNAME>", // optional - authPassword = "<AUTH_PASSWORD>" // optional + authPassword = "password" // optional ) ``` diff --git a/examples/1.9.x/server-nodejs/examples/account/create.md b/examples/1.9.x/server-nodejs/examples/account/create.md index db31f30b8..abc8c1335 100644 --- a/examples/1.9.x/server-nodejs/examples/account/create.md +++ b/examples/1.9.x/server-nodejs/examples/account/create.md @@ -11,7 +11,7 @@ const account = new sdk.Account(client); const result = await account.create({ userId: '<USER_ID>', email: 'email@example.com', - password: '', + password: 'password', name: '<NAME>' // optional }); ``` diff --git a/examples/1.9.x/server-nodejs/examples/account/update-password.md b/examples/1.9.x/server-nodejs/examples/account/update-password.md index f6b7bb54e..d359b344c 100644 --- a/examples/1.9.x/server-nodejs/examples/account/update-password.md +++ b/examples/1.9.x/server-nodejs/examples/account/update-password.md @@ -9,7 +9,7 @@ const client = new sdk.Client() const account = new sdk.Account(client); const result = await account.updatePassword({ - password: '', + password: 'password', oldPassword: 'password' // optional }); ``` diff --git a/examples/1.9.x/server-nodejs/examples/account/update-recovery.md b/examples/1.9.x/server-nodejs/examples/account/update-recovery.md index 268f3e979..9008f675b 100644 --- a/examples/1.9.x/server-nodejs/examples/account/update-recovery.md +++ b/examples/1.9.x/server-nodejs/examples/account/update-recovery.md @@ -11,6 +11,6 @@ const account = new sdk.Account(client); const result = await account.updateRecovery({ userId: '<USER_ID>', secret: '<SECRET>', - password: '' + password: 'password' }); ``` diff --git a/examples/1.9.x/server-nodejs/examples/avatars/get-browser.md b/examples/1.9.x/server-nodejs/examples/avatars/get-browser.md index 6ffb388d5..3559f2444 100644 --- a/examples/1.9.x/server-nodejs/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-nodejs/examples/avatars/get-browser.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new sdk.Avatars(client); diff --git a/examples/1.9.x/server-nodejs/examples/avatars/get-credit-card.md b/examples/1.9.x/server-nodejs/examples/avatars/get-credit-card.md index ea806baff..67e2c1bee 100644 --- a/examples/1.9.x/server-nodejs/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-nodejs/examples/avatars/get-credit-card.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new sdk.Avatars(client); diff --git a/examples/1.9.x/server-nodejs/examples/avatars/get-favicon.md b/examples/1.9.x/server-nodejs/examples/avatars/get-favicon.md index bd9ae2caa..83d2423d4 100644 --- a/examples/1.9.x/server-nodejs/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-nodejs/examples/avatars/get-favicon.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new sdk.Avatars(client); diff --git a/examples/1.9.x/server-nodejs/examples/avatars/get-flag.md b/examples/1.9.x/server-nodejs/examples/avatars/get-flag.md index d05b666bc..26f2c4f95 100644 --- a/examples/1.9.x/server-nodejs/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-nodejs/examples/avatars/get-flag.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new sdk.Avatars(client); diff --git a/examples/1.9.x/server-nodejs/examples/avatars/get-image.md b/examples/1.9.x/server-nodejs/examples/avatars/get-image.md index 6f013db19..f51eed1d3 100644 --- a/examples/1.9.x/server-nodejs/examples/avatars/get-image.md +++ b/examples/1.9.x/server-nodejs/examples/avatars/get-image.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new sdk.Avatars(client); diff --git a/examples/1.9.x/server-nodejs/examples/avatars/get-initials.md b/examples/1.9.x/server-nodejs/examples/avatars/get-initials.md index 3d35c6df9..e86f64580 100644 --- a/examples/1.9.x/server-nodejs/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-nodejs/examples/avatars/get-initials.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new sdk.Avatars(client); diff --git a/examples/1.9.x/server-nodejs/examples/avatars/get-qr.md b/examples/1.9.x/server-nodejs/examples/avatars/get-qr.md index e4235a38e..06cdd1ba9 100644 --- a/examples/1.9.x/server-nodejs/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-nodejs/examples/avatars/get-qr.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new sdk.Avatars(client); diff --git a/examples/1.9.x/server-nodejs/examples/avatars/get-screenshot.md b/examples/1.9.x/server-nodejs/examples/avatars/get-screenshot.md index d83f24ab3..9ea7564b7 100644 --- a/examples/1.9.x/server-nodejs/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-nodejs/examples/avatars/get-screenshot.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const avatars = new sdk.Avatars(client); diff --git a/examples/1.9.x/server-nodejs/examples/functions/create.md b/examples/1.9.x/server-nodejs/examples/functions/create.md index e62cbbdc9..cb9c3e8c5 100644 --- a/examples/1.9.x/server-nodejs/examples/functions/create.md +++ b/examples/1.9.x/server-nodejs/examples/functions/create.md @@ -11,7 +11,7 @@ const functions = new sdk.Functions(client); const result = await functions.create({ functionId: '<FUNCTION_ID>', name: '<NAME>', - runtime: sdk.FunctionRuntime.Node145, + runtime: sdk.Runtime.Node145, execute: ["any"], // optional events: [], // optional schedule: '', // optional diff --git a/examples/1.9.x/server-nodejs/examples/functions/get-deployment-download.md b/examples/1.9.x/server-nodejs/examples/functions/get-deployment-download.md index 5e9a956d0..81c41a838 100644 --- a/examples/1.9.x/server-nodejs/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-nodejs/examples/functions/get-deployment-download.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key + .setKey('<YOUR_API_KEY>') // Your secret API key + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const functions = new sdk.Functions(client); diff --git a/examples/1.9.x/server-nodejs/examples/functions/update.md b/examples/1.9.x/server-nodejs/examples/functions/update.md index 2cbe0f85e..7d64aa264 100644 --- a/examples/1.9.x/server-nodejs/examples/functions/update.md +++ b/examples/1.9.x/server-nodejs/examples/functions/update.md @@ -11,7 +11,7 @@ const functions = new sdk.Functions(client); const result = await functions.update({ functionId: '<FUNCTION_ID>', name: '<NAME>', - runtime: sdk.FunctionRuntime.Node145, // optional + runtime: sdk.Runtime.Node145, // optional execute: ["any"], // optional events: [], // optional schedule: '', // optional diff --git a/examples/1.9.x/server-nodejs/examples/health/get-audits-db.md b/examples/1.9.x/server-nodejs/examples/health/get-audits-db.md new file mode 100644 index 000000000..50d2eff84 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/health/get-audits-db.md @@ -0,0 +1,12 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getAuditsDB(); +``` diff --git a/examples/1.9.x/server-nodejs/examples/messaging/create-ses-provider.md b/examples/1.9.x/server-nodejs/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..c25a7fea6 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/messaging/create-ses-provider.md @@ -0,0 +1,23 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createSesProvider({ + providerId: '<PROVIDER_ID>', + name: '<NAME>', + accessKey: '<ACCESS_KEY>', // optional + secretKey: '<SECRET_KEY>', // optional + region: '<REGION>', // optional + fromName: '<FROM_NAME>', // optional + fromEmail: 'email@example.com', // optional + replyToName: '<REPLY_TO_NAME>', // optional + replyToEmail: 'email@example.com', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-nodejs/examples/messaging/create-smtp-provider.md index e17fdc193..b980c3b38 100644 --- a/examples/1.9.x/server-nodejs/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-nodejs/examples/messaging/create-smtp-provider.md @@ -14,7 +14,7 @@ const result = await messaging.createSMTPProvider({ host: '<HOST>', port: 1, // optional username: '<USERNAME>', // optional - password: '<PASSWORD>', // optional + password: 'password', // optional encryption: sdk.SmtpEncryption.None, // optional autoTLS: false, // optional mailer: '<MAILER>', // optional diff --git a/examples/1.9.x/server-nodejs/examples/messaging/update-ses-provider.md b/examples/1.9.x/server-nodejs/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..2858646f5 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/messaging/update-ses-provider.md @@ -0,0 +1,23 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateSesProvider({ + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + enabled: false, // optional + accessKey: '<ACCESS_KEY>', // optional + secretKey: '<SECRET_KEY>', // optional + region: '<REGION>', // optional + fromName: '<FROM_NAME>', // optional + fromEmail: 'email@example.com', // optional + replyToName: '<REPLY_TO_NAME>', // optional + replyToEmail: '<REPLY_TO_EMAIL>' // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-nodejs/examples/messaging/update-smtp-provider.md index d860736f5..1b0ec7250 100644 --- a/examples/1.9.x/server-nodejs/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-nodejs/examples/messaging/update-smtp-provider.md @@ -14,7 +14,7 @@ const result = await messaging.updateSMTPProvider({ host: '<HOST>', // optional port: 1, // optional username: '<USERNAME>', // optional - password: '<PASSWORD>', // optional + password: 'password', // optional encryption: sdk.SmtpEncryption.None, // optional autoTLS: false, // optional mailer: '<MAILER>', // optional diff --git a/examples/1.9.x/server-nodejs/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-nodejs/examples/project/update-membership-privacy-policy.md index 66eff9f37..6fda0908e 100644 --- a/examples/1.9.x/server-nodejs/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-nodejs/examples/project/update-membership-privacy-policy.md @@ -13,6 +13,7 @@ const result = await project.updateMembershipPrivacyPolicy({ userEmail: false, // optional userPhone: false, // optional userName: false, // optional - userMFA: false // optional + userMFA: false, // optional + userAccessedAt: false // optional }); ``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-server.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..5feef6a63 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-server.md @@ -0,0 +1,26 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Server({ + enabled: false, + authorizationUrl: 'https://example.com', + scopes: [], // optional + authorizationDetailsTypes: [], // optional + accessTokenDuration: 60, // optional + refreshTokenDuration: 60, // optional + publicAccessTokenDuration: 60, // optional + publicRefreshTokenDuration: 60, // optional + confidentialPkce: false, // optional + verificationUrl: 'https://example.com', // optional + userCodeLength: 6, // optional + userCodeFormat: 'numeric', // optional + deviceCodeDuration: 60 // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-password-strength-policy.md b/examples/1.9.x/server-nodejs/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..3d2648df4 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-password-strength-policy.md @@ -0,0 +1,18 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updatePasswordStrengthPolicy({ + min: 8, // optional + uppercase: false, // optional + lowercase: false, // optional + number: false, // optional + symbols: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-smtp.md b/examples/1.9.x/server-nodejs/examples/project/update-smtp.md index fe7258a53..d7ace0999 100644 --- a/examples/1.9.x/server-nodejs/examples/project/update-smtp.md +++ b/examples/1.9.x/server-nodejs/examples/project/update-smtp.md @@ -12,7 +12,7 @@ const result = await project.updateSMTP({ host: '', // optional port: null, // optional username: '<USERNAME>', // optional - password: '<PASSWORD>', // optional + password: 'password', // optional senderEmail: 'email@example.com', // optional senderName: '<SENDER_NAME>', // optional replyToEmail: 'email@example.com', // optional diff --git a/examples/1.9.x/server-nodejs/examples/proxy/create-redirect-rule.md b/examples/1.9.x/server-nodejs/examples/proxy/create-redirect-rule.md index 13d16dc57..bb028c15a 100644 --- a/examples/1.9.x/server-nodejs/examples/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-nodejs/examples/proxy/create-redirect-rule.md @@ -11,7 +11,7 @@ const proxy = new sdk.Proxy(client); const result = await proxy.createRedirectRule({ domain: '', url: 'https://example.com', - statusCode: sdk.RedirectStatusCode.MovedPermanently, + statusCode: sdk.StatusCode.MovedPermanently, resourceId: '<RESOURCE_ID>', resourceType: sdk.ProxyResourceType.Site }); diff --git a/examples/1.9.x/server-nodejs/examples/sites/create.md b/examples/1.9.x/server-nodejs/examples/sites/create.md index 51656335c..dc4e3ef76 100644 --- a/examples/1.9.x/server-nodejs/examples/sites/create.md +++ b/examples/1.9.x/server-nodejs/examples/sites/create.md @@ -11,8 +11,8 @@ const sites = new sdk.Sites(client); const result = await sites.create({ siteId: '<SITE_ID>', name: '<NAME>', - framework: sdk.SiteFramework.Analog, - buildRuntime: sdk.SiteBuildRuntime.Node145, + framework: sdk.Framework.Analog, + buildRuntime: sdk.BuildRuntime.Node145, enabled: false, // optional logging: false, // optional timeout: 1, // optional @@ -20,7 +20,7 @@ const result = await sites.create({ buildCommand: '<BUILD_COMMAND>', // optional startCommand: '<START_COMMAND>', // optional outputDirectory: '<OUTPUT_DIRECTORY>', // optional - adapter: sdk.SiteAdapter.Static, // optional + adapter: sdk.Adapter.Static, // optional installationId: '<INSTALLATION_ID>', // optional fallbackFile: '<FALLBACK_FILE>', // optional providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional diff --git a/examples/1.9.x/server-nodejs/examples/sites/get-deployment-download.md b/examples/1.9.x/server-nodejs/examples/sites/get-deployment-download.md index 6e7ee4aa0..c4c406491 100644 --- a/examples/1.9.x/server-nodejs/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-nodejs/examples/sites/get-deployment-download.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key + .setKey('<YOUR_API_KEY>') // Your secret API key + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const sites = new sdk.Sites(client); diff --git a/examples/1.9.x/server-nodejs/examples/sites/update.md b/examples/1.9.x/server-nodejs/examples/sites/update.md index ec2503362..30928f1d7 100644 --- a/examples/1.9.x/server-nodejs/examples/sites/update.md +++ b/examples/1.9.x/server-nodejs/examples/sites/update.md @@ -11,7 +11,7 @@ const sites = new sdk.Sites(client); const result = await sites.update({ siteId: '<SITE_ID>', name: '<NAME>', - framework: sdk.SiteFramework.Analog, + framework: sdk.Framework.Analog, enabled: false, // optional logging: false, // optional timeout: 1, // optional @@ -19,8 +19,8 @@ const result = await sites.update({ buildCommand: '<BUILD_COMMAND>', // optional startCommand: '<START_COMMAND>', // optional outputDirectory: '<OUTPUT_DIRECTORY>', // optional - buildRuntime: sdk.SiteBuildRuntime.Node145, // optional - adapter: sdk.SiteAdapter.Static, // optional + buildRuntime: sdk.BuildRuntime.Node145, // optional + adapter: sdk.Adapter.Static, // optional fallbackFile: '<FALLBACK_FILE>', // optional installationId: '<INSTALLATION_ID>', // optional providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional diff --git a/examples/1.9.x/server-nodejs/examples/storage/get-file-download.md b/examples/1.9.x/server-nodejs/examples/storage/get-file-download.md index c0a10d967..3c52437cf 100644 --- a/examples/1.9.x/server-nodejs/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-nodejs/examples/storage/get-file-download.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new sdk.Storage(client); diff --git a/examples/1.9.x/server-nodejs/examples/storage/get-file-preview.md b/examples/1.9.x/server-nodejs/examples/storage/get-file-preview.md index 984333db6..f1682d37d 100644 --- a/examples/1.9.x/server-nodejs/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-nodejs/examples/storage/get-file-preview.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new sdk.Storage(client); diff --git a/examples/1.9.x/server-nodejs/examples/storage/get-file-view.md b/examples/1.9.x/server-nodejs/examples/storage/get-file-view.md index a20c4ac2b..14a9af0b7 100644 --- a/examples/1.9.x/server-nodejs/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-nodejs/examples/storage/get-file-view.md @@ -4,7 +4,8 @@ const sdk = require('node-appwrite'); const client = new sdk.Client() .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. const storage = new sdk.Storage(client); diff --git a/examples/1.9.x/server-nodejs/examples/users/create.md b/examples/1.9.x/server-nodejs/examples/users/create.md index 5610f0621..c93772d2d 100644 --- a/examples/1.9.x/server-nodejs/examples/users/create.md +++ b/examples/1.9.x/server-nodejs/examples/users/create.md @@ -12,7 +12,7 @@ const result = await users.create({ userId: '<USER_ID>', email: 'email@example.com', // optional phone: '+12065550100', // optional - password: '', // optional + password: 'password', // optional name: '<NAME>' // optional }); ``` diff --git a/examples/1.9.x/server-nodejs/examples/users/update-password.md b/examples/1.9.x/server-nodejs/examples/users/update-password.md index ab572ca01..5cadfdba9 100644 --- a/examples/1.9.x/server-nodejs/examples/users/update-password.md +++ b/examples/1.9.x/server-nodejs/examples/users/update-password.md @@ -10,6 +10,6 @@ const users = new sdk.Users(client); const result = await users.updatePassword({ userId: '<USER_ID>', - password: '' + password: 'password' }); ``` diff --git a/examples/1.9.x/server-nodejs/examples/webhooks/create.md b/examples/1.9.x/server-nodejs/examples/webhooks/create.md index c8603872a..75c778c3a 100644 --- a/examples/1.9.x/server-nodejs/examples/webhooks/create.md +++ b/examples/1.9.x/server-nodejs/examples/webhooks/create.md @@ -16,7 +16,7 @@ const result = await webhooks.create({ enabled: false, // optional tls: false, // optional authUsername: '<AUTH_USERNAME>', // optional - authPassword: '<AUTH_PASSWORD>', // optional + authPassword: 'password', // optional secret: '<SECRET>' // optional }); ``` diff --git a/examples/1.9.x/server-nodejs/examples/webhooks/update.md b/examples/1.9.x/server-nodejs/examples/webhooks/update.md index 6596e900f..f83021c4d 100644 --- a/examples/1.9.x/server-nodejs/examples/webhooks/update.md +++ b/examples/1.9.x/server-nodejs/examples/webhooks/update.md @@ -16,6 +16,6 @@ const result = await webhooks.update({ enabled: false, // optional tls: false, // optional authUsername: '<AUTH_USERNAME>', // optional - authPassword: '<AUTH_PASSWORD>' // optional + authPassword: 'password' // optional }); ``` diff --git a/examples/1.9.x/server-php/examples/account/create.md b/examples/1.9.x/server-php/examples/account/create.md index 8975698b2..123538caa 100644 --- a/examples/1.9.x/server-php/examples/account/create.md +++ b/examples/1.9.x/server-php/examples/account/create.md @@ -14,6 +14,6 @@ $account = new Account($client); $result = $account->create( userId: '<USER_ID>', email: 'email@example.com', - password: '', + password: 'password', name: '<NAME>' // optional );``` diff --git a/examples/1.9.x/server-php/examples/account/update-password.md b/examples/1.9.x/server-php/examples/account/update-password.md index ea1996a6f..13f03c870 100644 --- a/examples/1.9.x/server-php/examples/account/update-password.md +++ b/examples/1.9.x/server-php/examples/account/update-password.md @@ -12,6 +12,6 @@ $client = (new Client()) $account = new Account($client); $result = $account->updatePassword( - password: '', + password: 'password', oldPassword: 'password' // optional );``` diff --git a/examples/1.9.x/server-php/examples/account/update-recovery.md b/examples/1.9.x/server-php/examples/account/update-recovery.md index 7b5c1d0b1..23a626e38 100644 --- a/examples/1.9.x/server-php/examples/account/update-recovery.md +++ b/examples/1.9.x/server-php/examples/account/update-recovery.md @@ -14,5 +14,5 @@ $account = new Account($client); $result = $account->updateRecovery( userId: '<USER_ID>', secret: '<SECRET>', - password: '' + password: 'password' );``` diff --git a/examples/1.9.x/server-php/examples/avatars/get-browser.md b/examples/1.9.x/server-php/examples/avatars/get-browser.md index ec2a7599f..1bc216de0 100644 --- a/examples/1.9.x/server-php/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-php/examples/avatars/get-browser.md @@ -8,7 +8,8 @@ use Appwrite\Enums\Browser; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with + ->setSession('') // The user session to authenticate with + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $avatars = new Avatars($client); diff --git a/examples/1.9.x/server-php/examples/avatars/get-credit-card.md b/examples/1.9.x/server-php/examples/avatars/get-credit-card.md index 05ddc2478..875c8f821 100644 --- a/examples/1.9.x/server-php/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-php/examples/avatars/get-credit-card.md @@ -8,7 +8,8 @@ use Appwrite\Enums\CreditCard; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with + ->setSession('') // The user session to authenticate with + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $avatars = new Avatars($client); diff --git a/examples/1.9.x/server-php/examples/avatars/get-favicon.md b/examples/1.9.x/server-php/examples/avatars/get-favicon.md index 424cea84b..1b0f61525 100644 --- a/examples/1.9.x/server-php/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-php/examples/avatars/get-favicon.md @@ -7,7 +7,8 @@ use Appwrite\Services\Avatars; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with + ->setSession('') // The user session to authenticate with + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $avatars = new Avatars($client); diff --git a/examples/1.9.x/server-php/examples/avatars/get-flag.md b/examples/1.9.x/server-php/examples/avatars/get-flag.md index 1a4ef37af..091539662 100644 --- a/examples/1.9.x/server-php/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-php/examples/avatars/get-flag.md @@ -8,7 +8,8 @@ use Appwrite\Enums\Flag; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with + ->setSession('') // The user session to authenticate with + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $avatars = new Avatars($client); diff --git a/examples/1.9.x/server-php/examples/avatars/get-image.md b/examples/1.9.x/server-php/examples/avatars/get-image.md index 4ceb8d380..cc0f5e9b2 100644 --- a/examples/1.9.x/server-php/examples/avatars/get-image.md +++ b/examples/1.9.x/server-php/examples/avatars/get-image.md @@ -7,7 +7,8 @@ use Appwrite\Services\Avatars; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with + ->setSession('') // The user session to authenticate with + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $avatars = new Avatars($client); diff --git a/examples/1.9.x/server-php/examples/avatars/get-initials.md b/examples/1.9.x/server-php/examples/avatars/get-initials.md index 2bd523b51..344cc2d57 100644 --- a/examples/1.9.x/server-php/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-php/examples/avatars/get-initials.md @@ -7,7 +7,8 @@ use Appwrite\Services\Avatars; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with + ->setSession('') // The user session to authenticate with + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $avatars = new Avatars($client); diff --git a/examples/1.9.x/server-php/examples/avatars/get-qr.md b/examples/1.9.x/server-php/examples/avatars/get-qr.md index ad49bf9e6..660ff05b8 100644 --- a/examples/1.9.x/server-php/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-php/examples/avatars/get-qr.md @@ -7,7 +7,8 @@ use Appwrite\Services\Avatars; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with + ->setSession('') // The user session to authenticate with + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $avatars = new Avatars($client); diff --git a/examples/1.9.x/server-php/examples/avatars/get-screenshot.md b/examples/1.9.x/server-php/examples/avatars/get-screenshot.md index d2381633e..68ffec1bc 100644 --- a/examples/1.9.x/server-php/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-php/examples/avatars/get-screenshot.md @@ -11,7 +11,8 @@ use Appwrite\Enums\ImageFormat; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with + ->setSession('') // The user session to authenticate with + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $avatars = new Avatars($client); diff --git a/examples/1.9.x/server-php/examples/functions/create.md b/examples/1.9.x/server-php/examples/functions/create.md index 10c6c32cf..4e8a23d74 100644 --- a/examples/1.9.x/server-php/examples/functions/create.md +++ b/examples/1.9.x/server-php/examples/functions/create.md @@ -3,7 +3,7 @@ use Appwrite\Client; use Appwrite\Services\Functions; -use Appwrite\Enums\FunctionRuntime; +use Appwrite\Enums\Runtime; use Appwrite\Enums\ProjectKeyScopes; $client = (new Client()) @@ -16,7 +16,7 @@ $functions = new Functions($client); $result = $functions->create( functionId: '<FUNCTION_ID>', name: '<NAME>', - runtime: FunctionRuntime::NODE145(), + runtime: Runtime::NODE145(), execute: ["any"], // optional events: [], // optional schedule: '', // optional diff --git a/examples/1.9.x/server-php/examples/functions/get-deployment-download.md b/examples/1.9.x/server-php/examples/functions/get-deployment-download.md index 73842f546..c1667b071 100644 --- a/examples/1.9.x/server-php/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-php/examples/functions/get-deployment-download.md @@ -8,7 +8,8 @@ use Appwrite\Enums\DeploymentDownloadType; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key + ->setKey('<YOUR_API_KEY>') // Your secret API key + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $functions = new Functions($client); diff --git a/examples/1.9.x/server-php/examples/functions/update.md b/examples/1.9.x/server-php/examples/functions/update.md index da68d963e..4eaeb871e 100644 --- a/examples/1.9.x/server-php/examples/functions/update.md +++ b/examples/1.9.x/server-php/examples/functions/update.md @@ -3,7 +3,7 @@ use Appwrite\Client; use Appwrite\Services\Functions; -use Appwrite\Enums\FunctionRuntime; +use Appwrite\Enums\Runtime; use Appwrite\Enums\ProjectKeyScopes; $client = (new Client()) @@ -16,7 +16,7 @@ $functions = new Functions($client); $result = $functions->update( functionId: '<FUNCTION_ID>', name: '<NAME>', - runtime: FunctionRuntime::NODE145(), // optional + runtime: Runtime::NODE145(), // optional execute: ["any"], // optional events: [], // optional schedule: '', // optional diff --git a/examples/1.9.x/server-php/examples/health/get-audits-db.md b/examples/1.9.x/server-php/examples/health/get-audits-db.md new file mode 100644 index 000000000..045c32fd9 --- /dev/null +++ b/examples/1.9.x/server-php/examples/health/get-audits-db.md @@ -0,0 +1,15 @@ +```php +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getAuditsDB(); +``` diff --git a/examples/1.9.x/server-php/examples/messaging/create-ses-provider.md b/examples/1.9.x/server-php/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..a9ec11c01 --- /dev/null +++ b/examples/1.9.x/server-php/examples/messaging/create-ses-provider.md @@ -0,0 +1,25 @@ +```php +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createSesProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + accessKey: '<ACCESS_KEY>', // optional + secretKey: '<SECRET_KEY>', // optional + region: '<REGION>', // optional + fromName: '<FROM_NAME>', // optional + fromEmail: 'email@example.com', // optional + replyToName: '<REPLY_TO_NAME>', // optional + replyToEmail: 'email@example.com', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-php/examples/messaging/create-smtp-provider.md index 053861250..a55fd0fc9 100644 --- a/examples/1.9.x/server-php/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-php/examples/messaging/create-smtp-provider.md @@ -18,7 +18,7 @@ $result = $messaging->createSMTPProvider( host: '<HOST>', port: 1, // optional username: '<USERNAME>', // optional - password: '<PASSWORD>', // optional + password: 'password', // optional encryption: SmtpEncryption::NONE(), // optional autoTLS: false, // optional mailer: '<MAILER>', // optional diff --git a/examples/1.9.x/server-php/examples/messaging/update-ses-provider.md b/examples/1.9.x/server-php/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..ee73b5cf8 --- /dev/null +++ b/examples/1.9.x/server-php/examples/messaging/update-ses-provider.md @@ -0,0 +1,25 @@ +```php +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateSesProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + enabled: false, // optional + accessKey: '<ACCESS_KEY>', // optional + secretKey: '<SECRET_KEY>', // optional + region: '<REGION>', // optional + fromName: '<FROM_NAME>', // optional + fromEmail: 'email@example.com', // optional + replyToName: '<REPLY_TO_NAME>', // optional + replyToEmail: '<REPLY_TO_EMAIL>' // optional +);``` diff --git a/examples/1.9.x/server-php/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-php/examples/messaging/update-smtp-provider.md index 5701b3c25..73b4b3af7 100644 --- a/examples/1.9.x/server-php/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-php/examples/messaging/update-smtp-provider.md @@ -18,7 +18,7 @@ $result = $messaging->updateSMTPProvider( host: '<HOST>', // optional port: 1, // optional username: '<USERNAME>', // optional - password: '<PASSWORD>', // optional + password: 'password', // optional encryption: SmtpEncryption::NONE(), // optional autoTLS: false, // optional mailer: '<MAILER>', // optional diff --git a/examples/1.9.x/server-php/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-php/examples/project/update-membership-privacy-policy.md index a62ace785..c41ce6112 100644 --- a/examples/1.9.x/server-php/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-php/examples/project/update-membership-privacy-policy.md @@ -16,5 +16,6 @@ $result = $project->updateMembershipPrivacyPolicy( userEmail: false, // optional userPhone: false, // optional userName: false, // optional - userMFA: false // optional + userMFA: false, // optional + userAccessedAt: false // optional );``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-server.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..d89743033 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-server.md @@ -0,0 +1,28 @@ +```php +<?php + +use Appwrite\Client; +use Appwrite\Services\Project; + +$client = (new Client()) + ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Server( + enabled: false, + authorizationUrl: 'https://example.com', + scopes: [], // optional + authorizationDetailsTypes: [], // optional + accessTokenDuration: 60, // optional + refreshTokenDuration: 60, // optional + publicAccessTokenDuration: 60, // optional + publicRefreshTokenDuration: 60, // optional + confidentialPkce: false, // optional + verificationUrl: 'https://example.com', // optional + userCodeLength: 6, // optional + userCodeFormat: 'numeric', // optional + deviceCodeDuration: 60 // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-password-strength-policy.md b/examples/1.9.x/server-php/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..9bc29daf0 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-password-strength-policy.md @@ -0,0 +1,20 @@ +```php +<?php + +use Appwrite\Client; +use Appwrite\Services\Project; + +$client = (new Client()) + ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$project = new Project($client); + +$result = $project->updatePasswordStrengthPolicy( + min: 8, // optional + uppercase: false, // optional + lowercase: false, // optional + number: false, // optional + symbols: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-smtp.md b/examples/1.9.x/server-php/examples/project/update-smtp.md index 452a3d863..71a7b8f0b 100644 --- a/examples/1.9.x/server-php/examples/project/update-smtp.md +++ b/examples/1.9.x/server-php/examples/project/update-smtp.md @@ -16,7 +16,7 @@ $result = $project->updateSMTP( host: '', // optional port: null, // optional username: '<USERNAME>', // optional - password: '<PASSWORD>', // optional + password: 'password', // optional senderEmail: 'email@example.com', // optional senderName: '<SENDER_NAME>', // optional replyToEmail: 'email@example.com', // optional diff --git a/examples/1.9.x/server-php/examples/proxy/create-redirect-rule.md b/examples/1.9.x/server-php/examples/proxy/create-redirect-rule.md index 592eb1c80..1c2bbc187 100644 --- a/examples/1.9.x/server-php/examples/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-php/examples/proxy/create-redirect-rule.md @@ -3,7 +3,7 @@ use Appwrite\Client; use Appwrite\Services\Proxy; -use Appwrite\Enums\RedirectStatusCode; +use Appwrite\Enums\StatusCode; use Appwrite\Enums\ProxyResourceType; $client = (new Client()) @@ -16,7 +16,7 @@ $proxy = new Proxy($client); $result = $proxy->createRedirectRule( domain: '', url: 'https://example.com', - statusCode: RedirectStatusCode::MOVEDPERMANENTLY(), + statusCode: StatusCode::MOVEDPERMANENTLY(), resourceId: '<RESOURCE_ID>', resourceType: ProxyResourceType::SITE() );``` diff --git a/examples/1.9.x/server-php/examples/sites/create.md b/examples/1.9.x/server-php/examples/sites/create.md index 8dca15fa5..eab5f21c7 100644 --- a/examples/1.9.x/server-php/examples/sites/create.md +++ b/examples/1.9.x/server-php/examples/sites/create.md @@ -3,9 +3,9 @@ use Appwrite\Client; use Appwrite\Services\Sites; -use Appwrite\Enums\SiteFramework; -use Appwrite\Enums\SiteBuildRuntime; -use Appwrite\Enums\SiteAdapter; +use Appwrite\Enums\Framework; +use Appwrite\Enums\BuildRuntime; +use Appwrite\Enums\Adapter; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint @@ -17,8 +17,8 @@ $sites = new Sites($client); $result = $sites->create( siteId: '<SITE_ID>', name: '<NAME>', - framework: SiteFramework::ANALOG(), - buildRuntime: SiteBuildRuntime::NODE145(), + framework: Framework::ANALOG(), + buildRuntime: BuildRuntime::NODE145(), enabled: false, // optional logging: false, // optional timeout: 1, // optional @@ -26,7 +26,7 @@ $result = $sites->create( buildCommand: '<BUILD_COMMAND>', // optional startCommand: '<START_COMMAND>', // optional outputDirectory: '<OUTPUT_DIRECTORY>', // optional - adapter: SiteAdapter::STATIC(), // optional + adapter: Adapter::STATIC(), // optional installationId: '<INSTALLATION_ID>', // optional fallbackFile: '<FALLBACK_FILE>', // optional providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional diff --git a/examples/1.9.x/server-php/examples/sites/get-deployment-download.md b/examples/1.9.x/server-php/examples/sites/get-deployment-download.md index 5582e9642..0a117b73e 100644 --- a/examples/1.9.x/server-php/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-php/examples/sites/get-deployment-download.md @@ -8,7 +8,8 @@ use Appwrite\Enums\DeploymentDownloadType; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key + ->setKey('<YOUR_API_KEY>') // Your secret API key + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $sites = new Sites($client); diff --git a/examples/1.9.x/server-php/examples/sites/update.md b/examples/1.9.x/server-php/examples/sites/update.md index d8dbdfeaa..907e0c6c7 100644 --- a/examples/1.9.x/server-php/examples/sites/update.md +++ b/examples/1.9.x/server-php/examples/sites/update.md @@ -3,9 +3,9 @@ use Appwrite\Client; use Appwrite\Services\Sites; -use Appwrite\Enums\SiteFramework; -use Appwrite\Enums\SiteBuildRuntime; -use Appwrite\Enums\SiteAdapter; +use Appwrite\Enums\Framework; +use Appwrite\Enums\BuildRuntime; +use Appwrite\Enums\Adapter; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint @@ -17,7 +17,7 @@ $sites = new Sites($client); $result = $sites->update( siteId: '<SITE_ID>', name: '<NAME>', - framework: SiteFramework::ANALOG(), + framework: Framework::ANALOG(), enabled: false, // optional logging: false, // optional timeout: 1, // optional @@ -25,8 +25,8 @@ $result = $sites->update( buildCommand: '<BUILD_COMMAND>', // optional startCommand: '<START_COMMAND>', // optional outputDirectory: '<OUTPUT_DIRECTORY>', // optional - buildRuntime: SiteBuildRuntime::NODE145(), // optional - adapter: SiteAdapter::STATIC(), // optional + buildRuntime: BuildRuntime::NODE145(), // optional + adapter: Adapter::STATIC(), // optional fallbackFile: '<FALLBACK_FILE>', // optional installationId: '<INSTALLATION_ID>', // optional providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional diff --git a/examples/1.9.x/server-php/examples/storage/get-file-download.md b/examples/1.9.x/server-php/examples/storage/get-file-download.md index f55376f05..4e4c2f0a0 100644 --- a/examples/1.9.x/server-php/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-php/examples/storage/get-file-download.md @@ -7,7 +7,8 @@ use Appwrite\Services\Storage; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with + ->setSession('') // The user session to authenticate with + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $storage = new Storage($client); diff --git a/examples/1.9.x/server-php/examples/storage/get-file-preview.md b/examples/1.9.x/server-php/examples/storage/get-file-preview.md index 8964011b8..93d829d2e 100644 --- a/examples/1.9.x/server-php/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-php/examples/storage/get-file-preview.md @@ -9,7 +9,8 @@ use Appwrite\Enums\ImageFormat; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with + ->setSession('') // The user session to authenticate with + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $storage = new Storage($client); diff --git a/examples/1.9.x/server-php/examples/storage/get-file-view.md b/examples/1.9.x/server-php/examples/storage/get-file-view.md index 6a729dc89..7ca08b4e3 100644 --- a/examples/1.9.x/server-php/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-php/examples/storage/get-file-view.md @@ -7,7 +7,8 @@ use Appwrite\Services\Storage; $client = (new Client()) ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with + ->setSession('') // The user session to authenticate with + ->setImpersonateUserId(''); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. $storage = new Storage($client); diff --git a/examples/1.9.x/server-php/examples/users/create.md b/examples/1.9.x/server-php/examples/users/create.md index ec9b6839f..a2feb7c3b 100644 --- a/examples/1.9.x/server-php/examples/users/create.md +++ b/examples/1.9.x/server-php/examples/users/create.md @@ -15,6 +15,6 @@ $result = $users->create( userId: '<USER_ID>', email: 'email@example.com', // optional phone: '+12065550100', // optional - password: '', // optional + password: 'password', // optional name: '<NAME>' // optional );``` diff --git a/examples/1.9.x/server-php/examples/users/update-password.md b/examples/1.9.x/server-php/examples/users/update-password.md index 69d93300c..d8f2ed1c5 100644 --- a/examples/1.9.x/server-php/examples/users/update-password.md +++ b/examples/1.9.x/server-php/examples/users/update-password.md @@ -13,5 +13,5 @@ $users = new Users($client); $result = $users->updatePassword( userId: '<USER_ID>', - password: '' + password: 'password' );``` diff --git a/examples/1.9.x/server-php/examples/webhooks/create.md b/examples/1.9.x/server-php/examples/webhooks/create.md index 4e0175063..dd8eb1cd0 100644 --- a/examples/1.9.x/server-php/examples/webhooks/create.md +++ b/examples/1.9.x/server-php/examples/webhooks/create.md @@ -19,6 +19,6 @@ $result = $webhooks->create( enabled: false, // optional tls: false, // optional authUsername: '<AUTH_USERNAME>', // optional - authPassword: '<AUTH_PASSWORD>', // optional + authPassword: 'password', // optional secret: '<SECRET>' // optional );``` diff --git a/examples/1.9.x/server-php/examples/webhooks/update.md b/examples/1.9.x/server-php/examples/webhooks/update.md index 8b71a93f6..c6bf00b27 100644 --- a/examples/1.9.x/server-php/examples/webhooks/update.md +++ b/examples/1.9.x/server-php/examples/webhooks/update.md @@ -19,5 +19,5 @@ $result = $webhooks->update( enabled: false, // optional tls: false, // optional authUsername: '<AUTH_USERNAME>', // optional - authPassword: '<AUTH_PASSWORD>' // optional + authPassword: 'password' // optional );``` diff --git a/examples/1.9.x/server-python/examples/account/create.md b/examples/1.9.x/server-python/examples/account/create.md index 87c8fabaf..503b37016 100644 --- a/examples/1.9.x/server-python/examples/account/create.md +++ b/examples/1.9.x/server-python/examples/account/create.md @@ -13,7 +13,7 @@ account = Account(client) result: User = account.create( user_id = '<USER_ID>', email = 'email@example.com', - password = '', + password = 'password', name = '<NAME>' # optional ) diff --git a/examples/1.9.x/server-python/examples/account/update-password.md b/examples/1.9.x/server-python/examples/account/update-password.md index dc504e2c3..2c6db58bc 100644 --- a/examples/1.9.x/server-python/examples/account/update-password.md +++ b/examples/1.9.x/server-python/examples/account/update-password.md @@ -11,7 +11,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) result: User = account.update_password( - password = '', + password = 'password', old_password = 'password' # optional ) diff --git a/examples/1.9.x/server-python/examples/account/update-recovery.md b/examples/1.9.x/server-python/examples/account/update-recovery.md index 90ed3096c..3201722e7 100644 --- a/examples/1.9.x/server-python/examples/account/update-recovery.md +++ b/examples/1.9.x/server-python/examples/account/update-recovery.md @@ -13,7 +13,7 @@ account = Account(client) result: Token = account.update_recovery( user_id = '<USER_ID>', secret = '<SECRET>', - password = '' + password = 'password' ) print(result.model_dump()) diff --git a/examples/1.9.x/server-python/examples/avatars/get-browser.md b/examples/1.9.x/server-python/examples/avatars/get-browser.md index 3c950dbb8..78ecba94d 100644 --- a/examples/1.9.x/server-python/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-python/examples/avatars/get-browser.md @@ -7,6 +7,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_session('') # The user session to authenticate with +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars(client) diff --git a/examples/1.9.x/server-python/examples/avatars/get-credit-card.md b/examples/1.9.x/server-python/examples/avatars/get-credit-card.md index 8ef04f635..71846467f 100644 --- a/examples/1.9.x/server-python/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-python/examples/avatars/get-credit-card.md @@ -7,6 +7,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_session('') # The user session to authenticate with +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars(client) diff --git a/examples/1.9.x/server-python/examples/avatars/get-favicon.md b/examples/1.9.x/server-python/examples/avatars/get-favicon.md index dd234eafc..8c0dfeb77 100644 --- a/examples/1.9.x/server-python/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-python/examples/avatars/get-favicon.md @@ -6,6 +6,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_session('') # The user session to authenticate with +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars(client) diff --git a/examples/1.9.x/server-python/examples/avatars/get-flag.md b/examples/1.9.x/server-python/examples/avatars/get-flag.md index f97b20dd8..307349fb4 100644 --- a/examples/1.9.x/server-python/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-python/examples/avatars/get-flag.md @@ -7,6 +7,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_session('') # The user session to authenticate with +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars(client) diff --git a/examples/1.9.x/server-python/examples/avatars/get-image.md b/examples/1.9.x/server-python/examples/avatars/get-image.md index 9beea030e..a0b8587be 100644 --- a/examples/1.9.x/server-python/examples/avatars/get-image.md +++ b/examples/1.9.x/server-python/examples/avatars/get-image.md @@ -6,6 +6,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_session('') # The user session to authenticate with +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars(client) diff --git a/examples/1.9.x/server-python/examples/avatars/get-initials.md b/examples/1.9.x/server-python/examples/avatars/get-initials.md index 30a39a8ec..31061a81e 100644 --- a/examples/1.9.x/server-python/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-python/examples/avatars/get-initials.md @@ -6,6 +6,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_session('') # The user session to authenticate with +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars(client) diff --git a/examples/1.9.x/server-python/examples/avatars/get-qr.md b/examples/1.9.x/server-python/examples/avatars/get-qr.md index a7968e75c..99ae1c57f 100644 --- a/examples/1.9.x/server-python/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-python/examples/avatars/get-qr.md @@ -6,6 +6,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_session('') # The user session to authenticate with +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars(client) diff --git a/examples/1.9.x/server-python/examples/avatars/get-screenshot.md b/examples/1.9.x/server-python/examples/avatars/get-screenshot.md index cf7f9a6b4..b3a4cf510 100644 --- a/examples/1.9.x/server-python/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-python/examples/avatars/get-screenshot.md @@ -10,6 +10,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_session('') # The user session to authenticate with +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars(client) diff --git a/examples/1.9.x/server-python/examples/functions/create.md b/examples/1.9.x/server-python/examples/functions/create.md index af1436f77..1c6c3854d 100644 --- a/examples/1.9.x/server-python/examples/functions/create.md +++ b/examples/1.9.x/server-python/examples/functions/create.md @@ -2,7 +2,7 @@ from appwrite.client import Client from appwrite.services.functions import Functions from appwrite.models import Function -from appwrite.enums import FunctionRuntime +from appwrite.enums import Runtime from appwrite.enums import ProjectKeyScopes client = Client() @@ -15,7 +15,7 @@ functions = Functions(client) result: Function = functions.create( function_id = '<FUNCTION_ID>', name = '<NAME>', - runtime = FunctionRuntime.NODE_14_5, + runtime = Runtime.NODE_14_5, execute = ["any"], # optional events = [], # optional schedule = '', # optional diff --git a/examples/1.9.x/server-python/examples/functions/get-deployment-download.md b/examples/1.9.x/server-python/examples/functions/get-deployment-download.md index 7f6b2f6ba..3579d0930 100644 --- a/examples/1.9.x/server-python/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-python/examples/functions/get-deployment-download.md @@ -7,6 +7,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_key('<YOUR_API_KEY>') # Your secret API key +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. functions = Functions(client) diff --git a/examples/1.9.x/server-python/examples/functions/update.md b/examples/1.9.x/server-python/examples/functions/update.md index ce592d769..c7b1393a7 100644 --- a/examples/1.9.x/server-python/examples/functions/update.md +++ b/examples/1.9.x/server-python/examples/functions/update.md @@ -2,7 +2,7 @@ from appwrite.client import Client from appwrite.services.functions import Functions from appwrite.models import Function -from appwrite.enums import FunctionRuntime +from appwrite.enums import Runtime from appwrite.enums import ProjectKeyScopes client = Client() @@ -15,7 +15,7 @@ functions = Functions(client) result: Function = functions.update( function_id = '<FUNCTION_ID>', name = '<NAME>', - runtime = FunctionRuntime.NODE_14_5, # optional + runtime = Runtime.NODE_14_5, # optional execute = ["any"], # optional events = [], # optional schedule = '', # optional diff --git a/examples/1.9.x/server-python/examples/health/get-audits-db.md b/examples/1.9.x/server-python/examples/health/get-audits-db.md new file mode 100644 index 000000000..774edec1e --- /dev/null +++ b/examples/1.9.x/server-python/examples/health/get-audits-db.md @@ -0,0 +1,16 @@ +```python +from appwrite.client import Client +from appwrite.services.health import Health +from appwrite.models import HealthStatusList + +client = Client() +client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result: HealthStatusList = health.get_audits_db() + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/messaging/create-ses-provider.md b/examples/1.9.x/server-python/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..369ffc71e --- /dev/null +++ b/examples/1.9.x/server-python/examples/messaging/create-ses-provider.md @@ -0,0 +1,27 @@ +```python +from appwrite.client import Client +from appwrite.services.messaging import Messaging +from appwrite.models import Provider + +client = Client() +client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result: Provider = messaging.create_ses_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + access_key = '<ACCESS_KEY>', # optional + secret_key = '<SECRET_KEY>', # optional + region = '<REGION>', # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = 'email@example.com', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-python/examples/messaging/create-smtp-provider.md index 55e5b6eaf..fd5995f26 100644 --- a/examples/1.9.x/server-python/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-python/examples/messaging/create-smtp-provider.md @@ -17,7 +17,7 @@ result: Provider = messaging.create_smtp_provider( host = '<HOST>', port = 1, # optional username = '<USERNAME>', # optional - password = '<PASSWORD>', # optional + password = 'password', # optional encryption = SmtpEncryption.NONE, # optional auto_tls = False, # optional mailer = '<MAILER>', # optional diff --git a/examples/1.9.x/server-python/examples/messaging/update-ses-provider.md b/examples/1.9.x/server-python/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..ab77e2eb7 --- /dev/null +++ b/examples/1.9.x/server-python/examples/messaging/update-ses-provider.md @@ -0,0 +1,27 @@ +```python +from appwrite.client import Client +from appwrite.services.messaging import Messaging +from appwrite.models import Provider + +client = Client() +client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result: Provider = messaging.update_ses_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + access_key = '<ACCESS_KEY>', # optional + secret_key = '<SECRET_KEY>', # optional + region = '<REGION>', # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = '<REPLY_TO_EMAIL>' # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-python/examples/messaging/update-smtp-provider.md index b47125009..23294e88b 100644 --- a/examples/1.9.x/server-python/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-python/examples/messaging/update-smtp-provider.md @@ -17,7 +17,7 @@ result: Provider = messaging.update_smtp_provider( host = '<HOST>', # optional port = 1, # optional username = '<USERNAME>', # optional - password = '<PASSWORD>', # optional + password = 'password', # optional encryption = SmtpEncryption.NONE, # optional auto_tls = False, # optional mailer = '<MAILER>', # optional diff --git a/examples/1.9.x/server-python/examples/project/get-policy.md b/examples/1.9.x/server-python/examples/project/get-policy.md index e05516f89..a26145e1a 100644 --- a/examples/1.9.x/server-python/examples/project/get-policy.md +++ b/examples/1.9.x/server-python/examples/project/get-policy.md @@ -3,6 +3,7 @@ from appwrite.client import Client from appwrite.services.project import Project from appwrite.models import PolicyPasswordDictionary from appwrite.models import PolicyPasswordHistory +from appwrite.models import PolicyPasswordStrength from appwrite.models import PolicyPasswordPersonalData from appwrite.models import PolicySessionAlert from appwrite.models import PolicySessionDuration @@ -10,6 +11,9 @@ from appwrite.models import PolicySessionInvalidation from appwrite.models import PolicySessionLimit from appwrite.models import PolicyUserLimit from appwrite.models import PolicyMembershipPrivacy +from appwrite.models import PolicyDenyAliasedEmail +from appwrite.models import PolicyDenyDisposableEmail +from appwrite.models import PolicyDenyFreeEmail from typing import Union from appwrite.enums import ProjectPolicyId @@ -20,7 +24,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key project = Project(client) -result: Union[PolicyPasswordDictionary, PolicyPasswordHistory, PolicyPasswordPersonalData, PolicySessionAlert, PolicySessionDuration, PolicySessionInvalidation, PolicySessionLimit, PolicyUserLimit, PolicyMembershipPrivacy] = project.get_policy( +result: Union[PolicyPasswordDictionary, PolicyPasswordHistory, PolicyPasswordStrength, PolicyPasswordPersonalData, PolicySessionAlert, PolicySessionDuration, PolicySessionInvalidation, PolicySessionLimit, PolicyUserLimit, PolicyMembershipPrivacy, PolicyDenyAliasedEmail, PolicyDenyDisposableEmail, PolicyDenyFreeEmail] = project.get_policy( policy_id = ProjectPolicyId.PASSWORD_DICTIONARY ) diff --git a/examples/1.9.x/server-python/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-python/examples/project/update-membership-privacy-policy.md index 733699b14..f6878ee47 100644 --- a/examples/1.9.x/server-python/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-python/examples/project/update-membership-privacy-policy.md @@ -15,7 +15,8 @@ result: ProjectModel = project.update_membership_privacy_policy( user_email = False, # optional user_phone = False, # optional user_name = False, # optional - user_mfa = False # optional + user_mfa = False, # optional + user_accessed_at = False # optional ) print(result.model_dump()) diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-server.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..6c5b25787 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-server.md @@ -0,0 +1,30 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import Project as ProjectModel + +client = Client() +client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +project = Project(client) + +result: ProjectModel = project.update_o_auth2_server( + enabled = False, + authorization_url = 'https://example.com', + scopes = [], # optional + authorization_details_types = [], # optional + access_token_duration = 60, # optional + refresh_token_duration = 60, # optional + public_access_token_duration = 60, # optional + public_refresh_token_duration = 60, # optional + confidential_pkce = False, # optional + verification_url = 'https://example.com', # optional + user_code_length = 6, # optional + user_code_format = 'numeric', # optional + device_code_duration = 60 # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-password-strength-policy.md b/examples/1.9.x/server-python/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..c87aeaf3f --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-password-strength-policy.md @@ -0,0 +1,22 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import PolicyPasswordStrength + +client = Client() +client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +project = Project(client) + +result: PolicyPasswordStrength = project.update_password_strength_policy( + min = 8, # optional + uppercase = False, # optional + lowercase = False, # optional + number = False, # optional + symbols = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-smtp.md b/examples/1.9.x/server-python/examples/project/update-smtp.md index 66428e019..b5f7847b0 100644 --- a/examples/1.9.x/server-python/examples/project/update-smtp.md +++ b/examples/1.9.x/server-python/examples/project/update-smtp.md @@ -15,7 +15,7 @@ result: ProjectModel = project.update_smtp( host = '', # optional port = None, # optional username = '<USERNAME>', # optional - password = '<PASSWORD>', # optional + password = 'password', # optional sender_email = 'email@example.com', # optional sender_name = '<SENDER_NAME>', # optional reply_to_email = 'email@example.com', # optional diff --git a/examples/1.9.x/server-python/examples/proxy/create-redirect-rule.md b/examples/1.9.x/server-python/examples/proxy/create-redirect-rule.md index bf93d0403..6014fbeda 100644 --- a/examples/1.9.x/server-python/examples/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-python/examples/proxy/create-redirect-rule.md @@ -2,7 +2,7 @@ from appwrite.client import Client from appwrite.services.proxy import Proxy from appwrite.models import ProxyRule -from appwrite.enums import RedirectStatusCode +from appwrite.enums import StatusCode from appwrite.enums import ProxyResourceType client = Client() @@ -15,7 +15,7 @@ proxy = Proxy(client) result: ProxyRule = proxy.create_redirect_rule( domain = '', url = 'https://example.com', - status_code = RedirectStatusCode.MOVEDPERMANENTLY, + status_code = StatusCode.MOVEDPERMANENTLY, resource_id = '<RESOURCE_ID>', resource_type = ProxyResourceType.SITE ) diff --git a/examples/1.9.x/server-python/examples/sites/create.md b/examples/1.9.x/server-python/examples/sites/create.md index a87f0703f..684cd0546 100644 --- a/examples/1.9.x/server-python/examples/sites/create.md +++ b/examples/1.9.x/server-python/examples/sites/create.md @@ -2,9 +2,9 @@ from appwrite.client import Client from appwrite.services.sites import Sites from appwrite.models import Site -from appwrite.enums import SiteFramework -from appwrite.enums import SiteBuildRuntime -from appwrite.enums import SiteAdapter +from appwrite.enums import Framework +from appwrite.enums import BuildRuntime +from appwrite.enums import Adapter client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -16,8 +16,8 @@ sites = Sites(client) result: Site = sites.create( site_id = '<SITE_ID>', name = '<NAME>', - framework = SiteFramework.ANALOG, - build_runtime = SiteBuildRuntime.NODE_14_5, + framework = Framework.ANALOG, + build_runtime = BuildRuntime.NODE_14_5, enabled = False, # optional logging = False, # optional timeout = 1, # optional @@ -25,7 +25,7 @@ result: Site = sites.create( build_command = '<BUILD_COMMAND>', # optional start_command = '<START_COMMAND>', # optional output_directory = '<OUTPUT_DIRECTORY>', # optional - adapter = SiteAdapter.STATIC, # optional + adapter = Adapter.STATIC, # optional installation_id = '<INSTALLATION_ID>', # optional fallback_file = '<FALLBACK_FILE>', # optional provider_repository_id = '<PROVIDER_REPOSITORY_ID>', # optional diff --git a/examples/1.9.x/server-python/examples/sites/get-deployment-download.md b/examples/1.9.x/server-python/examples/sites/get-deployment-download.md index eae2543c4..174cf760c 100644 --- a/examples/1.9.x/server-python/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-python/examples/sites/get-deployment-download.md @@ -7,6 +7,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_key('<YOUR_API_KEY>') # Your secret API key +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. sites = Sites(client) diff --git a/examples/1.9.x/server-python/examples/sites/update.md b/examples/1.9.x/server-python/examples/sites/update.md index 595cd7448..2c917b9fd 100644 --- a/examples/1.9.x/server-python/examples/sites/update.md +++ b/examples/1.9.x/server-python/examples/sites/update.md @@ -2,9 +2,9 @@ from appwrite.client import Client from appwrite.services.sites import Sites from appwrite.models import Site -from appwrite.enums import SiteFramework -from appwrite.enums import SiteBuildRuntime -from appwrite.enums import SiteAdapter +from appwrite.enums import Framework +from appwrite.enums import BuildRuntime +from appwrite.enums import Adapter client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -16,7 +16,7 @@ sites = Sites(client) result: Site = sites.update( site_id = '<SITE_ID>', name = '<NAME>', - framework = SiteFramework.ANALOG, + framework = Framework.ANALOG, enabled = False, # optional logging = False, # optional timeout = 1, # optional @@ -24,8 +24,8 @@ result: Site = sites.update( build_command = '<BUILD_COMMAND>', # optional start_command = '<START_COMMAND>', # optional output_directory = '<OUTPUT_DIRECTORY>', # optional - build_runtime = SiteBuildRuntime.NODE_14_5, # optional - adapter = SiteAdapter.STATIC, # optional + build_runtime = BuildRuntime.NODE_14_5, # optional + adapter = Adapter.STATIC, # optional fallback_file = '<FALLBACK_FILE>', # optional installation_id = '<INSTALLATION_ID>', # optional provider_repository_id = '<PROVIDER_REPOSITORY_ID>', # optional diff --git a/examples/1.9.x/server-python/examples/storage/get-file-download.md b/examples/1.9.x/server-python/examples/storage/get-file-download.md index ac6f9424d..275afb974 100644 --- a/examples/1.9.x/server-python/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-python/examples/storage/get-file-download.md @@ -6,6 +6,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_session('') # The user session to authenticate with +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. storage = Storage(client) diff --git a/examples/1.9.x/server-python/examples/storage/get-file-preview.md b/examples/1.9.x/server-python/examples/storage/get-file-preview.md index 4cbc4a586..c082fd040 100644 --- a/examples/1.9.x/server-python/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-python/examples/storage/get-file-preview.md @@ -8,6 +8,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_session('') # The user session to authenticate with +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. storage = Storage(client) diff --git a/examples/1.9.x/server-python/examples/storage/get-file-view.md b/examples/1.9.x/server-python/examples/storage/get-file-view.md index 5cceef6ff..4971f0c42 100644 --- a/examples/1.9.x/server-python/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-python/examples/storage/get-file-view.md @@ -6,6 +6,7 @@ client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint client.set_project('<YOUR_PROJECT_ID>') # Your project ID client.set_session('') # The user session to authenticate with +client.set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. storage = Storage(client) diff --git a/examples/1.9.x/server-python/examples/users/create.md b/examples/1.9.x/server-python/examples/users/create.md index 38361cbf5..0a7a7eeeb 100644 --- a/examples/1.9.x/server-python/examples/users/create.md +++ b/examples/1.9.x/server-python/examples/users/create.md @@ -14,7 +14,7 @@ result: User = users.create( user_id = '<USER_ID>', email = 'email@example.com', # optional phone = '+12065550100', # optional - password = '', # optional + password = 'password', # optional name = '<NAME>' # optional ) diff --git a/examples/1.9.x/server-python/examples/users/update-password.md b/examples/1.9.x/server-python/examples/users/update-password.md index 2a0c93236..d0238ec38 100644 --- a/examples/1.9.x/server-python/examples/users/update-password.md +++ b/examples/1.9.x/server-python/examples/users/update-password.md @@ -12,7 +12,7 @@ users = Users(client) result: User = users.update_password( user_id = '<USER_ID>', - password = '' + password = 'password' ) print(result.model_dump()) diff --git a/examples/1.9.x/server-python/examples/webhooks/create.md b/examples/1.9.x/server-python/examples/webhooks/create.md index d02922219..53d45317e 100644 --- a/examples/1.9.x/server-python/examples/webhooks/create.md +++ b/examples/1.9.x/server-python/examples/webhooks/create.md @@ -18,7 +18,7 @@ result: Webhook = webhooks.create( enabled = False, # optional tls = False, # optional auth_username = '<AUTH_USERNAME>', # optional - auth_password = '<AUTH_PASSWORD>', # optional + auth_password = 'password', # optional secret = '<SECRET>' # optional ) diff --git a/examples/1.9.x/server-python/examples/webhooks/update.md b/examples/1.9.x/server-python/examples/webhooks/update.md index 626d793cd..b399d55c3 100644 --- a/examples/1.9.x/server-python/examples/webhooks/update.md +++ b/examples/1.9.x/server-python/examples/webhooks/update.md @@ -18,7 +18,7 @@ result: Webhook = webhooks.update( enabled = False, # optional tls = False, # optional auth_username = '<AUTH_USERNAME>', # optional - auth_password = '<AUTH_PASSWORD>' # optional + auth_password = 'password' # optional ) print(result.model_dump()) diff --git a/examples/1.9.x/server-rest/examples/account/create-anonymous-session.md b/examples/1.9.x/server-rest/examples/account/create-anonymous-session.md index 4d9374b1f..86cfd4eb1 100644 --- a/examples/1.9.x/server-rest/examples/account/create-anonymous-session.md +++ b/examples/1.9.x/server-rest/examples/account/create-anonymous-session.md @@ -2,9 +2,9 @@ POST /v1/account/sessions/anonymous HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/create-email-password-session.md b/examples/1.9.x/server-rest/examples/account/create-email-password-session.md index 95c87871d..d37a82554 100644 --- a/examples/1.9.x/server-rest/examples/account/create-email-password-session.md +++ b/examples/1.9.x/server-rest/examples/account/create-email-password-session.md @@ -2,10 +2,14 @@ POST /v1/account/sessions/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "email": "email@example.com", + "password": "password" +} { "email": "email@example.com", diff --git a/examples/1.9.x/server-rest/examples/account/create-email-token.md b/examples/1.9.x/server-rest/examples/account/create-email-token.md index 8f2763ae6..f09aa38be 100644 --- a/examples/1.9.x/server-rest/examples/account/create-email-token.md +++ b/examples/1.9.x/server-rest/examples/account/create-email-token.md @@ -2,10 +2,15 @@ POST /v1/account/tokens/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "phrase": false +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/account/create-email-verification.md b/examples/1.9.x/server-rest/examples/account/create-email-verification.md index f11c9256d..70f169608 100644 --- a/examples/1.9.x/server-rest/examples/account/create-email-verification.md +++ b/examples/1.9.x/server-rest/examples/account/create-email-verification.md @@ -2,10 +2,13 @@ POST /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "url": "https://example.com" +} { "url": "https://example.com" diff --git a/examples/1.9.x/server-rest/examples/account/create-jwt.md b/examples/1.9.x/server-rest/examples/account/create-jwt.md index 80b7cbb11..4fb1f39f4 100644 --- a/examples/1.9.x/server-rest/examples/account/create-jwt.md +++ b/examples/1.9.x/server-rest/examples/account/create-jwt.md @@ -2,10 +2,13 @@ POST /v1/account/jwts HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "duration": 0 +} { "duration": 0 diff --git a/examples/1.9.x/server-rest/examples/account/create-magic-url-token.md b/examples/1.9.x/server-rest/examples/account/create-magic-url-token.md index caadbb17e..162eadcc4 100644 --- a/examples/1.9.x/server-rest/examples/account/create-magic-url-token.md +++ b/examples/1.9.x/server-rest/examples/account/create-magic-url-token.md @@ -2,10 +2,16 @@ POST /v1/account/tokens/magic-url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "url": "https://example.com", + "phrase": false +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/account/create-mfa-authenticator.md b/examples/1.9.x/server-rest/examples/account/create-mfa-authenticator.md index 549895b69..6985e4dd7 100644 --- a/examples/1.9.x/server-rest/examples/account/create-mfa-authenticator.md +++ b/examples/1.9.x/server-rest/examples/account/create-mfa-authenticator.md @@ -2,9 +2,9 @@ POST /v1/account/mfa/authenticators/{type} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/create-mfa-challenge.md b/examples/1.9.x/server-rest/examples/account/create-mfa-challenge.md index a4d644866..74d99f626 100644 --- a/examples/1.9.x/server-rest/examples/account/create-mfa-challenge.md +++ b/examples/1.9.x/server-rest/examples/account/create-mfa-challenge.md @@ -2,10 +2,13 @@ POST /v1/account/mfa/challenges HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "factor": "email" +} { "factor": "email" diff --git a/examples/1.9.x/server-rest/examples/account/create-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/account/create-mfa-recovery-codes.md index 59ada759c..fdc7d3375 100644 --- a/examples/1.9.x/server-rest/examples/account/create-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/account/create-mfa-recovery-codes.md @@ -2,9 +2,9 @@ POST /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/create-o-auth-2-token.md b/examples/1.9.x/server-rest/examples/account/create-o-auth-2-token.md index 660264560..931a965f1 100644 --- a/examples/1.9.x/server-rest/examples/account/create-o-auth-2-token.md +++ b/examples/1.9.x/server-rest/examples/account/create-o-auth-2-token.md @@ -1,8 +1,7 @@ ```http GET /v1/account/tokens/oauth2/{provider} HTTP/1.1 Host: cloud.appwrite.io +Accept: text/html X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/account/create-phone-token.md b/examples/1.9.x/server-rest/examples/account/create-phone-token.md index a5c677b33..2c78cef88 100644 --- a/examples/1.9.x/server-rest/examples/account/create-phone-token.md +++ b/examples/1.9.x/server-rest/examples/account/create-phone-token.md @@ -2,10 +2,14 @@ POST /v1/account/tokens/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "phone": "+12065550100" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/account/create-phone-verification.md b/examples/1.9.x/server-rest/examples/account/create-phone-verification.md index 3e37fdde1..144fbe7a3 100644 --- a/examples/1.9.x/server-rest/examples/account/create-phone-verification.md +++ b/examples/1.9.x/server-rest/examples/account/create-phone-verification.md @@ -2,9 +2,9 @@ POST /v1/account/verifications/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/create-recovery.md b/examples/1.9.x/server-rest/examples/account/create-recovery.md index 7b3512ae9..ff610b1f8 100644 --- a/examples/1.9.x/server-rest/examples/account/create-recovery.md +++ b/examples/1.9.x/server-rest/examples/account/create-recovery.md @@ -2,10 +2,14 @@ POST /v1/account/recovery HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "email": "email@example.com", + "url": "https://example.com" +} { "email": "email@example.com", diff --git a/examples/1.9.x/server-rest/examples/account/create-session.md b/examples/1.9.x/server-rest/examples/account/create-session.md index 13aef6b2a..5f3cecc67 100644 --- a/examples/1.9.x/server-rest/examples/account/create-session.md +++ b/examples/1.9.x/server-rest/examples/account/create-session.md @@ -2,10 +2,14 @@ POST /v1/account/sessions/token HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/account/create-verification.md b/examples/1.9.x/server-rest/examples/account/create-verification.md index f11c9256d..70f169608 100644 --- a/examples/1.9.x/server-rest/examples/account/create-verification.md +++ b/examples/1.9.x/server-rest/examples/account/create-verification.md @@ -2,10 +2,13 @@ POST /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "url": "https://example.com" +} { "url": "https://example.com" diff --git a/examples/1.9.x/server-rest/examples/account/create.md b/examples/1.9.x/server-rest/examples/account/create.md index 1f845f01a..78a8adfcc 100644 --- a/examples/1.9.x/server-rest/examples/account/create.md +++ b/examples/1.9.x/server-rest/examples/account/create.md @@ -2,15 +2,21 @@ POST /v1/account HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> { "userId": "<USER_ID>", "email": "email@example.com", - "password": "", + "password": "password", + "name": "<NAME>" +} + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", "name": "<NAME>" } ``` diff --git a/examples/1.9.x/server-rest/examples/account/delete-identity.md b/examples/1.9.x/server-rest/examples/account/delete-identity.md index c510090af..9833b6143 100644 --- a/examples/1.9.x/server-rest/examples/account/delete-identity.md +++ b/examples/1.9.x/server-rest/examples/account/delete-identity.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/account/delete-mfa-authenticator.md b/examples/1.9.x/server-rest/examples/account/delete-mfa-authenticator.md index 8da06fb10..2d5dac3e3 100644 --- a/examples/1.9.x/server-rest/examples/account/delete-mfa-authenticator.md +++ b/examples/1.9.x/server-rest/examples/account/delete-mfa-authenticator.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/account/delete-session.md b/examples/1.9.x/server-rest/examples/account/delete-session.md index 7044fb19e..13f4ac7a0 100644 --- a/examples/1.9.x/server-rest/examples/account/delete-session.md +++ b/examples/1.9.x/server-rest/examples/account/delete-session.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/account/delete-sessions.md b/examples/1.9.x/server-rest/examples/account/delete-sessions.md index 511f8d151..1bf29ad2e 100644 --- a/examples/1.9.x/server-rest/examples/account/delete-sessions.md +++ b/examples/1.9.x/server-rest/examples/account/delete-sessions.md @@ -4,7 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/account/get-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/account/get-mfa-recovery-codes.md index a0a902f9a..232d81807 100644 --- a/examples/1.9.x/server-rest/examples/account/get-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/account/get-mfa-recovery-codes.md @@ -1,8 +1,8 @@ ```http GET /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/get-prefs.md b/examples/1.9.x/server-rest/examples/account/get-prefs.md index 99b97bcf5..229107e49 100644 --- a/examples/1.9.x/server-rest/examples/account/get-prefs.md +++ b/examples/1.9.x/server-rest/examples/account/get-prefs.md @@ -1,8 +1,8 @@ ```http GET /v1/account/prefs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/get-session.md b/examples/1.9.x/server-rest/examples/account/get-session.md index 3799251ab..5eddb7f77 100644 --- a/examples/1.9.x/server-rest/examples/account/get-session.md +++ b/examples/1.9.x/server-rest/examples/account/get-session.md @@ -1,8 +1,8 @@ ```http GET /v1/account/sessions/{sessionId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/get.md b/examples/1.9.x/server-rest/examples/account/get.md index e61f07626..f4ff4b834 100644 --- a/examples/1.9.x/server-rest/examples/account/get.md +++ b/examples/1.9.x/server-rest/examples/account/get.md @@ -1,8 +1,8 @@ ```http GET /v1/account HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/list-identities.md b/examples/1.9.x/server-rest/examples/account/list-identities.md index 0813a1bf5..418556f0d 100644 --- a/examples/1.9.x/server-rest/examples/account/list-identities.md +++ b/examples/1.9.x/server-rest/examples/account/list-identities.md @@ -1,8 +1,8 @@ ```http GET /v1/account/identities HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/list-logs.md b/examples/1.9.x/server-rest/examples/account/list-logs.md index cc8110e07..24ad00cf2 100644 --- a/examples/1.9.x/server-rest/examples/account/list-logs.md +++ b/examples/1.9.x/server-rest/examples/account/list-logs.md @@ -1,8 +1,8 @@ ```http GET /v1/account/logs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/list-mfa-factors.md b/examples/1.9.x/server-rest/examples/account/list-mfa-factors.md index 2de5e9a27..b2429265f 100644 --- a/examples/1.9.x/server-rest/examples/account/list-mfa-factors.md +++ b/examples/1.9.x/server-rest/examples/account/list-mfa-factors.md @@ -1,8 +1,8 @@ ```http GET /v1/account/mfa/factors HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/list-sessions.md b/examples/1.9.x/server-rest/examples/account/list-sessions.md index c7dc84d7b..4da0c7014 100644 --- a/examples/1.9.x/server-rest/examples/account/list-sessions.md +++ b/examples/1.9.x/server-rest/examples/account/list-sessions.md @@ -1,8 +1,8 @@ ```http GET /v1/account/sessions HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/update-email-verification.md b/examples/1.9.x/server-rest/examples/account/update-email-verification.md index 6ea3255e7..c2f9de20a 100644 --- a/examples/1.9.x/server-rest/examples/account/update-email-verification.md +++ b/examples/1.9.x/server-rest/examples/account/update-email-verification.md @@ -2,10 +2,14 @@ PUT /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/account/update-email.md b/examples/1.9.x/server-rest/examples/account/update-email.md index 841d076b8..05de98b21 100644 --- a/examples/1.9.x/server-rest/examples/account/update-email.md +++ b/examples/1.9.x/server-rest/examples/account/update-email.md @@ -2,10 +2,14 @@ PATCH /v1/account/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "email": "email@example.com", + "password": "password" +} { "email": "email@example.com", diff --git a/examples/1.9.x/server-rest/examples/account/update-magic-url-session.md b/examples/1.9.x/server-rest/examples/account/update-magic-url-session.md index 273bf326b..38e294434 100644 --- a/examples/1.9.x/server-rest/examples/account/update-magic-url-session.md +++ b/examples/1.9.x/server-rest/examples/account/update-magic-url-session.md @@ -2,10 +2,14 @@ PUT /v1/account/sessions/magic-url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/account/update-mfa-authenticator.md b/examples/1.9.x/server-rest/examples/account/update-mfa-authenticator.md index e7464765d..4c794f227 100644 --- a/examples/1.9.x/server-rest/examples/account/update-mfa-authenticator.md +++ b/examples/1.9.x/server-rest/examples/account/update-mfa-authenticator.md @@ -2,10 +2,13 @@ PUT /v1/account/mfa/authenticators/{type} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "otp": "<OTP>" +} { "otp": "<OTP>" diff --git a/examples/1.9.x/server-rest/examples/account/update-mfa-challenge.md b/examples/1.9.x/server-rest/examples/account/update-mfa-challenge.md index 9964263cc..16d693747 100644 --- a/examples/1.9.x/server-rest/examples/account/update-mfa-challenge.md +++ b/examples/1.9.x/server-rest/examples/account/update-mfa-challenge.md @@ -2,10 +2,14 @@ PUT /v1/account/mfa/challenges HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "challengeId": "<CHALLENGE_ID>", + "otp": "<OTP>" +} { "challengeId": "<CHALLENGE_ID>", diff --git a/examples/1.9.x/server-rest/examples/account/update-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/account/update-mfa-recovery-codes.md index bd2c3832d..9887b4374 100644 --- a/examples/1.9.x/server-rest/examples/account/update-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/account/update-mfa-recovery-codes.md @@ -2,9 +2,9 @@ PATCH /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/update-mfa.md b/examples/1.9.x/server-rest/examples/account/update-mfa.md index a117bb6e1..f0ab3fee3 100644 --- a/examples/1.9.x/server-rest/examples/account/update-mfa.md +++ b/examples/1.9.x/server-rest/examples/account/update-mfa.md @@ -2,10 +2,13 @@ PATCH /v1/account/mfa HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "mfa": false +} { "mfa": false diff --git a/examples/1.9.x/server-rest/examples/account/update-name.md b/examples/1.9.x/server-rest/examples/account/update-name.md index 7159a49e3..2ea52fb66 100644 --- a/examples/1.9.x/server-rest/examples/account/update-name.md +++ b/examples/1.9.x/server-rest/examples/account/update-name.md @@ -2,10 +2,13 @@ PATCH /v1/account/name HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "name": "<NAME>" +} { "name": "<NAME>" diff --git a/examples/1.9.x/server-rest/examples/account/update-password.md b/examples/1.9.x/server-rest/examples/account/update-password.md index dbde18b56..f191517bd 100644 --- a/examples/1.9.x/server-rest/examples/account/update-password.md +++ b/examples/1.9.x/server-rest/examples/account/update-password.md @@ -2,13 +2,17 @@ PATCH /v1/account/password HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> { - "password": "", + "password": "password", + "oldPassword": "password" +} + +{ + "password": "password", "oldPassword": "password" } ``` diff --git a/examples/1.9.x/server-rest/examples/account/update-phone-session.md b/examples/1.9.x/server-rest/examples/account/update-phone-session.md index 82e387bf7..afeb4dfb0 100644 --- a/examples/1.9.x/server-rest/examples/account/update-phone-session.md +++ b/examples/1.9.x/server-rest/examples/account/update-phone-session.md @@ -2,10 +2,14 @@ PUT /v1/account/sessions/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/account/update-phone-verification.md b/examples/1.9.x/server-rest/examples/account/update-phone-verification.md index 1f68f5080..b8f78ba32 100644 --- a/examples/1.9.x/server-rest/examples/account/update-phone-verification.md +++ b/examples/1.9.x/server-rest/examples/account/update-phone-verification.md @@ -2,10 +2,14 @@ PUT /v1/account/verifications/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/account/update-phone.md b/examples/1.9.x/server-rest/examples/account/update-phone.md index 42d99202e..cfe3dfda9 100644 --- a/examples/1.9.x/server-rest/examples/account/update-phone.md +++ b/examples/1.9.x/server-rest/examples/account/update-phone.md @@ -2,10 +2,14 @@ PATCH /v1/account/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "phone": "+12065550100", + "password": "password" +} { "phone": "+12065550100", diff --git a/examples/1.9.x/server-rest/examples/account/update-prefs.md b/examples/1.9.x/server-rest/examples/account/update-prefs.md index 5795da398..69dae5c7f 100644 --- a/examples/1.9.x/server-rest/examples/account/update-prefs.md +++ b/examples/1.9.x/server-rest/examples/account/update-prefs.md @@ -2,10 +2,17 @@ PATCH /v1/account/prefs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "prefs": { + "language": "en", + "timezone": "UTC", + "darkTheme": true + } +} { "prefs": { diff --git a/examples/1.9.x/server-rest/examples/account/update-recovery.md b/examples/1.9.x/server-rest/examples/account/update-recovery.md index ebe7ee91f..4227f9fab 100644 --- a/examples/1.9.x/server-rest/examples/account/update-recovery.md +++ b/examples/1.9.x/server-rest/examples/account/update-recovery.md @@ -2,14 +2,19 @@ PUT /v1/account/recovery HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> { "userId": "<USER_ID>", "secret": "<SECRET>", - "password": "" + "password": "password" +} + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>", + "password": "password" } ``` diff --git a/examples/1.9.x/server-rest/examples/account/update-session.md b/examples/1.9.x/server-rest/examples/account/update-session.md index 6c9cf78f7..e29298f70 100644 --- a/examples/1.9.x/server-rest/examples/account/update-session.md +++ b/examples/1.9.x/server-rest/examples/account/update-session.md @@ -2,9 +2,9 @@ PATCH /v1/account/sessions/{sessionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/update-status.md b/examples/1.9.x/server-rest/examples/account/update-status.md index b57e878df..43905851e 100644 --- a/examples/1.9.x/server-rest/examples/account/update-status.md +++ b/examples/1.9.x/server-rest/examples/account/update-status.md @@ -2,9 +2,9 @@ PATCH /v1/account/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/account/update-verification.md b/examples/1.9.x/server-rest/examples/account/update-verification.md index 6ea3255e7..c2f9de20a 100644 --- a/examples/1.9.x/server-rest/examples/account/update-verification.md +++ b/examples/1.9.x/server-rest/examples/account/update-verification.md @@ -2,10 +2,14 @@ PUT /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/activities/get-event.md b/examples/1.9.x/server-rest/examples/activities/get-event.md index bd287b510..d8f89d8d9 100644 --- a/examples/1.9.x/server-rest/examples/activities/get-event.md +++ b/examples/1.9.x/server-rest/examples/activities/get-event.md @@ -1,7 +1,8 @@ ```http GET /v1/activities/events/{eventId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/activities/list-events.md b/examples/1.9.x/server-rest/examples/activities/list-events.md index fa3df6987..b1b68d642 100644 --- a/examples/1.9.x/server-rest/examples/activities/list-events.md +++ b/examples/1.9.x/server-rest/examples/activities/list-events.md @@ -1,7 +1,8 @@ ```http GET /v1/activities/events HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/advisor/delete-report.md b/examples/1.9.x/server-rest/examples/advisor/delete-report.md index 43729f924..d6f622ff2 100644 --- a/examples/1.9.x/server-rest/examples/advisor/delete-report.md +++ b/examples/1.9.x/server-rest/examples/advisor/delete-report.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/advisor/get-insight.md b/examples/1.9.x/server-rest/examples/advisor/get-insight.md index 1e4c661b4..54d832f5a 100644 --- a/examples/1.9.x/server-rest/examples/advisor/get-insight.md +++ b/examples/1.9.x/server-rest/examples/advisor/get-insight.md @@ -1,7 +1,8 @@ ```http GET /v1/reports/{reportId}/insights/{insightId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/advisor/get-report.md b/examples/1.9.x/server-rest/examples/advisor/get-report.md index 48e9ba06e..686608a72 100644 --- a/examples/1.9.x/server-rest/examples/advisor/get-report.md +++ b/examples/1.9.x/server-rest/examples/advisor/get-report.md @@ -1,7 +1,8 @@ ```http GET /v1/reports/{reportId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/advisor/list-insights.md b/examples/1.9.x/server-rest/examples/advisor/list-insights.md index ec3933c5f..0934cb831 100644 --- a/examples/1.9.x/server-rest/examples/advisor/list-insights.md +++ b/examples/1.9.x/server-rest/examples/advisor/list-insights.md @@ -1,7 +1,8 @@ ```http GET /v1/reports/{reportId}/insights HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/advisor/list-reports.md b/examples/1.9.x/server-rest/examples/advisor/list-reports.md index ce9a78d2d..ab1b7f7b8 100644 --- a/examples/1.9.x/server-rest/examples/advisor/list-reports.md +++ b/examples/1.9.x/server-rest/examples/advisor/list-reports.md @@ -1,7 +1,8 @@ ```http GET /v1/reports HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/avatars/get-browser.md b/examples/1.9.x/server-rest/examples/avatars/get-browser.md index d79419797..08aa956fd 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-browser.md @@ -1,9 +1,7 @@ ```http GET /v1/avatars/browsers/{code} HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/avatars/get-credit-card.md b/examples/1.9.x/server-rest/examples/avatars/get-credit-card.md index 610c8f58b..e77defdb2 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-credit-card.md @@ -1,9 +1,7 @@ ```http GET /v1/avatars/credit-cards/{code} HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/avatars/get-favicon.md b/examples/1.9.x/server-rest/examples/avatars/get-favicon.md index 39d89d455..aa2b1712f 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-favicon.md @@ -1,9 +1,7 @@ ```http GET /v1/avatars/favicon HTTP/1.1 Host: cloud.appwrite.io +Accept: image/* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/avatars/get-flag.md b/examples/1.9.x/server-rest/examples/avatars/get-flag.md index f0ed3c575..084eff36a 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-flag.md @@ -1,9 +1,7 @@ ```http GET /v1/avatars/flags/{code} HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/avatars/get-image.md b/examples/1.9.x/server-rest/examples/avatars/get-image.md index 1087f5160..72309cc58 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-image.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-image.md @@ -1,9 +1,7 @@ ```http GET /v1/avatars/image HTTP/1.1 Host: cloud.appwrite.io +Accept: image/* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/avatars/get-initials.md b/examples/1.9.x/server-rest/examples/avatars/get-initials.md index 32cf05d32..4cf077af7 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-initials.md @@ -1,9 +1,7 @@ ```http GET /v1/avatars/initials HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/avatars/get-qr.md b/examples/1.9.x/server-rest/examples/avatars/get-qr.md index ffadf37bc..1b0e9c60c 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-qr.md @@ -1,9 +1,7 @@ ```http GET /v1/avatars/qr HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/avatars/get-screenshot.md b/examples/1.9.x/server-rest/examples/avatars/get-screenshot.md index dc27d87c0..aaa7340a5 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-screenshot.md @@ -1,9 +1,7 @@ ```http GET /v1/avatars/screenshots HTTP/1.1 Host: cloud.appwrite.io +Accept: image/png X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/backups/create-archive.md b/examples/1.9.x/server-rest/examples/backups/create-archive.md index d4ba549c4..b1f747434 100644 --- a/examples/1.9.x/server-rest/examples/backups/create-archive.md +++ b/examples/1.9.x/server-rest/examples/backups/create-archive.md @@ -2,9 +2,14 @@ POST /v1/backups/archives HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "services": [], + "resourceId": "<RESOURCE_ID>" +} { "services": [], diff --git a/examples/1.9.x/server-rest/examples/backups/create-policy.md b/examples/1.9.x/server-rest/examples/backups/create-policy.md index d18c1280f..1f3b9fc17 100644 --- a/examples/1.9.x/server-rest/examples/backups/create-policy.md +++ b/examples/1.9.x/server-rest/examples/backups/create-policy.md @@ -2,9 +2,19 @@ POST /v1/backups/policies HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "policyId": "<POLICY_ID>", + "name": "<NAME>", + "services": [], + "resourceId": "<RESOURCE_ID>", + "enabled": false, + "retention": 1, + "schedule": "" +} { "policyId": "<POLICY_ID>", diff --git a/examples/1.9.x/server-rest/examples/backups/create-restoration.md b/examples/1.9.x/server-rest/examples/backups/create-restoration.md index aeefe7ea3..b3dc60488 100644 --- a/examples/1.9.x/server-rest/examples/backups/create-restoration.md +++ b/examples/1.9.x/server-rest/examples/backups/create-restoration.md @@ -2,9 +2,16 @@ POST /v1/backups/restoration HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "archiveId": "<ARCHIVE_ID>", + "services": [], + "newResourceId": "<NEW_RESOURCE_ID>", + "newResourceName": "<NEW_RESOURCE_NAME>" +} { "archiveId": "<ARCHIVE_ID>", diff --git a/examples/1.9.x/server-rest/examples/backups/delete-archive.md b/examples/1.9.x/server-rest/examples/backups/delete-archive.md index 50bf84758..222bceabf 100644 --- a/examples/1.9.x/server-rest/examples/backups/delete-archive.md +++ b/examples/1.9.x/server-rest/examples/backups/delete-archive.md @@ -2,8 +2,9 @@ DELETE /v1/backups/archives/{archiveId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/backups/delete-policy.md b/examples/1.9.x/server-rest/examples/backups/delete-policy.md index 5dcb7657f..9a6dd8918 100644 --- a/examples/1.9.x/server-rest/examples/backups/delete-policy.md +++ b/examples/1.9.x/server-rest/examples/backups/delete-policy.md @@ -2,8 +2,9 @@ DELETE /v1/backups/policies/{policyId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/backups/get-archive.md b/examples/1.9.x/server-rest/examples/backups/get-archive.md index 094bef500..6e5c37bf4 100644 --- a/examples/1.9.x/server-rest/examples/backups/get-archive.md +++ b/examples/1.9.x/server-rest/examples/backups/get-archive.md @@ -1,7 +1,8 @@ ```http GET /v1/backups/archives/{archiveId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/backups/get-policy.md b/examples/1.9.x/server-rest/examples/backups/get-policy.md index 493f7b25e..1ecf69385 100644 --- a/examples/1.9.x/server-rest/examples/backups/get-policy.md +++ b/examples/1.9.x/server-rest/examples/backups/get-policy.md @@ -1,7 +1,8 @@ ```http GET /v1/backups/policies/{policyId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/backups/get-restoration.md b/examples/1.9.x/server-rest/examples/backups/get-restoration.md index ead889038..d0089389e 100644 --- a/examples/1.9.x/server-rest/examples/backups/get-restoration.md +++ b/examples/1.9.x/server-rest/examples/backups/get-restoration.md @@ -1,7 +1,8 @@ ```http GET /v1/backups/restorations/{restorationId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/backups/list-archives.md b/examples/1.9.x/server-rest/examples/backups/list-archives.md index a0bd83083..c2f2423d3 100644 --- a/examples/1.9.x/server-rest/examples/backups/list-archives.md +++ b/examples/1.9.x/server-rest/examples/backups/list-archives.md @@ -1,7 +1,8 @@ ```http GET /v1/backups/archives HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/backups/list-policies.md b/examples/1.9.x/server-rest/examples/backups/list-policies.md index d2da23b93..47f2fe46f 100644 --- a/examples/1.9.x/server-rest/examples/backups/list-policies.md +++ b/examples/1.9.x/server-rest/examples/backups/list-policies.md @@ -1,7 +1,8 @@ ```http GET /v1/backups/policies HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/backups/list-restorations.md b/examples/1.9.x/server-rest/examples/backups/list-restorations.md index dee3f33eb..8f8bb2cf1 100644 --- a/examples/1.9.x/server-rest/examples/backups/list-restorations.md +++ b/examples/1.9.x/server-rest/examples/backups/list-restorations.md @@ -1,7 +1,8 @@ ```http GET /v1/backups/restorations HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/backups/update-policy.md b/examples/1.9.x/server-rest/examples/backups/update-policy.md index efadda8af..6bc0a00e2 100644 --- a/examples/1.9.x/server-rest/examples/backups/update-policy.md +++ b/examples/1.9.x/server-rest/examples/backups/update-policy.md @@ -2,9 +2,16 @@ PATCH /v1/backups/policies/{policyId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "retention": 1, + "schedule": "", + "enabled": false +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/databases/create-big-int-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-big-int-attribute.md index 7717d46e9..28ac2649d 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-big-int-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-big-int-attribute.md @@ -2,9 +2,18 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/bigint HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "min": 0, + "max": 0, + "default": 0, + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-boolean-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-boolean-attribute.md index cb1039200..22b702658 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-boolean-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-boolean-attribute.md @@ -2,9 +2,16 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": false, + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-collection.md b/examples/1.9.x/server-rest/examples/databases/create-collection.md index 55a127b35..52b7a6d35 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-collection.md +++ b/examples/1.9.x/server-rest/examples/databases/create-collection.md @@ -2,9 +2,19 @@ POST /v1/databases/{databaseId}/collections HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "collectionId": "<COLLECTION_ID>", + "name": "<NAME>", + "permissions": ["read(\"any\")"], + "documentSecurity": false, + "enabled": false, + "attributes": [], + "indexes": [] +} { "collectionId": "<COLLECTION_ID>", diff --git a/examples/1.9.x/server-rest/examples/databases/create-datetime-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-datetime-attribute.md index 372a78dc5..aba54a4cf 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-datetime-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-datetime-attribute.md @@ -2,9 +2,16 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "2020-10-15T06:38:00.000+00:00", + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-document.md b/examples/1.9.x/server-rest/examples/databases/create-document.md index 4ef3ca2ba..d6a37128b 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-document.md +++ b/examples/1.9.x/server-rest/examples/databases/create-document.md @@ -2,11 +2,22 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "documentId": "<DOCUMENT_ID>", + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "<TRANSACTION_ID>" +} { "documentId": "<DOCUMENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/databases/create-documents.md b/examples/1.9.x/server-rest/examples/databases/create-documents.md index 27c7986c8..60a762287 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-documents.md +++ b/examples/1.9.x/server-rest/examples/databases/create-documents.md @@ -2,11 +2,14 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "documents": [], + "transactionId": "<TRANSACTION_ID>" +} { "documents": [], diff --git a/examples/1.9.x/server-rest/examples/databases/create-email-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-email-attribute.md index 90a53bd4d..0f7257e07 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-email-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-email-attribute.md @@ -2,9 +2,16 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "email@example.com", + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-enum-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-enum-attribute.md index 1e95e9293..3ea56c47d 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-enum-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-enum-attribute.md @@ -2,9 +2,17 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "elements": [], + "required": false, + "default": "<DEFAULT>", + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-float-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-float-attribute.md index 69a78f1bd..45bdf9c47 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-float-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-float-attribute.md @@ -2,9 +2,18 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/float HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "min": 0, + "max": 0, + "default": 0, + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-index.md b/examples/1.9.x/server-rest/examples/databases/create-index.md index b272df1ad..e02c5de88 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-index.md +++ b/examples/1.9.x/server-rest/examples/databases/create-index.md @@ -2,9 +2,17 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "type": "key", + "attributes": [], + "orders": [], + "lengths": [] +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-integer-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-integer-attribute.md index 3453e2f26..cfdf34481 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-integer-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-integer-attribute.md @@ -2,9 +2,18 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "min": 0, + "max": 0, + "default": 0, + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-ip-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-ip-attribute.md index 206449eec..45a1176bf 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-ip-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-ip-attribute.md @@ -2,9 +2,16 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "", + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-line-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-line-attribute.md index 738b9f7ff..515dd660e 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-line-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-line-attribute.md @@ -2,9 +2,15 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/line HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": [[1, 2], [3, 4], [5, 6]] +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-longtext-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-longtext-attribute.md index b16a21f38..9166e8195 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-longtext-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-longtext-attribute.md @@ -2,9 +2,17 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/longtext HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "<DEFAULT>", + "array": false, + "encrypt": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-mediumtext-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-mediumtext-attribute.md index 88730f4d3..1d62bb270 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-mediumtext-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-mediumtext-attribute.md @@ -2,9 +2,17 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "<DEFAULT>", + "array": false, + "encrypt": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-operations.md b/examples/1.9.x/server-rest/examples/databases/create-operations.md index 2009bb9ce..74537e862 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-operations.md +++ b/examples/1.9.x/server-rest/examples/databases/create-operations.md @@ -2,11 +2,23 @@ POST /v1/databases/transactions/{transactionId}/operations HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "operations": [ + { + "action": "create", + "databaseId": "<DATABASE_ID>", + "collectionId": "<COLLECTION_ID>", + "documentId": "<DOCUMENT_ID>", + "data": { + "name": "Walter O'Brien" + } + } + ] +} { "operations": [ diff --git a/examples/1.9.x/server-rest/examples/databases/create-point-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-point-attribute.md index cb8dc01c5..4309f5282 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-point-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-point-attribute.md @@ -2,9 +2,15 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/point HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": [1, 2] +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-polygon-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-polygon-attribute.md index 81fd14498..c5cf9d586 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-polygon-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-polygon-attribute.md @@ -2,9 +2,15 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/polygon HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": [[[1, 2], [3, 4], [5, 6], [1, 2]]] +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-relationship-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-relationship-attribute.md index d2be31093..7d300e2af 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-relationship-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-relationship-attribute.md @@ -2,9 +2,18 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/relationship HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "relatedCollectionId": "<RELATED_COLLECTION_ID>", + "type": "oneToOne", + "twoWay": false, + "key": "", + "twoWayKey": "", + "onDelete": "cascade" +} { "relatedCollectionId": "<RELATED_COLLECTION_ID>", diff --git a/examples/1.9.x/server-rest/examples/databases/create-string-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-string-attribute.md index f918138d9..37d812c06 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-string-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-string-attribute.md @@ -2,9 +2,18 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/string HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "size": 1, + "required": false, + "default": "<DEFAULT>", + "array": false, + "encrypt": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-text-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-text-attribute.md index 6191f5082..37a3ba70d 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-text-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-text-attribute.md @@ -2,9 +2,17 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/text HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "<DEFAULT>", + "array": false, + "encrypt": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-transaction.md b/examples/1.9.x/server-rest/examples/databases/create-transaction.md index bbf487b75..4fde327e7 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-transaction.md +++ b/examples/1.9.x/server-rest/examples/databases/create-transaction.md @@ -2,11 +2,13 @@ POST /v1/databases/transactions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "ttl": 60 +} { "ttl": 60 diff --git a/examples/1.9.x/server-rest/examples/databases/create-url-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-url-attribute.md index 81eb78742..5ac24fc56 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-url-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-url-attribute.md @@ -2,9 +2,16 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "https://example.com", + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create-varchar-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-varchar-attribute.md index 5c94128cd..a8c1d4e13 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-varchar-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-varchar-attribute.md @@ -2,9 +2,18 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/varchar HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "size": 1, + "required": false, + "default": "<DEFAULT>", + "array": false, + "encrypt": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/databases/create.md b/examples/1.9.x/server-rest/examples/databases/create.md index cc1244d7a..13484a42c 100644 --- a/examples/1.9.x/server-rest/examples/databases/create.md +++ b/examples/1.9.x/server-rest/examples/databases/create.md @@ -2,9 +2,15 @@ POST /v1/databases HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "databaseId": "<DATABASE_ID>", + "name": "<NAME>", + "enabled": false +} { "databaseId": "<DATABASE_ID>", diff --git a/examples/1.9.x/server-rest/examples/databases/decrement-document-attribute.md b/examples/1.9.x/server-rest/examples/databases/decrement-document-attribute.md index 986117ce4..a1b48c20a 100644 --- a/examples/1.9.x/server-rest/examples/databases/decrement-document-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/decrement-document-attribute.md @@ -2,11 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/decrement HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "value": 0, + "min": 0, + "transactionId": "<TRANSACTION_ID>" +} { "value": 0, diff --git a/examples/1.9.x/server-rest/examples/databases/delete-attribute.md b/examples/1.9.x/server-rest/examples/databases/delete-attribute.md index 83278c42e..8aedf87f4 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-attribute.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/databases/delete-collection.md b/examples/1.9.x/server-rest/examples/databases/delete-collection.md index ff2bdadc8..a7e8d7e92 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-collection.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-collection.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/databases/delete-document.md b/examples/1.9.x/server-rest/examples/databases/delete-document.md index 20567a7a7..a4472d07a 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-document.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-document.md @@ -4,9 +4,6 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> { "transactionId": "<TRANSACTION_ID>" diff --git a/examples/1.9.x/server-rest/examples/databases/delete-documents.md b/examples/1.9.x/server-rest/examples/databases/delete-documents.md index d5ecd864e..aa7b59739 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-documents.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-documents.md @@ -2,9 +2,14 @@ DELETE /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "queries": [], + "transactionId": "<TRANSACTION_ID>" +} { "queries": [], diff --git a/examples/1.9.x/server-rest/examples/databases/delete-index.md b/examples/1.9.x/server-rest/examples/databases/delete-index.md index a4499892b..5b2034b83 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-index.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-index.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/databases/delete-transaction.md b/examples/1.9.x/server-rest/examples/databases/delete-transaction.md index 95e13261d..d7d8e21d3 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-transaction.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-transaction.md @@ -4,8 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/databases/delete.md b/examples/1.9.x/server-rest/examples/databases/delete.md index 43509f834..5fa616b20 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete.md +++ b/examples/1.9.x/server-rest/examples/databases/delete.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/databases/get-attribute.md b/examples/1.9.x/server-rest/examples/databases/get-attribute.md index 2bf086eef..bf562d6c2 100644 --- a/examples/1.9.x/server-rest/examples/databases/get-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/get-attribute.md @@ -1,7 +1,8 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/get-collection.md b/examples/1.9.x/server-rest/examples/databases/get-collection.md index 14787c832..7f30e9bd4 100644 --- a/examples/1.9.x/server-rest/examples/databases/get-collection.md +++ b/examples/1.9.x/server-rest/examples/databases/get-collection.md @@ -1,7 +1,8 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/get-document.md b/examples/1.9.x/server-rest/examples/databases/get-document.md index 304abb070..6760bfe21 100644 --- a/examples/1.9.x/server-rest/examples/databases/get-document.md +++ b/examples/1.9.x/server-rest/examples/databases/get-document.md @@ -1,9 +1,8 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/get-index.md b/examples/1.9.x/server-rest/examples/databases/get-index.md index 7314255fb..04e043ccb 100644 --- a/examples/1.9.x/server-rest/examples/databases/get-index.md +++ b/examples/1.9.x/server-rest/examples/databases/get-index.md @@ -1,7 +1,8 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/indexes/{key} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/get-transaction.md b/examples/1.9.x/server-rest/examples/databases/get-transaction.md index b10a448b0..2ccc35124 100644 --- a/examples/1.9.x/server-rest/examples/databases/get-transaction.md +++ b/examples/1.9.x/server-rest/examples/databases/get-transaction.md @@ -1,9 +1,8 @@ ```http GET /v1/databases/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/get.md b/examples/1.9.x/server-rest/examples/databases/get.md index c995ff26f..37f84d58b 100644 --- a/examples/1.9.x/server-rest/examples/databases/get.md +++ b/examples/1.9.x/server-rest/examples/databases/get.md @@ -1,7 +1,8 @@ ```http GET /v1/databases/{databaseId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/increment-document-attribute.md b/examples/1.9.x/server-rest/examples/databases/increment-document-attribute.md index ef0539443..6e1e384e1 100644 --- a/examples/1.9.x/server-rest/examples/databases/increment-document-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/increment-document-attribute.md @@ -2,11 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/increment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "value": 0, + "max": 0, + "transactionId": "<TRANSACTION_ID>" +} { "value": 0, diff --git a/examples/1.9.x/server-rest/examples/databases/list-attributes.md b/examples/1.9.x/server-rest/examples/databases/list-attributes.md index 20b42bc08..0c61b2884 100644 --- a/examples/1.9.x/server-rest/examples/databases/list-attributes.md +++ b/examples/1.9.x/server-rest/examples/databases/list-attributes.md @@ -1,7 +1,8 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/attributes HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/list-collections.md b/examples/1.9.x/server-rest/examples/databases/list-collections.md index 6431aff0a..f23f93669 100644 --- a/examples/1.9.x/server-rest/examples/databases/list-collections.md +++ b/examples/1.9.x/server-rest/examples/databases/list-collections.md @@ -1,7 +1,8 @@ ```http GET /v1/databases/{databaseId}/collections HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/list-documents.md b/examples/1.9.x/server-rest/examples/databases/list-documents.md index d25e10b4f..71fedf120 100644 --- a/examples/1.9.x/server-rest/examples/databases/list-documents.md +++ b/examples/1.9.x/server-rest/examples/databases/list-documents.md @@ -1,9 +1,8 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/list-indexes.md b/examples/1.9.x/server-rest/examples/databases/list-indexes.md index d44cd37da..be065ef14 100644 --- a/examples/1.9.x/server-rest/examples/databases/list-indexes.md +++ b/examples/1.9.x/server-rest/examples/databases/list-indexes.md @@ -1,7 +1,8 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/list-transactions.md b/examples/1.9.x/server-rest/examples/databases/list-transactions.md index 77bb0b95d..45b09ded2 100644 --- a/examples/1.9.x/server-rest/examples/databases/list-transactions.md +++ b/examples/1.9.x/server-rest/examples/databases/list-transactions.md @@ -1,9 +1,8 @@ ```http GET /v1/databases/transactions HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/list.md b/examples/1.9.x/server-rest/examples/databases/list.md index a2ce2b574..0c1e0157f 100644 --- a/examples/1.9.x/server-rest/examples/databases/list.md +++ b/examples/1.9.x/server-rest/examples/databases/list.md @@ -1,7 +1,8 @@ ```http GET /v1/databases HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/databases/update-big-int-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-big-int-attribute.md index ad5aa8553..2532527ce 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-big-int-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-big-int-attribute.md @@ -2,9 +2,17 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/bigint/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "min": 0, + "max": 0, + "default": 0, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-boolean-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-boolean-attribute.md index a1b01b01d..7a1aaacd8 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-boolean-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-boolean-attribute.md @@ -2,9 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": false, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-collection.md b/examples/1.9.x/server-rest/examples/databases/update-collection.md index fd68170c5..d788c1b4d 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-collection.md +++ b/examples/1.9.x/server-rest/examples/databases/update-collection.md @@ -2,9 +2,17 @@ PUT /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "permissions": ["read(\"any\")"], + "documentSecurity": false, + "enabled": false, + "purge": false +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/databases/update-datetime-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-datetime-attribute.md index 4e972eaa6..0650ac5e0 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-datetime-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-datetime-attribute.md @@ -2,9 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "2020-10-15T06:38:00.000+00:00", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-document.md b/examples/1.9.x/server-rest/examples/databases/update-document.md index fa465b907..1e99373c4 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-document.md +++ b/examples/1.9.x/server-rest/examples/databases/update-document.md @@ -2,11 +2,21 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "<TRANSACTION_ID>" +} { "data": { diff --git a/examples/1.9.x/server-rest/examples/databases/update-documents.md b/examples/1.9.x/server-rest/examples/databases/update-documents.md index 55df64702..c9c2f3f2f 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-documents.md +++ b/examples/1.9.x/server-rest/examples/databases/update-documents.md @@ -2,9 +2,21 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + }, + "queries": [], + "transactionId": "<TRANSACTION_ID>" +} { "data": { diff --git a/examples/1.9.x/server-rest/examples/databases/update-email-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-email-attribute.md index 6a2e27f78..df160c2c1 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-email-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-email-attribute.md @@ -2,9 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/email/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "email@example.com", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-enum-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-enum-attribute.md index d83f1cd9f..3c542c103 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-enum-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-enum-attribute.md @@ -2,9 +2,16 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "elements": [], + "required": false, + "default": "<DEFAULT>", + "newKey": "" +} { "elements": [], diff --git a/examples/1.9.x/server-rest/examples/databases/update-float-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-float-attribute.md index 66663584d..24f46a3e2 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-float-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-float-attribute.md @@ -2,9 +2,17 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/float/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "min": 0, + "max": 0, + "default": 0, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-integer-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-integer-attribute.md index 357c27f96..f6b8ef57b 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-integer-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-integer-attribute.md @@ -2,9 +2,17 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "min": 0, + "max": 0, + "default": 0, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-ip-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-ip-attribute.md index c5be3af9e..1f5b0a8e2 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-ip-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-ip-attribute.md @@ -2,9 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-line-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-line-attribute.md index b4aa40ade..569f0758d 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-line-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-line-attribute.md @@ -2,9 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/line/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": [[1, 2], [3, 4], [5, 6]], + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-longtext-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-longtext-attribute.md index 6900834d8..a661717e2 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-longtext-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-longtext-attribute.md @@ -2,9 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/longtext/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "<DEFAULT>", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-mediumtext-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-mediumtext-attribute.md index edcd20565..2f5c23864 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-mediumtext-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-mediumtext-attribute.md @@ -2,9 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "<DEFAULT>", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-point-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-point-attribute.md index 7ed75baf4..08cd8a88b 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-point-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-point-attribute.md @@ -2,9 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/point/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": [1, 2], + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-polygon-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-polygon-attribute.md index 8e39bda56..7ef588722 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-polygon-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-polygon-attribute.md @@ -2,9 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/polygon/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": [[[1, 2], [3, 4], [5, 6], [1, 2]]], + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-relationship-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-relationship-attribute.md index 0d4d348ae..d8a684256 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-relationship-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-relationship-attribute.md @@ -2,9 +2,14 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/relationship/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "onDelete": "cascade", + "newKey": "" +} { "onDelete": "cascade", diff --git a/examples/1.9.x/server-rest/examples/databases/update-string-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-string-attribute.md index 88e57c009..d3ea9adf3 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-string-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-string-attribute.md @@ -2,9 +2,16 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/string/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "<DEFAULT>", + "size": 1, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-text-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-text-attribute.md index 166ae59dc..7a9e575d5 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-text-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-text-attribute.md @@ -2,9 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/text/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "<DEFAULT>", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-transaction.md b/examples/1.9.x/server-rest/examples/databases/update-transaction.md index 9e321a9bd..34acb91b1 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-transaction.md +++ b/examples/1.9.x/server-rest/examples/databases/update-transaction.md @@ -2,11 +2,14 @@ PATCH /v1/databases/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "commit": false, + "rollback": false +} { "commit": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-url-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-url-attribute.md index 6085c72b8..e297bcc41 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-url-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-url-attribute.md @@ -2,9 +2,15 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/url/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "https://example.com", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update-varchar-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-varchar-attribute.md index 942cf323b..ddbc8600d 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-varchar-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-varchar-attribute.md @@ -2,9 +2,16 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/varchar/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "<DEFAULT>", + "size": 1, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/databases/update.md b/examples/1.9.x/server-rest/examples/databases/update.md index 75f071c20..0f335a919 100644 --- a/examples/1.9.x/server-rest/examples/databases/update.md +++ b/examples/1.9.x/server-rest/examples/databases/update.md @@ -2,9 +2,14 @@ PUT /v1/databases/{databaseId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/databases/upsert-document.md b/examples/1.9.x/server-rest/examples/databases/upsert-document.md index fe254e2da..3dde00359 100644 --- a/examples/1.9.x/server-rest/examples/databases/upsert-document.md +++ b/examples/1.9.x/server-rest/examples/databases/upsert-document.md @@ -2,11 +2,21 @@ PUT /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "<TRANSACTION_ID>" +} { "data": { diff --git a/examples/1.9.x/server-rest/examples/databases/upsert-documents.md b/examples/1.9.x/server-rest/examples/databases/upsert-documents.md index 3925187ed..93c5e794a 100644 --- a/examples/1.9.x/server-rest/examples/databases/upsert-documents.md +++ b/examples/1.9.x/server-rest/examples/databases/upsert-documents.md @@ -2,9 +2,14 @@ PUT /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "documents": [], + "transactionId": "<TRANSACTION_ID>" +} { "documents": [], diff --git a/examples/1.9.x/server-rest/examples/functions/create-deployment.md b/examples/1.9.x/server-rest/examples/functions/create-deployment.md index 820c9ddef..0c44cf098 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/create-deployment.md @@ -2,9 +2,9 @@ POST /v1/functions/{functionId}/deployments HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> Content-Length: *Length of your entity body in bytes* --cec8e8123c05ba25 @@ -28,4 +28,11 @@ Content-Disposition: form-data; name="activate" false --cec8e8123c05ba25-- + +{ + "entrypoint": "<ENTRYPOINT>", + "commands": "<COMMANDS>", + "code": cf 94 84 24 8d c4 91 10 0f dc 54 26 6c 8e 4b bc e8 ee 55 94 29 e7 94 89 19 26 28 01 26 29 3f 16..., + "activate": false +} ``` diff --git a/examples/1.9.x/server-rest/examples/functions/create-duplicate-deployment.md b/examples/1.9.x/server-rest/examples/functions/create-duplicate-deployment.md index e93489938..8738122df 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-duplicate-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/create-duplicate-deployment.md @@ -2,9 +2,14 @@ POST /v1/functions/{functionId}/deployments/duplicate HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "deploymentId": "<DEPLOYMENT_ID>", + "buildId": "<BUILD_ID>" +} { "deploymentId": "<DEPLOYMENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/functions/create-execution.md b/examples/1.9.x/server-rest/examples/functions/create-execution.md index 0578c321f..c118443fb 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-execution.md +++ b/examples/1.9.x/server-rest/examples/functions/create-execution.md @@ -2,11 +2,18 @@ POST /v1/functions/{functionId}/executions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "body": "<BODY>", + "async": false, + "path": "<PATH>", + "method": "GET", + "headers": {}, + "scheduledAt": "<SCHEDULED_AT>" +} { "body": "<BODY>", diff --git a/examples/1.9.x/server-rest/examples/functions/create-template-deployment.md b/examples/1.9.x/server-rest/examples/functions/create-template-deployment.md index e16c62da7..24bb16600 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-template-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/create-template-deployment.md @@ -2,9 +2,18 @@ POST /v1/functions/{functionId}/deployments/template HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "repository": "<REPOSITORY>", + "owner": "<OWNER>", + "rootDirectory": "<ROOT_DIRECTORY>", + "type": "commit", + "reference": "<REFERENCE>", + "activate": false +} { "repository": "<REPOSITORY>", diff --git a/examples/1.9.x/server-rest/examples/functions/create-variable.md b/examples/1.9.x/server-rest/examples/functions/create-variable.md index c20fc70cd..1f737526d 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-variable.md +++ b/examples/1.9.x/server-rest/examples/functions/create-variable.md @@ -2,9 +2,16 @@ POST /v1/functions/{functionId}/variables HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "variableId": "<VARIABLE_ID>", + "key": "<KEY>", + "value": "<VALUE>", + "secret": false +} { "variableId": "<VARIABLE_ID>", diff --git a/examples/1.9.x/server-rest/examples/functions/create-vcs-deployment.md b/examples/1.9.x/server-rest/examples/functions/create-vcs-deployment.md index 3a684506a..7a9244f1e 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-vcs-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/create-vcs-deployment.md @@ -2,9 +2,15 @@ POST /v1/functions/{functionId}/deployments/vcs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "type": "branch", + "reference": "<REFERENCE>", + "activate": false +} { "type": "branch", diff --git a/examples/1.9.x/server-rest/examples/functions/create.md b/examples/1.9.x/server-rest/examples/functions/create.md index 2ef0865d7..f27eac026 100644 --- a/examples/1.9.x/server-rest/examples/functions/create.md +++ b/examples/1.9.x/server-rest/examples/functions/create.md @@ -2,9 +2,34 @@ POST /v1/functions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "functionId": "<FUNCTION_ID>", + "name": "<NAME>", + "runtime": "node-14.5", + "execute": ["any"], + "events": [], + "schedule": "", + "timeout": 1, + "enabled": false, + "logging": false, + "entrypoint": "<ENTRYPOINT>", + "commands": "<COMMANDS>", + "scopes": [], + "installationId": "<INSTALLATION_ID>", + "providerRepositoryId": "<PROVIDER_REPOSITORY_ID>", + "providerBranch": "<PROVIDER_BRANCH>", + "providerSilentMode": false, + "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>", + "providerBranches": [], + "providerPaths": [], + "buildSpecification": "", + "runtimeSpecification": "", + "deploymentRetention": 0 +} { "functionId": "<FUNCTION_ID>", diff --git a/examples/1.9.x/server-rest/examples/functions/delete-deployment.md b/examples/1.9.x/server-rest/examples/functions/delete-deployment.md index 9c1e8d6c3..2dc7c20fc 100644 --- a/examples/1.9.x/server-rest/examples/functions/delete-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/delete-deployment.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/functions/delete-execution.md b/examples/1.9.x/server-rest/examples/functions/delete-execution.md index 7b35348b1..8a4e5ce28 100644 --- a/examples/1.9.x/server-rest/examples/functions/delete-execution.md +++ b/examples/1.9.x/server-rest/examples/functions/delete-execution.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/functions/delete-variable.md b/examples/1.9.x/server-rest/examples/functions/delete-variable.md index 93bf52c93..66311e158 100644 --- a/examples/1.9.x/server-rest/examples/functions/delete-variable.md +++ b/examples/1.9.x/server-rest/examples/functions/delete-variable.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/functions/delete.md b/examples/1.9.x/server-rest/examples/functions/delete.md index 829af120b..42e72a44b 100644 --- a/examples/1.9.x/server-rest/examples/functions/delete.md +++ b/examples/1.9.x/server-rest/examples/functions/delete.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/functions/get-deployment-download.md b/examples/1.9.x/server-rest/examples/functions/get-deployment-download.md index 2ea00750c..3888c8256 100644 --- a/examples/1.9.x/server-rest/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-rest/examples/functions/get-deployment-download.md @@ -1,8 +1,7 @@ ```http GET /v1/functions/{functionId}/deployments/{deploymentId}/download HTTP/1.1 Host: cloud.appwrite.io +Accept: */* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/functions/get-deployment.md b/examples/1.9.x/server-rest/examples/functions/get-deployment.md index 4b2b49527..ec342eaeb 100644 --- a/examples/1.9.x/server-rest/examples/functions/get-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/get-deployment.md @@ -1,7 +1,8 @@ ```http GET /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/functions/get-execution.md b/examples/1.9.x/server-rest/examples/functions/get-execution.md index 691784908..2a48f2abd 100644 --- a/examples/1.9.x/server-rest/examples/functions/get-execution.md +++ b/examples/1.9.x/server-rest/examples/functions/get-execution.md @@ -1,9 +1,8 @@ ```http GET /v1/functions/{functionId}/executions/{executionId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/functions/get-variable.md b/examples/1.9.x/server-rest/examples/functions/get-variable.md index f02719443..62675eb9c 100644 --- a/examples/1.9.x/server-rest/examples/functions/get-variable.md +++ b/examples/1.9.x/server-rest/examples/functions/get-variable.md @@ -1,7 +1,8 @@ ```http GET /v1/functions/{functionId}/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/functions/get.md b/examples/1.9.x/server-rest/examples/functions/get.md index 1b1ecd3a5..992402d86 100644 --- a/examples/1.9.x/server-rest/examples/functions/get.md +++ b/examples/1.9.x/server-rest/examples/functions/get.md @@ -1,7 +1,8 @@ ```http GET /v1/functions/{functionId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/functions/list-deployments.md b/examples/1.9.x/server-rest/examples/functions/list-deployments.md index a7778619e..289aac916 100644 --- a/examples/1.9.x/server-rest/examples/functions/list-deployments.md +++ b/examples/1.9.x/server-rest/examples/functions/list-deployments.md @@ -1,7 +1,8 @@ ```http GET /v1/functions/{functionId}/deployments HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/functions/list-executions.md b/examples/1.9.x/server-rest/examples/functions/list-executions.md index 38e3d28bd..e4fe41b1b 100644 --- a/examples/1.9.x/server-rest/examples/functions/list-executions.md +++ b/examples/1.9.x/server-rest/examples/functions/list-executions.md @@ -1,9 +1,8 @@ ```http GET /v1/functions/{functionId}/executions HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/functions/list-runtimes.md b/examples/1.9.x/server-rest/examples/functions/list-runtimes.md index 31cc77451..a0063b0d1 100644 --- a/examples/1.9.x/server-rest/examples/functions/list-runtimes.md +++ b/examples/1.9.x/server-rest/examples/functions/list-runtimes.md @@ -1,7 +1,8 @@ ```http GET /v1/functions/runtimes HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/functions/list-specifications.md b/examples/1.9.x/server-rest/examples/functions/list-specifications.md index 902ffcd3c..e4d96d59f 100644 --- a/examples/1.9.x/server-rest/examples/functions/list-specifications.md +++ b/examples/1.9.x/server-rest/examples/functions/list-specifications.md @@ -1,7 +1,8 @@ ```http GET /v1/functions/specifications HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/functions/list-variables.md b/examples/1.9.x/server-rest/examples/functions/list-variables.md index 6b9ed06ef..3c6ae4852 100644 --- a/examples/1.9.x/server-rest/examples/functions/list-variables.md +++ b/examples/1.9.x/server-rest/examples/functions/list-variables.md @@ -1,7 +1,8 @@ ```http GET /v1/functions/{functionId}/variables HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/functions/list.md b/examples/1.9.x/server-rest/examples/functions/list.md index 59b5ddc9c..c7952cb73 100644 --- a/examples/1.9.x/server-rest/examples/functions/list.md +++ b/examples/1.9.x/server-rest/examples/functions/list.md @@ -1,7 +1,8 @@ ```http GET /v1/functions HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/functions/update-deployment-status.md b/examples/1.9.x/server-rest/examples/functions/update-deployment-status.md index cde302546..a8333b8d6 100644 --- a/examples/1.9.x/server-rest/examples/functions/update-deployment-status.md +++ b/examples/1.9.x/server-rest/examples/functions/update-deployment-status.md @@ -2,8 +2,9 @@ PATCH /v1/functions/{functionId}/deployments/{deploymentId}/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/functions/update-function-deployment.md b/examples/1.9.x/server-rest/examples/functions/update-function-deployment.md index 43a13347c..86ebac878 100644 --- a/examples/1.9.x/server-rest/examples/functions/update-function-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/update-function-deployment.md @@ -2,9 +2,13 @@ PATCH /v1/functions/{functionId}/deployment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "deploymentId": "<DEPLOYMENT_ID>" +} { "deploymentId": "<DEPLOYMENT_ID>" diff --git a/examples/1.9.x/server-rest/examples/functions/update-variable.md b/examples/1.9.x/server-rest/examples/functions/update-variable.md index ae2676f73..73b676eae 100644 --- a/examples/1.9.x/server-rest/examples/functions/update-variable.md +++ b/examples/1.9.x/server-rest/examples/functions/update-variable.md @@ -2,9 +2,15 @@ PUT /v1/functions/{functionId}/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "<KEY>", + "value": "<VALUE>", + "secret": false +} { "key": "<KEY>", diff --git a/examples/1.9.x/server-rest/examples/functions/update.md b/examples/1.9.x/server-rest/examples/functions/update.md index 487fef4fa..2b9872a7e 100644 --- a/examples/1.9.x/server-rest/examples/functions/update.md +++ b/examples/1.9.x/server-rest/examples/functions/update.md @@ -2,9 +2,33 @@ PUT /v1/functions/{functionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "runtime": "node-14.5", + "execute": ["any"], + "events": [], + "schedule": "", + "timeout": 1, + "enabled": false, + "logging": false, + "entrypoint": "<ENTRYPOINT>", + "commands": "<COMMANDS>", + "scopes": [], + "installationId": "<INSTALLATION_ID>", + "providerRepositoryId": "<PROVIDER_REPOSITORY_ID>", + "providerBranch": "<PROVIDER_BRANCH>", + "providerSilentMode": false, + "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>", + "providerBranches": [], + "providerPaths": [], + "buildSpecification": "", + "runtimeSpecification": "", + "deploymentRetention": 0 +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/graphql/mutation.md b/examples/1.9.x/server-rest/examples/graphql/mutation.md index 6d6f939a9..3885359b7 100644 --- a/examples/1.9.x/server-rest/examples/graphql/mutation.md +++ b/examples/1.9.x/server-rest/examples/graphql/mutation.md @@ -3,11 +3,13 @@ POST /v1/graphql/mutation HTTP/1.1 Host: cloud.appwrite.io X-Sdk-Graphql: true Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "query": {} +} { "query": {} diff --git a/examples/1.9.x/server-rest/examples/graphql/query.md b/examples/1.9.x/server-rest/examples/graphql/query.md index 215dcc58b..02fbb9f31 100644 --- a/examples/1.9.x/server-rest/examples/graphql/query.md +++ b/examples/1.9.x/server-rest/examples/graphql/query.md @@ -3,11 +3,13 @@ POST /v1/graphql HTTP/1.1 Host: cloud.appwrite.io X-Sdk-Graphql: true Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "query": {} +} { "query": {} diff --git a/examples/1.9.x/server-rest/examples/health/get-antivirus.md b/examples/1.9.x/server-rest/examples/health/get-antivirus.md index 5f5758ffd..31ac04a61 100644 --- a/examples/1.9.x/server-rest/examples/health/get-antivirus.md +++ b/examples/1.9.x/server-rest/examples/health/get-antivirus.md @@ -1,7 +1,8 @@ ```http GET /v1/health/anti-virus HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-audits-db.md b/examples/1.9.x/server-rest/examples/health/get-audits-db.md new file mode 100644 index 000000000..07f6121a8 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/health/get-audits-db.md @@ -0,0 +1,8 @@ +```http +GET /v1/health/audits-db HTTP/1.1 +Host: cloud.appwrite.io +Accept: application/json +X-Appwrite-Response-Format: 1.9.5 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +``` diff --git a/examples/1.9.x/server-rest/examples/health/get-cache.md b/examples/1.9.x/server-rest/examples/health/get-cache.md index 0724f821a..4082272ef 100644 --- a/examples/1.9.x/server-rest/examples/health/get-cache.md +++ b/examples/1.9.x/server-rest/examples/health/get-cache.md @@ -1,7 +1,8 @@ ```http GET /v1/health/cache HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-certificate.md b/examples/1.9.x/server-rest/examples/health/get-certificate.md index f801536fe..16212ce98 100644 --- a/examples/1.9.x/server-rest/examples/health/get-certificate.md +++ b/examples/1.9.x/server-rest/examples/health/get-certificate.md @@ -1,7 +1,8 @@ ```http GET /v1/health/certificate HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-console-pausing.md b/examples/1.9.x/server-rest/examples/health/get-console-pausing.md index cc23b7b92..cf1a18829 100644 --- a/examples/1.9.x/server-rest/examples/health/get-console-pausing.md +++ b/examples/1.9.x/server-rest/examples/health/get-console-pausing.md @@ -1,7 +1,8 @@ ```http GET /v1/health/console-pausing HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-db.md b/examples/1.9.x/server-rest/examples/health/get-db.md index 3456a29fc..e37f5718c 100644 --- a/examples/1.9.x/server-rest/examples/health/get-db.md +++ b/examples/1.9.x/server-rest/examples/health/get-db.md @@ -1,7 +1,8 @@ ```http GET /v1/health/db HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-failed-jobs.md b/examples/1.9.x/server-rest/examples/health/get-failed-jobs.md index 99a779959..f89b6c2c1 100644 --- a/examples/1.9.x/server-rest/examples/health/get-failed-jobs.md +++ b/examples/1.9.x/server-rest/examples/health/get-failed-jobs.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/failed/{name} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-pub-sub.md b/examples/1.9.x/server-rest/examples/health/get-pub-sub.md index 1ea221d62..cfb14343f 100644 --- a/examples/1.9.x/server-rest/examples/health/get-pub-sub.md +++ b/examples/1.9.x/server-rest/examples/health/get-pub-sub.md @@ -1,7 +1,8 @@ ```http GET /v1/health/pubsub HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-audits.md b/examples/1.9.x/server-rest/examples/health/get-queue-audits.md index 2fe0a3b7d..0bf305269 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-audits.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-audits.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/audits HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-builds.md b/examples/1.9.x/server-rest/examples/health/get-queue-builds.md index 6fed7799b..36dcc91f8 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-builds.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-builds.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/builds HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-certificates.md b/examples/1.9.x/server-rest/examples/health/get-queue-certificates.md index f54c77609..22a0124fe 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-certificates.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-certificates.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/certificates HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-databases.md b/examples/1.9.x/server-rest/examples/health/get-queue-databases.md index 4f0ff877c..ce4889a3b 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-databases.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-databases.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/databases HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-deletes.md b/examples/1.9.x/server-rest/examples/health/get-queue-deletes.md index 52628c792..f4727b763 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-deletes.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-deletes.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/deletes HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-functions.md b/examples/1.9.x/server-rest/examples/health/get-queue-functions.md index 90bae0662..dca18b8f4 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-functions.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-functions.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/functions HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-logs.md b/examples/1.9.x/server-rest/examples/health/get-queue-logs.md index 6e98ebe94..b6d9b8a50 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-logs.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-logs.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/logs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-mails.md b/examples/1.9.x/server-rest/examples/health/get-queue-mails.md index c56b004df..4708a4741 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-mails.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-mails.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/mails HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-messaging.md b/examples/1.9.x/server-rest/examples/health/get-queue-messaging.md index 26d9b9305..fdcf23a21 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-messaging.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-messaging.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/messaging HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-migrations.md b/examples/1.9.x/server-rest/examples/health/get-queue-migrations.md index 820ef8bbc..adbade115 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-migrations.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-migrations.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/migrations HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-stats-resources.md b/examples/1.9.x/server-rest/examples/health/get-queue-stats-resources.md index 44219eef1..4851cd55b 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-stats-resources.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-stats-resources.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/stats-resources HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-usage.md b/examples/1.9.x/server-rest/examples/health/get-queue-usage.md index 6359467ee..1c6b1b6d8 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-usage.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-usage.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/stats-usage HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-webhooks.md b/examples/1.9.x/server-rest/examples/health/get-queue-webhooks.md index fd8050c06..908f82bcc 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-webhooks.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-webhooks.md @@ -1,7 +1,8 @@ ```http GET /v1/health/queue/webhooks HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-storage-local.md b/examples/1.9.x/server-rest/examples/health/get-storage-local.md index dde11fa8f..6a4fd0805 100644 --- a/examples/1.9.x/server-rest/examples/health/get-storage-local.md +++ b/examples/1.9.x/server-rest/examples/health/get-storage-local.md @@ -1,7 +1,8 @@ ```http GET /v1/health/storage/local HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-storage.md b/examples/1.9.x/server-rest/examples/health/get-storage.md index f9e0d17a6..efef14256 100644 --- a/examples/1.9.x/server-rest/examples/health/get-storage.md +++ b/examples/1.9.x/server-rest/examples/health/get-storage.md @@ -1,7 +1,8 @@ ```http GET /v1/health/storage HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-time.md b/examples/1.9.x/server-rest/examples/health/get-time.md index 7db5414ca..bb5267ca3 100644 --- a/examples/1.9.x/server-rest/examples/health/get-time.md +++ b/examples/1.9.x/server-rest/examples/health/get-time.md @@ -1,7 +1,8 @@ ```http GET /v1/health/time HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/health/get.md b/examples/1.9.x/server-rest/examples/health/get.md index 3e407dcb8..8fedbbffc 100644 --- a/examples/1.9.x/server-rest/examples/health/get.md +++ b/examples/1.9.x/server-rest/examples/health/get.md @@ -1,7 +1,8 @@ ```http GET /v1/health HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/locale/get.md b/examples/1.9.x/server-rest/examples/locale/get.md index 28743917c..0a94eabb9 100644 --- a/examples/1.9.x/server-rest/examples/locale/get.md +++ b/examples/1.9.x/server-rest/examples/locale/get.md @@ -1,9 +1,8 @@ ```http GET /v1/locale HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/locale/list-codes.md b/examples/1.9.x/server-rest/examples/locale/list-codes.md index 0944f3179..8c3d3b0be 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-codes.md +++ b/examples/1.9.x/server-rest/examples/locale/list-codes.md @@ -1,9 +1,8 @@ ```http GET /v1/locale/codes HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/locale/list-continents.md b/examples/1.9.x/server-rest/examples/locale/list-continents.md index d19563396..65bd3de26 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-continents.md +++ b/examples/1.9.x/server-rest/examples/locale/list-continents.md @@ -1,9 +1,8 @@ ```http GET /v1/locale/continents HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/locale/list-countries-eu.md b/examples/1.9.x/server-rest/examples/locale/list-countries-eu.md index d6f6a4217..70c694303 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-countries-eu.md +++ b/examples/1.9.x/server-rest/examples/locale/list-countries-eu.md @@ -1,9 +1,8 @@ ```http GET /v1/locale/countries/eu HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/locale/list-countries-phones.md b/examples/1.9.x/server-rest/examples/locale/list-countries-phones.md index 4fdc8a32f..87d891629 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-countries-phones.md +++ b/examples/1.9.x/server-rest/examples/locale/list-countries-phones.md @@ -1,9 +1,8 @@ ```http GET /v1/locale/countries/phones HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/locale/list-countries.md b/examples/1.9.x/server-rest/examples/locale/list-countries.md index d362b24c1..1da657fa0 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-countries.md +++ b/examples/1.9.x/server-rest/examples/locale/list-countries.md @@ -1,9 +1,8 @@ ```http GET /v1/locale/countries HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/locale/list-currencies.md b/examples/1.9.x/server-rest/examples/locale/list-currencies.md index 723178cff..7aa5bf1a8 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-currencies.md +++ b/examples/1.9.x/server-rest/examples/locale/list-currencies.md @@ -1,9 +1,8 @@ ```http GET /v1/locale/currencies HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/locale/list-languages.md b/examples/1.9.x/server-rest/examples/locale/list-languages.md index 2cf86bafd..a4f74808f 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-languages.md +++ b/examples/1.9.x/server-rest/examples/locale/list-languages.md @@ -1,9 +1,8 @@ ```http GET /v1/locale/languages HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/create-apns-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-apns-provider.md index fae1e22d2..2f1453fd0 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-apns-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-apns-provider.md @@ -2,9 +2,20 @@ POST /v1/messaging/providers/apns HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "authKey": "<AUTH_KEY>", + "authKeyId": "<AUTH_KEY_ID>", + "teamId": "<TEAM_ID>", + "bundleId": "<BUNDLE_ID>", + "sandbox": false, + "enabled": false +} { "providerId": "<PROVIDER_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-email.md b/examples/1.9.x/server-rest/examples/messaging/create-email.md index 83c94a05f..975b6d326 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-email.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-email.md @@ -2,9 +2,24 @@ POST /v1/messaging/messages/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "messageId": "<MESSAGE_ID>", + "subject": "<SUBJECT>", + "content": "<CONTENT>", + "topics": [], + "users": [], + "targets": [], + "cc": [], + "bcc": [], + "attachments": [], + "draft": false, + "html": false, + "scheduledAt": "2020-10-15T06:38:00.000+00:00" +} { "messageId": "<MESSAGE_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-fcm-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-fcm-provider.md index c71e17eb9..87037a77a 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-fcm-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-fcm-provider.md @@ -2,9 +2,16 @@ POST /v1/messaging/providers/fcm HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "serviceAccountJSON": {}, + "enabled": false +} { "providerId": "<PROVIDER_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-mailgun-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-mailgun-provider.md index 901461bcd..b785e2924 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-mailgun-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-mailgun-provider.md @@ -2,9 +2,22 @@ POST /v1/messaging/providers/mailgun HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "apiKey": "<API_KEY>", + "domain": "<DOMAIN>", + "isEuRegion": false, + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "email@example.com", + "enabled": false +} { "providerId": "<PROVIDER_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-msg-91-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-msg-91-provider.md index da88e1b91..f57398b96 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-msg-91-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-msg-91-provider.md @@ -2,9 +2,18 @@ POST /v1/messaging/providers/msg91 HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "templateId": "<TEMPLATE_ID>", + "senderId": "<SENDER_ID>", + "authKey": "<AUTH_KEY>", + "enabled": false +} { "providerId": "<PROVIDER_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-push.md b/examples/1.9.x/server-rest/examples/messaging/create-push.md index 0d7c93152..ea9dd29da 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-push.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-push.md @@ -2,9 +2,31 @@ POST /v1/messaging/messages/push HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "messageId": "<MESSAGE_ID>", + "title": "<TITLE>", + "body": "<BODY>", + "topics": [], + "users": [], + "targets": [], + "data": {}, + "action": "<ACTION>", + "image": "<ID1:ID2>", + "icon": "<ICON>", + "sound": "<SOUND>", + "color": "<COLOR>", + "tag": "<TAG>", + "badge": 0, + "draft": false, + "scheduledAt": "2020-10-15T06:38:00.000+00:00", + "contentAvailable": false, + "critical": false, + "priority": "normal" +} { "messageId": "<MESSAGE_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-resend-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-resend-provider.md index 491c49ce6..ee5d4ce05 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-resend-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-resend-provider.md @@ -2,9 +2,20 @@ POST /v1/messaging/providers/resend HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "apiKey": "<API_KEY>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "email@example.com", + "enabled": false +} { "providerId": "<PROVIDER_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-sendgrid-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-sendgrid-provider.md index 378c9a68c..8e676d58c 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-sendgrid-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-sendgrid-provider.md @@ -2,9 +2,20 @@ POST /v1/messaging/providers/sendgrid HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "apiKey": "<API_KEY>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "email@example.com", + "enabled": false +} { "providerId": "<PROVIDER_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-ses-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..94bc57ff5 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/messaging/create-ses-provider.md @@ -0,0 +1,34 @@ +```http +POST /v1/messaging/providers/ses HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +Accept: application/json +X-Appwrite-Response-Format: 1.9.5 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "accessKey": "<ACCESS_KEY>", + "secretKey": "<SECRET_KEY>", + "region": "<REGION>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "email@example.com", + "enabled": false +} + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "accessKey": "<ACCESS_KEY>", + "secretKey": "<SECRET_KEY>", + "region": "<REGION>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "email@example.com", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/messaging/create-sms.md b/examples/1.9.x/server-rest/examples/messaging/create-sms.md index e1dea383b..ebe2f35a2 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-sms.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-sms.md @@ -2,9 +2,19 @@ POST /v1/messaging/messages/sms HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "messageId": "<MESSAGE_ID>", + "content": "<CONTENT>", + "topics": [], + "users": [], + "targets": [], + "draft": false, + "scheduledAt": "2020-10-15T06:38:00.000+00:00" +} { "messageId": "<MESSAGE_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-smtp-provider.md index 668214644..136b3d57e 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-smtp-provider.md @@ -2,9 +2,9 @@ POST /v1/messaging/providers/smtp HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> { "providerId": "<PROVIDER_ID>", @@ -12,7 +12,24 @@ X-Appwrite-Key: <YOUR_API_KEY> "host": "<HOST>", "port": 1, "username": "<USERNAME>", - "password": "<PASSWORD>", + "password": "password", + "encryption": "none", + "autoTLS": false, + "mailer": "<MAILER>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "email@example.com", + "enabled": false +} + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "host": "<HOST>", + "port": 1, + "username": "<USERNAME>", + "password": "password", "encryption": "none", "autoTLS": false, "mailer": "<MAILER>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-subscriber.md b/examples/1.9.x/server-rest/examples/messaging/create-subscriber.md index 6b7c31174..b024bf092 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-subscriber.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-subscriber.md @@ -2,11 +2,14 @@ POST /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-JWT: <YOUR_JWT> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "subscriberId": "<SUBSCRIBER_ID>", + "targetId": "<TARGET_ID>" +} { "subscriberId": "<SUBSCRIBER_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-telesign-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-telesign-provider.md index a7a5d5198..a60302c99 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-telesign-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-telesign-provider.md @@ -2,9 +2,18 @@ POST /v1/messaging/providers/telesign HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "from": "+12065550100", + "customerId": "<CUSTOMER_ID>", + "apiKey": "<API_KEY>", + "enabled": false +} { "providerId": "<PROVIDER_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-textmagic-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-textmagic-provider.md index 007177f36..ee9cf564e 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-textmagic-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-textmagic-provider.md @@ -2,9 +2,18 @@ POST /v1/messaging/providers/textmagic HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "from": "+12065550100", + "username": "<USERNAME>", + "apiKey": "<API_KEY>", + "enabled": false +} { "providerId": "<PROVIDER_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-topic.md b/examples/1.9.x/server-rest/examples/messaging/create-topic.md index 22ca645cb..638a704f9 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-topic.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-topic.md @@ -2,9 +2,15 @@ POST /v1/messaging/topics HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "topicId": "<TOPIC_ID>", + "name": "<NAME>", + "subscribe": ["any"] +} { "topicId": "<TOPIC_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-twilio-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-twilio-provider.md index 67b13d284..06f917cfc 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-twilio-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-twilio-provider.md @@ -2,9 +2,18 @@ POST /v1/messaging/providers/twilio HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "from": "+12065550100", + "accountSid": "<ACCOUNT_SID>", + "authToken": "<AUTH_TOKEN>", + "enabled": false +} { "providerId": "<PROVIDER_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/create-vonage-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-vonage-provider.md index 7ad02272b..568c76c72 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-vonage-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-vonage-provider.md @@ -2,9 +2,18 @@ POST /v1/messaging/providers/vonage HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "from": "+12065550100", + "apiKey": "<API_KEY>", + "apiSecret": "<API_SECRET>", + "enabled": false +} { "providerId": "<PROVIDER_ID>", diff --git a/examples/1.9.x/server-rest/examples/messaging/delete-provider.md b/examples/1.9.x/server-rest/examples/messaging/delete-provider.md index 7d807e36e..a89342265 100644 --- a/examples/1.9.x/server-rest/examples/messaging/delete-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/delete-provider.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/delete-subscriber.md b/examples/1.9.x/server-rest/examples/messaging/delete-subscriber.md index 634e31d1c..3c0e3402c 100644 --- a/examples/1.9.x/server-rest/examples/messaging/delete-subscriber.md +++ b/examples/1.9.x/server-rest/examples/messaging/delete-subscriber.md @@ -4,8 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-JWT: <YOUR_JWT> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/delete-topic.md b/examples/1.9.x/server-rest/examples/messaging/delete-topic.md index 28120d847..c5df97f75 100644 --- a/examples/1.9.x/server-rest/examples/messaging/delete-topic.md +++ b/examples/1.9.x/server-rest/examples/messaging/delete-topic.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/delete.md b/examples/1.9.x/server-rest/examples/messaging/delete.md index d7f8e5690..168663cfb 100644 --- a/examples/1.9.x/server-rest/examples/messaging/delete.md +++ b/examples/1.9.x/server-rest/examples/messaging/delete.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/get-message.md b/examples/1.9.x/server-rest/examples/messaging/get-message.md index eaa76ea7c..660ca05d9 100644 --- a/examples/1.9.x/server-rest/examples/messaging/get-message.md +++ b/examples/1.9.x/server-rest/examples/messaging/get-message.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/messages/{messageId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/get-provider.md b/examples/1.9.x/server-rest/examples/messaging/get-provider.md index 2ebfef568..182e78f0d 100644 --- a/examples/1.9.x/server-rest/examples/messaging/get-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/get-provider.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/providers/{providerId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/get-subscriber.md b/examples/1.9.x/server-rest/examples/messaging/get-subscriber.md index 1081ddd1a..0ba0bbb22 100644 --- a/examples/1.9.x/server-rest/examples/messaging/get-subscriber.md +++ b/examples/1.9.x/server-rest/examples/messaging/get-subscriber.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/get-topic.md b/examples/1.9.x/server-rest/examples/messaging/get-topic.md index 105b6b57c..3d5125496 100644 --- a/examples/1.9.x/server-rest/examples/messaging/get-topic.md +++ b/examples/1.9.x/server-rest/examples/messaging/get-topic.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/topics/{topicId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-message-logs.md b/examples/1.9.x/server-rest/examples/messaging/list-message-logs.md index 4a972bb1d..0bf87e6bd 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-message-logs.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-message-logs.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/messages/{messageId}/logs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-messages.md b/examples/1.9.x/server-rest/examples/messaging/list-messages.md index 6221e155f..6e3ff7365 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-messages.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-messages.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/messages HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-provider-logs.md b/examples/1.9.x/server-rest/examples/messaging/list-provider-logs.md index 4e2544090..1c50045a4 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-provider-logs.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-provider-logs.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/providers/{providerId}/logs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-providers.md b/examples/1.9.x/server-rest/examples/messaging/list-providers.md index 99c30fed2..fc5acc342 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-providers.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-providers.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/providers HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-subscriber-logs.md b/examples/1.9.x/server-rest/examples/messaging/list-subscriber-logs.md index 37d8ae232..a7c06e049 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-subscriber-logs.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-subscriber-logs.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/subscribers/{subscriberId}/logs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-subscribers.md b/examples/1.9.x/server-rest/examples/messaging/list-subscribers.md index d871fcae2..ca6b10a10 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-subscribers.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-subscribers.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-targets.md b/examples/1.9.x/server-rest/examples/messaging/list-targets.md index 12f5b5ac8..8802c65f9 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-targets.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-targets.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/messages/{messageId}/targets HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-topic-logs.md b/examples/1.9.x/server-rest/examples/messaging/list-topic-logs.md index a8a1009a2..3c3f5f5f4 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-topic-logs.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-topic-logs.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/topics/{topicId}/logs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-topics.md b/examples/1.9.x/server-rest/examples/messaging/list-topics.md index 99ace4b61..956ec53f0 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-topics.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-topics.md @@ -1,7 +1,8 @@ ```http GET /v1/messaging/topics HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/update-apns-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-apns-provider.md index 9be2943c3..527201f3c 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-apns-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-apns-provider.md @@ -2,9 +2,19 @@ PATCH /v1/messaging/providers/apns/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "authKey": "<AUTH_KEY>", + "authKeyId": "<AUTH_KEY_ID>", + "teamId": "<TEAM_ID>", + "bundleId": "<BUNDLE_ID>", + "sandbox": false +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/messaging/update-email.md b/examples/1.9.x/server-rest/examples/messaging/update-email.md index 31797753d..575208197 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-email.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-email.md @@ -2,9 +2,23 @@ PATCH /v1/messaging/messages/email/{messageId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "topics": [], + "users": [], + "targets": [], + "subject": "<SUBJECT>", + "content": "<CONTENT>", + "draft": false, + "html": false, + "cc": [], + "bcc": [], + "scheduledAt": "2020-10-15T06:38:00.000+00:00", + "attachments": [] +} { "topics": [], diff --git a/examples/1.9.x/server-rest/examples/messaging/update-fcm-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-fcm-provider.md index e3f53564b..079bcf929 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-fcm-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-fcm-provider.md @@ -2,9 +2,15 @@ PATCH /v1/messaging/providers/fcm/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "serviceAccountJSON": {} +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/messaging/update-mailgun-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-mailgun-provider.md index 7b55df758..783c3b400 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-mailgun-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-mailgun-provider.md @@ -2,9 +2,21 @@ PATCH /v1/messaging/providers/mailgun/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "apiKey": "<API_KEY>", + "domain": "<DOMAIN>", + "isEuRegion": false, + "enabled": false, + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "<REPLY_TO_EMAIL>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/messaging/update-msg-91-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-msg-91-provider.md index ab1018bea..a6ad16a0d 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-msg-91-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-msg-91-provider.md @@ -2,9 +2,17 @@ PATCH /v1/messaging/providers/msg91/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "templateId": "<TEMPLATE_ID>", + "senderId": "<SENDER_ID>", + "authKey": "<AUTH_KEY>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/messaging/update-push.md b/examples/1.9.x/server-rest/examples/messaging/update-push.md index 73f4302e7..628ddcdfb 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-push.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-push.md @@ -2,9 +2,30 @@ PATCH /v1/messaging/messages/push/{messageId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "topics": [], + "users": [], + "targets": [], + "title": "<TITLE>", + "body": "<BODY>", + "data": {}, + "action": "<ACTION>", + "image": "<ID1:ID2>", + "icon": "<ICON>", + "sound": "<SOUND>", + "color": "<COLOR>", + "tag": "<TAG>", + "badge": 0, + "draft": false, + "scheduledAt": "2020-10-15T06:38:00.000+00:00", + "contentAvailable": false, + "critical": false, + "priority": "normal" +} { "topics": [], diff --git a/examples/1.9.x/server-rest/examples/messaging/update-resend-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-resend-provider.md index 3b12e0218..184ee974a 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-resend-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-resend-provider.md @@ -2,9 +2,19 @@ PATCH /v1/messaging/providers/resend/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "apiKey": "<API_KEY>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "<REPLY_TO_EMAIL>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/messaging/update-sendgrid-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-sendgrid-provider.md index 3210049f0..5b0c8ed31 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-sendgrid-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-sendgrid-provider.md @@ -2,9 +2,19 @@ PATCH /v1/messaging/providers/sendgrid/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "apiKey": "<API_KEY>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "<REPLY_TO_EMAIL>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/messaging/update-ses-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..7cf0346f8 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/messaging/update-ses-provider.md @@ -0,0 +1,32 @@ +```http +PATCH /v1/messaging/providers/ses/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +Accept: application/json +X-Appwrite-Response-Format: 1.9.5 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "name": "<NAME>", + "enabled": false, + "accessKey": "<ACCESS_KEY>", + "secretKey": "<SECRET_KEY>", + "region": "<REGION>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "<REPLY_TO_EMAIL>" +} + +{ + "name": "<NAME>", + "enabled": false, + "accessKey": "<ACCESS_KEY>", + "secretKey": "<SECRET_KEY>", + "region": "<REGION>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "<REPLY_TO_EMAIL>" +} +``` diff --git a/examples/1.9.x/server-rest/examples/messaging/update-sms.md b/examples/1.9.x/server-rest/examples/messaging/update-sms.md index 028455dac..0a8ee809a 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-sms.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-sms.md @@ -2,9 +2,18 @@ PATCH /v1/messaging/messages/sms/{messageId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "topics": [], + "users": [], + "targets": [], + "content": "<CONTENT>", + "draft": false, + "scheduledAt": "2020-10-15T06:38:00.000+00:00" +} { "topics": [], diff --git a/examples/1.9.x/server-rest/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-smtp-provider.md index 713b096a4..cc9f6628b 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-smtp-provider.md @@ -2,16 +2,32 @@ PATCH /v1/messaging/providers/smtp/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> { "name": "<NAME>", "host": "<HOST>", "port": 1, "username": "<USERNAME>", - "password": "<PASSWORD>", + "password": "password", + "encryption": "none", + "autoTLS": false, + "mailer": "<MAILER>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "<REPLY_TO_EMAIL>", + "enabled": false +} + +{ + "name": "<NAME>", + "host": "<HOST>", + "port": 1, + "username": "<USERNAME>", + "password": "password", "encryption": "none", "autoTLS": false, "mailer": "<MAILER>", diff --git a/examples/1.9.x/server-rest/examples/messaging/update-telesign-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-telesign-provider.md index df6e0e209..2af3b58cf 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-telesign-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-telesign-provider.md @@ -2,9 +2,17 @@ PATCH /v1/messaging/providers/telesign/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "customerId": "<CUSTOMER_ID>", + "apiKey": "<API_KEY>", + "from": "<FROM>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/messaging/update-textmagic-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-textmagic-provider.md index 05796c083..30edf7528 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-textmagic-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-textmagic-provider.md @@ -2,9 +2,17 @@ PATCH /v1/messaging/providers/textmagic/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "username": "<USERNAME>", + "apiKey": "<API_KEY>", + "from": "<FROM>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/messaging/update-topic.md b/examples/1.9.x/server-rest/examples/messaging/update-topic.md index 0490cbfc6..5a7799b58 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-topic.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-topic.md @@ -2,9 +2,14 @@ PATCH /v1/messaging/topics/{topicId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "subscribe": ["any"] +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/messaging/update-twilio-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-twilio-provider.md index 577faf055..9d607a55c 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-twilio-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-twilio-provider.md @@ -2,9 +2,17 @@ PATCH /v1/messaging/providers/twilio/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "accountSid": "<ACCOUNT_SID>", + "authToken": "<AUTH_TOKEN>", + "from": "<FROM>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/messaging/update-vonage-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-vonage-provider.md index c7171876d..702080c8d 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-vonage-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-vonage-provider.md @@ -2,9 +2,17 @@ PATCH /v1/messaging/providers/vonage/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "apiKey": "<API_KEY>", + "apiSecret": "<API_SECRET>", + "from": "<FROM>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/organization/create-key.md b/examples/1.9.x/server-rest/examples/organization/create-key.md index acbfcb4f8..40b78ed2e 100644 --- a/examples/1.9.x/server-rest/examples/organization/create-key.md +++ b/examples/1.9.x/server-rest/examples/organization/create-key.md @@ -2,9 +2,16 @@ POST /v1/organization/keys HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "keyId": "<KEY_ID>", + "name": "<NAME>", + "scopes": [], + "expire": "2020-10-15T06:38:00.000+00:00" +} { "keyId": "<KEY_ID>", diff --git a/examples/1.9.x/server-rest/examples/organization/create-project.md b/examples/1.9.x/server-rest/examples/organization/create-project.md index 24cd87251..43047c04e 100644 --- a/examples/1.9.x/server-rest/examples/organization/create-project.md +++ b/examples/1.9.x/server-rest/examples/organization/create-project.md @@ -2,9 +2,15 @@ POST /v1/organization/projects HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "projectId": "", + "name": "<NAME>", + "region": "fra" +} { "projectId": "", diff --git a/examples/1.9.x/server-rest/examples/organization/delete-key.md b/examples/1.9.x/server-rest/examples/organization/delete-key.md index aab1ef88c..3a24fadba 100644 --- a/examples/1.9.x/server-rest/examples/organization/delete-key.md +++ b/examples/1.9.x/server-rest/examples/organization/delete-key.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/organization/delete-project.md b/examples/1.9.x/server-rest/examples/organization/delete-project.md index 92cf6850a..9a2b20548 100644 --- a/examples/1.9.x/server-rest/examples/organization/delete-project.md +++ b/examples/1.9.x/server-rest/examples/organization/delete-project.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/organization/get-key.md b/examples/1.9.x/server-rest/examples/organization/get-key.md index b4d8fa2e0..18c560f34 100644 --- a/examples/1.9.x/server-rest/examples/organization/get-key.md +++ b/examples/1.9.x/server-rest/examples/organization/get-key.md @@ -1,7 +1,8 @@ ```http GET /v1/organization/keys/{keyId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/organization/get-project.md b/examples/1.9.x/server-rest/examples/organization/get-project.md index cc4a30578..ea1795025 100644 --- a/examples/1.9.x/server-rest/examples/organization/get-project.md +++ b/examples/1.9.x/server-rest/examples/organization/get-project.md @@ -3,5 +3,4 @@ GET /v1/organization/projects/{projectId} HTTP/1.1 Host: cloud.appwrite.io X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/organization/list-keys.md b/examples/1.9.x/server-rest/examples/organization/list-keys.md index 7c4809086..d3b369b9f 100644 --- a/examples/1.9.x/server-rest/examples/organization/list-keys.md +++ b/examples/1.9.x/server-rest/examples/organization/list-keys.md @@ -1,7 +1,8 @@ ```http GET /v1/organization/keys HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/organization/list-projects.md b/examples/1.9.x/server-rest/examples/organization/list-projects.md index d3edd593d..175264b54 100644 --- a/examples/1.9.x/server-rest/examples/organization/list-projects.md +++ b/examples/1.9.x/server-rest/examples/organization/list-projects.md @@ -1,7 +1,8 @@ ```http GET /v1/organization/projects HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/organization/update-key.md b/examples/1.9.x/server-rest/examples/organization/update-key.md index caf6209b0..d1256dc98 100644 --- a/examples/1.9.x/server-rest/examples/organization/update-key.md +++ b/examples/1.9.x/server-rest/examples/organization/update-key.md @@ -2,9 +2,15 @@ PUT /v1/organization/keys/{keyId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "scopes": [], + "expire": "2020-10-15T06:38:00.000+00:00" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/organization/update-project.md b/examples/1.9.x/server-rest/examples/organization/update-project.md index 33aeaac5a..caf534da8 100644 --- a/examples/1.9.x/server-rest/examples/organization/update-project.md +++ b/examples/1.9.x/server-rest/examples/organization/update-project.md @@ -2,9 +2,13 @@ PATCH /v1/organization/projects/{projectId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>" +} { "name": "<NAME>" diff --git a/examples/1.9.x/server-rest/examples/presences/delete.md b/examples/1.9.x/server-rest/examples/presences/delete.md index ca9314521..e8360375a 100644 --- a/examples/1.9.x/server-rest/examples/presences/delete.md +++ b/examples/1.9.x/server-rest/examples/presences/delete.md @@ -4,8 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/presences/get.md b/examples/1.9.x/server-rest/examples/presences/get.md index f30ddaacf..d7a45180b 100644 --- a/examples/1.9.x/server-rest/examples/presences/get.md +++ b/examples/1.9.x/server-rest/examples/presences/get.md @@ -1,9 +1,8 @@ ```http GET /v1/presences/{presenceId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/presences/list.md b/examples/1.9.x/server-rest/examples/presences/list.md index b72c9a3de..d64d29391 100644 --- a/examples/1.9.x/server-rest/examples/presences/list.md +++ b/examples/1.9.x/server-rest/examples/presences/list.md @@ -1,9 +1,8 @@ ```http GET /v1/presences HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/presences/update.md b/examples/1.9.x/server-rest/examples/presences/update.md index 03afb4367..f10b19c04 100644 --- a/examples/1.9.x/server-rest/examples/presences/update.md +++ b/examples/1.9.x/server-rest/examples/presences/update.md @@ -2,9 +2,18 @@ PATCH /v1/presences/{presenceId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: + +{ + "userId": "<USER_ID>", + "status": "<STATUS>", + "expiresAt": "2020-10-15T06:38:00.000+00:00", + "metadata": {}, + "permissions": ["read(\"any\")"], + "purge": false +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/presences/upsert.md b/examples/1.9.x/server-rest/examples/presences/upsert.md index 0336a5541..cd2fd7980 100644 --- a/examples/1.9.x/server-rest/examples/presences/upsert.md +++ b/examples/1.9.x/server-rest/examples/presences/upsert.md @@ -2,9 +2,17 @@ PUT /v1/presences/{presenceId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: + +{ + "userId": "<USER_ID>", + "status": "<STATUS>", + "permissions": ["read(\"any\")"], + "expiresAt": "2020-10-15T06:38:00.000+00:00", + "metadata": {} +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/create-android-platform.md b/examples/1.9.x/server-rest/examples/project/create-android-platform.md index ecf27c42e..b006d1218 100644 --- a/examples/1.9.x/server-rest/examples/project/create-android-platform.md +++ b/examples/1.9.x/server-rest/examples/project/create-android-platform.md @@ -2,9 +2,15 @@ POST /v1/project/platforms/android HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "platformId": "<PLATFORM_ID>", + "name": "<NAME>", + "applicationId": "<APPLICATION_ID>" +} { "platformId": "<PLATFORM_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/create-apple-platform.md b/examples/1.9.x/server-rest/examples/project/create-apple-platform.md index 41cc0546b..a23958d8d 100644 --- a/examples/1.9.x/server-rest/examples/project/create-apple-platform.md +++ b/examples/1.9.x/server-rest/examples/project/create-apple-platform.md @@ -2,9 +2,15 @@ POST /v1/project/platforms/apple HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "platformId": "<PLATFORM_ID>", + "name": "<NAME>", + "bundleIdentifier": "<BUNDLE_IDENTIFIER>" +} { "platformId": "<PLATFORM_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-rest/examples/project/create-ephemeral-key.md index e5563560b..0957cf52c 100644 --- a/examples/1.9.x/server-rest/examples/project/create-ephemeral-key.md +++ b/examples/1.9.x/server-rest/examples/project/create-ephemeral-key.md @@ -2,9 +2,14 @@ POST /v1/project/keys/ephemeral HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "scopes": [], + "duration": 600 +} { "scopes": [], diff --git a/examples/1.9.x/server-rest/examples/project/create-key.md b/examples/1.9.x/server-rest/examples/project/create-key.md index 290c9efb8..2395b1e60 100644 --- a/examples/1.9.x/server-rest/examples/project/create-key.md +++ b/examples/1.9.x/server-rest/examples/project/create-key.md @@ -2,9 +2,16 @@ POST /v1/project/keys HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "keyId": "<KEY_ID>", + "name": "<NAME>", + "scopes": [], + "expire": "2020-10-15T06:38:00.000+00:00" +} { "keyId": "<KEY_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/create-linux-platform.md b/examples/1.9.x/server-rest/examples/project/create-linux-platform.md index 601a7f94b..607f44120 100644 --- a/examples/1.9.x/server-rest/examples/project/create-linux-platform.md +++ b/examples/1.9.x/server-rest/examples/project/create-linux-platform.md @@ -2,9 +2,15 @@ POST /v1/project/platforms/linux HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "platformId": "<PLATFORM_ID>", + "name": "<NAME>", + "packageName": "<PACKAGE_NAME>" +} { "platformId": "<PLATFORM_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/create-mock-phone.md b/examples/1.9.x/server-rest/examples/project/create-mock-phone.md index 49cfa8de1..2c500d512 100644 --- a/examples/1.9.x/server-rest/examples/project/create-mock-phone.md +++ b/examples/1.9.x/server-rest/examples/project/create-mock-phone.md @@ -2,9 +2,14 @@ POST /v1/project/mock-phones HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "number": "+12065550100", + "otp": "<OTP>" +} { "number": "+12065550100", diff --git a/examples/1.9.x/server-rest/examples/project/create-smtp-test.md b/examples/1.9.x/server-rest/examples/project/create-smtp-test.md index 019c03358..c9a766797 100644 --- a/examples/1.9.x/server-rest/examples/project/create-smtp-test.md +++ b/examples/1.9.x/server-rest/examples/project/create-smtp-test.md @@ -4,7 +4,6 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> { "emails": [] diff --git a/examples/1.9.x/server-rest/examples/project/create-variable.md b/examples/1.9.x/server-rest/examples/project/create-variable.md index 3c2d1a4af..893991481 100644 --- a/examples/1.9.x/server-rest/examples/project/create-variable.md +++ b/examples/1.9.x/server-rest/examples/project/create-variable.md @@ -2,9 +2,16 @@ POST /v1/project/variables HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "variableId": "<VARIABLE_ID>", + "key": "<KEY>", + "value": "<VALUE>", + "secret": false +} { "variableId": "<VARIABLE_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/create-web-platform.md b/examples/1.9.x/server-rest/examples/project/create-web-platform.md index c01e3d4a4..ca2fdf4c2 100644 --- a/examples/1.9.x/server-rest/examples/project/create-web-platform.md +++ b/examples/1.9.x/server-rest/examples/project/create-web-platform.md @@ -2,9 +2,15 @@ POST /v1/project/platforms/web HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "platformId": "<PLATFORM_ID>", + "name": "<NAME>", + "hostname": "app.example.com" +} { "platformId": "<PLATFORM_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/create-windows-platform.md b/examples/1.9.x/server-rest/examples/project/create-windows-platform.md index 4c73dd5a0..65c3a909a 100644 --- a/examples/1.9.x/server-rest/examples/project/create-windows-platform.md +++ b/examples/1.9.x/server-rest/examples/project/create-windows-platform.md @@ -2,9 +2,15 @@ POST /v1/project/platforms/windows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "platformId": "<PLATFORM_ID>", + "name": "<NAME>", + "packageIdentifierName": "<PACKAGE_IDENTIFIER_NAME>" +} { "platformId": "<PLATFORM_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/delete-key.md b/examples/1.9.x/server-rest/examples/project/delete-key.md index 455e5b8cc..4fc1574b3 100644 --- a/examples/1.9.x/server-rest/examples/project/delete-key.md +++ b/examples/1.9.x/server-rest/examples/project/delete-key.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/project/delete-mock-phone.md b/examples/1.9.x/server-rest/examples/project/delete-mock-phone.md index 539d1978f..cd01b440a 100644 --- a/examples/1.9.x/server-rest/examples/project/delete-mock-phone.md +++ b/examples/1.9.x/server-rest/examples/project/delete-mock-phone.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/project/delete-platform.md b/examples/1.9.x/server-rest/examples/project/delete-platform.md index 6ffb21fd0..1045f74b2 100644 --- a/examples/1.9.x/server-rest/examples/project/delete-platform.md +++ b/examples/1.9.x/server-rest/examples/project/delete-platform.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/project/delete-variable.md b/examples/1.9.x/server-rest/examples/project/delete-variable.md index b79ae90ee..8482888a3 100644 --- a/examples/1.9.x/server-rest/examples/project/delete-variable.md +++ b/examples/1.9.x/server-rest/examples/project/delete-variable.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/project/delete.md b/examples/1.9.x/server-rest/examples/project/delete.md index 62c50cf3f..3d85472d2 100644 --- a/examples/1.9.x/server-rest/examples/project/delete.md +++ b/examples/1.9.x/server-rest/examples/project/delete.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/project/get-email-template.md b/examples/1.9.x/server-rest/examples/project/get-email-template.md index 76ad75133..668059abd 100644 --- a/examples/1.9.x/server-rest/examples/project/get-email-template.md +++ b/examples/1.9.x/server-rest/examples/project/get-email-template.md @@ -1,7 +1,8 @@ ```http GET /v1/project/templates/email/{templateId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/get-key.md b/examples/1.9.x/server-rest/examples/project/get-key.md index eabc4259c..4d4b39a25 100644 --- a/examples/1.9.x/server-rest/examples/project/get-key.md +++ b/examples/1.9.x/server-rest/examples/project/get-key.md @@ -1,7 +1,8 @@ ```http GET /v1/project/keys/{keyId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/get-mock-phone.md b/examples/1.9.x/server-rest/examples/project/get-mock-phone.md index a861551eb..66415b78d 100644 --- a/examples/1.9.x/server-rest/examples/project/get-mock-phone.md +++ b/examples/1.9.x/server-rest/examples/project/get-mock-phone.md @@ -1,7 +1,8 @@ ```http GET /v1/project/mock-phones/{number} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-rest/examples/project/get-o-auth-2-provider.md index f0427c532..204c26dd3 100644 --- a/examples/1.9.x/server-rest/examples/project/get-o-auth-2-provider.md +++ b/examples/1.9.x/server-rest/examples/project/get-o-auth-2-provider.md @@ -1,7 +1,8 @@ ```http GET /v1/project/oauth2/{providerId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/get-platform.md b/examples/1.9.x/server-rest/examples/project/get-platform.md index afec8f6c7..44024a406 100644 --- a/examples/1.9.x/server-rest/examples/project/get-platform.md +++ b/examples/1.9.x/server-rest/examples/project/get-platform.md @@ -1,7 +1,8 @@ ```http GET /v1/project/platforms/{platformId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/get-policy.md b/examples/1.9.x/server-rest/examples/project/get-policy.md index 0440b3b74..0bd047aae 100644 --- a/examples/1.9.x/server-rest/examples/project/get-policy.md +++ b/examples/1.9.x/server-rest/examples/project/get-policy.md @@ -1,7 +1,8 @@ ```http GET /v1/project/policies/{policyId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/get-variable.md b/examples/1.9.x/server-rest/examples/project/get-variable.md index cb8926ae7..9303de46d 100644 --- a/examples/1.9.x/server-rest/examples/project/get-variable.md +++ b/examples/1.9.x/server-rest/examples/project/get-variable.md @@ -1,7 +1,8 @@ ```http GET /v1/project/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/get.md b/examples/1.9.x/server-rest/examples/project/get.md index a9e13f243..67b5af4cd 100644 --- a/examples/1.9.x/server-rest/examples/project/get.md +++ b/examples/1.9.x/server-rest/examples/project/get.md @@ -3,5 +3,4 @@ GET /v1/project HTTP/1.1 Host: cloud.appwrite.io X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/project/list-email-templates.md b/examples/1.9.x/server-rest/examples/project/list-email-templates.md index 7e1be51e2..61100625a 100644 --- a/examples/1.9.x/server-rest/examples/project/list-email-templates.md +++ b/examples/1.9.x/server-rest/examples/project/list-email-templates.md @@ -1,7 +1,8 @@ ```http GET /v1/project/templates/email HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/list-keys.md b/examples/1.9.x/server-rest/examples/project/list-keys.md index c43c355ac..c319abb24 100644 --- a/examples/1.9.x/server-rest/examples/project/list-keys.md +++ b/examples/1.9.x/server-rest/examples/project/list-keys.md @@ -1,7 +1,8 @@ ```http GET /v1/project/keys HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/list-mock-phones.md b/examples/1.9.x/server-rest/examples/project/list-mock-phones.md index 45adc866b..5446b8519 100644 --- a/examples/1.9.x/server-rest/examples/project/list-mock-phones.md +++ b/examples/1.9.x/server-rest/examples/project/list-mock-phones.md @@ -1,7 +1,8 @@ ```http GET /v1/project/mock-phones HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-rest/examples/project/list-o-auth-2-providers.md index f10c82c97..a92897cab 100644 --- a/examples/1.9.x/server-rest/examples/project/list-o-auth-2-providers.md +++ b/examples/1.9.x/server-rest/examples/project/list-o-auth-2-providers.md @@ -1,7 +1,8 @@ ```http GET /v1/project/oauth2 HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/list-platforms.md b/examples/1.9.x/server-rest/examples/project/list-platforms.md index cd27e445f..98685fb4a 100644 --- a/examples/1.9.x/server-rest/examples/project/list-platforms.md +++ b/examples/1.9.x/server-rest/examples/project/list-platforms.md @@ -1,7 +1,8 @@ ```http GET /v1/project/platforms HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/list-policies.md b/examples/1.9.x/server-rest/examples/project/list-policies.md index 4ddbd3c96..c981840b4 100644 --- a/examples/1.9.x/server-rest/examples/project/list-policies.md +++ b/examples/1.9.x/server-rest/examples/project/list-policies.md @@ -1,7 +1,8 @@ ```http GET /v1/project/policies HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/list-variables.md b/examples/1.9.x/server-rest/examples/project/list-variables.md index f61b1360e..bd0f4cf21 100644 --- a/examples/1.9.x/server-rest/examples/project/list-variables.md +++ b/examples/1.9.x/server-rest/examples/project/list-variables.md @@ -1,7 +1,8 @@ ```http GET /v1/project/variables HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/project/update-android-platform.md b/examples/1.9.x/server-rest/examples/project/update-android-platform.md index 80e63ad58..dcea04237 100644 --- a/examples/1.9.x/server-rest/examples/project/update-android-platform.md +++ b/examples/1.9.x/server-rest/examples/project/update-android-platform.md @@ -2,9 +2,14 @@ PUT /v1/project/platforms/android/{platformId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "applicationId": "<APPLICATION_ID>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/project/update-apple-platform.md b/examples/1.9.x/server-rest/examples/project/update-apple-platform.md index d08225b65..ab9adc13c 100644 --- a/examples/1.9.x/server-rest/examples/project/update-apple-platform.md +++ b/examples/1.9.x/server-rest/examples/project/update-apple-platform.md @@ -2,9 +2,14 @@ PUT /v1/project/platforms/apple/{platformId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "bundleIdentifier": "<BUNDLE_IDENTIFIER>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/project/update-auth-method.md b/examples/1.9.x/server-rest/examples/project/update-auth-method.md index 4c5c817c4..6bb32f001 100644 --- a/examples/1.9.x/server-rest/examples/project/update-auth-method.md +++ b/examples/1.9.x/server-rest/examples/project/update-auth-method.md @@ -2,9 +2,13 @@ PATCH /v1/project/auth-methods/{methodId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "enabled": false +} { "enabled": false diff --git a/examples/1.9.x/server-rest/examples/project/update-deny-aliased-email-policy.md b/examples/1.9.x/server-rest/examples/project/update-deny-aliased-email-policy.md index dd82dc0bf..2b6a3676a 100644 --- a/examples/1.9.x/server-rest/examples/project/update-deny-aliased-email-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-deny-aliased-email-policy.md @@ -2,9 +2,13 @@ PATCH /v1/project/policies/deny-aliased-email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "enabled": false +} { "enabled": false diff --git a/examples/1.9.x/server-rest/examples/project/update-deny-disposable-email-policy.md b/examples/1.9.x/server-rest/examples/project/update-deny-disposable-email-policy.md index 48feef6f8..f7f2c1236 100644 --- a/examples/1.9.x/server-rest/examples/project/update-deny-disposable-email-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-deny-disposable-email-policy.md @@ -2,9 +2,13 @@ PATCH /v1/project/policies/deny-disposable-email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "enabled": false +} { "enabled": false diff --git a/examples/1.9.x/server-rest/examples/project/update-deny-free-email-policy.md b/examples/1.9.x/server-rest/examples/project/update-deny-free-email-policy.md index 3dc979af6..de7217280 100644 --- a/examples/1.9.x/server-rest/examples/project/update-deny-free-email-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-deny-free-email-policy.md @@ -2,9 +2,13 @@ PATCH /v1/project/policies/deny-free-email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "enabled": false +} { "enabled": false diff --git a/examples/1.9.x/server-rest/examples/project/update-email-template.md b/examples/1.9.x/server-rest/examples/project/update-email-template.md index a336edcfd..361325526 100644 --- a/examples/1.9.x/server-rest/examples/project/update-email-template.md +++ b/examples/1.9.x/server-rest/examples/project/update-email-template.md @@ -2,9 +2,20 @@ PATCH /v1/project/templates/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "templateId": "verification", + "locale": "af", + "subject": "<SUBJECT>", + "message": "<MESSAGE>", + "senderName": "<SENDER_NAME>", + "senderEmail": "email@example.com", + "replyToEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>" +} { "templateId": "verification", diff --git a/examples/1.9.x/server-rest/examples/project/update-key.md b/examples/1.9.x/server-rest/examples/project/update-key.md index 254c54997..b090c2cd6 100644 --- a/examples/1.9.x/server-rest/examples/project/update-key.md +++ b/examples/1.9.x/server-rest/examples/project/update-key.md @@ -2,9 +2,15 @@ PUT /v1/project/keys/{keyId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "scopes": [], + "expire": "2020-10-15T06:38:00.000+00:00" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/project/update-labels.md b/examples/1.9.x/server-rest/examples/project/update-labels.md index 53d08ee6e..a3337d858 100644 --- a/examples/1.9.x/server-rest/examples/project/update-labels.md +++ b/examples/1.9.x/server-rest/examples/project/update-labels.md @@ -2,9 +2,13 @@ PUT /v1/project/labels HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "labels": [] +} { "labels": [] diff --git a/examples/1.9.x/server-rest/examples/project/update-linux-platform.md b/examples/1.9.x/server-rest/examples/project/update-linux-platform.md index 40c2bebaa..7f8a16878 100644 --- a/examples/1.9.x/server-rest/examples/project/update-linux-platform.md +++ b/examples/1.9.x/server-rest/examples/project/update-linux-platform.md @@ -2,9 +2,14 @@ PUT /v1/project/platforms/linux/{platformId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "packageName": "<PACKAGE_NAME>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-rest/examples/project/update-membership-privacy-policy.md index 3814e2f87..9d9da5f39 100644 --- a/examples/1.9.x/server-rest/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-membership-privacy-policy.md @@ -2,15 +2,25 @@ PATCH /v1/project/policies/membership-privacy HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> { "userId": false, "userEmail": false, "userPhone": false, "userName": false, - "userMFA": false + "userMFA": false, + "userAccessedAt": false +} + +{ + "userId": false, + "userEmail": false, + "userPhone": false, + "userName": false, + "userMFA": false, + "userAccessedAt": false } ``` diff --git a/examples/1.9.x/server-rest/examples/project/update-mock-phone.md b/examples/1.9.x/server-rest/examples/project/update-mock-phone.md index 7d0e990f5..345b54c12 100644 --- a/examples/1.9.x/server-rest/examples/project/update-mock-phone.md +++ b/examples/1.9.x/server-rest/examples/project/update-mock-phone.md @@ -2,9 +2,13 @@ PUT /v1/project/mock-phones/{number} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "otp": "<OTP>" +} { "otp": "<OTP>" diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-amazon.md index 52e635736..bcefde1c6 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-amazon.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-amazon.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/amazon HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-apple.md index 6ae7eac9e..eaf8b3048 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-apple.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-apple.md @@ -2,9 +2,17 @@ PATCH /v1/project/oauth2/apple HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "serviceId": "<SERVICE_ID>", + "keyId": "<KEY_ID>", + "teamId": "<TEAM_ID>", + "p8File": "<P8_FILE>", + "enabled": false +} { "serviceId": "<SERVICE_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-auth-0.md index 91b2ce21f..980bf9896 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-auth-0.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-auth-0.md @@ -2,9 +2,16 @@ PATCH /v1/project/oauth2/auth0 HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "endpoint": "<ENDPOINT>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-authentik.md index a16d99328..ac62e48ea 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-authentik.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-authentik.md @@ -2,9 +2,16 @@ PATCH /v1/project/oauth2/authentik HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "endpoint": "<ENDPOINT>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-autodesk.md index 9edca76db..3f501c255 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-autodesk.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-autodesk.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/autodesk HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitbucket.md index feaf3fba6..e854bd176 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitbucket.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitbucket.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/bitbucket HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "<KEY>", + "secret": "<SECRET>", + "enabled": false +} { "key": "<KEY>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitly.md index 53efef7c8..86b660623 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitly.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitly.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/bitly HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-box.md index 0c8e00cdd..8fae307bb 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-box.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-box.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/box HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dailymotion.md index 7681eb723..fd2484776 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dailymotion.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dailymotion.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/dailymotion HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "apiKey": "<API_KEY>", + "apiSecret": "<API_SECRET>", + "enabled": false +} { "apiKey": "<API_KEY>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-discord.md index bcfd88f2a..e01622400 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-discord.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-discord.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/discord HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-disqus.md index e1af4ba5f..d08f96308 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-disqus.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-disqus.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/disqus HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "publicKey": "<PUBLIC_KEY>", + "secretKey": "<SECRET_KEY>", + "enabled": false +} { "publicKey": "<PUBLIC_KEY>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dropbox.md index d38dc11c0..97f7dd0c4 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dropbox.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dropbox.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/dropbox HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "appKey": "<APP_KEY>", + "appSecret": "<APP_SECRET>", + "enabled": false +} { "appKey": "<APP_KEY>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-etsy.md index 3e3409ace..3d0479e30 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-etsy.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-etsy.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/etsy HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "keyString": "<KEY_STRING>", + "sharedSecret": "<SHARED_SECRET>", + "enabled": false +} { "keyString": "<KEY_STRING>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-facebook.md index 310400277..6bca79a5c 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-facebook.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-facebook.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/facebook HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "appId": "<APP_ID>", + "appSecret": "<APP_SECRET>", + "enabled": false +} { "appId": "<APP_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-figma.md index a93fd50e9..f87591eac 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-figma.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-figma.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/figma HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-fusion-auth.md index a0dcbcb68..df011e981 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-fusion-auth.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-fusion-auth.md @@ -2,9 +2,16 @@ PATCH /v1/project/oauth2/fusionauth HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "endpoint": "<ENDPOINT>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-git-hub.md index 49a938601..0bd397024 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-git-hub.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-git-hub.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/github HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-gitlab.md index d71950560..b332531d0 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-gitlab.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-gitlab.md @@ -2,9 +2,16 @@ PATCH /v1/project/oauth2/gitlab HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "applicationId": "<APPLICATION_ID>", + "secret": "<SECRET>", + "endpoint": "https://example.com", + "enabled": false +} { "applicationId": "<APPLICATION_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-google.md index cdab8d368..bf1108fac 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-google.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-google.md @@ -2,9 +2,16 @@ PATCH /v1/project/oauth2/google HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "prompt": [], + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-keycloak.md index ee2df2abf..070ceaed7 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-keycloak.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-keycloak.md @@ -2,9 +2,17 @@ PATCH /v1/project/oauth2/keycloak HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "endpoint": "<ENDPOINT>", + "realmName": "<REALM_NAME>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-kick.md index bbf61a949..ce0e8549a 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-kick.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-kick.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/kick HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-linkedin.md index 0aa19135c..1f874fba2 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-linkedin.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-linkedin.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/linkedin HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "primaryClientSecret": "<PRIMARY_CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-microsoft.md index 872731a03..df326405c 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-microsoft.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-microsoft.md @@ -2,9 +2,16 @@ PATCH /v1/project/oauth2/microsoft HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "applicationId": "<APPLICATION_ID>", + "applicationSecret": "<APPLICATION_SECRET>", + "tenant": "<TENANT>", + "enabled": false +} { "applicationId": "<APPLICATION_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-notion.md index de62ee004..1c5b210d6 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-notion.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-notion.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/notion HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "oauthClientId": "<OAUTH_CLIENT_ID>", + "oauthClientSecret": "<OAUTH_CLIENT_SECRET>", + "enabled": false +} { "oauthClientId": "<OAUTH_CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-oidc.md index a77402ac7..5b24f5435 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-oidc.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-oidc.md @@ -2,9 +2,19 @@ PATCH /v1/project/oauth2/oidc HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "wellKnownURL": "https://example.com", + "authorizationURL": "https://example.com", + "tokenURL": "https://example.com", + "userInfoURL": "https://example.com", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-okta.md index d016cad3d..bc9ea0d3d 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-okta.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-okta.md @@ -2,9 +2,17 @@ PATCH /v1/project/oauth2/okta HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "domain": "", + "authorizationServerId": "<AUTHORIZATION_SERVER_ID>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal-sandbox.md index 0a8b00017..465c2a6b0 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal-sandbox.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal-sandbox.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/paypalSandbox HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "secretKey": "<SECRET_KEY>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal.md index 3ff3c1877..1f6d3ebd3 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/paypal HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "secretKey": "<SECRET_KEY>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-podio.md index 7d8b3e11a..e797eddbb 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-podio.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-podio.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/podio HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-salesforce.md index 7d8b1779a..d909ea9e1 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-salesforce.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-salesforce.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/salesforce HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "customerKey": "<CUSTOMER_KEY>", + "customerSecret": "<CUSTOMER_SECRET>", + "enabled": false +} { "customerKey": "<CUSTOMER_KEY>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-server.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..8e06460ad --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-server.md @@ -0,0 +1,40 @@ +```http +PUT /v1/project/oauth2-server HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +Accept: application/json +X-Appwrite-Response-Format: 1.9.5 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "enabled": false, + "authorizationUrl": "https://example.com", + "scopes": [], + "authorizationDetailsTypes": [], + "accessTokenDuration": 60, + "refreshTokenDuration": 60, + "publicAccessTokenDuration": 60, + "publicRefreshTokenDuration": 60, + "confidentialPkce": false, + "verificationUrl": "https://example.com", + "userCodeLength": 6, + "userCodeFormat": "numeric", + "deviceCodeDuration": 60 +} + +{ + "enabled": false, + "authorizationUrl": "https://example.com", + "scopes": [], + "authorizationDetailsTypes": [], + "accessTokenDuration": 60, + "refreshTokenDuration": 60, + "publicAccessTokenDuration": 60, + "publicRefreshTokenDuration": 60, + "confidentialPkce": false, + "verificationUrl": "https://example.com", + "userCodeLength": 6, + "userCodeFormat": "numeric", + "deviceCodeDuration": 60 +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-slack.md index 1cbf43333..2a50d5a35 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-slack.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-slack.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/slack HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-spotify.md index a042f2ffb..c5d0213e9 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-spotify.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-spotify.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/spotify HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-stripe.md index fb28459a7..940fafd0e 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-stripe.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-stripe.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/stripe HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "apiSecretKey": "<API_SECRET_KEY>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift-sandbox.md index 51c4ab074..2a78e5abb 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift-sandbox.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/tradeshiftBox HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "oauth2ClientId": "<OAUTH2_CLIENT_ID>", + "oauth2ClientSecret": "<OAUTH2_CLIENT_SECRET>", + "enabled": false +} { "oauth2ClientId": "<OAUTH2_CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift.md index efb009d50..1718eea47 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/tradeshift HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "oauth2ClientId": "<OAUTH2_CLIENT_ID>", + "oauth2ClientSecret": "<OAUTH2_CLIENT_SECRET>", + "enabled": false +} { "oauth2ClientId": "<OAUTH2_CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-twitch.md index 2e8d8b702..c2f93f41e 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-twitch.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-twitch.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/twitch HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-word-press.md index ecc50962d..cc60c2ed9 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-word-press.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-word-press.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/wordpress HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yahoo.md index 8118ec7a7..0ff9ff760 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yahoo.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yahoo.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/yahoo HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yandex.md index 9c492d3e1..040e91f80 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yandex.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yandex.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/yandex HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoho.md index 812b7ac04..9a1f9cb67 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoho.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoho.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/zoho HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoom.md index 1a6a82b26..b98e03a5b 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoom.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoom.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/zoom HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "clientId": "<CLIENT_ID>", + "clientSecret": "<CLIENT_SECRET>", + "enabled": false +} { "clientId": "<CLIENT_ID>", diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2x.md index 612cf69c4..6c6cb3bd0 100644 --- a/examples/1.9.x/server-rest/examples/project/update-o-auth-2x.md +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2x.md @@ -2,9 +2,15 @@ PATCH /v1/project/oauth2/x HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "customerKey": "<CUSTOMER_KEY>", + "secretKey": "<SECRET_KEY>", + "enabled": false +} { "customerKey": "<CUSTOMER_KEY>", diff --git a/examples/1.9.x/server-rest/examples/project/update-password-dictionary-policy.md b/examples/1.9.x/server-rest/examples/project/update-password-dictionary-policy.md index 9cc782a2d..91f6b96f8 100644 --- a/examples/1.9.x/server-rest/examples/project/update-password-dictionary-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-password-dictionary-policy.md @@ -2,9 +2,13 @@ PATCH /v1/project/policies/password-dictionary HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "enabled": false +} { "enabled": false diff --git a/examples/1.9.x/server-rest/examples/project/update-password-history-policy.md b/examples/1.9.x/server-rest/examples/project/update-password-history-policy.md index dc51f2f5e..f11eeb6b6 100644 --- a/examples/1.9.x/server-rest/examples/project/update-password-history-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-password-history-policy.md @@ -2,9 +2,13 @@ PATCH /v1/project/policies/password-history HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "total": 1 +} { "total": 1 diff --git a/examples/1.9.x/server-rest/examples/project/update-password-personal-data-policy.md b/examples/1.9.x/server-rest/examples/project/update-password-personal-data-policy.md index 2b1936927..ec83ea2ae 100644 --- a/examples/1.9.x/server-rest/examples/project/update-password-personal-data-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-password-personal-data-policy.md @@ -2,9 +2,13 @@ PATCH /v1/project/policies/password-personal-data HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "enabled": false +} { "enabled": false diff --git a/examples/1.9.x/server-rest/examples/project/update-password-strength-policy.md b/examples/1.9.x/server-rest/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..4864d8ec7 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-password-strength-policy.md @@ -0,0 +1,24 @@ +```http +PATCH /v1/project/policies/password-strength HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +Accept: application/json +X-Appwrite-Response-Format: 1.9.5 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "min": 8, + "uppercase": false, + "lowercase": false, + "number": false, + "symbols": false +} + +{ + "min": 8, + "uppercase": false, + "lowercase": false, + "number": false, + "symbols": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-protocol.md b/examples/1.9.x/server-rest/examples/project/update-protocol.md index fad8a531b..5fbd43b41 100644 --- a/examples/1.9.x/server-rest/examples/project/update-protocol.md +++ b/examples/1.9.x/server-rest/examples/project/update-protocol.md @@ -2,9 +2,13 @@ PATCH /v1/project/protocols/{protocolId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "enabled": false +} { "enabled": false diff --git a/examples/1.9.x/server-rest/examples/project/update-service.md b/examples/1.9.x/server-rest/examples/project/update-service.md index 45395c402..fa574a5ab 100644 --- a/examples/1.9.x/server-rest/examples/project/update-service.md +++ b/examples/1.9.x/server-rest/examples/project/update-service.md @@ -2,9 +2,13 @@ PATCH /v1/project/services/{serviceId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "enabled": false +} { "enabled": false diff --git a/examples/1.9.x/server-rest/examples/project/update-session-alert-policy.md b/examples/1.9.x/server-rest/examples/project/update-session-alert-policy.md index 1d85fd574..41261c984 100644 --- a/examples/1.9.x/server-rest/examples/project/update-session-alert-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-session-alert-policy.md @@ -2,9 +2,13 @@ PATCH /v1/project/policies/session-alert HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "enabled": false +} { "enabled": false diff --git a/examples/1.9.x/server-rest/examples/project/update-session-duration-policy.md b/examples/1.9.x/server-rest/examples/project/update-session-duration-policy.md index 40e2de213..d1c2547b7 100644 --- a/examples/1.9.x/server-rest/examples/project/update-session-duration-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-session-duration-policy.md @@ -2,9 +2,13 @@ PATCH /v1/project/policies/session-duration HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "duration": 5 +} { "duration": 5 diff --git a/examples/1.9.x/server-rest/examples/project/update-session-invalidation-policy.md b/examples/1.9.x/server-rest/examples/project/update-session-invalidation-policy.md index 77a0f9d88..df03d1438 100644 --- a/examples/1.9.x/server-rest/examples/project/update-session-invalidation-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-session-invalidation-policy.md @@ -2,9 +2,13 @@ PATCH /v1/project/policies/session-invalidation HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "enabled": false +} { "enabled": false diff --git a/examples/1.9.x/server-rest/examples/project/update-session-limit-policy.md b/examples/1.9.x/server-rest/examples/project/update-session-limit-policy.md index 1daf0132c..f16e8440e 100644 --- a/examples/1.9.x/server-rest/examples/project/update-session-limit-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-session-limit-policy.md @@ -2,9 +2,13 @@ PATCH /v1/project/policies/session-limit HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "total": 1 +} { "total": 1 diff --git a/examples/1.9.x/server-rest/examples/project/update-smtp.md b/examples/1.9.x/server-rest/examples/project/update-smtp.md index 4499f7188..1e16560a8 100644 --- a/examples/1.9.x/server-rest/examples/project/update-smtp.md +++ b/examples/1.9.x/server-rest/examples/project/update-smtp.md @@ -2,15 +2,28 @@ PATCH /v1/project/smtp HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> { "host": "", "port": 0, "username": "<USERNAME>", - "password": "<PASSWORD>", + "password": "password", + "senderEmail": "email@example.com", + "senderName": "<SENDER_NAME>", + "replyToEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "secure": "tls", + "enabled": false +} + +{ + "host": "", + "port": 0, + "username": "<USERNAME>", + "password": "password", "senderEmail": "email@example.com", "senderName": "<SENDER_NAME>", "replyToEmail": "email@example.com", diff --git a/examples/1.9.x/server-rest/examples/project/update-user-limit-policy.md b/examples/1.9.x/server-rest/examples/project/update-user-limit-policy.md index bf6345fc4..3b2ec476f 100644 --- a/examples/1.9.x/server-rest/examples/project/update-user-limit-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-user-limit-policy.md @@ -2,9 +2,13 @@ PATCH /v1/project/policies/user-limit HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "total": 1 +} { "total": 1 diff --git a/examples/1.9.x/server-rest/examples/project/update-variable.md b/examples/1.9.x/server-rest/examples/project/update-variable.md index 94d5988d0..167a3ad54 100644 --- a/examples/1.9.x/server-rest/examples/project/update-variable.md +++ b/examples/1.9.x/server-rest/examples/project/update-variable.md @@ -2,9 +2,15 @@ PUT /v1/project/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "<KEY>", + "value": "<VALUE>", + "secret": false +} { "key": "<KEY>", diff --git a/examples/1.9.x/server-rest/examples/project/update-web-platform.md b/examples/1.9.x/server-rest/examples/project/update-web-platform.md index d2fb60545..f5ac79c4f 100644 --- a/examples/1.9.x/server-rest/examples/project/update-web-platform.md +++ b/examples/1.9.x/server-rest/examples/project/update-web-platform.md @@ -2,9 +2,14 @@ PUT /v1/project/platforms/web/{platformId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "hostname": "app.example.com" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/project/update-windows-platform.md b/examples/1.9.x/server-rest/examples/project/update-windows-platform.md index b85d680f8..c918048bb 100644 --- a/examples/1.9.x/server-rest/examples/project/update-windows-platform.md +++ b/examples/1.9.x/server-rest/examples/project/update-windows-platform.md @@ -2,9 +2,14 @@ PUT /v1/project/platforms/windows/{platformId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "packageIdentifierName": "<PACKAGE_IDENTIFIER_NAME>" +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/proxy/create-api-rule.md b/examples/1.9.x/server-rest/examples/proxy/create-api-rule.md index 35e13b673..02f8d9a2c 100644 --- a/examples/1.9.x/server-rest/examples/proxy/create-api-rule.md +++ b/examples/1.9.x/server-rest/examples/proxy/create-api-rule.md @@ -2,9 +2,13 @@ POST /v1/proxy/rules/api HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "domain": "" +} { "domain": "" diff --git a/examples/1.9.x/server-rest/examples/proxy/create-function-rule.md b/examples/1.9.x/server-rest/examples/proxy/create-function-rule.md index c9458ac41..c5dad0c02 100644 --- a/examples/1.9.x/server-rest/examples/proxy/create-function-rule.md +++ b/examples/1.9.x/server-rest/examples/proxy/create-function-rule.md @@ -2,9 +2,15 @@ POST /v1/proxy/rules/function HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "domain": "", + "functionId": "<FUNCTION_ID>", + "branch": "<BRANCH>" +} { "domain": "", diff --git a/examples/1.9.x/server-rest/examples/proxy/create-redirect-rule.md b/examples/1.9.x/server-rest/examples/proxy/create-redirect-rule.md index 678a9772b..6a9b3fdfc 100644 --- a/examples/1.9.x/server-rest/examples/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-rest/examples/proxy/create-redirect-rule.md @@ -2,9 +2,17 @@ POST /v1/proxy/rules/redirect HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "domain": "", + "url": "https://example.com", + "statusCode": "301", + "resourceId": "<RESOURCE_ID>", + "resourceType": "site" +} { "domain": "", diff --git a/examples/1.9.x/server-rest/examples/proxy/create-site-rule.md b/examples/1.9.x/server-rest/examples/proxy/create-site-rule.md index e97ad6b56..6aea7e906 100644 --- a/examples/1.9.x/server-rest/examples/proxy/create-site-rule.md +++ b/examples/1.9.x/server-rest/examples/proxy/create-site-rule.md @@ -2,9 +2,15 @@ POST /v1/proxy/rules/site HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "domain": "", + "siteId": "<SITE_ID>", + "branch": "<BRANCH>" +} { "domain": "", diff --git a/examples/1.9.x/server-rest/examples/proxy/delete-rule.md b/examples/1.9.x/server-rest/examples/proxy/delete-rule.md index db407700a..ebe88df62 100644 --- a/examples/1.9.x/server-rest/examples/proxy/delete-rule.md +++ b/examples/1.9.x/server-rest/examples/proxy/delete-rule.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/proxy/get-rule.md b/examples/1.9.x/server-rest/examples/proxy/get-rule.md index da9432973..54a5b89eb 100644 --- a/examples/1.9.x/server-rest/examples/proxy/get-rule.md +++ b/examples/1.9.x/server-rest/examples/proxy/get-rule.md @@ -1,7 +1,8 @@ ```http GET /v1/proxy/rules/{ruleId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/proxy/list-rules.md b/examples/1.9.x/server-rest/examples/proxy/list-rules.md index 43b084e00..27d597b76 100644 --- a/examples/1.9.x/server-rest/examples/proxy/list-rules.md +++ b/examples/1.9.x/server-rest/examples/proxy/list-rules.md @@ -1,7 +1,8 @@ ```http GET /v1/proxy/rules HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/proxy/update-rule-status.md b/examples/1.9.x/server-rest/examples/proxy/update-rule-status.md index 6daf45707..bb99e0e43 100644 --- a/examples/1.9.x/server-rest/examples/proxy/update-rule-status.md +++ b/examples/1.9.x/server-rest/examples/proxy/update-rule-status.md @@ -2,8 +2,9 @@ PATCH /v1/proxy/rules/{ruleId}/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/create-deployment.md b/examples/1.9.x/server-rest/examples/sites/create-deployment.md index 4bb4769ae..f5afc589f 100644 --- a/examples/1.9.x/server-rest/examples/sites/create-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/create-deployment.md @@ -2,9 +2,9 @@ POST /v1/sites/{siteId}/deployments HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> Content-Length: *Length of your entity body in bytes* --cec8e8123c05ba25 @@ -33,4 +33,12 @@ Content-Disposition: form-data; name="activate" false --cec8e8123c05ba25-- + +{ + "installCommand": "<INSTALL_COMMAND>", + "buildCommand": "<BUILD_COMMAND>", + "outputDirectory": "<OUTPUT_DIRECTORY>", + "code": cf 94 84 24 8d c4 91 10 0f dc 54 26 6c 8e 4b bc e8 ee 55 94 29 e7 94 89 19 26 28 01 26 29 3f 16..., + "activate": false +} ``` diff --git a/examples/1.9.x/server-rest/examples/sites/create-duplicate-deployment.md b/examples/1.9.x/server-rest/examples/sites/create-duplicate-deployment.md index dcb7f1e33..35024030a 100644 --- a/examples/1.9.x/server-rest/examples/sites/create-duplicate-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/create-duplicate-deployment.md @@ -2,9 +2,13 @@ POST /v1/sites/{siteId}/deployments/duplicate HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "deploymentId": "<DEPLOYMENT_ID>" +} { "deploymentId": "<DEPLOYMENT_ID>" diff --git a/examples/1.9.x/server-rest/examples/sites/create-template-deployment.md b/examples/1.9.x/server-rest/examples/sites/create-template-deployment.md index be4aa23ab..59835573b 100644 --- a/examples/1.9.x/server-rest/examples/sites/create-template-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/create-template-deployment.md @@ -2,9 +2,18 @@ POST /v1/sites/{siteId}/deployments/template HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "repository": "<REPOSITORY>", + "owner": "<OWNER>", + "rootDirectory": "<ROOT_DIRECTORY>", + "type": "branch", + "reference": "<REFERENCE>", + "activate": false +} { "repository": "<REPOSITORY>", diff --git a/examples/1.9.x/server-rest/examples/sites/create-variable.md b/examples/1.9.x/server-rest/examples/sites/create-variable.md index 3cbd670ac..3aed4570a 100644 --- a/examples/1.9.x/server-rest/examples/sites/create-variable.md +++ b/examples/1.9.x/server-rest/examples/sites/create-variable.md @@ -2,9 +2,16 @@ POST /v1/sites/{siteId}/variables HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "variableId": "<VARIABLE_ID>", + "key": "<KEY>", + "value": "<VALUE>", + "secret": false +} { "variableId": "<VARIABLE_ID>", diff --git a/examples/1.9.x/server-rest/examples/sites/create-vcs-deployment.md b/examples/1.9.x/server-rest/examples/sites/create-vcs-deployment.md index a23307adc..df18d12cd 100644 --- a/examples/1.9.x/server-rest/examples/sites/create-vcs-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/create-vcs-deployment.md @@ -2,9 +2,15 @@ POST /v1/sites/{siteId}/deployments/vcs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "type": "branch", + "reference": "<REFERENCE>", + "activate": false +} { "type": "branch", diff --git a/examples/1.9.x/server-rest/examples/sites/create.md b/examples/1.9.x/server-rest/examples/sites/create.md index 4028d8986..1f1358a3b 100644 --- a/examples/1.9.x/server-rest/examples/sites/create.md +++ b/examples/1.9.x/server-rest/examples/sites/create.md @@ -2,9 +2,35 @@ POST /v1/sites HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "siteId": "<SITE_ID>", + "name": "<NAME>", + "framework": "analog", + "enabled": false, + "logging": false, + "timeout": 1, + "installCommand": "<INSTALL_COMMAND>", + "buildCommand": "<BUILD_COMMAND>", + "startCommand": "<START_COMMAND>", + "outputDirectory": "<OUTPUT_DIRECTORY>", + "buildRuntime": "node-14.5", + "adapter": "static", + "installationId": "<INSTALLATION_ID>", + "fallbackFile": "<FALLBACK_FILE>", + "providerRepositoryId": "<PROVIDER_REPOSITORY_ID>", + "providerBranch": "<PROVIDER_BRANCH>", + "providerSilentMode": false, + "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>", + "providerBranches": [], + "providerPaths": [], + "buildSpecification": "", + "runtimeSpecification": "", + "deploymentRetention": 0 +} { "siteId": "<SITE_ID>", diff --git a/examples/1.9.x/server-rest/examples/sites/delete-deployment.md b/examples/1.9.x/server-rest/examples/sites/delete-deployment.md index 3e1178397..71d38de57 100644 --- a/examples/1.9.x/server-rest/examples/sites/delete-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/delete-deployment.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/sites/delete-log.md b/examples/1.9.x/server-rest/examples/sites/delete-log.md index 9e92abdfc..c9fb45c9c 100644 --- a/examples/1.9.x/server-rest/examples/sites/delete-log.md +++ b/examples/1.9.x/server-rest/examples/sites/delete-log.md @@ -2,8 +2,9 @@ DELETE /v1/sites/{siteId}/logs/{logId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/delete-variable.md b/examples/1.9.x/server-rest/examples/sites/delete-variable.md index a35bcd5de..d41fdd981 100644 --- a/examples/1.9.x/server-rest/examples/sites/delete-variable.md +++ b/examples/1.9.x/server-rest/examples/sites/delete-variable.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/sites/delete.md b/examples/1.9.x/server-rest/examples/sites/delete.md index 9b17039b3..8b86fdd7e 100644 --- a/examples/1.9.x/server-rest/examples/sites/delete.md +++ b/examples/1.9.x/server-rest/examples/sites/delete.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/sites/get-deployment-download.md b/examples/1.9.x/server-rest/examples/sites/get-deployment-download.md index ff4b5ba03..4b9ebac6e 100644 --- a/examples/1.9.x/server-rest/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-rest/examples/sites/get-deployment-download.md @@ -1,8 +1,7 @@ ```http GET /v1/sites/{siteId}/deployments/{deploymentId}/download HTTP/1.1 Host: cloud.appwrite.io +Accept: */* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/sites/get-deployment.md b/examples/1.9.x/server-rest/examples/sites/get-deployment.md index 480528b9f..89be8f1d7 100644 --- a/examples/1.9.x/server-rest/examples/sites/get-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/get-deployment.md @@ -1,7 +1,8 @@ ```http GET /v1/sites/{siteId}/deployments/{deploymentId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/get-log.md b/examples/1.9.x/server-rest/examples/sites/get-log.md index 11bddca96..c9e95af0b 100644 --- a/examples/1.9.x/server-rest/examples/sites/get-log.md +++ b/examples/1.9.x/server-rest/examples/sites/get-log.md @@ -1,7 +1,8 @@ ```http GET /v1/sites/{siteId}/logs/{logId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/get-variable.md b/examples/1.9.x/server-rest/examples/sites/get-variable.md index 5f8e17ee5..2451928f4 100644 --- a/examples/1.9.x/server-rest/examples/sites/get-variable.md +++ b/examples/1.9.x/server-rest/examples/sites/get-variable.md @@ -1,7 +1,8 @@ ```http GET /v1/sites/{siteId}/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/get.md b/examples/1.9.x/server-rest/examples/sites/get.md index e85cf63cc..a2891f386 100644 --- a/examples/1.9.x/server-rest/examples/sites/get.md +++ b/examples/1.9.x/server-rest/examples/sites/get.md @@ -1,7 +1,8 @@ ```http GET /v1/sites/{siteId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list-deployments.md b/examples/1.9.x/server-rest/examples/sites/list-deployments.md index 21b04a5a1..25351d016 100644 --- a/examples/1.9.x/server-rest/examples/sites/list-deployments.md +++ b/examples/1.9.x/server-rest/examples/sites/list-deployments.md @@ -1,7 +1,8 @@ ```http GET /v1/sites/{siteId}/deployments HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list-frameworks.md b/examples/1.9.x/server-rest/examples/sites/list-frameworks.md index 9c052c2cf..fd239b8da 100644 --- a/examples/1.9.x/server-rest/examples/sites/list-frameworks.md +++ b/examples/1.9.x/server-rest/examples/sites/list-frameworks.md @@ -1,7 +1,8 @@ ```http GET /v1/sites/frameworks HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list-logs.md b/examples/1.9.x/server-rest/examples/sites/list-logs.md index aeb007a22..fbd3c63cd 100644 --- a/examples/1.9.x/server-rest/examples/sites/list-logs.md +++ b/examples/1.9.x/server-rest/examples/sites/list-logs.md @@ -1,7 +1,8 @@ ```http GET /v1/sites/{siteId}/logs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list-specifications.md b/examples/1.9.x/server-rest/examples/sites/list-specifications.md index 0f524629b..576150e48 100644 --- a/examples/1.9.x/server-rest/examples/sites/list-specifications.md +++ b/examples/1.9.x/server-rest/examples/sites/list-specifications.md @@ -1,7 +1,8 @@ ```http GET /v1/sites/specifications HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list-variables.md b/examples/1.9.x/server-rest/examples/sites/list-variables.md index e4f69a84a..2235cb286 100644 --- a/examples/1.9.x/server-rest/examples/sites/list-variables.md +++ b/examples/1.9.x/server-rest/examples/sites/list-variables.md @@ -1,7 +1,8 @@ ```http GET /v1/sites/{siteId}/variables HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list.md b/examples/1.9.x/server-rest/examples/sites/list.md index 13d6612ed..875541eaf 100644 --- a/examples/1.9.x/server-rest/examples/sites/list.md +++ b/examples/1.9.x/server-rest/examples/sites/list.md @@ -1,7 +1,8 @@ ```http GET /v1/sites HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/update-deployment-status.md b/examples/1.9.x/server-rest/examples/sites/update-deployment-status.md index 85ff96431..ebd5e68c6 100644 --- a/examples/1.9.x/server-rest/examples/sites/update-deployment-status.md +++ b/examples/1.9.x/server-rest/examples/sites/update-deployment-status.md @@ -2,8 +2,9 @@ PATCH /v1/sites/{siteId}/deployments/{deploymentId}/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/sites/update-site-deployment.md b/examples/1.9.x/server-rest/examples/sites/update-site-deployment.md index 1220e6650..e19b67b2d 100644 --- a/examples/1.9.x/server-rest/examples/sites/update-site-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/update-site-deployment.md @@ -2,9 +2,13 @@ PATCH /v1/sites/{siteId}/deployment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "deploymentId": "<DEPLOYMENT_ID>" +} { "deploymentId": "<DEPLOYMENT_ID>" diff --git a/examples/1.9.x/server-rest/examples/sites/update-variable.md b/examples/1.9.x/server-rest/examples/sites/update-variable.md index 51ea888a4..1f7eb9f05 100644 --- a/examples/1.9.x/server-rest/examples/sites/update-variable.md +++ b/examples/1.9.x/server-rest/examples/sites/update-variable.md @@ -2,9 +2,15 @@ PUT /v1/sites/{siteId}/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "<KEY>", + "value": "<VALUE>", + "secret": false +} { "key": "<KEY>", diff --git a/examples/1.9.x/server-rest/examples/sites/update.md b/examples/1.9.x/server-rest/examples/sites/update.md index a8331d160..28899dce1 100644 --- a/examples/1.9.x/server-rest/examples/sites/update.md +++ b/examples/1.9.x/server-rest/examples/sites/update.md @@ -2,9 +2,34 @@ PUT /v1/sites/{siteId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "framework": "analog", + "enabled": false, + "logging": false, + "timeout": 1, + "installCommand": "<INSTALL_COMMAND>", + "buildCommand": "<BUILD_COMMAND>", + "startCommand": "<START_COMMAND>", + "outputDirectory": "<OUTPUT_DIRECTORY>", + "buildRuntime": "node-14.5", + "adapter": "static", + "fallbackFile": "<FALLBACK_FILE>", + "installationId": "<INSTALLATION_ID>", + "providerRepositoryId": "<PROVIDER_REPOSITORY_ID>", + "providerBranch": "<PROVIDER_BRANCH>", + "providerSilentMode": false, + "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>", + "providerBranches": [], + "providerPaths": [], + "buildSpecification": "", + "runtimeSpecification": "", + "deploymentRetention": 0 +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/storage/create-bucket.md b/examples/1.9.x/server-rest/examples/storage/create-bucket.md index 219d09639..e730a7c96 100644 --- a/examples/1.9.x/server-rest/examples/storage/create-bucket.md +++ b/examples/1.9.x/server-rest/examples/storage/create-bucket.md @@ -2,9 +2,23 @@ POST /v1/storage/buckets HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "bucketId": "<BUCKET_ID>", + "name": "<NAME>", + "permissions": ["read(\"any\")"], + "fileSecurity": false, + "enabled": false, + "maximumFileSize": 1, + "allowedFileExtensions": [], + "compression": "none", + "encryption": false, + "antivirus": false, + "transformations": false +} { "bucketId": "<BUCKET_ID>", diff --git a/examples/1.9.x/server-rest/examples/storage/create-file.md b/examples/1.9.x/server-rest/examples/storage/create-file.md index 071057f9a..a126c6c86 100644 --- a/examples/1.9.x/server-rest/examples/storage/create-file.md +++ b/examples/1.9.x/server-rest/examples/storage/create-file.md @@ -2,11 +2,9 @@ POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> Content-Length: *Length of your entity body in bytes* --cec8e8123c05ba25 @@ -25,4 +23,10 @@ Content-Disposition: form-data; name="permissions[]" ["read(\"any\")"] --cec8e8123c05ba25-- + +{ + "fileId": "<FILE_ID>", + "file": cf 94 84 24 8d c4 91 10 0f dc 54 26 6c 8e 4b bc e8 ee 55 94 29 e7 94 89 19 26 28 01 26 29 3f 16..., + "permissions": ["read(\"any\")"] +} ``` diff --git a/examples/1.9.x/server-rest/examples/storage/delete-bucket.md b/examples/1.9.x/server-rest/examples/storage/delete-bucket.md index d414c4174..da2652a2c 100644 --- a/examples/1.9.x/server-rest/examples/storage/delete-bucket.md +++ b/examples/1.9.x/server-rest/examples/storage/delete-bucket.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/storage/delete-file.md b/examples/1.9.x/server-rest/examples/storage/delete-file.md index 6c902c50a..6896905e0 100644 --- a/examples/1.9.x/server-rest/examples/storage/delete-file.md +++ b/examples/1.9.x/server-rest/examples/storage/delete-file.md @@ -4,8 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/storage/get-bucket.md b/examples/1.9.x/server-rest/examples/storage/get-bucket.md index f29db4e90..8feff77b2 100644 --- a/examples/1.9.x/server-rest/examples/storage/get-bucket.md +++ b/examples/1.9.x/server-rest/examples/storage/get-bucket.md @@ -1,7 +1,8 @@ ```http GET /v1/storage/buckets/{bucketId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/storage/get-file-download.md b/examples/1.9.x/server-rest/examples/storage/get-file-download.md index ebff74f09..65a2b3fd4 100644 --- a/examples/1.9.x/server-rest/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-rest/examples/storage/get-file-download.md @@ -1,9 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/download HTTP/1.1 Host: cloud.appwrite.io +Accept: */* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/storage/get-file-preview.md b/examples/1.9.x/server-rest/examples/storage/get-file-preview.md index 2f2b2bea2..b2530d485 100644 --- a/examples/1.9.x/server-rest/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-rest/examples/storage/get-file-preview.md @@ -1,9 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/preview HTTP/1.1 Host: cloud.appwrite.io +Accept: image/* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/storage/get-file-view.md b/examples/1.9.x/server-rest/examples/storage/get-file-view.md index 34ab49fd8..385fe3c61 100644 --- a/examples/1.9.x/server-rest/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-rest/examples/storage/get-file-view.md @@ -1,9 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/view HTTP/1.1 Host: cloud.appwrite.io +Accept: */* X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/storage/get-file.md b/examples/1.9.x/server-rest/examples/storage/get-file.md index d42a49f83..3eae0c9ea 100644 --- a/examples/1.9.x/server-rest/examples/storage/get-file.md +++ b/examples/1.9.x/server-rest/examples/storage/get-file.md @@ -1,9 +1,8 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/storage/list-buckets.md b/examples/1.9.x/server-rest/examples/storage/list-buckets.md index 6e6a907fe..0ac3ca582 100644 --- a/examples/1.9.x/server-rest/examples/storage/list-buckets.md +++ b/examples/1.9.x/server-rest/examples/storage/list-buckets.md @@ -1,7 +1,8 @@ ```http GET /v1/storage/buckets HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/storage/list-files.md b/examples/1.9.x/server-rest/examples/storage/list-files.md index 2923d6375..f8cdc1118 100644 --- a/examples/1.9.x/server-rest/examples/storage/list-files.md +++ b/examples/1.9.x/server-rest/examples/storage/list-files.md @@ -1,9 +1,8 @@ ```http GET /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/storage/update-bucket.md b/examples/1.9.x/server-rest/examples/storage/update-bucket.md index 94be69994..58be0509b 100644 --- a/examples/1.9.x/server-rest/examples/storage/update-bucket.md +++ b/examples/1.9.x/server-rest/examples/storage/update-bucket.md @@ -2,9 +2,22 @@ PUT /v1/storage/buckets/{bucketId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "permissions": ["read(\"any\")"], + "fileSecurity": false, + "enabled": false, + "maximumFileSize": 1, + "allowedFileExtensions": [], + "compression": "none", + "encryption": false, + "antivirus": false, + "transformations": false +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/storage/update-file.md b/examples/1.9.x/server-rest/examples/storage/update-file.md index 85fdda727..366058549 100644 --- a/examples/1.9.x/server-rest/examples/storage/update-file.md +++ b/examples/1.9.x/server-rest/examples/storage/update-file.md @@ -2,11 +2,14 @@ PUT /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "name": "<NAME>", + "permissions": ["read(\"any\")"] +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-big-int-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-big-int-column.md index dc67b7745..c515588db 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-big-int-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-big-int-column.md @@ -2,9 +2,18 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/bigint HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "min": 0, + "max": 0, + "default": 0, + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-boolean-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-boolean-column.md index 9c01e5866..e0b710ece 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-boolean-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-boolean-column.md @@ -2,9 +2,16 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/boolean HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": false, + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-datetime-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-datetime-column.md index 9e46c1877..14e603b47 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-datetime-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-datetime-column.md @@ -2,9 +2,16 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/datetime HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "2020-10-15T06:38:00.000+00:00", + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-email-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-email-column.md index 71eefb0ea..83b2677e0 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-email-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-email-column.md @@ -2,9 +2,16 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "email@example.com", + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-enum-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-enum-column.md index 804f41b04..7b0b89d39 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-enum-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-enum-column.md @@ -2,9 +2,17 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/enum HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "elements": [], + "required": false, + "default": "<DEFAULT>", + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-float-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-float-column.md index efa216d4f..40f6122e8 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-float-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-float-column.md @@ -2,9 +2,18 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/float HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "min": 0, + "max": 0, + "default": 0, + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-index.md b/examples/1.9.x/server-rest/examples/tablesdb/create-index.md index 855f1c96f..be6a091a0 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-index.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-index.md @@ -2,9 +2,17 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/indexes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "type": "key", + "columns": [], + "orders": [], + "lengths": [] +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-integer-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-integer-column.md index a0827c453..e116306e8 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-integer-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-integer-column.md @@ -2,9 +2,18 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/integer HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "min": 0, + "max": 0, + "default": 0, + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-ip-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-ip-column.md index e5d65810b..6e01845b1 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-ip-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-ip-column.md @@ -2,9 +2,16 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/ip HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "", + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-line-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-line-column.md index 5fd06be5c..663d8d807 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-line-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-line-column.md @@ -2,9 +2,15 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/line HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": [[1, 2], [3, 4], [5, 6]] +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-longtext-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-longtext-column.md index d5f54501d..b2c8f8e17 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-longtext-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-longtext-column.md @@ -2,9 +2,17 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/longtext HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "<DEFAULT>", + "array": false, + "encrypt": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-mediumtext-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-mediumtext-column.md index 31db13efb..3c952e944 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-mediumtext-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-mediumtext-column.md @@ -2,9 +2,17 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/mediumtext HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "<DEFAULT>", + "array": false, + "encrypt": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-operations.md b/examples/1.9.x/server-rest/examples/tablesdb/create-operations.md index 8974ba21c..f33e029cd 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-operations.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-operations.md @@ -2,11 +2,23 @@ POST /v1/tablesdb/transactions/{transactionId}/operations HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "operations": [ + { + "action": "create", + "databaseId": "<DATABASE_ID>", + "tableId": "<TABLE_ID>", + "rowId": "<ROW_ID>", + "data": { + "name": "Walter O'Brien" + } + } + ] +} { "operations": [ diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-point-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-point-column.md index e03e32351..621e2c45d 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-point-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-point-column.md @@ -2,9 +2,15 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/point HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": [1, 2] +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-polygon-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-polygon-column.md index 3d192978d..4a2454ef3 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-polygon-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-polygon-column.md @@ -2,9 +2,15 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/polygon HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": [[[1, 2], [3, 4], [5, 6], [1, 2]]] +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-relationship-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-relationship-column.md index 1f5660ba7..3d6da4ca2 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-relationship-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-relationship-column.md @@ -2,9 +2,18 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/relationship HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "relatedTableId": "<RELATED_TABLE_ID>", + "type": "oneToOne", + "twoWay": false, + "key": "", + "twoWayKey": "", + "onDelete": "cascade" +} { "relatedTableId": "<RELATED_TABLE_ID>", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-row.md b/examples/1.9.x/server-rest/examples/tablesdb/create-row.md index b0c6ef125..52de0256f 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-row.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-row.md @@ -2,11 +2,22 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "rowId": "<ROW_ID>", + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "<TRANSACTION_ID>" +} { "rowId": "<ROW_ID>", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-rows.md b/examples/1.9.x/server-rest/examples/tablesdb/create-rows.md index 8bf6c96d2..970601e4c 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-rows.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-rows.md @@ -2,11 +2,14 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "rows": [], + "transactionId": "<TRANSACTION_ID>" +} { "rows": [], diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-string-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-string-column.md index cdac5aa2a..72af7d2ec 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-string-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-string-column.md @@ -2,9 +2,18 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/string HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "size": 1, + "required": false, + "default": "<DEFAULT>", + "array": false, + "encrypt": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-table.md b/examples/1.9.x/server-rest/examples/tablesdb/create-table.md index b9098ac39..ce97a0af6 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-table.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-table.md @@ -2,9 +2,19 @@ POST /v1/tablesdb/{databaseId}/tables HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "tableId": "<TABLE_ID>", + "name": "<NAME>", + "permissions": ["read(\"any\")"], + "rowSecurity": false, + "enabled": false, + "columns": [], + "indexes": [] +} { "tableId": "<TABLE_ID>", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-text-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-text-column.md index fa51b1756..b6c5a93de 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-text-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-text-column.md @@ -2,9 +2,17 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/text HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "<DEFAULT>", + "array": false, + "encrypt": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-transaction.md b/examples/1.9.x/server-rest/examples/tablesdb/create-transaction.md index 4a423ed94..df6deb44a 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-transaction.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-transaction.md @@ -2,11 +2,13 @@ POST /v1/tablesdb/transactions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "ttl": 60 +} { "ttl": 60 diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-url-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-url-column.md index 16787734b..c06177dae 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-url-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-url-column.md @@ -2,9 +2,16 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "required": false, + "default": "https://example.com", + "array": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-varchar-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-varchar-column.md index 9ac96241d..8a845beba 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-varchar-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-varchar-column.md @@ -2,9 +2,18 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/varchar HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "", + "size": 1, + "required": false, + "default": "<DEFAULT>", + "array": false, + "encrypt": false +} { "key": "", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create.md b/examples/1.9.x/server-rest/examples/tablesdb/create.md index 9cef15473..d17fd22e9 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create.md @@ -2,9 +2,15 @@ POST /v1/tablesdb HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "databaseId": "<DATABASE_ID>", + "name": "<NAME>", + "enabled": false +} { "databaseId": "<DATABASE_ID>", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/decrement-row-column.md b/examples/1.9.x/server-rest/examples/tablesdb/decrement-row-column.md index c8bb492ed..78b1b86b9 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/decrement-row-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/decrement-row-column.md @@ -2,11 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}/{column}/decrement HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "value": 0, + "min": 0, + "transactionId": "<TRANSACTION_ID>" +} { "value": 0, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-column.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-column.md index b1cbbfab6..fc7adfa02 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-column.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-index.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-index.md index 5161ec12f..fb9f308ed 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-index.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-index.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md index df2ee91b7..277afbd1c 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md @@ -4,9 +4,6 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> { "transactionId": "<TRANSACTION_ID>" diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md index 3aa651d4b..fff623bbc 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md @@ -2,9 +2,14 @@ DELETE /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "queries": [], + "transactionId": "<TRANSACTION_ID>" +} { "queries": [], diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-table.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-table.md index fd92f8417..e0303e2a9 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-table.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-table.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-transaction.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-transaction.md index b3c767b68..91257dbe8 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-transaction.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-transaction.md @@ -4,8 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete.md b/examples/1.9.x/server-rest/examples/tablesdb/delete.md index 6b9e60ae5..c048d6071 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get-column.md b/examples/1.9.x/server-rest/examples/tablesdb/get-column.md index fcd02d73b..5fd466a61 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get-column.md @@ -1,7 +1,8 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/columns/{key} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get-index.md b/examples/1.9.x/server-rest/examples/tablesdb/get-index.md index 5f3779742..2b0c0669f 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get-index.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get-index.md @@ -1,7 +1,8 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/indexes/{key} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get-row.md b/examples/1.9.x/server-rest/examples/tablesdb/get-row.md index be835aefe..364d09472 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get-row.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get-row.md @@ -1,9 +1,8 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get-table.md b/examples/1.9.x/server-rest/examples/tablesdb/get-table.md index 67d20bb30..992518b34 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get-table.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get-table.md @@ -1,7 +1,8 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get-transaction.md b/examples/1.9.x/server-rest/examples/tablesdb/get-transaction.md index b4938d1f3..54b0abe1a 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get-transaction.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get-transaction.md @@ -1,9 +1,8 @@ ```http GET /v1/tablesdb/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get.md b/examples/1.9.x/server-rest/examples/tablesdb/get.md index 7ad4e457b..51ac68deb 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get.md @@ -1,7 +1,8 @@ ```http GET /v1/tablesdb/{databaseId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/increment-row-column.md b/examples/1.9.x/server-rest/examples/tablesdb/increment-row-column.md index efe6a6d6a..aee67a5e8 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/increment-row-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/increment-row-column.md @@ -2,11 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}/{column}/increment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "value": 0, + "max": 0, + "transactionId": "<TRANSACTION_ID>" +} { "value": 0, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list-columns.md b/examples/1.9.x/server-rest/examples/tablesdb/list-columns.md index 99707d330..587204ebe 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list-columns.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list-columns.md @@ -1,7 +1,8 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/columns HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list-indexes.md b/examples/1.9.x/server-rest/examples/tablesdb/list-indexes.md index 4a2d639ad..8b1307401 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list-indexes.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list-indexes.md @@ -1,7 +1,8 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/indexes HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list-rows.md b/examples/1.9.x/server-rest/examples/tablesdb/list-rows.md index 99e425432..32447db8a 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list-rows.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list-rows.md @@ -1,9 +1,8 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list-tables.md b/examples/1.9.x/server-rest/examples/tablesdb/list-tables.md index 4066afec6..26ee94d2b 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list-tables.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list-tables.md @@ -1,7 +1,8 @@ ```http GET /v1/tablesdb/{databaseId}/tables HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list-transactions.md b/examples/1.9.x/server-rest/examples/tablesdb/list-transactions.md index a755b8ff2..afa16fd8d 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list-transactions.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list-transactions.md @@ -1,9 +1,8 @@ ```http GET /v1/tablesdb/transactions HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list.md b/examples/1.9.x/server-rest/examples/tablesdb/list.md index 864c2a62a..af2b666ce 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list.md @@ -1,7 +1,8 @@ ```http GET /v1/tablesdb HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-big-int-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-big-int-column.md index eff4d6030..b5bce8060 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-big-int-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-big-int-column.md @@ -2,9 +2,17 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/bigint/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "min": 0, + "max": 0, + "default": 0, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-boolean-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-boolean-column.md index 42bb5ae6f..5ec68f2df 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-boolean-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-boolean-column.md @@ -2,9 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/boolean/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": false, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-datetime-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-datetime-column.md index 327528ddf..a305517cf 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-datetime-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-datetime-column.md @@ -2,9 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/datetime/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "2020-10-15T06:38:00.000+00:00", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-email-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-email-column.md index fefe1c273..575ec7afd 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-email-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-email-column.md @@ -2,9 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/email/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "email@example.com", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-enum-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-enum-column.md index 55400785c..573b37b85 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-enum-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-enum-column.md @@ -2,9 +2,16 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/enum/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "elements": [], + "required": false, + "default": "<DEFAULT>", + "newKey": "" +} { "elements": [], diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-float-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-float-column.md index 7093f92a0..c7c2932b1 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-float-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-float-column.md @@ -2,9 +2,17 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/float/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "min": 0, + "max": 0, + "default": 0, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-integer-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-integer-column.md index f12653d1f..8fedbfc8b 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-integer-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-integer-column.md @@ -2,9 +2,17 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/integer/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "min": 0, + "max": 0, + "default": 0, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-ip-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-ip-column.md index cff4ac416..671e7772d 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-ip-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-ip-column.md @@ -2,9 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/ip/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-line-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-line-column.md index f2ede4f09..e68ea8d3c 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-line-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-line-column.md @@ -2,9 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/line/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": [[1, 2], [3, 4], [5, 6]], + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-longtext-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-longtext-column.md index ab030c92c..d97705700 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-longtext-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-longtext-column.md @@ -2,9 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/longtext/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "<DEFAULT>", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-mediumtext-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-mediumtext-column.md index 1a9536eed..8082c1820 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-mediumtext-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-mediumtext-column.md @@ -2,9 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/mediumtext/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "<DEFAULT>", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-point-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-point-column.md index aa5dc855f..c6fda9df7 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-point-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-point-column.md @@ -2,9 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/point/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": [1, 2], + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-polygon-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-polygon-column.md index 3e4268940..5d3a47c5f 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-polygon-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-polygon-column.md @@ -2,9 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/polygon/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": [[[1, 2], [3, 4], [5, 6], [1, 2]]], + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-relationship-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-relationship-column.md index 3f6914afb..58009cd78 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-relationship-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-relationship-column.md @@ -2,9 +2,14 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/{key}/relationship HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "onDelete": "cascade", + "newKey": "" +} { "onDelete": "cascade", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-row.md b/examples/1.9.x/server-rest/examples/tablesdb/update-row.md index 3f22494cd..e467827b5 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-row.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-row.md @@ -2,11 +2,21 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "<TRANSACTION_ID>" +} { "data": { diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-rows.md b/examples/1.9.x/server-rest/examples/tablesdb/update-rows.md index 93d694032..bce88857f 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-rows.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-rows.md @@ -2,9 +2,21 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + }, + "queries": [], + "transactionId": "<TRANSACTION_ID>" +} { "data": { diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-string-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-string-column.md index e982f3023..b7441785f 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-string-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-string-column.md @@ -2,9 +2,16 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/string/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "<DEFAULT>", + "size": 1, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-table.md b/examples/1.9.x/server-rest/examples/tablesdb/update-table.md index 93a0bb577..05ed753d2 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-table.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-table.md @@ -2,9 +2,17 @@ PUT /v1/tablesdb/{databaseId}/tables/{tableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "permissions": ["read(\"any\")"], + "rowSecurity": false, + "enabled": false, + "purge": false +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-text-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-text-column.md index cb16770fe..b25cad63b 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-text-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-text-column.md @@ -2,9 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/text/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "<DEFAULT>", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-transaction.md b/examples/1.9.x/server-rest/examples/tablesdb/update-transaction.md index 26740954e..6062f2c21 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-transaction.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-transaction.md @@ -2,11 +2,14 @@ PATCH /v1/tablesdb/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "commit": false, + "rollback": false +} { "commit": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-url-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-url-column.md index 700e849fe..ef51651b8 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-url-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-url-column.md @@ -2,9 +2,15 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/url/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "https://example.com", + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-varchar-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-varchar-column.md index 80512e7c8..e070716c1 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-varchar-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-varchar-column.md @@ -2,9 +2,16 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/varchar/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "<DEFAULT>", + "size": 1, + "newKey": "" +} { "required": false, diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update.md b/examples/1.9.x/server-rest/examples/tablesdb/update.md index e32da8b8b..7b394a93a 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update.md @@ -2,9 +2,14 @@ PUT /v1/tablesdb/{databaseId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false +} { "name": "<NAME>", diff --git a/examples/1.9.x/server-rest/examples/tablesdb/upsert-row.md b/examples/1.9.x/server-rest/examples/tablesdb/upsert-row.md index 984577cc3..7a12c6622 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/upsert-row.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/upsert-row.md @@ -2,11 +2,21 @@ PUT /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "data": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + }, + "permissions": ["read(\"any\")"], + "transactionId": "<TRANSACTION_ID>" +} { "data": { diff --git a/examples/1.9.x/server-rest/examples/tablesdb/upsert-rows.md b/examples/1.9.x/server-rest/examples/tablesdb/upsert-rows.md index 2c9099f17..137307fc5 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/upsert-rows.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/upsert-rows.md @@ -2,9 +2,14 @@ PUT /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "rows": [], + "transactionId": "<TRANSACTION_ID>" +} { "rows": [], diff --git a/examples/1.9.x/server-rest/examples/teams/create-membership.md b/examples/1.9.x/server-rest/examples/teams/create-membership.md index eb8c817b2..2a51992d4 100644 --- a/examples/1.9.x/server-rest/examples/teams/create-membership.md +++ b/examples/1.9.x/server-rest/examples/teams/create-membership.md @@ -2,11 +2,18 @@ POST /v1/teams/{teamId}/memberships HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "email": "email@example.com", + "userId": "<USER_ID>", + "phone": "+12065550100", + "roles": [], + "url": "https://example.com", + "name": "<NAME>" +} { "email": "email@example.com", diff --git a/examples/1.9.x/server-rest/examples/teams/create.md b/examples/1.9.x/server-rest/examples/teams/create.md index 46c387359..29bf29db9 100644 --- a/examples/1.9.x/server-rest/examples/teams/create.md +++ b/examples/1.9.x/server-rest/examples/teams/create.md @@ -2,11 +2,15 @@ POST /v1/teams HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "teamId": "<TEAM_ID>", + "name": "<NAME>", + "roles": [] +} { "teamId": "<TEAM_ID>", diff --git a/examples/1.9.x/server-rest/examples/teams/delete-membership.md b/examples/1.9.x/server-rest/examples/teams/delete-membership.md index b23962553..867583674 100644 --- a/examples/1.9.x/server-rest/examples/teams/delete-membership.md +++ b/examples/1.9.x/server-rest/examples/teams/delete-membership.md @@ -4,8 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/teams/delete.md b/examples/1.9.x/server-rest/examples/teams/delete.md index f00de9a71..4e7264791 100644 --- a/examples/1.9.x/server-rest/examples/teams/delete.md +++ b/examples/1.9.x/server-rest/examples/teams/delete.md @@ -4,8 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> ``` diff --git a/examples/1.9.x/server-rest/examples/teams/get-membership.md b/examples/1.9.x/server-rest/examples/teams/get-membership.md index 25f321b2a..1fd0dd33b 100644 --- a/examples/1.9.x/server-rest/examples/teams/get-membership.md +++ b/examples/1.9.x/server-rest/examples/teams/get-membership.md @@ -1,9 +1,8 @@ ```http GET /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/teams/get-prefs.md b/examples/1.9.x/server-rest/examples/teams/get-prefs.md index 16af3d333..dc7a3eefb 100644 --- a/examples/1.9.x/server-rest/examples/teams/get-prefs.md +++ b/examples/1.9.x/server-rest/examples/teams/get-prefs.md @@ -1,8 +1,8 @@ ```http GET /v1/teams/{teamId}/prefs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/teams/get.md b/examples/1.9.x/server-rest/examples/teams/get.md index 97bcc043e..d905f4377 100644 --- a/examples/1.9.x/server-rest/examples/teams/get.md +++ b/examples/1.9.x/server-rest/examples/teams/get.md @@ -1,9 +1,8 @@ ```http GET /v1/teams/{teamId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/teams/list-memberships.md b/examples/1.9.x/server-rest/examples/teams/list-memberships.md index 37be86d09..7a1c29085 100644 --- a/examples/1.9.x/server-rest/examples/teams/list-memberships.md +++ b/examples/1.9.x/server-rest/examples/teams/list-memberships.md @@ -1,9 +1,8 @@ ```http GET /v1/teams/{teamId}/memberships HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/teams/list.md b/examples/1.9.x/server-rest/examples/teams/list.md index ec5739097..9bd0d9671 100644 --- a/examples/1.9.x/server-rest/examples/teams/list.md +++ b/examples/1.9.x/server-rest/examples/teams/list.md @@ -1,9 +1,8 @@ ```http GET /v1/teams HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + ``` diff --git a/examples/1.9.x/server-rest/examples/teams/update-membership-status.md b/examples/1.9.x/server-rest/examples/teams/update-membership-status.md index d9f376fbb..bc085747d 100644 --- a/examples/1.9.x/server-rest/examples/teams/update-membership-status.md +++ b/examples/1.9.x/server-rest/examples/teams/update-membership-status.md @@ -2,10 +2,14 @@ PATCH /v1/teams/{teamId}/memberships/{membershipId}/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/teams/update-membership.md b/examples/1.9.x/server-rest/examples/teams/update-membership.md index 873136a15..14c545e6e 100644 --- a/examples/1.9.x/server-rest/examples/teams/update-membership.md +++ b/examples/1.9.x/server-rest/examples/teams/update-membership.md @@ -2,11 +2,13 @@ PATCH /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "roles": [] +} { "roles": [] diff --git a/examples/1.9.x/server-rest/examples/teams/update-name.md b/examples/1.9.x/server-rest/examples/teams/update-name.md index 5ed922a6b..6b033f89b 100644 --- a/examples/1.9.x/server-rest/examples/teams/update-name.md +++ b/examples/1.9.x/server-rest/examples/teams/update-name.md @@ -2,11 +2,13 @@ PUT /v1/teams/{teamId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> + +{ + "name": "<NAME>" +} { "name": "<NAME>" diff --git a/examples/1.9.x/server-rest/examples/teams/update-prefs.md b/examples/1.9.x/server-rest/examples/teams/update-prefs.md index ec1eefacc..826c07001 100644 --- a/examples/1.9.x/server-rest/examples/teams/update-prefs.md +++ b/examples/1.9.x/server-rest/examples/teams/update-prefs.md @@ -2,10 +2,13 @@ PUT /v1/teams/{teamId}/prefs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> + +{ + "prefs": {} +} { "prefs": {} diff --git a/examples/1.9.x/server-rest/examples/tokens/create-file-token.md b/examples/1.9.x/server-rest/examples/tokens/create-file-token.md index 8dc59d11c..ca97c9a56 100644 --- a/examples/1.9.x/server-rest/examples/tokens/create-file-token.md +++ b/examples/1.9.x/server-rest/examples/tokens/create-file-token.md @@ -2,9 +2,13 @@ POST /v1/tokens/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "expire": "2020-10-15T06:38:00.000+00:00" +} { "expire": "2020-10-15T06:38:00.000+00:00" diff --git a/examples/1.9.x/server-rest/examples/tokens/delete.md b/examples/1.9.x/server-rest/examples/tokens/delete.md index 87a640cdf..ec320a1c8 100644 --- a/examples/1.9.x/server-rest/examples/tokens/delete.md +++ b/examples/1.9.x/server-rest/examples/tokens/delete.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/tokens/get.md b/examples/1.9.x/server-rest/examples/tokens/get.md index cc2a1c15b..041683a1c 100644 --- a/examples/1.9.x/server-rest/examples/tokens/get.md +++ b/examples/1.9.x/server-rest/examples/tokens/get.md @@ -1,7 +1,8 @@ ```http GET /v1/tokens/{tokenId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/tokens/list.md b/examples/1.9.x/server-rest/examples/tokens/list.md index 781ce6c49..540b4737e 100644 --- a/examples/1.9.x/server-rest/examples/tokens/list.md +++ b/examples/1.9.x/server-rest/examples/tokens/list.md @@ -1,7 +1,8 @@ ```http GET /v1/tokens/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/tokens/update.md b/examples/1.9.x/server-rest/examples/tokens/update.md index 13dfce01a..3b550326a 100644 --- a/examples/1.9.x/server-rest/examples/tokens/update.md +++ b/examples/1.9.x/server-rest/examples/tokens/update.md @@ -2,9 +2,13 @@ PATCH /v1/tokens/{tokenId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "expire": "2020-10-15T06:38:00.000+00:00" +} { "expire": "2020-10-15T06:38:00.000+00:00" diff --git a/examples/1.9.x/server-rest/examples/usage/list-events.md b/examples/1.9.x/server-rest/examples/usage/list-events.md index 679b7e25c..21a931c15 100644 --- a/examples/1.9.x/server-rest/examples/usage/list-events.md +++ b/examples/1.9.x/server-rest/examples/usage/list-events.md @@ -1,7 +1,8 @@ ```http GET /v1/usage/events HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/usage/list-gauges.md b/examples/1.9.x/server-rest/examples/usage/list-gauges.md index 65c2fe068..67dd8c731 100644 --- a/examples/1.9.x/server-rest/examples/usage/list-gauges.md +++ b/examples/1.9.x/server-rest/examples/usage/list-gauges.md @@ -1,7 +1,8 @@ ```http GET /v1/usage/gauges HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/create-argon-2-user.md b/examples/1.9.x/server-rest/examples/users/create-argon-2-user.md index ec189edd3..5c4813fac 100644 --- a/examples/1.9.x/server-rest/examples/users/create-argon-2-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-argon-2-user.md @@ -2,9 +2,16 @@ POST /v1/users/argon2 HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "name": "<NAME>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/users/create-bcrypt-user.md b/examples/1.9.x/server-rest/examples/users/create-bcrypt-user.md index 9c14e86ee..c8afb91e5 100644 --- a/examples/1.9.x/server-rest/examples/users/create-bcrypt-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-bcrypt-user.md @@ -2,9 +2,16 @@ POST /v1/users/bcrypt HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "name": "<NAME>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/users/create-jwt.md b/examples/1.9.x/server-rest/examples/users/create-jwt.md index dc1e3efb1..49dee179c 100644 --- a/examples/1.9.x/server-rest/examples/users/create-jwt.md +++ b/examples/1.9.x/server-rest/examples/users/create-jwt.md @@ -2,9 +2,14 @@ POST /v1/users/{userId}/jwts HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "sessionId": "<SESSION_ID>", + "duration": 0 +} { "sessionId": "<SESSION_ID>", diff --git a/examples/1.9.x/server-rest/examples/users/create-md-5-user.md b/examples/1.9.x/server-rest/examples/users/create-md-5-user.md index 59d46471f..f465b60ff 100644 --- a/examples/1.9.x/server-rest/examples/users/create-md-5-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-md-5-user.md @@ -2,9 +2,16 @@ POST /v1/users/md5 HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "name": "<NAME>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/users/create-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/users/create-mfa-recovery-codes.md index 1211c5562..09d77cc27 100644 --- a/examples/1.9.x/server-rest/examples/users/create-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/users/create-mfa-recovery-codes.md @@ -2,8 +2,9 @@ PATCH /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/create-ph-pass-user.md b/examples/1.9.x/server-rest/examples/users/create-ph-pass-user.md index d5575b77c..f7046cab7 100644 --- a/examples/1.9.x/server-rest/examples/users/create-ph-pass-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-ph-pass-user.md @@ -2,9 +2,16 @@ POST /v1/users/phpass HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "name": "<NAME>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/users/create-scrypt-modified-user.md b/examples/1.9.x/server-rest/examples/users/create-scrypt-modified-user.md index de355024a..a79fb2b4e 100644 --- a/examples/1.9.x/server-rest/examples/users/create-scrypt-modified-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-scrypt-modified-user.md @@ -2,9 +2,19 @@ POST /v1/users/scrypt-modified HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "passwordSalt": "<PASSWORD_SALT>", + "passwordSaltSeparator": "<PASSWORD_SALT_SEPARATOR>", + "passwordSignerKey": "<PASSWORD_SIGNER_KEY>", + "name": "<NAME>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/users/create-scrypt-user.md b/examples/1.9.x/server-rest/examples/users/create-scrypt-user.md index ecd25ca2f..6b5307934 100644 --- a/examples/1.9.x/server-rest/examples/users/create-scrypt-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-scrypt-user.md @@ -2,9 +2,21 @@ POST /v1/users/scrypt HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "passwordSalt": "<PASSWORD_SALT>", + "passwordCpu": 0, + "passwordMemory": 0, + "passwordParallel": 0, + "passwordLength": 0, + "name": "<NAME>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/users/create-session.md b/examples/1.9.x/server-rest/examples/users/create-session.md index 827187976..0e5e7b6e9 100644 --- a/examples/1.9.x/server-rest/examples/users/create-session.md +++ b/examples/1.9.x/server-rest/examples/users/create-session.md @@ -2,8 +2,9 @@ POST /v1/users/{userId}/sessions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/create-sha-user.md b/examples/1.9.x/server-rest/examples/users/create-sha-user.md index 0e78d6cd6..1cedbaed4 100644 --- a/examples/1.9.x/server-rest/examples/users/create-sha-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-sha-user.md @@ -2,9 +2,17 @@ POST /v1/users/sha HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "passwordVersion": "sha1", + "name": "<NAME>" +} { "userId": "<USER_ID>", diff --git a/examples/1.9.x/server-rest/examples/users/create-target.md b/examples/1.9.x/server-rest/examples/users/create-target.md index b6357e0f0..a22a23796 100644 --- a/examples/1.9.x/server-rest/examples/users/create-target.md +++ b/examples/1.9.x/server-rest/examples/users/create-target.md @@ -2,9 +2,17 @@ POST /v1/users/{userId}/targets HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "targetId": "<TARGET_ID>", + "providerType": "email", + "identifier": "<IDENTIFIER>", + "providerId": "<PROVIDER_ID>", + "name": "<NAME>" +} { "targetId": "<TARGET_ID>", diff --git a/examples/1.9.x/server-rest/examples/users/create-token.md b/examples/1.9.x/server-rest/examples/users/create-token.md index 800b93be3..ff9e6bab4 100644 --- a/examples/1.9.x/server-rest/examples/users/create-token.md +++ b/examples/1.9.x/server-rest/examples/users/create-token.md @@ -2,9 +2,14 @@ POST /v1/users/{userId}/tokens HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "length": 4, + "expire": 60 +} { "length": 4, diff --git a/examples/1.9.x/server-rest/examples/users/create.md b/examples/1.9.x/server-rest/examples/users/create.md index 64af31742..c1b73ea55 100644 --- a/examples/1.9.x/server-rest/examples/users/create.md +++ b/examples/1.9.x/server-rest/examples/users/create.md @@ -2,15 +2,23 @@ POST /v1/users HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> { "userId": "<USER_ID>", "email": "email@example.com", "phone": "+12065550100", - "password": "", + "password": "password", + "name": "<NAME>" +} + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "phone": "+12065550100", + "password": "password", "name": "<NAME>" } ``` diff --git a/examples/1.9.x/server-rest/examples/users/delete-identity.md b/examples/1.9.x/server-rest/examples/users/delete-identity.md index 70497619c..0f6db0e7b 100644 --- a/examples/1.9.x/server-rest/examples/users/delete-identity.md +++ b/examples/1.9.x/server-rest/examples/users/delete-identity.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/users/delete-mfa-authenticator.md b/examples/1.9.x/server-rest/examples/users/delete-mfa-authenticator.md index e0eb30877..c8168a09c 100644 --- a/examples/1.9.x/server-rest/examples/users/delete-mfa-authenticator.md +++ b/examples/1.9.x/server-rest/examples/users/delete-mfa-authenticator.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/users/delete-session.md b/examples/1.9.x/server-rest/examples/users/delete-session.md index dfb5bdef6..cb25bb2ca 100644 --- a/examples/1.9.x/server-rest/examples/users/delete-session.md +++ b/examples/1.9.x/server-rest/examples/users/delete-session.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/users/delete-sessions.md b/examples/1.9.x/server-rest/examples/users/delete-sessions.md index 8df4f7bb6..f3f40199b 100644 --- a/examples/1.9.x/server-rest/examples/users/delete-sessions.md +++ b/examples/1.9.x/server-rest/examples/users/delete-sessions.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/users/delete-target.md b/examples/1.9.x/server-rest/examples/users/delete-target.md index 31b36bbc4..bbabdb953 100644 --- a/examples/1.9.x/server-rest/examples/users/delete-target.md +++ b/examples/1.9.x/server-rest/examples/users/delete-target.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/users/delete.md b/examples/1.9.x/server-rest/examples/users/delete.md index 5094af578..a53145c98 100644 --- a/examples/1.9.x/server-rest/examples/users/delete.md +++ b/examples/1.9.x/server-rest/examples/users/delete.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/users/get-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/users/get-mfa-recovery-codes.md index 22729a1ac..aa61ef0ab 100644 --- a/examples/1.9.x/server-rest/examples/users/get-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/users/get-mfa-recovery-codes.md @@ -1,7 +1,8 @@ ```http GET /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/get-prefs.md b/examples/1.9.x/server-rest/examples/users/get-prefs.md index 7bbb02195..5c342444f 100644 --- a/examples/1.9.x/server-rest/examples/users/get-prefs.md +++ b/examples/1.9.x/server-rest/examples/users/get-prefs.md @@ -1,7 +1,8 @@ ```http GET /v1/users/{userId}/prefs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/get-target.md b/examples/1.9.x/server-rest/examples/users/get-target.md index 76050b52d..ddded546b 100644 --- a/examples/1.9.x/server-rest/examples/users/get-target.md +++ b/examples/1.9.x/server-rest/examples/users/get-target.md @@ -1,7 +1,8 @@ ```http GET /v1/users/{userId}/targets/{targetId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/get.md b/examples/1.9.x/server-rest/examples/users/get.md index a5fdd29de..8f5f02905 100644 --- a/examples/1.9.x/server-rest/examples/users/get.md +++ b/examples/1.9.x/server-rest/examples/users/get.md @@ -1,7 +1,8 @@ ```http GET /v1/users/{userId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-identities.md b/examples/1.9.x/server-rest/examples/users/list-identities.md index 96a14aecd..cab3c6f79 100644 --- a/examples/1.9.x/server-rest/examples/users/list-identities.md +++ b/examples/1.9.x/server-rest/examples/users/list-identities.md @@ -1,7 +1,8 @@ ```http GET /v1/users/identities HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-logs.md b/examples/1.9.x/server-rest/examples/users/list-logs.md index b6a4b2245..010c007f3 100644 --- a/examples/1.9.x/server-rest/examples/users/list-logs.md +++ b/examples/1.9.x/server-rest/examples/users/list-logs.md @@ -1,7 +1,8 @@ ```http GET /v1/users/{userId}/logs HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-memberships.md b/examples/1.9.x/server-rest/examples/users/list-memberships.md index fb4a04f78..7395dc956 100644 --- a/examples/1.9.x/server-rest/examples/users/list-memberships.md +++ b/examples/1.9.x/server-rest/examples/users/list-memberships.md @@ -1,7 +1,8 @@ ```http GET /v1/users/{userId}/memberships HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-mfa-factors.md b/examples/1.9.x/server-rest/examples/users/list-mfa-factors.md index f7ee17d5c..e0fc099d1 100644 --- a/examples/1.9.x/server-rest/examples/users/list-mfa-factors.md +++ b/examples/1.9.x/server-rest/examples/users/list-mfa-factors.md @@ -1,7 +1,8 @@ ```http GET /v1/users/{userId}/mfa/factors HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-sessions.md b/examples/1.9.x/server-rest/examples/users/list-sessions.md index 3619bcb94..b1719897d 100644 --- a/examples/1.9.x/server-rest/examples/users/list-sessions.md +++ b/examples/1.9.x/server-rest/examples/users/list-sessions.md @@ -1,7 +1,8 @@ ```http GET /v1/users/{userId}/sessions HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-targets.md b/examples/1.9.x/server-rest/examples/users/list-targets.md index d906b8a94..ed404b018 100644 --- a/examples/1.9.x/server-rest/examples/users/list-targets.md +++ b/examples/1.9.x/server-rest/examples/users/list-targets.md @@ -1,7 +1,8 @@ ```http GET /v1/users/{userId}/targets HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/list.md b/examples/1.9.x/server-rest/examples/users/list.md index ed4c67f33..a26a4bfb3 100644 --- a/examples/1.9.x/server-rest/examples/users/list.md +++ b/examples/1.9.x/server-rest/examples/users/list.md @@ -1,7 +1,8 @@ ```http GET /v1/users HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/update-email-verification.md b/examples/1.9.x/server-rest/examples/users/update-email-verification.md index 3f43ac6ff..614f3226e 100644 --- a/examples/1.9.x/server-rest/examples/users/update-email-verification.md +++ b/examples/1.9.x/server-rest/examples/users/update-email-verification.md @@ -2,9 +2,13 @@ PATCH /v1/users/{userId}/verification HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "emailVerification": false +} { "emailVerification": false diff --git a/examples/1.9.x/server-rest/examples/users/update-email.md b/examples/1.9.x/server-rest/examples/users/update-email.md index 47c5cc156..cb1aae0ef 100644 --- a/examples/1.9.x/server-rest/examples/users/update-email.md +++ b/examples/1.9.x/server-rest/examples/users/update-email.md @@ -2,9 +2,13 @@ PATCH /v1/users/{userId}/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "email": "email@example.com" +} { "email": "email@example.com" diff --git a/examples/1.9.x/server-rest/examples/users/update-impersonator.md b/examples/1.9.x/server-rest/examples/users/update-impersonator.md index c51e88784..1a0ac7827 100644 --- a/examples/1.9.x/server-rest/examples/users/update-impersonator.md +++ b/examples/1.9.x/server-rest/examples/users/update-impersonator.md @@ -2,9 +2,13 @@ PATCH /v1/users/{userId}/impersonator HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "impersonator": false +} { "impersonator": false diff --git a/examples/1.9.x/server-rest/examples/users/update-labels.md b/examples/1.9.x/server-rest/examples/users/update-labels.md index 753b41a19..8526af2d4 100644 --- a/examples/1.9.x/server-rest/examples/users/update-labels.md +++ b/examples/1.9.x/server-rest/examples/users/update-labels.md @@ -2,9 +2,13 @@ PUT /v1/users/{userId}/labels HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "labels": [] +} { "labels": [] diff --git a/examples/1.9.x/server-rest/examples/users/update-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/users/update-mfa-recovery-codes.md index 4001d274f..de38876a2 100644 --- a/examples/1.9.x/server-rest/examples/users/update-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/users/update-mfa-recovery-codes.md @@ -2,8 +2,9 @@ PUT /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/users/update-mfa.md b/examples/1.9.x/server-rest/examples/users/update-mfa.md index 162dfe6f2..443383141 100644 --- a/examples/1.9.x/server-rest/examples/users/update-mfa.md +++ b/examples/1.9.x/server-rest/examples/users/update-mfa.md @@ -2,9 +2,13 @@ PATCH /v1/users/{userId}/mfa HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "mfa": false +} { "mfa": false diff --git a/examples/1.9.x/server-rest/examples/users/update-name.md b/examples/1.9.x/server-rest/examples/users/update-name.md index ab470e0db..03ee3ec0f 100644 --- a/examples/1.9.x/server-rest/examples/users/update-name.md +++ b/examples/1.9.x/server-rest/examples/users/update-name.md @@ -2,9 +2,13 @@ PATCH /v1/users/{userId}/name HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>" +} { "name": "<NAME>" diff --git a/examples/1.9.x/server-rest/examples/users/update-password.md b/examples/1.9.x/server-rest/examples/users/update-password.md index d303e0bdb..dac76f878 100644 --- a/examples/1.9.x/server-rest/examples/users/update-password.md +++ b/examples/1.9.x/server-rest/examples/users/update-password.md @@ -2,11 +2,15 @@ PATCH /v1/users/{userId}/password HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> { - "password": "" + "password": "password" +} + +{ + "password": "password" } ``` diff --git a/examples/1.9.x/server-rest/examples/users/update-phone-verification.md b/examples/1.9.x/server-rest/examples/users/update-phone-verification.md index f7da175d4..156c8e86e 100644 --- a/examples/1.9.x/server-rest/examples/users/update-phone-verification.md +++ b/examples/1.9.x/server-rest/examples/users/update-phone-verification.md @@ -2,9 +2,13 @@ PATCH /v1/users/{userId}/verification/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "phoneVerification": false +} { "phoneVerification": false diff --git a/examples/1.9.x/server-rest/examples/users/update-phone.md b/examples/1.9.x/server-rest/examples/users/update-phone.md index e0005c57f..e0b968e99 100644 --- a/examples/1.9.x/server-rest/examples/users/update-phone.md +++ b/examples/1.9.x/server-rest/examples/users/update-phone.md @@ -2,9 +2,13 @@ PATCH /v1/users/{userId}/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "number": "+12065550100" +} { "number": "+12065550100" diff --git a/examples/1.9.x/server-rest/examples/users/update-prefs.md b/examples/1.9.x/server-rest/examples/users/update-prefs.md index 1e66f349e..7fcec4274 100644 --- a/examples/1.9.x/server-rest/examples/users/update-prefs.md +++ b/examples/1.9.x/server-rest/examples/users/update-prefs.md @@ -2,9 +2,13 @@ PATCH /v1/users/{userId}/prefs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "prefs": {} +} { "prefs": {} diff --git a/examples/1.9.x/server-rest/examples/users/update-status.md b/examples/1.9.x/server-rest/examples/users/update-status.md index 4841a8cae..562154a24 100644 --- a/examples/1.9.x/server-rest/examples/users/update-status.md +++ b/examples/1.9.x/server-rest/examples/users/update-status.md @@ -2,9 +2,13 @@ PATCH /v1/users/{userId}/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "status": false +} { "status": false diff --git a/examples/1.9.x/server-rest/examples/users/update-target.md b/examples/1.9.x/server-rest/examples/users/update-target.md index 4d82a24fc..3cd01a810 100644 --- a/examples/1.9.x/server-rest/examples/users/update-target.md +++ b/examples/1.9.x/server-rest/examples/users/update-target.md @@ -2,9 +2,15 @@ PATCH /v1/users/{userId}/targets/{targetId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "identifier": "<IDENTIFIER>", + "providerId": "<PROVIDER_ID>", + "name": "<NAME>" +} { "identifier": "<IDENTIFIER>", diff --git a/examples/1.9.x/server-rest/examples/webhooks/create.md b/examples/1.9.x/server-rest/examples/webhooks/create.md index b7f3d526d..c30b52b30 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/create.md +++ b/examples/1.9.x/server-rest/examples/webhooks/create.md @@ -2,9 +2,9 @@ POST /v1/webhooks HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> { "webhookId": "<WEBHOOK_ID>", @@ -14,7 +14,19 @@ X-Appwrite-Key: <YOUR_API_KEY> "enabled": false, "tls": false, "authUsername": "<AUTH_USERNAME>", - "authPassword": "<AUTH_PASSWORD>", + "authPassword": "password", + "secret": "<SECRET>" +} + +{ + "webhookId": "<WEBHOOK_ID>", + "url": "", + "name": "<NAME>", + "events": [], + "enabled": false, + "tls": false, + "authUsername": "<AUTH_USERNAME>", + "authPassword": "password", "secret": "<SECRET>" } ``` diff --git a/examples/1.9.x/server-rest/examples/webhooks/delete.md b/examples/1.9.x/server-rest/examples/webhooks/delete.md index d9b01d6e8..8b9622e2e 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/delete.md +++ b/examples/1.9.x/server-rest/examples/webhooks/delete.md @@ -4,6 +4,5 @@ Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> ``` diff --git a/examples/1.9.x/server-rest/examples/webhooks/get.md b/examples/1.9.x/server-rest/examples/webhooks/get.md index fa845390f..c9ffde32b 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/get.md +++ b/examples/1.9.x/server-rest/examples/webhooks/get.md @@ -1,7 +1,8 @@ ```http GET /v1/webhooks/{webhookId} HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/webhooks/list.md b/examples/1.9.x/server-rest/examples/webhooks/list.md index 555eef1fb..88aa7734a 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/list.md +++ b/examples/1.9.x/server-rest/examples/webhooks/list.md @@ -1,7 +1,8 @@ ```http GET /v1/webhooks HTTP/1.1 Host: cloud.appwrite.io +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + ``` diff --git a/examples/1.9.x/server-rest/examples/webhooks/update-secret.md b/examples/1.9.x/server-rest/examples/webhooks/update-secret.md index 0e0b0a36c..901a3aa31 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/update-secret.md +++ b/examples/1.9.x/server-rest/examples/webhooks/update-secret.md @@ -2,9 +2,13 @@ PATCH /v1/webhooks/{webhookId}/secret HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> + +{ + "secret": "<SECRET>" +} { "secret": "<SECRET>" diff --git a/examples/1.9.x/server-rest/examples/webhooks/update.md b/examples/1.9.x/server-rest/examples/webhooks/update.md index 316f2894c..dd2cd1d67 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/update.md +++ b/examples/1.9.x/server-rest/examples/webhooks/update.md @@ -2,9 +2,9 @@ PUT /v1/webhooks/{webhookId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json +Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> { "name": "<NAME>", @@ -13,6 +13,16 @@ X-Appwrite-Key: <YOUR_API_KEY> "enabled": false, "tls": false, "authUsername": "<AUTH_USERNAME>", - "authPassword": "<AUTH_PASSWORD>" + "authPassword": "password" +} + +{ + "name": "<NAME>", + "url": "", + "events": [], + "enabled": false, + "tls": false, + "authUsername": "<AUTH_USERNAME>", + "authPassword": "password" } ``` diff --git a/examples/1.9.x/server-ruby/examples/account/create.md b/examples/1.9.x/server-ruby/examples/account/create.md index 673c8f3f0..683fd89dd 100644 --- a/examples/1.9.x/server-ruby/examples/account/create.md +++ b/examples/1.9.x/server-ruby/examples/account/create.md @@ -13,7 +13,7 @@ account = Account.new(client) result = account.create( user_id: '<USER_ID>', email: 'email@example.com', - password: '', + password: 'password', name: '<NAME>' # optional ) ``` diff --git a/examples/1.9.x/server-ruby/examples/account/update-password.md b/examples/1.9.x/server-ruby/examples/account/update-password.md index c9f935101..1e9aba5ad 100644 --- a/examples/1.9.x/server-ruby/examples/account/update-password.md +++ b/examples/1.9.x/server-ruby/examples/account/update-password.md @@ -11,7 +11,7 @@ client = Client.new account = Account.new(client) result = account.update_password( - password: '', + password: 'password', old_password: 'password' # optional ) ``` diff --git a/examples/1.9.x/server-ruby/examples/account/update-recovery.md b/examples/1.9.x/server-ruby/examples/account/update-recovery.md index 198579aed..e3cfb643b 100644 --- a/examples/1.9.x/server-ruby/examples/account/update-recovery.md +++ b/examples/1.9.x/server-ruby/examples/account/update-recovery.md @@ -13,6 +13,6 @@ account = Account.new(client) result = account.update_recovery( user_id: '<USER_ID>', secret: '<SECRET>', - password: '' + password: 'password' ) ``` diff --git a/examples/1.9.x/server-ruby/examples/avatars/get-browser.md b/examples/1.9.x/server-ruby/examples/avatars/get-browser.md index 2c9c1272d..e9a919811 100644 --- a/examples/1.9.x/server-ruby/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-ruby/examples/avatars/get-browser.md @@ -8,6 +8,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_session('') # The user session to authenticate with + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars.new(client) diff --git a/examples/1.9.x/server-ruby/examples/avatars/get-credit-card.md b/examples/1.9.x/server-ruby/examples/avatars/get-credit-card.md index a912b9cd4..b82429583 100644 --- a/examples/1.9.x/server-ruby/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-ruby/examples/avatars/get-credit-card.md @@ -8,6 +8,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_session('') # The user session to authenticate with + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars.new(client) diff --git a/examples/1.9.x/server-ruby/examples/avatars/get-favicon.md b/examples/1.9.x/server-ruby/examples/avatars/get-favicon.md index a50b91a85..6e27653c0 100644 --- a/examples/1.9.x/server-ruby/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-ruby/examples/avatars/get-favicon.md @@ -7,6 +7,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_session('') # The user session to authenticate with + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars.new(client) diff --git a/examples/1.9.x/server-ruby/examples/avatars/get-flag.md b/examples/1.9.x/server-ruby/examples/avatars/get-flag.md index a2f120672..fad03b05b 100644 --- a/examples/1.9.x/server-ruby/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-ruby/examples/avatars/get-flag.md @@ -8,6 +8,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_session('') # The user session to authenticate with + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars.new(client) diff --git a/examples/1.9.x/server-ruby/examples/avatars/get-image.md b/examples/1.9.x/server-ruby/examples/avatars/get-image.md index b3bcce331..40da035be 100644 --- a/examples/1.9.x/server-ruby/examples/avatars/get-image.md +++ b/examples/1.9.x/server-ruby/examples/avatars/get-image.md @@ -7,6 +7,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_session('') # The user session to authenticate with + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars.new(client) diff --git a/examples/1.9.x/server-ruby/examples/avatars/get-initials.md b/examples/1.9.x/server-ruby/examples/avatars/get-initials.md index 695ccf72d..efee39850 100644 --- a/examples/1.9.x/server-ruby/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-ruby/examples/avatars/get-initials.md @@ -7,6 +7,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_session('') # The user session to authenticate with + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars.new(client) diff --git a/examples/1.9.x/server-ruby/examples/avatars/get-qr.md b/examples/1.9.x/server-ruby/examples/avatars/get-qr.md index 2ccde309a..2024413ce 100644 --- a/examples/1.9.x/server-ruby/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-ruby/examples/avatars/get-qr.md @@ -7,6 +7,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_session('') # The user session to authenticate with + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars.new(client) diff --git a/examples/1.9.x/server-ruby/examples/avatars/get-screenshot.md b/examples/1.9.x/server-ruby/examples/avatars/get-screenshot.md index 742c87fd9..19aa9a702 100644 --- a/examples/1.9.x/server-ruby/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-ruby/examples/avatars/get-screenshot.md @@ -8,6 +8,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_session('') # The user session to authenticate with + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. avatars = Avatars.new(client) diff --git a/examples/1.9.x/server-ruby/examples/functions/create.md b/examples/1.9.x/server-ruby/examples/functions/create.md index 36f036f40..b51c2f2a1 100644 --- a/examples/1.9.x/server-ruby/examples/functions/create.md +++ b/examples/1.9.x/server-ruby/examples/functions/create.md @@ -14,7 +14,7 @@ functions = Functions.new(client) result = functions.create( function_id: '<FUNCTION_ID>', name: '<NAME>', - runtime: FunctionRuntime::NODE_14_5, + runtime: Runtime::NODE_14_5, execute: ["any"], # optional events: [], # optional schedule: '', # optional diff --git a/examples/1.9.x/server-ruby/examples/functions/get-deployment-download.md b/examples/1.9.x/server-ruby/examples/functions/get-deployment-download.md index 728cfca6b..7b6522a26 100644 --- a/examples/1.9.x/server-ruby/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-ruby/examples/functions/get-deployment-download.md @@ -8,6 +8,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_key('<YOUR_API_KEY>') # Your secret API key + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. functions = Functions.new(client) diff --git a/examples/1.9.x/server-ruby/examples/functions/update.md b/examples/1.9.x/server-ruby/examples/functions/update.md index 9693112ff..458be60eb 100644 --- a/examples/1.9.x/server-ruby/examples/functions/update.md +++ b/examples/1.9.x/server-ruby/examples/functions/update.md @@ -14,7 +14,7 @@ functions = Functions.new(client) result = functions.update( function_id: '<FUNCTION_ID>', name: '<NAME>', - runtime: FunctionRuntime::NODE_14_5, # optional + runtime: Runtime::NODE_14_5, # optional execute: ["any"], # optional events: [], # optional schedule: '', # optional diff --git a/examples/1.9.x/server-ruby/examples/health/get-audits-db.md b/examples/1.9.x/server-ruby/examples/health/get-audits-db.md new file mode 100644 index 000000000..19ad2e750 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/health/get-audits-db.md @@ -0,0 +1,14 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_audits_db() +``` diff --git a/examples/1.9.x/server-ruby/examples/messaging/create-ses-provider.md b/examples/1.9.x/server-ruby/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..2ac71f733 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/messaging/create-ses-provider.md @@ -0,0 +1,25 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_ses_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', + access_key: '<ACCESS_KEY>', # optional + secret_key: '<SECRET_KEY>', # optional + region: '<REGION>', # optional + from_name: '<FROM_NAME>', # optional + from_email: 'email@example.com', # optional + reply_to_name: '<REPLY_TO_NAME>', # optional + reply_to_email: 'email@example.com', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-ruby/examples/messaging/create-smtp-provider.md index f3fd75d99..85c1abdaf 100644 --- a/examples/1.9.x/server-ruby/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-ruby/examples/messaging/create-smtp-provider.md @@ -17,7 +17,7 @@ result = messaging.create_smtp_provider( host: '<HOST>', port: 1, # optional username: '<USERNAME>', # optional - password: '<PASSWORD>', # optional + password: 'password', # optional encryption: SmtpEncryption::NONE, # optional auto_tls: false, # optional mailer: '<MAILER>', # optional diff --git a/examples/1.9.x/server-ruby/examples/messaging/update-ses-provider.md b/examples/1.9.x/server-ruby/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..9465ac31b --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/messaging/update-ses-provider.md @@ -0,0 +1,25 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_ses_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', # optional + enabled: false, # optional + access_key: '<ACCESS_KEY>', # optional + secret_key: '<SECRET_KEY>', # optional + region: '<REGION>', # optional + from_name: '<FROM_NAME>', # optional + from_email: 'email@example.com', # optional + reply_to_name: '<REPLY_TO_NAME>', # optional + reply_to_email: '<REPLY_TO_EMAIL>' # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-ruby/examples/messaging/update-smtp-provider.md index 3c810609b..a7355fefc 100644 --- a/examples/1.9.x/server-ruby/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-ruby/examples/messaging/update-smtp-provider.md @@ -17,7 +17,7 @@ result = messaging.update_smtp_provider( host: '<HOST>', # optional port: 1, # optional username: '<USERNAME>', # optional - password: '<PASSWORD>', # optional + password: 'password', # optional encryption: SmtpEncryption::NONE, # optional auto_tls: false, # optional mailer: '<MAILER>', # optional diff --git a/examples/1.9.x/server-ruby/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-ruby/examples/project/update-membership-privacy-policy.md index e29b6b937..b84a8facc 100644 --- a/examples/1.9.x/server-ruby/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-ruby/examples/project/update-membership-privacy-policy.md @@ -15,6 +15,7 @@ result = project.update_membership_privacy_policy( user_email: false, # optional user_phone: false, # optional user_name: false, # optional - user_mfa: false # optional + user_mfa: false, # optional + user_accessed_at: false # optional ) ``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-server.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..6bdc13410 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-server.md @@ -0,0 +1,28 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_server( + enabled: false, + authorization_url: 'https://example.com', + scopes: [], # optional + authorization_details_types: [], # optional + access_token_duration: 60, # optional + refresh_token_duration: 60, # optional + public_access_token_duration: 60, # optional + public_refresh_token_duration: 60, # optional + confidential_pkce: false, # optional + verification_url: 'https://example.com', # optional + user_code_length: 6, # optional + user_code_format: 'numeric', # optional + device_code_duration: 60 # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-password-strength-policy.md b/examples/1.9.x/server-ruby/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..516324116 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-password-strength-policy.md @@ -0,0 +1,20 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +project = Project.new(client) + +result = project.update_password_strength_policy( + min: 8, # optional + uppercase: false, # optional + lowercase: false, # optional + number: false, # optional + symbols: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-smtp.md b/examples/1.9.x/server-ruby/examples/project/update-smtp.md index ca53c6b53..7dda7710a 100644 --- a/examples/1.9.x/server-ruby/examples/project/update-smtp.md +++ b/examples/1.9.x/server-ruby/examples/project/update-smtp.md @@ -15,7 +15,7 @@ result = project.update_smtp( host: '', # optional port: null, # optional username: '<USERNAME>', # optional - password: '<PASSWORD>', # optional + password: 'password', # optional sender_email: 'email@example.com', # optional sender_name: '<SENDER_NAME>', # optional reply_to_email: 'email@example.com', # optional diff --git a/examples/1.9.x/server-ruby/examples/proxy/create-redirect-rule.md b/examples/1.9.x/server-ruby/examples/proxy/create-redirect-rule.md index c0e5c704d..b07fb4a48 100644 --- a/examples/1.9.x/server-ruby/examples/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-ruby/examples/proxy/create-redirect-rule.md @@ -14,7 +14,7 @@ proxy = Proxy.new(client) result = proxy.create_redirect_rule( domain: '', url: 'https://example.com', - status_code: RedirectStatusCode::MOVEDPERMANENTLY, + status_code: StatusCode::MOVEDPERMANENTLY, resource_id: '<RESOURCE_ID>', resource_type: ProxyResourceType::SITE ) diff --git a/examples/1.9.x/server-ruby/examples/sites/create.md b/examples/1.9.x/server-ruby/examples/sites/create.md index 39336bb18..8eccf032d 100644 --- a/examples/1.9.x/server-ruby/examples/sites/create.md +++ b/examples/1.9.x/server-ruby/examples/sites/create.md @@ -14,8 +14,8 @@ sites = Sites.new(client) result = sites.create( site_id: '<SITE_ID>', name: '<NAME>', - framework: SiteFramework::ANALOG, - build_runtime: SiteBuildRuntime::NODE_14_5, + framework: Framework::ANALOG, + build_runtime: BuildRuntime::NODE_14_5, enabled: false, # optional logging: false, # optional timeout: 1, # optional @@ -23,7 +23,7 @@ result = sites.create( build_command: '<BUILD_COMMAND>', # optional start_command: '<START_COMMAND>', # optional output_directory: '<OUTPUT_DIRECTORY>', # optional - adapter: SiteAdapter::STATIC, # optional + adapter: Adapter::STATIC, # optional installation_id: '<INSTALLATION_ID>', # optional fallback_file: '<FALLBACK_FILE>', # optional provider_repository_id: '<PROVIDER_REPOSITORY_ID>', # optional diff --git a/examples/1.9.x/server-ruby/examples/sites/get-deployment-download.md b/examples/1.9.x/server-ruby/examples/sites/get-deployment-download.md index 0fe19a3c4..4c8694357 100644 --- a/examples/1.9.x/server-ruby/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-ruby/examples/sites/get-deployment-download.md @@ -8,6 +8,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_key('<YOUR_API_KEY>') # Your secret API key + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. sites = Sites.new(client) diff --git a/examples/1.9.x/server-ruby/examples/sites/update.md b/examples/1.9.x/server-ruby/examples/sites/update.md index 9f4e79eeb..663dadcae 100644 --- a/examples/1.9.x/server-ruby/examples/sites/update.md +++ b/examples/1.9.x/server-ruby/examples/sites/update.md @@ -14,7 +14,7 @@ sites = Sites.new(client) result = sites.update( site_id: '<SITE_ID>', name: '<NAME>', - framework: SiteFramework::ANALOG, + framework: Framework::ANALOG, enabled: false, # optional logging: false, # optional timeout: 1, # optional @@ -22,8 +22,8 @@ result = sites.update( build_command: '<BUILD_COMMAND>', # optional start_command: '<START_COMMAND>', # optional output_directory: '<OUTPUT_DIRECTORY>', # optional - build_runtime: SiteBuildRuntime::NODE_14_5, # optional - adapter: SiteAdapter::STATIC, # optional + build_runtime: BuildRuntime::NODE_14_5, # optional + adapter: Adapter::STATIC, # optional fallback_file: '<FALLBACK_FILE>', # optional installation_id: '<INSTALLATION_ID>', # optional provider_repository_id: '<PROVIDER_REPOSITORY_ID>', # optional diff --git a/examples/1.9.x/server-ruby/examples/storage/get-file-download.md b/examples/1.9.x/server-ruby/examples/storage/get-file-download.md index 33324990c..7ebcbf485 100644 --- a/examples/1.9.x/server-ruby/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-ruby/examples/storage/get-file-download.md @@ -7,6 +7,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_session('') # The user session to authenticate with + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. storage = Storage.new(client) diff --git a/examples/1.9.x/server-ruby/examples/storage/get-file-preview.md b/examples/1.9.x/server-ruby/examples/storage/get-file-preview.md index 8db54e015..8469e45c2 100644 --- a/examples/1.9.x/server-ruby/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-ruby/examples/storage/get-file-preview.md @@ -8,6 +8,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_session('') # The user session to authenticate with + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. storage = Storage.new(client) diff --git a/examples/1.9.x/server-ruby/examples/storage/get-file-view.md b/examples/1.9.x/server-ruby/examples/storage/get-file-view.md index ed3e898e1..d074f6451 100644 --- a/examples/1.9.x/server-ruby/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-ruby/examples/storage/get-file-view.md @@ -7,6 +7,7 @@ client = Client.new .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint .set_project('<YOUR_PROJECT_ID>') # Your project ID .set_session('') # The user session to authenticate with + .set_impersonate_user_id('') # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. storage = Storage.new(client) diff --git a/examples/1.9.x/server-ruby/examples/users/create.md b/examples/1.9.x/server-ruby/examples/users/create.md index 06e308890..183fa0769 100644 --- a/examples/1.9.x/server-ruby/examples/users/create.md +++ b/examples/1.9.x/server-ruby/examples/users/create.md @@ -14,7 +14,7 @@ result = users.create( user_id: '<USER_ID>', email: 'email@example.com', # optional phone: '+12065550100', # optional - password: '', # optional + password: 'password', # optional name: '<NAME>' # optional ) ``` diff --git a/examples/1.9.x/server-ruby/examples/users/update-password.md b/examples/1.9.x/server-ruby/examples/users/update-password.md index b7779e638..6be197188 100644 --- a/examples/1.9.x/server-ruby/examples/users/update-password.md +++ b/examples/1.9.x/server-ruby/examples/users/update-password.md @@ -12,6 +12,6 @@ users = Users.new(client) result = users.update_password( user_id: '<USER_ID>', - password: '' + password: 'password' ) ``` diff --git a/examples/1.9.x/server-ruby/examples/webhooks/create.md b/examples/1.9.x/server-ruby/examples/webhooks/create.md index e55391087..58177d5ac 100644 --- a/examples/1.9.x/server-ruby/examples/webhooks/create.md +++ b/examples/1.9.x/server-ruby/examples/webhooks/create.md @@ -18,7 +18,7 @@ result = webhooks.create( enabled: false, # optional tls: false, # optional auth_username: '<AUTH_USERNAME>', # optional - auth_password: '<AUTH_PASSWORD>', # optional + auth_password: 'password', # optional secret: '<SECRET>' # optional ) ``` diff --git a/examples/1.9.x/server-ruby/examples/webhooks/update.md b/examples/1.9.x/server-ruby/examples/webhooks/update.md index 1de7c044a..d5d954287 100644 --- a/examples/1.9.x/server-ruby/examples/webhooks/update.md +++ b/examples/1.9.x/server-ruby/examples/webhooks/update.md @@ -18,6 +18,6 @@ result = webhooks.update( enabled: false, # optional tls: false, # optional auth_username: '<AUTH_USERNAME>', # optional - auth_password: '<AUTH_PASSWORD>' # optional + auth_password: 'password' # optional ) ``` diff --git a/examples/1.9.x/server-rust/examples/account/create.md b/examples/1.9.x/server-rust/examples/account/create.md index 27143111a..b32e57733 100644 --- a/examples/1.9.x/server-rust/examples/account/create.md +++ b/examples/1.9.x/server-rust/examples/account/create.md @@ -14,7 +14,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let result = account.create( "<USER_ID>", "email@example.com", - "", + "password", Some("<NAME>") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/account/update-password.md b/examples/1.9.x/server-rust/examples/account/update-password.md index c6c4d5ca0..2e0ac1d36 100644 --- a/examples/1.9.x/server-rust/examples/account/update-password.md +++ b/examples/1.9.x/server-rust/examples/account/update-password.md @@ -12,7 +12,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let account = Account::new(&client); let result = account.update_password( - "", + "password", Some("password") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/account/update-recovery.md b/examples/1.9.x/server-rust/examples/account/update-recovery.md index 8c1c814a5..340134c60 100644 --- a/examples/1.9.x/server-rust/examples/account/update-recovery.md +++ b/examples/1.9.x/server-rust/examples/account/update-recovery.md @@ -14,7 +14,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let result = account.update_recovery( "<USER_ID>", "<SECRET>", - "" + "password" ).await?; let _ = result; diff --git a/examples/1.9.x/server-rust/examples/avatars/get-browser.md b/examples/1.9.x/server-rust/examples/avatars/get-browser.md index e61031416..ab33367c6 100644 --- a/examples/1.9.x/server-rust/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-rust/examples/avatars/get-browser.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_session(""); // The user session to authenticate with + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars::new(&client); diff --git a/examples/1.9.x/server-rust/examples/avatars/get-credit-card.md b/examples/1.9.x/server-rust/examples/avatars/get-credit-card.md index 2fb6fef00..b21ea21fc 100644 --- a/examples/1.9.x/server-rust/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-rust/examples/avatars/get-credit-card.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_session(""); // The user session to authenticate with + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars::new(&client); diff --git a/examples/1.9.x/server-rust/examples/avatars/get-favicon.md b/examples/1.9.x/server-rust/examples/avatars/get-favicon.md index 74c33216a..8fddde9fa 100644 --- a/examples/1.9.x/server-rust/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-rust/examples/avatars/get-favicon.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_session(""); // The user session to authenticate with + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars::new(&client); diff --git a/examples/1.9.x/server-rust/examples/avatars/get-flag.md b/examples/1.9.x/server-rust/examples/avatars/get-flag.md index 621d2c13e..436d809f8 100644 --- a/examples/1.9.x/server-rust/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-rust/examples/avatars/get-flag.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_session(""); // The user session to authenticate with + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars::new(&client); diff --git a/examples/1.9.x/server-rust/examples/avatars/get-image.md b/examples/1.9.x/server-rust/examples/avatars/get-image.md index b7175c7bf..13dc99768 100644 --- a/examples/1.9.x/server-rust/examples/avatars/get-image.md +++ b/examples/1.9.x/server-rust/examples/avatars/get-image.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_session(""); // The user session to authenticate with + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars::new(&client); diff --git a/examples/1.9.x/server-rust/examples/avatars/get-initials.md b/examples/1.9.x/server-rust/examples/avatars/get-initials.md index 47209751c..f036f3d79 100644 --- a/examples/1.9.x/server-rust/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-rust/examples/avatars/get-initials.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_session(""); // The user session to authenticate with + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars::new(&client); diff --git a/examples/1.9.x/server-rust/examples/avatars/get-qr.md b/examples/1.9.x/server-rust/examples/avatars/get-qr.md index 585f63a04..e4a322260 100644 --- a/examples/1.9.x/server-rust/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-rust/examples/avatars/get-qr.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_session(""); // The user session to authenticate with + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars::new(&client); diff --git a/examples/1.9.x/server-rust/examples/avatars/get-screenshot.md b/examples/1.9.x/server-rust/examples/avatars/get-screenshot.md index d21ece0b5..c1a8dc8a9 100644 --- a/examples/1.9.x/server-rust/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-rust/examples/avatars/get-screenshot.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_session(""); // The user session to authenticate with + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars::new(&client); diff --git a/examples/1.9.x/server-rust/examples/backups/delete-archive.md b/examples/1.9.x/server-rust/examples/backups/delete-archive.md index 5929752f9..d75868a22 100644 --- a/examples/1.9.x/server-rust/examples/backups/delete-archive.md +++ b/examples/1.9.x/server-rust/examples/backups/delete-archive.md @@ -11,10 +11,12 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let backups = Backups::new(&client); - backups.delete_archive( + let result = backups.delete_archive( "<ARCHIVE_ID>" ).await?; + let _ = result; + Ok(()) } ``` diff --git a/examples/1.9.x/server-rust/examples/backups/delete-policy.md b/examples/1.9.x/server-rust/examples/backups/delete-policy.md index 2368cc217..05e44f4d8 100644 --- a/examples/1.9.x/server-rust/examples/backups/delete-policy.md +++ b/examples/1.9.x/server-rust/examples/backups/delete-policy.md @@ -11,10 +11,12 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let backups = Backups::new(&client); - backups.delete_policy( + let result = backups.delete_policy( "<POLICY_ID>" ).await?; + let _ = result; + Ok(()) } ``` diff --git a/examples/1.9.x/server-rust/examples/functions/create.md b/examples/1.9.x/server-rust/examples/functions/create.md index 680f4cd88..cea46ea88 100644 --- a/examples/1.9.x/server-rust/examples/functions/create.md +++ b/examples/1.9.x/server-rust/examples/functions/create.md @@ -14,7 +14,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let result = functions.create( "<FUNCTION_ID>", "<NAME>", - appwrite::enums::FunctionRuntime::Node145, + appwrite::enums::Runtime::Node145, Some(vec!["any".into()]), // optional Some(vec![]), // optional Some(""), // optional diff --git a/examples/1.9.x/server-rust/examples/functions/get-deployment-download.md b/examples/1.9.x/server-rust/examples/functions/get-deployment-download.md index 9ff7cb83e..efe8e732c 100644 --- a/examples/1.9.x/server-rust/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-rust/examples/functions/get-deployment-download.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_key("<YOUR_API_KEY>"); // Your secret API key + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let functions = Functions::new(&client); diff --git a/examples/1.9.x/server-rust/examples/functions/update.md b/examples/1.9.x/server-rust/examples/functions/update.md index 0978b2713..2eec7ae7c 100644 --- a/examples/1.9.x/server-rust/examples/functions/update.md +++ b/examples/1.9.x/server-rust/examples/functions/update.md @@ -14,7 +14,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let result = functions.update( "<FUNCTION_ID>", "<NAME>", - Some(appwrite::enums::FunctionRuntime::Node145), // optional + Some(appwrite::enums::Runtime::Node145), // optional Some(vec!["any".into()]), // optional Some(vec![]), // optional Some(""), // optional diff --git a/examples/1.9.x/server-rust/examples/graphql/mutation.md b/examples/1.9.x/server-rust/examples/graphql/mutation.md index d9d7fa28c..559dc2854 100644 --- a/examples/1.9.x/server-rust/examples/graphql/mutation.md +++ b/examples/1.9.x/server-rust/examples/graphql/mutation.md @@ -11,10 +11,12 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let graphql = Graphql::new(&client); - graphql.mutation( + let result = graphql.mutation( serde_json::json!({}) ).await?; + let _ = result; + Ok(()) } ``` diff --git a/examples/1.9.x/server-rust/examples/graphql/query.md b/examples/1.9.x/server-rust/examples/graphql/query.md index 506e4371a..edd210470 100644 --- a/examples/1.9.x/server-rust/examples/graphql/query.md +++ b/examples/1.9.x/server-rust/examples/graphql/query.md @@ -11,10 +11,12 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let graphql = Graphql::new(&client); - graphql.query( + let result = graphql.query( serde_json::json!({}) ).await?; + let _ = result; + Ok(()) } ``` diff --git a/examples/1.9.x/server-rust/examples/health/get-audits-db.md b/examples/1.9.x/server-rust/examples/health/get-audits-db.md new file mode 100644 index 000000000..a83d6aa9e --- /dev/null +++ b/examples/1.9.x/server-rust/examples/health/get-audits-db.md @@ -0,0 +1,20 @@ +```rust +use appwrite::Client; +use appwrite::services::Health; + +#[tokio::main] +async fn main() -> Result<(), Box<dyn std::error::Error>> { + let client = Client::new(); + client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project("<YOUR_PROJECT_ID>"); // Your project ID + client.set_key("<YOUR_API_KEY>"); // Your secret API key + + let health = Health::new(&client); + + let result = health.get_audits_db().await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/messaging/create-ses-provider.md b/examples/1.9.x/server-rust/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..f5d8344c5 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/messaging/create-ses-provider.md @@ -0,0 +1,31 @@ +```rust +use appwrite::Client; +use appwrite::services::Messaging; + +#[tokio::main] +async fn main() -> Result<(), Box<dyn std::error::Error>> { + let client = Client::new(); + client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project("<YOUR_PROJECT_ID>"); // Your project ID + client.set_key("<YOUR_API_KEY>"); // Your secret API key + + let messaging = Messaging::new(&client); + + let result = messaging.create_ses_provider( + "<PROVIDER_ID>", + "<NAME>", + Some("<ACCESS_KEY>"), // optional + Some("<SECRET_KEY>"), // optional + Some("<REGION>"), // optional + Some("<FROM_NAME>"), // optional + Some("email@example.com"), // optional + Some("<REPLY_TO_NAME>"), // optional + Some("email@example.com"), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-rust/examples/messaging/create-smtp-provider.md index 9a3209895..37dfb1745 100644 --- a/examples/1.9.x/server-rust/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-rust/examples/messaging/create-smtp-provider.md @@ -17,7 +17,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { "<HOST>", Some(1), // optional Some("<USERNAME>"), // optional - Some("<PASSWORD>"), // optional + Some("password"), // optional Some(appwrite::enums::SmtpEncryption::None), // optional Some(false), // optional Some("<MAILER>"), // optional diff --git a/examples/1.9.x/server-rust/examples/messaging/update-ses-provider.md b/examples/1.9.x/server-rust/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..c7b44d097 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/messaging/update-ses-provider.md @@ -0,0 +1,31 @@ +```rust +use appwrite::Client; +use appwrite::services::Messaging; + +#[tokio::main] +async fn main() -> Result<(), Box<dyn std::error::Error>> { + let client = Client::new(); + client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project("<YOUR_PROJECT_ID>"); // Your project ID + client.set_key("<YOUR_API_KEY>"); // Your secret API key + + let messaging = Messaging::new(&client); + + let result = messaging.update_ses_provider( + "<PROVIDER_ID>", + Some("<NAME>"), // optional + Some(false), // optional + Some("<ACCESS_KEY>"), // optional + Some("<SECRET_KEY>"), // optional + Some("<REGION>"), // optional + Some("<FROM_NAME>"), // optional + Some("email@example.com"), // optional + Some("<REPLY_TO_NAME>"), // optional + Some("<REPLY_TO_EMAIL>") // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-rust/examples/messaging/update-smtp-provider.md index 9d105ffe7..0790c9db1 100644 --- a/examples/1.9.x/server-rust/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-rust/examples/messaging/update-smtp-provider.md @@ -17,7 +17,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { Some("<HOST>"), // optional Some(1), // optional Some("<USERNAME>"), // optional - Some("<PASSWORD>"), // optional + Some("password"), // optional Some(appwrite::enums::SmtpEncryption::None), // optional Some(false), // optional Some("<MAILER>"), // optional diff --git a/examples/1.9.x/server-rust/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-rust/examples/project/update-membership-privacy-policy.md index 754d8b727..42f9faec8 100644 --- a/examples/1.9.x/server-rust/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-rust/examples/project/update-membership-privacy-policy.md @@ -16,6 +16,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { Some(false), // optional Some(false), // optional Some(false), // optional + Some(false), // optional Some(false) // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-server.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..7dceea83d --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-server.md @@ -0,0 +1,34 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box<dyn std::error::Error>> { + let client = Client::new(); + client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project("<YOUR_PROJECT_ID>"); // Your project ID + client.set_key("<YOUR_API_KEY>"); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_server( + false, + "https://example.com", + Some(vec![]), // optional + Some(vec![]), // optional + Some(60), // optional + Some(60), // optional + Some(60), // optional + Some(60), // optional + Some(false), // optional + Some("https://example.com"), // optional + Some(6), // optional + Some("numeric"), // optional + Some(60) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-password-strength-policy.md b/examples/1.9.x/server-rust/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..dc1b12806 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-password-strength-policy.md @@ -0,0 +1,26 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box<dyn std::error::Error>> { + let client = Client::new(); + client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project("<YOUR_PROJECT_ID>"); // Your project ID + client.set_key("<YOUR_API_KEY>"); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_password_strength_policy( + Some(8), // optional + Some(false), // optional + Some(false), // optional + Some(false), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-smtp.md b/examples/1.9.x/server-rust/examples/project/update-smtp.md index d3b7291f4..6080824ee 100644 --- a/examples/1.9.x/server-rust/examples/project/update-smtp.md +++ b/examples/1.9.x/server-rust/examples/project/update-smtp.md @@ -15,7 +15,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { Some(""), // optional Some(0), // optional Some("<USERNAME>"), // optional - Some("<PASSWORD>"), // optional + Some("password"), // optional Some("email@example.com"), // optional Some("<SENDER_NAME>"), // optional Some("email@example.com"), // optional diff --git a/examples/1.9.x/server-rust/examples/proxy/create-redirect-rule.md b/examples/1.9.x/server-rust/examples/proxy/create-redirect-rule.md index 8b524878f..803ffbaa0 100644 --- a/examples/1.9.x/server-rust/examples/proxy/create-redirect-rule.md +++ b/examples/1.9.x/server-rust/examples/proxy/create-redirect-rule.md @@ -14,7 +14,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let result = proxy.create_redirect_rule( "", "https://example.com", - appwrite::enums::RedirectStatusCode::MovedPermanently, + appwrite::enums::StatusCode::MovedPermanently, "<RESOURCE_ID>", appwrite::enums::ProxyResourceType::Site ).await?; diff --git a/examples/1.9.x/server-rust/examples/sites/create.md b/examples/1.9.x/server-rust/examples/sites/create.md index 30c7529e6..051514f38 100644 --- a/examples/1.9.x/server-rust/examples/sites/create.md +++ b/examples/1.9.x/server-rust/examples/sites/create.md @@ -14,8 +14,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let result = sites.create( "<SITE_ID>", "<NAME>", - appwrite::enums::SiteFramework::Analog, - appwrite::enums::SiteBuildRuntime::Node145, + appwrite::enums::Framework::Analog, + appwrite::enums::BuildRuntime::Node145, Some(false), // optional Some(false), // optional Some(1), // optional @@ -23,7 +23,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { Some("<BUILD_COMMAND>"), // optional Some("<START_COMMAND>"), // optional Some("<OUTPUT_DIRECTORY>"), // optional - Some(appwrite::enums::SiteAdapter::Static), // optional + Some(appwrite::enums::Adapter::Static), // optional Some("<INSTALLATION_ID>"), // optional Some("<FALLBACK_FILE>"), // optional Some("<PROVIDER_REPOSITORY_ID>"), // optional diff --git a/examples/1.9.x/server-rust/examples/sites/delete-log.md b/examples/1.9.x/server-rust/examples/sites/delete-log.md index d837d4edc..7e5d91586 100644 --- a/examples/1.9.x/server-rust/examples/sites/delete-log.md +++ b/examples/1.9.x/server-rust/examples/sites/delete-log.md @@ -11,11 +11,13 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let sites = Sites::new(&client); - sites.delete_log( + let result = sites.delete_log( "<SITE_ID>", "<LOG_ID>" ).await?; + let _ = result; + Ok(()) } ``` diff --git a/examples/1.9.x/server-rust/examples/sites/get-deployment-download.md b/examples/1.9.x/server-rust/examples/sites/get-deployment-download.md index da8b45ad4..933d4e52b 100644 --- a/examples/1.9.x/server-rust/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-rust/examples/sites/get-deployment-download.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_key("<YOUR_API_KEY>"); // Your secret API key + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let sites = Sites::new(&client); diff --git a/examples/1.9.x/server-rust/examples/sites/update.md b/examples/1.9.x/server-rust/examples/sites/update.md index 872b498b3..90a5cf217 100644 --- a/examples/1.9.x/server-rust/examples/sites/update.md +++ b/examples/1.9.x/server-rust/examples/sites/update.md @@ -14,7 +14,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let result = sites.update( "<SITE_ID>", "<NAME>", - appwrite::enums::SiteFramework::Analog, + appwrite::enums::Framework::Analog, Some(false), // optional Some(false), // optional Some(1), // optional @@ -22,8 +22,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { Some("<BUILD_COMMAND>"), // optional Some("<START_COMMAND>"), // optional Some("<OUTPUT_DIRECTORY>"), // optional - Some(appwrite::enums::SiteBuildRuntime::Node145), // optional - Some(appwrite::enums::SiteAdapter::Static), // optional + Some(appwrite::enums::BuildRuntime::Node145), // optional + Some(appwrite::enums::Adapter::Static), // optional Some("<FALLBACK_FILE>"), // optional Some("<INSTALLATION_ID>"), // optional Some("<PROVIDER_REPOSITORY_ID>"), // optional diff --git a/examples/1.9.x/server-rust/examples/storage/get-file-download.md b/examples/1.9.x/server-rust/examples/storage/get-file-download.md index 1119b18fe..b85863112 100644 --- a/examples/1.9.x/server-rust/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-rust/examples/storage/get-file-download.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_session(""); // The user session to authenticate with + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let storage = Storage::new(&client); diff --git a/examples/1.9.x/server-rust/examples/storage/get-file-preview.md b/examples/1.9.x/server-rust/examples/storage/get-file-preview.md index 004702cfe..f1fb056e1 100644 --- a/examples/1.9.x/server-rust/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-rust/examples/storage/get-file-preview.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_session(""); // The user session to authenticate with + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let storage = Storage::new(&client); diff --git a/examples/1.9.x/server-rust/examples/storage/get-file-view.md b/examples/1.9.x/server-rust/examples/storage/get-file-view.md index 01079108b..aa135ce08 100644 --- a/examples/1.9.x/server-rust/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-rust/examples/storage/get-file-view.md @@ -8,6 +8,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { client.set_endpoint("https://<REGION>.cloud.appwrite.io/v1"); // Your API Endpoint client.set_project("<YOUR_PROJECT_ID>"); // Your project ID client.set_session(""); // The user session to authenticate with + client.set_impersonate_user_id(""); // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let storage = Storage::new(&client); diff --git a/examples/1.9.x/server-rust/examples/users/create.md b/examples/1.9.x/server-rust/examples/users/create.md index 1600e5437..c22ebd52e 100644 --- a/examples/1.9.x/server-rust/examples/users/create.md +++ b/examples/1.9.x/server-rust/examples/users/create.md @@ -15,7 +15,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { "<USER_ID>", Some("email@example.com"), // optional Some("+12065550100"), // optional - Some(""), // optional + Some("password"), // optional Some("<NAME>") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/users/update-password.md b/examples/1.9.x/server-rust/examples/users/update-password.md index c1451c1bf..dc1aab353 100644 --- a/examples/1.9.x/server-rust/examples/users/update-password.md +++ b/examples/1.9.x/server-rust/examples/users/update-password.md @@ -13,7 +13,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { let result = users.update_password( "<USER_ID>", - "" + "password" ).await?; let _ = result; diff --git a/examples/1.9.x/server-rust/examples/webhooks/create.md b/examples/1.9.x/server-rust/examples/webhooks/create.md index 98128546c..8bffd65ef 100644 --- a/examples/1.9.x/server-rust/examples/webhooks/create.md +++ b/examples/1.9.x/server-rust/examples/webhooks/create.md @@ -19,7 +19,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { Some(false), // optional Some(false), // optional Some("<AUTH_USERNAME>"), // optional - Some("<AUTH_PASSWORD>"), // optional + Some("password"), // optional Some("<SECRET>") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/webhooks/update.md b/examples/1.9.x/server-rust/examples/webhooks/update.md index b6804e1ca..6873084dd 100644 --- a/examples/1.9.x/server-rust/examples/webhooks/update.md +++ b/examples/1.9.x/server-rust/examples/webhooks/update.md @@ -19,7 +19,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { Some(false), // optional Some(false), // optional Some("<AUTH_USERNAME>"), // optional - Some("<AUTH_PASSWORD>") // optional + Some("password") // optional ).await?; let _ = result; diff --git a/examples/1.9.x/server-swift/examples/account/create.md b/examples/1.9.x/server-swift/examples/account/create.md index 7331f6b21..8161264be 100644 --- a/examples/1.9.x/server-swift/examples/account/create.md +++ b/examples/1.9.x/server-swift/examples/account/create.md @@ -11,7 +11,7 @@ let account = Account(client) let user = try await account.create( userId: "<USER_ID>", email: "email@example.com", - password: "", + password: "password", name: "<NAME>" // optional ) diff --git a/examples/1.9.x/server-swift/examples/account/update-password.md b/examples/1.9.x/server-swift/examples/account/update-password.md index e4468d523..96e97e047 100644 --- a/examples/1.9.x/server-swift/examples/account/update-password.md +++ b/examples/1.9.x/server-swift/examples/account/update-password.md @@ -9,7 +9,7 @@ let client = Client() let account = Account(client) let user = try await account.updatePassword( - password: "", + password: "password", oldPassword: "password" // optional ) diff --git a/examples/1.9.x/server-swift/examples/account/update-recovery.md b/examples/1.9.x/server-swift/examples/account/update-recovery.md index 023c5a291..27eaa78ee 100644 --- a/examples/1.9.x/server-swift/examples/account/update-recovery.md +++ b/examples/1.9.x/server-swift/examples/account/update-recovery.md @@ -11,7 +11,7 @@ let account = Account(client) let token = try await account.updateRecovery( userId: "<USER_ID>", secret: "<SECRET>", - password: "" + password: "password" ) ``` diff --git a/examples/1.9.x/server-swift/examples/avatars/get-browser.md b/examples/1.9.x/server-swift/examples/avatars/get-browser.md index 324540b47..7c201a41b 100644 --- a/examples/1.9.x/server-swift/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-swift/examples/avatars/get-browser.md @@ -6,6 +6,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/server-swift/examples/avatars/get-credit-card.md b/examples/1.9.x/server-swift/examples/avatars/get-credit-card.md index 45b7d4bef..1f375c3c8 100644 --- a/examples/1.9.x/server-swift/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-swift/examples/avatars/get-credit-card.md @@ -6,6 +6,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/server-swift/examples/avatars/get-favicon.md b/examples/1.9.x/server-swift/examples/avatars/get-favicon.md index f0945dcaf..f2adb690d 100644 --- a/examples/1.9.x/server-swift/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-swift/examples/avatars/get-favicon.md @@ -5,6 +5,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/server-swift/examples/avatars/get-flag.md b/examples/1.9.x/server-swift/examples/avatars/get-flag.md index d7cc8c6ab..e75a277ef 100644 --- a/examples/1.9.x/server-swift/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-swift/examples/avatars/get-flag.md @@ -6,6 +6,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/server-swift/examples/avatars/get-image.md b/examples/1.9.x/server-swift/examples/avatars/get-image.md index 4f18af5a2..2505da805 100644 --- a/examples/1.9.x/server-swift/examples/avatars/get-image.md +++ b/examples/1.9.x/server-swift/examples/avatars/get-image.md @@ -5,6 +5,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/server-swift/examples/avatars/get-initials.md b/examples/1.9.x/server-swift/examples/avatars/get-initials.md index aa5e5e980..d44b30e61 100644 --- a/examples/1.9.x/server-swift/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-swift/examples/avatars/get-initials.md @@ -5,6 +5,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/server-swift/examples/avatars/get-qr.md b/examples/1.9.x/server-swift/examples/avatars/get-qr.md index c5bfa168e..1cad864a0 100644 --- a/examples/1.9.x/server-swift/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-swift/examples/avatars/get-qr.md @@ -5,6 +5,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/server-swift/examples/avatars/get-screenshot.md b/examples/1.9.x/server-swift/examples/avatars/get-screenshot.md index 482905ea9..ed5ee8065 100644 --- a/examples/1.9.x/server-swift/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-swift/examples/avatars/get-screenshot.md @@ -6,6 +6,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let avatars = Avatars(client) diff --git a/examples/1.9.x/server-swift/examples/functions/get-deployment-download.md b/examples/1.9.x/server-swift/examples/functions/get-deployment-download.md index cbef3a215..40b74d3ac 100644 --- a/examples/1.9.x/server-swift/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-swift/examples/functions/get-deployment-download.md @@ -6,6 +6,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setKey("<YOUR_API_KEY>") // Your secret API key + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let functions = Functions(client) diff --git a/examples/1.9.x/server-swift/examples/health/get-audits-db.md b/examples/1.9.x/server-swift/examples/health/get-audits-db.md new file mode 100644 index 000000000..996917138 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/health/get-audits-db.md @@ -0,0 +1,13 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthStatusList = try await health.getAuditsDB() + +``` diff --git a/examples/1.9.x/server-swift/examples/messaging/create-ses-provider.md b/examples/1.9.x/server-swift/examples/messaging/create-ses-provider.md new file mode 100644 index 000000000..5184d79a2 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/messaging/create-ses-provider.md @@ -0,0 +1,24 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.createSesProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + accessKey: "<ACCESS_KEY>", // optional + secretKey: "<SECRET_KEY>", // optional + region: "<REGION>", // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "email@example.com", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-swift/examples/messaging/create-smtp-provider.md index b4c32819c..ac49a0271 100644 --- a/examples/1.9.x/server-swift/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-swift/examples/messaging/create-smtp-provider.md @@ -15,7 +15,7 @@ let provider = try await messaging.createSMTPProvider( host: "<HOST>", port: 1, // optional username: "<USERNAME>", // optional - password: "<PASSWORD>", // optional + password: "password", // optional encryption: .none, // optional autoTLS: false, // optional mailer: "<MAILER>", // optional diff --git a/examples/1.9.x/server-swift/examples/messaging/update-ses-provider.md b/examples/1.9.x/server-swift/examples/messaging/update-ses-provider.md new file mode 100644 index 000000000..3a3b9387d --- /dev/null +++ b/examples/1.9.x/server-swift/examples/messaging/update-ses-provider.md @@ -0,0 +1,24 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.updateSesProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + accessKey: "<ACCESS_KEY>", // optional + secretKey: "<SECRET_KEY>", // optional + region: "<REGION>", // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "<REPLY_TO_EMAIL>" // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-swift/examples/messaging/update-smtp-provider.md index 44578eb46..c9d2a5e5f 100644 --- a/examples/1.9.x/server-swift/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-swift/examples/messaging/update-smtp-provider.md @@ -15,7 +15,7 @@ let provider = try await messaging.updateSMTPProvider( host: "<HOST>", // optional port: 1, // optional username: "<USERNAME>", // optional - password: "<PASSWORD>", // optional + password: "password", // optional encryption: .none, // optional autoTLS: false, // optional mailer: "<MAILER>", // optional diff --git a/examples/1.9.x/server-swift/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-swift/examples/project/update-membership-privacy-policy.md index d3865319a..70c29fc5a 100644 --- a/examples/1.9.x/server-swift/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-swift/examples/project/update-membership-privacy-policy.md @@ -13,7 +13,8 @@ let project = try await project.updateMembershipPrivacyPolicy( userEmail: false, // optional userPhone: false, // optional userName: false, // optional - userMFA: false // optional + userMFA: false, // optional + userAccessedAt: false // optional ) ``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-server.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-server.md new file mode 100644 index 000000000..4361a1a08 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-server.md @@ -0,0 +1,27 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let project = Project(client) + +let project = try await project.updateOAuth2Server( + enabled: false, + authorizationUrl: "https://example.com", + scopes: [], // optional + authorizationDetailsTypes: [], // optional + accessTokenDuration: 60, // optional + refreshTokenDuration: 60, // optional + publicAccessTokenDuration: 60, // optional + publicRefreshTokenDuration: 60, // optional + confidentialPkce: false, // optional + verificationUrl: "https://example.com", // optional + userCodeLength: 6, // optional + userCodeFormat: "numeric", // optional + deviceCodeDuration: 60 // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-password-strength-policy.md b/examples/1.9.x/server-swift/examples/project/update-password-strength-policy.md new file mode 100644 index 000000000..57b127903 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-password-strength-policy.md @@ -0,0 +1,19 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let project = Project(client) + +let policyPasswordStrength = try await project.updatePasswordStrengthPolicy( + min: 8, // optional + uppercase: false, // optional + lowercase: false, // optional + number: false, // optional + symbols: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-smtp.md b/examples/1.9.x/server-swift/examples/project/update-smtp.md index da346c09b..fcb0130e6 100644 --- a/examples/1.9.x/server-swift/examples/project/update-smtp.md +++ b/examples/1.9.x/server-swift/examples/project/update-smtp.md @@ -13,7 +13,7 @@ let project = try await project.updateSMTP( host: "", // optional port: 0, // optional username: "<USERNAME>", // optional - password: "<PASSWORD>", // optional + password: "password", // optional senderEmail: "email@example.com", // optional senderName: "<SENDER_NAME>", // optional replyToEmail: "email@example.com", // optional diff --git a/examples/1.9.x/server-swift/examples/sites/get-deployment-download.md b/examples/1.9.x/server-swift/examples/sites/get-deployment-download.md index 4c11b91cc..860daf523 100644 --- a/examples/1.9.x/server-swift/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-swift/examples/sites/get-deployment-download.md @@ -6,6 +6,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setKey("<YOUR_API_KEY>") // Your secret API key + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let sites = Sites(client) diff --git a/examples/1.9.x/server-swift/examples/storage/get-file-download.md b/examples/1.9.x/server-swift/examples/storage/get-file-download.md index 2efb755f7..9e6e01604 100644 --- a/examples/1.9.x/server-swift/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-swift/examples/storage/get-file-download.md @@ -5,6 +5,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let storage = Storage(client) diff --git a/examples/1.9.x/server-swift/examples/storage/get-file-preview.md b/examples/1.9.x/server-swift/examples/storage/get-file-preview.md index e30e19aa5..a090acd27 100644 --- a/examples/1.9.x/server-swift/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-swift/examples/storage/get-file-preview.md @@ -6,6 +6,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let storage = Storage(client) diff --git a/examples/1.9.x/server-swift/examples/storage/get-file-view.md b/examples/1.9.x/server-swift/examples/storage/get-file-view.md index df514f7e4..e3ea3576d 100644 --- a/examples/1.9.x/server-swift/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-swift/examples/storage/get-file-view.md @@ -5,6 +5,7 @@ let client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setSession("") // The user session to authenticate with + .setImpersonateUserId("") // Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data. let storage = Storage(client) diff --git a/examples/1.9.x/server-swift/examples/users/create.md b/examples/1.9.x/server-swift/examples/users/create.md index 8068f438a..fb168bbd6 100644 --- a/examples/1.9.x/server-swift/examples/users/create.md +++ b/examples/1.9.x/server-swift/examples/users/create.md @@ -12,7 +12,7 @@ let user = try await users.create( userId: "<USER_ID>", email: "email@example.com", // optional phone: "+12065550100", // optional - password: "", // optional + password: "password", // optional name: "<NAME>" // optional ) diff --git a/examples/1.9.x/server-swift/examples/users/update-password.md b/examples/1.9.x/server-swift/examples/users/update-password.md index 6a29be4bd..b0bcd862f 100644 --- a/examples/1.9.x/server-swift/examples/users/update-password.md +++ b/examples/1.9.x/server-swift/examples/users/update-password.md @@ -10,7 +10,7 @@ let users = Users(client) let user = try await users.updatePassword( userId: "<USER_ID>", - password: "" + password: "password" ) ``` diff --git a/examples/1.9.x/server-swift/examples/webhooks/create.md b/examples/1.9.x/server-swift/examples/webhooks/create.md index 0534f62fb..2b13340ee 100644 --- a/examples/1.9.x/server-swift/examples/webhooks/create.md +++ b/examples/1.9.x/server-swift/examples/webhooks/create.md @@ -16,7 +16,7 @@ let webhook = try await webhooks.create( enabled: false, // optional tls: false, // optional authUsername: "<AUTH_USERNAME>", // optional - authPassword: "<AUTH_PASSWORD>", // optional + authPassword: "password", // optional secret: "<SECRET>" // optional ) diff --git a/examples/1.9.x/server-swift/examples/webhooks/update.md b/examples/1.9.x/server-swift/examples/webhooks/update.md index 8c42a8837..dfef4c73f 100644 --- a/examples/1.9.x/server-swift/examples/webhooks/update.md +++ b/examples/1.9.x/server-swift/examples/webhooks/update.md @@ -16,7 +16,7 @@ let webhook = try await webhooks.update( enabled: false, // optional tls: false, // optional authUsername: "<AUTH_USERNAME>", // optional - authPassword: "<AUTH_PASSWORD>" // optional + authPassword: "password" // optional ) ``` diff --git a/specs/1.9.x/open-api3-1.9.x-client.json b/specs/1.9.x/open-api3-1.9.x-client.json index fcfebf153..a0bba0dd4 100644 --- a/specs/1.9.x/open-api3-1.9.x-client.json +++ b/specs/1.9.x/open-api3-1.9.x-client.json @@ -141,7 +141,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -152,7 +155,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "name": { "type": "string", @@ -1782,11 +1786,12 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "oldPassword": { "type": "string", - "description": "Current user password. Must be at least 8 chars.", + "description": "Current user password. Max length: 256 chars.", "default": "", "x-example": "password", "format": "password" @@ -2150,7 +2155,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" } }, "required": [ @@ -2453,7 +2459,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -2674,7 +2683,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -2751,7 +2763,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -3059,7 +3074,10 @@ "targetId": { "type": "string", "description": "Target 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.", - "x-example": "<TARGET_ID>" + "x-example": "<TARGET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "identifier": { "type": "string", @@ -3279,7 +3297,10 @@ "userId": { "type": "string", "description": "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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -3366,7 +3387,10 @@ "userId": { "type": "string", "description": "Unique 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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -3600,7 +3624,10 @@ "userId": { "type": "string", "description": "Unique 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. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "phone": { "type": "string", @@ -4004,30 +4031,37 @@ } } }, - "\/avatars\/browsers\/{code}": { + "\/apps": { "get": { - "summary": "Get browser icon", - "operationId": "avatarsGetBrowser", + "summary": "List Applications", + "operationId": "appsList", "tags": [ - "avatars" + "apps" ], - "description": "You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.", + "description": "List applications.", "responses": { "200": { - "description": "Image" + "description": "Apps list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appsList" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getBrowser", + "method": "list", "group": null, "cookies": false, - "type": "location", - "demo": "avatars\/get-browser.md", + "type": "", + "demo": "apps\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "avatars.read", + "scope": "apps.read", "platforms": [ "console", "client", @@ -4036,7 +4070,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md", "auth": { "Project": [] } @@ -4050,111 +4083,174 @@ ], "parameters": [ { - "name": "code", - "description": "Browser Code.", - "required": true, - "schema": { - "type": "string", - "x-example": "aa", - "enum": [ - "aa", - "an", - "ch", - "ci", - "cm", - "cr", - "ff", - "sf", - "mf", - "ps", - "oi", - "om", - "op", - "on" - ], - "x-enum-name": "Browser", - "x-enum-keys": [ - "Avant Browser", - "Android WebView Beta", - "Google Chrome", - "Google Chrome (iOS)", - "Google Chrome (Mobile)", - "Chromium", - "Mozilla Firefox", - "Safari", - "Mobile Safari", - "Microsoft Edge", - "Microsoft Edge (iOS)", - "Opera Mini", - "Opera", - "Opera (Next)" - ] - }, - "in": "path" - }, - { - "name": "width", - "description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 100 - }, - "in": "query" - }, - { - "name": "height", - "description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.", + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", "required": false, "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 100 + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, "in": "query" }, { - "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", "required": false, "schema": { - "type": "integer", - "format": "int32", - "x-example": -1, - "default": -1 + "type": "boolean", + "x-example": false, + "default": true }, "in": "query" } ] + }, + "post": { + "summary": "Create Application", + "operationId": "appsCreate", + "tags": [ + "apps" + ], + "description": "Create a new application.", + "responses": { + "201": { + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "appId": { + "type": "string", + "description": "Application 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.", + "x-example": "<APP_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + }, + "teamId": { + "type": "string", + "description": "Team unique ID.", + "default": "", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "appId", + "name", + "redirectUris" + ] + } + } + } + } } }, - "\/avatars\/credit-cards\/{code}": { + "\/apps\/{appId}": { "get": { - "summary": "Get credit card icon", - "operationId": "avatarsGetCreditCard", + "summary": "Get Application", + "operationId": "appsGet", "tags": [ - "avatars" + "apps" ], - "description": "The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", + "description": "Get an application by its unique ID.", "responses": { "200": { - "description": "Image" + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getCreditCard", + "method": "get", "group": null, "cookies": false, - "type": "location", - "demo": "avatars\/get-credit-card.md", + "type": "", + "demo": "apps\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "avatars.read", + "scope": "apps.read", "platforms": [ "console", "client", @@ -4163,7 +4259,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md", "auth": { "Project": [] } @@ -4177,117 +4272,212 @@ ], "parameters": [ { - "name": "code", - "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.", + "name": "appId", + "description": "Application unique ID.", "required": true, "schema": { "type": "string", - "x-example": "amex", - "enum": [ - "amex", - "argencard", - "cabal", - "cencosud", - "diners", - "discover", - "elo", - "hipercard", - "jcb", - "mastercard", - "naranja", - "targeta-shopping", - "unionpay", - "visa", - "mir", - "maestro", - "rupay" - ], - "x-enum-name": "CreditCard", - "x-enum-keys": [ - "American Express", - "Argencard", - "Cabal", - "Cencosud", - "Diners Club", - "Discover", - "Elo", - "Hipercard", - "JCB", - "Mastercard", - "Naranja", - "Tarjeta Shopping", - "Union Pay", - "Visa", - "MIR", - "Maestro", - "Rupay" - ] + "x-example": "<APP_ID>" }, "in": "path" - }, + } + ] + }, + "put": { + "summary": "Update Application", + "operationId": "appsUpdate", + "tags": [ + "apps" + ], + "description": "Update an application by its unique ID.", + "responses": { + "200": { + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "width", - "description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 100 - }, - "in": "query" - }, + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ { - "name": "height", - "description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.", - "required": false, + "name": "appId", + "description": "Application unique ID.", + "required": true, "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 100 + "type": "string", + "x-example": "<APP_ID>" }, - "in": "query" - }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete Application", + "operationId": "appsDelete", + "tags": [ + "apps" + ], + "description": "Delete an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", - "required": false, + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, "schema": { - "type": "integer", - "format": "int32", - "x-example": -1, - "default": -1 + "type": "string", + "x-example": "<APP_ID>" }, - "in": "query" + "in": "path" } ] } }, - "\/avatars\/favicon": { + "\/apps\/{appId}\/secrets": { "get": { - "summary": "Get favicon", - "operationId": "avatarsGetFavicon", + "summary": "List Secrets", + "operationId": "appsListSecrets", "tags": [ - "avatars" + "apps" ], - "description": "Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n\nThis endpoint does not follow HTTP redirects.", + "description": "List client secrets for an application.", "responses": { "200": { - "description": "Image" + "description": "App secrets list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appSecretList" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getFavicon", + "method": "listSecrets", "group": null, "cookies": false, - "type": "location", - "demo": "avatars\/get-favicon.md", + "type": "", + "demo": "apps\/list-secrets.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "avatars.read", + "scope": "apps.read", "platforms": [ "console", "client", @@ -4296,7 +4486,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md", "auth": { "Project": [] } @@ -4310,43 +4499,71 @@ ], "parameters": [ { - "name": "url", - "description": "Website URL which you want to fetch the favicon from.", + "name": "appId", + "description": "Application unique ID.", "required": true, "schema": { "type": "string", - "format": "url", - "x-example": "https:\/\/example.com" + "x-example": "<APP_ID>" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true }, "in": "query" } ] - } - }, - "\/avatars\/flags\/{code}": { - "get": { - "summary": "Get country flag", - "operationId": "avatarsGetFlag", + }, + "post": { + "summary": "Create Secret", + "operationId": "appsCreateSecret", "tags": [ - "avatars" + "apps" ], - "description": "You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", + "description": "Create a new client secret for an application.", "responses": { - "200": { - "description": "Image" + "201": { + "description": "AppSecretPlaintext", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appSecretPlaintext" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getFlag", + "method": "createSecret", "group": null, "cookies": false, - "type": "location", - "demo": "avatars\/get-flag.md", + "type": "", + "demo": "apps\/create-secret.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "avatars.read", + "scope": "apps.write", "platforms": [ "console", "client", @@ -4355,7 +4572,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md", "auth": { "Project": [] } @@ -4369,34 +4585,698 @@ ], "parameters": [ { - "name": "code", - "description": "Country Code. ISO Alpha-2 country code format.", + "name": "appId", + "description": "Application unique ID.", "required": true, "schema": { "type": "string", - "x-example": "af", - "enum": [ - "af", - "ao", - "al", - "ad", - "ae", - "ar", - "am", - "ag", - "au", - "at", - "az", - "bi", - "be", - "bj", - "bf", - "bd", - "bg", - "bh", - "bs", - "ba", - "by", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/secrets\/{secretId}": { + "get": { + "summary": "Get Secret", + "operationId": "appsGetSecret", + "tags": [ + "apps" + ], + "description": "Get an application client secret by its unique ID.", + "responses": { + "200": { + "description": "AppSecret", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appSecret" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/get-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<SECRET_ID>" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete Secret", + "operationId": "appsDeleteSecret", + "tags": [ + "apps" + ], + "description": "Delete an application client secret by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<SECRET_ID>" + }, + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/team": { + "patch": { + "summary": "Update Team", + "operationId": "appsUpdateTeam", + "tags": [ + "apps" + ], + "description": "Transfer an application to another team by its unique ID.", + "responses": { + "200": { + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTeam", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update-team.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team ID of the team to transfer application to.", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "teamId" + ] + } + } + } + } + } + }, + "\/apps\/{appId}\/tokens": { + "delete": { + "summary": "Delete Tokens", + "operationId": "appsDeleteTokens", + "tags": [ + "apps" + ], + "description": "Revoke all tokens for an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTokens", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-tokens.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ] + } + }, + "\/avatars\/browsers\/{code}": { + "get": { + "summary": "Get browser icon", + "operationId": "avatarsGetBrowser", + "tags": [ + "avatars" + ], + "description": "You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.", + "responses": { + "200": { + "description": "Image" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getBrowser", + "group": null, + "cookies": false, + "type": "location", + "demo": "avatars\/get-browser.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "avatars.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md", + "auth": { + "Project": [], + "ImpersonateUserId": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [], + "ImpersonateUserId": [] + } + ], + "parameters": [ + { + "name": "code", + "description": "Browser Code.", + "required": true, + "schema": { + "type": "string", + "x-example": "aa", + "enum": [ + "aa", + "an", + "ch", + "ci", + "cm", + "cr", + "ff", + "sf", + "mf", + "ps", + "oi", + "om", + "op", + "on" + ], + "x-enum-name": "Browser", + "x-enum-keys": [ + "Avant Browser", + "Android WebView Beta", + "Google Chrome", + "Google Chrome (iOS)", + "Google Chrome (Mobile)", + "Chromium", + "Mozilla Firefox", + "Safari", + "Mobile Safari", + "Microsoft Edge", + "Microsoft Edge (iOS)", + "Opera Mini", + "Opera", + "Opera (Next)" + ] + }, + "in": "path" + }, + { + "name": "width", + "description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 100 + }, + "in": "query" + }, + { + "name": "height", + "description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 100 + }, + "in": "query" + }, + { + "name": "quality", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": -1, + "default": -1 + }, + "in": "query" + } + ] + } + }, + "\/avatars\/credit-cards\/{code}": { + "get": { + "summary": "Get credit card icon", + "operationId": "avatarsGetCreditCard", + "tags": [ + "avatars" + ], + "description": "The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", + "responses": { + "200": { + "description": "Image" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCreditCard", + "group": null, + "cookies": false, + "type": "location", + "demo": "avatars\/get-credit-card.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "avatars.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md", + "auth": { + "Project": [], + "ImpersonateUserId": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [], + "ImpersonateUserId": [] + } + ], + "parameters": [ + { + "name": "code", + "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.", + "required": true, + "schema": { + "type": "string", + "x-example": "amex", + "enum": [ + "amex", + "argencard", + "cabal", + "cencosud", + "diners", + "discover", + "elo", + "hipercard", + "jcb", + "mastercard", + "naranja", + "targeta-shopping", + "unionpay", + "visa", + "mir", + "maestro", + "rupay" + ], + "x-enum-name": "CreditCard", + "x-enum-keys": [ + "American Express", + "Argencard", + "Cabal", + "Cencosud", + "Diners Club", + "Discover", + "Elo", + "Hipercard", + "JCB", + "Mastercard", + "Naranja", + "Tarjeta Shopping", + "Union Pay", + "Visa", + "MIR", + "Maestro", + "Rupay" + ] + }, + "in": "path" + }, + { + "name": "width", + "description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 100 + }, + "in": "query" + }, + { + "name": "height", + "description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 100 + }, + "in": "query" + }, + { + "name": "quality", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": -1, + "default": -1 + }, + "in": "query" + } + ] + } + }, + "\/avatars\/favicon": { + "get": { + "summary": "Get favicon", + "operationId": "avatarsGetFavicon", + "tags": [ + "avatars" + ], + "description": "Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n\nThis endpoint does not follow HTTP redirects.", + "responses": { + "200": { + "description": "Image" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getFavicon", + "group": null, + "cookies": false, + "type": "location", + "demo": "avatars\/get-favicon.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "avatars.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md", + "auth": { + "Project": [], + "ImpersonateUserId": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [], + "ImpersonateUserId": [] + } + ], + "parameters": [ + { + "name": "url", + "description": "Website URL which you want to fetch the favicon from.", + "required": true, + "schema": { + "type": "string", + "format": "url", + "x-example": "https:\/\/example.com" + }, + "in": "query" + } + ] + } + }, + "\/avatars\/flags\/{code}": { + "get": { + "summary": "Get country flag", + "operationId": "avatarsGetFlag", + "tags": [ + "avatars" + ], + "description": "You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", + "responses": { + "200": { + "description": "Image" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getFlag", + "group": null, + "cookies": false, + "type": "location", + "demo": "avatars\/get-flag.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "avatars.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md", + "auth": { + "Project": [], + "ImpersonateUserId": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [], + "ImpersonateUserId": [] + } + ], + "parameters": [ + { + "name": "code", + "description": "Country Code. ISO Alpha-2 country code format.", + "required": true, + "schema": { + "type": "string", + "x-example": "af", + "enum": [ + "af", + "ao", + "al", + "ad", + "ae", + "ar", + "am", + "ag", + "au", + "at", + "az", + "bi", + "be", + "bj", + "bf", + "bd", + "bg", + "bh", + "bs", + "ba", + "by", "bz", "bo", "br", @@ -4846,14 +5726,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4929,14 +5811,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5022,14 +5906,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5115,14 +6001,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-screenshot.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6106,39 +6994,193 @@ } } } - }, - "delete": { - "summary": "Delete transaction", - "operationId": "databasesDeleteTransaction", + }, + "delete": { + "summary": "Delete transaction", + "operationId": "databasesDeleteTransaction", + "tags": [ + "databases" + ], + "description": "Delete a transaction by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "cookies": false, + "type": "", + "demo": "databases\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<TRANSACTION_ID>" + }, + "in": "path" + } + ] + } + }, + "\/databases\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "databasesCreateOperations", + "tags": [ + "databases" + ], + "description": "Create multiple operations in a single transaction.", + "responses": { + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createOperations", + "group": "transactions", + "cookies": false, + "type": "", + "demo": "databases\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-operations.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<TRANSACTION_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "operations": { + "type": "array", + "description": "Array of staged operations.", + "default": [], + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "databasesListDocuments", "tags": [ "databases" ], - "description": "Delete a transaction by its unique ID.", + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", + "method": "listDocuments", + "group": "documents", "cookies": false, "type": "", - "demo": "databases\/delete-transaction.md", + "demo": "databases\/list-documents.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "documents.read", "platforms": [ "console", - "server", "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.listRows" + }, "auth": { "Project": [] } @@ -6152,58 +7194,153 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "x-example": "<DATABASE_ID>" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "<COLLECTION_ID>" }, "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "<TRANSACTION_ID>" + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" } ] - } - }, - "\/databases\/transactions\/{transactionId}\/operations": { + }, "post": { - "summary": "Create operations", - "operationId": "databasesCreateOperations", + "summary": "Create document", + "operationId": "databasesCreateDocument", "tags": [ "databases" ], - "description": "Create multiple operations in a single transaction.", + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { "201": { - "description": "Transaction", + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/document" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createOperations", - "group": "transactions", + "method": "createDocument", + "group": "documents", "cookies": false, "type": "", - "demo": "databases\/create-operations.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", + "demo": "databases\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ "console", - "server", "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-operations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + }, + "methods": [ + { + "name": "createDocument", + "namespace": "databases", + "desc": "Create document", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", + "demo": "databases\/create-document.md", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + } + } + ], "auth": { "Project": [] } @@ -6217,12 +7354,22 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "x-example": "<DATABASE_ID>" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "required": true, + "schema": { + "type": "string", + "x-example": "<COLLECTION_ID>" }, "in": "path" } @@ -6233,14 +7380,44 @@ "schema": { "type": "object", "properties": { - "operations": { + "documentId": { + "type": "string", + "description": "Document 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.", + "default": "", + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "data": { + "type": "object", + "description": "Document data as JSON object.", + "default": {}, + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + }, + "permissions": { "type": "array", - "description": "Array of staged operations.", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "x-example": null, "items": { "type": "object" } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>", + "x-nullable": true } } } @@ -6249,21 +7426,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { "get": { - "summary": "List documents", - "operationId": "databasesListDocuments", + "summary": "Get document", + "operationId": "databasesGetDocument", "tags": [ "databases" ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", "responses": { "200": { - "description": "Documents List", + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/document" } } } @@ -6271,11 +7448,11 @@ }, "deprecated": true, "x-appwrite": { - "method": "listDocuments", + "method": "getDocument", "group": "documents", "cookies": false, "type": "", - "demo": "databases\/list-documents.md", + "demo": "databases\/get-document.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -6288,10 +7465,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.listRows" + "replaceWith": "tablesDB.getRow" }, "auth": { "Project": [] @@ -6311,17 +7488,27 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "<COLLECTION_ID>" }, "in": "path" }, { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "documentId", + "description": "Document ID.", "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "x-example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -6347,39 +7534,16 @@ "x-example": "<TRANSACTION_ID>" }, "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true - }, - "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" } ] }, - "post": { - "summary": "Create document", - "operationId": "databasesCreateDocument", + "put": { + "summary": "Upsert a document", + "operationId": "databasesUpsertDocument", "tags": [ "databases" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { "201": { "description": "Document", @@ -6394,11 +7558,11 @@ }, "deprecated": true, "x-appwrite": { - "method": "createDocument", + "method": "upsertDocument", "group": "documents", "cookies": false, "type": "", - "demo": "databases\/create-document.md", + "demo": "databases\/upsert-document.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", @@ -6411,16 +7575,16 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRow" + "replaceWith": "tablesDB.upsertRow" }, "methods": [ { - "name": "createDocument", + "name": "upsertDocument", "namespace": "databases", - "desc": "Create document", + "desc": "", "auth": { "Project": [] }, @@ -6435,8 +7599,7 @@ "required": [ "databaseId", "collectionId", - "documentId", - "data" + "documentId" ], "responses": [ { @@ -6444,12 +7607,12 @@ "model": "#\/components\/schemas\/document" } ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", - "demo": "databases\/create-document.md", + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", + "demo": "databases\/upsert-document.md", "public": true, "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRow" + "replaceWith": "tablesDB.upsertRow" } } ], @@ -6477,13 +7640,26 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "description": "Collection ID.", "required": true, "schema": { "type": "string", "x-example": "<COLLECTION_ID>" }, "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, + "x-example": "<DOCUMENT_ID>" + }, + "in": "path" } ], "requestBody": { @@ -6492,36 +7668,21 @@ "schema": { "type": "object", "properties": { - "documentId": { - "type": "string", - "description": "Document 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.", - "default": "", - "x-example": "<DOCUMENT_ID>" - }, "data": { "type": "object", - "description": "Document data as JSON object.", + "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", "default": {}, "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "x-example": "[\"read(\"any\")\"]", "items": { "type": "string" }, "x-nullable": true }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", - "default": [], - "x-example": null, - "items": { - "type": "object" - } - }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", @@ -6533,16 +7694,14 @@ } } } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { - "get": { - "summary": "Get document", - "operationId": "databasesGetDocument", + }, + "patch": { + "summary": "Update document", + "operationId": "databasesUpdateDocument", "tags": [ "databases" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { "200": { "description": "Document", @@ -6557,15 +7716,15 @@ }, "deprecated": true, "x-appwrite": { - "method": "getDocument", + "method": "updateDocument", "group": "documents", "cookies": false, "type": "", - "demo": "databases\/get-document.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "databases\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "client", @@ -6574,10 +7733,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.getRow" + "replaceWith": "tablesDB.updateRow" }, "auth": { "Project": [] @@ -6603,7 +7762,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6620,41 +7779,149 @@ "x-example": "<DOCUMENT_ID>" }, "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "default": {}, + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>", + "x-nullable": true + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete document", + "operationId": "databasesDeleteDocument", + "tags": [ + "databases" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": true, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "cookies": false, + "type": "", + "demo": "databases\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.deleteRow" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<DATABASE_ID>" + }, + "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "string", + "x-example": "<COLLECTION_ID>" }, - "in": "query" + "in": "path" }, { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, + "name": "documentId", + "description": "Document ID.", + "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "x-example": "<DOCUMENT_ID>" }, - "in": "query" + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>", + "x-nullable": true + } + } + } + } } - ] - }, - "put": { - "summary": "Upsert a document", - "operationId": "databasesUpsertDocument", + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "databasesDecrementDocumentAttribute", "tags": [ "databases" ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", + "description": "Decrement a specific attribute of a document by a given value.", "responses": { - "201": { + "200": { "description": "Document", "content": { "application\/json": { @@ -6667,64 +7934,28 @@ }, "deprecated": true, "x-appwrite": { - "method": "upsertDocument", + "method": "decrementDocumentAttribute", "group": "documents", "cookies": false, "type": "", - "demo": "databases\/upsert-document.md", + "demo": "databases\/decrement-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", + "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" + "replaceWith": "tablesDB.decrementRowColumn" }, - "methods": [ - { - "name": "upsertDocument", - "namespace": "databases", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/document" - } - ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", - "demo": "databases\/upsert-document.md", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" - } - } - ], "auth": { "Project": [] } @@ -6766,6 +7997,15 @@ "x-example": "<DOCUMENT_ID>" }, "in": "path" + }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -6774,19 +8014,18 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", - "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, + "min": { + "type": "number", + "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", + "x-example": null, + "format": "float", "x-nullable": true }, "transactionId": { @@ -6800,14 +8039,16 @@ } } } - }, + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { "patch": { - "summary": "Update document", - "operationId": "databasesUpdateDocument", + "summary": "Increment document attribute", + "operationId": "databasesIncrementDocumentAttribute", "tags": [ "databases" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Increment a specific attribute of a document by a given value.", "responses": { "200": { "description": "Document", @@ -6822,27 +8063,27 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateDocument", + "method": "incrementDocumentAttribute", "group": "documents", "cookies": false, "type": "", - "demo": "databases\/update-document.md", + "demo": "databases\/increment-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", + "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRow" + "replaceWith": "tablesDB.incrementRowColumn" }, "auth": { "Project": [] @@ -6885,6 +8126,15 @@ "x-example": "<DOCUMENT_ID>" }, "in": "path" + }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -6893,19 +8143,18 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, + "max": { + "type": "number", + "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", + "x-example": null, + "format": "float", "x-nullable": true }, "transactionId": { @@ -6919,43 +8168,114 @@ } } } + } + }, + "\/documentsdb\/transactions": { + "get": { + "summary": "List transactions", + "operationId": "documentsDBListTransactions", + "tags": [ + "documentsDB" + ], + "description": "List transactions across all databases.", + "responses": { + "200": { + "description": "Transaction List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transactionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTransactions", + "group": "transactions", + "cookies": false, + "type": "", + "demo": "documentsdb\/list-transactions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-transactions.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries).", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] }, - "delete": { - "summary": "Delete document", - "operationId": "databasesDeleteDocument", + "post": { + "summary": "Create transaction", + "operationId": "documentsDBCreateTransaction", "tags": [ - "databases" + "documentsDB" ], - "description": "Delete a document by its unique ID.", + "description": "Create a new transaction.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "deleteDocument", - "group": "documents", + "method": "createTransaction", + "group": "transactions", "cookies": false, "type": "", - "demo": "databases\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "documentsdb\/create-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": "documents.write", "platforms": [ "console", - "client", "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.deleteRow" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-transaction.md", "auth": { "Project": [] } @@ -6967,49 +8287,18 @@ "JWT": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DATABASE_ID>" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "schema": { - "type": "string", - "x-example": "<COLLECTION_ID>" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DOCUMENT_ID>" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "default": 300, + "x-example": 60, + "format": "int32" } } } @@ -7018,50 +8307,46 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "databasesDecrementDocumentAttribute", + "\/documentsdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "documentsDBGetTransaction", "tags": [ - "databases" + "documentsDB" ], - "description": "Decrement a specific attribute of a document by a given value.", + "description": "Get a transaction by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/transaction" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", + "method": "getTransaction", + "group": "transactions", "cookies": false, "type": "", - "demo": "databases\/decrement-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "documentsdb\/get-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", "platforms": [ - "client", - "server", "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.decrementRowColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-transaction.md", "auth": { "Project": [] } @@ -7075,122 +8360,56 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DATABASE_ID>" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<COLLECTION_ID>" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" - }, - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "schema": { - "type": "string" + "x-example": "<TRANSACTION_ID>" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "min": { - "type": "number", - "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true - } - } - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + ] + }, "patch": { - "summary": "Increment document attribute", - "operationId": "databasesIncrementDocumentAttribute", + "summary": "Update transaction", + "operationId": "documentsDBUpdateTransaction", "tags": [ - "databases" + "documentsDB" ], - "description": "Increment a specific attribute of a document by a given value.", + "description": "Update a transaction, to either commit or roll back its operations.", "responses": { "200": { - "description": "Document", + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/transaction" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", + "method": "updateTransaction", + "group": "transactions", "cookies": false, "type": "", - "demo": "databases\/increment-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "documentsdb\/update-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": "documents.write", "platforms": [ - "client", - "server", "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.incrementRowColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-transaction.md", "auth": { "Project": [] } @@ -7204,41 +8423,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DATABASE_ID>" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<COLLECTION_ID>" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" - }, - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "schema": { - "type": "string" + "x-example": "<TRANSACTION_ID>" }, "in": "path" } @@ -7249,64 +8439,47 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "max": { - "type": "number", - "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, - "format": "float", - "x-nullable": true + "commit": { + "type": "boolean", + "description": "Commit transaction?", + "default": false, + "x-example": false }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "rollback": { + "type": "boolean", + "description": "Rollback transaction?", + "default": false, + "x-example": false } } } } } } - } - }, - "\/documentsdb\/transactions": { - "get": { - "summary": "List transactions", - "operationId": "documentsDBListTransactions", + }, + "delete": { + "summary": "Delete transaction", + "operationId": "documentsDBDeleteTransaction", "tags": [ "documentsDB" ], - "description": "List transactions across all databases.", + "description": "Delete a transaction by its unique ID.", "responses": { - "200": { - "description": "Transaction List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transactionList" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", + "method": "deleteTransaction", "group": "transactions", "cookies": false, "type": "", - "demo": "documentsdb\/list-transactions.md", + "demo": "documentsdb\/delete-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "documents.write", "platforms": [ "console", "server", @@ -7315,7 +8488,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-transactions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-transaction.md", "auth": { "Project": [] } @@ -7329,27 +8502,26 @@ ], "parameters": [ { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries).", - "required": false, + "name": "transactionId", + "description": "Transaction ID.", + "required": true, "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "string", + "x-example": "<TRANSACTION_ID>" }, - "in": "query" + "in": "path" } ] - }, + } + }, + "\/documentsdb\/transactions\/{transactionId}\/operations": { "post": { - "summary": "Create transaction", - "operationId": "documentsDBCreateTransaction", + "summary": "Create operations", + "operationId": "documentsDBCreateOperations", "tags": [ "documentsDB" ], - "description": "Create a new transaction.", + "description": "Create multiple operations in a single transaction.", "responses": { "201": { "description": "Transaction", @@ -7364,24 +8536,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", + "method": "createOperations", "group": "transactions", "cookies": false, "type": "", - "demo": "documentsdb\/create-transaction.md", + "demo": "documentsdb\/create-operations.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": "documents.write", "platforms": [ - "console", "server", "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-operations.md", "auth": { "Project": [] } @@ -7393,18 +8564,32 @@ "JWT": [] } ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<TRANSACTION_ID>" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "default": 300, - "x-example": 60, - "format": "int32" + "operations": { + "type": "array", + "description": "Array of staged operations.", + "default": [], + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } } } } @@ -7413,21 +8598,21 @@ } } }, - "\/documentsdb\/transactions\/{transactionId}": { + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents": { "get": { - "summary": "Get transaction", - "operationId": "documentsDBGetTransaction", + "summary": "List documents", + "operationId": "documentsDBListDocuments", "tags": [ "documentsDB" ], - "description": "Get a transaction by its unique ID.", + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", "responses": { "200": { - "description": "Transaction", + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/documentList" } } } @@ -7435,24 +8620,24 @@ }, "deprecated": false, "x-appwrite": { - "method": "getTransaction", - "group": "transactions", + "method": "listDocuments", + "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/get-transaction.md", + "demo": "documentsdb\/list-documents.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": "documents.read", "platforms": [ "console", - "server", "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-documents.md", "auth": { "Project": [] } @@ -7466,31 +8651,87 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "x-example": "<DATABASE_ID>" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "<COLLECTION_ID>" }, "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "<TRANSACTION_ID>" + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" } ] }, - "patch": { - "summary": "Update transaction", - "operationId": "documentsDBUpdateTransaction", + "post": { + "summary": "Create document", + "operationId": "documentsDBCreateDocument", "tags": [ "documentsDB" ], - "description": "Update a transaction, to either commit or roll back its operations.", + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", "responses": { - "200": { - "description": "Transaction", + "201": { + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/document" } } } @@ -7498,24 +8739,83 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", + "method": "createDocument", + "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/update-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", + "demo": "documentsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ "console", - "server", "client", + "server", "server" ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-transaction.md", + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-document.md", + "methods": [ + { + "name": "createDocument", + "namespace": "documentsDB", + "desc": "Create document", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-document.md", + "public": true + }, + { + "name": "createDocuments", + "namespace": "documentsDB", + "desc": "Create documents", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-documents.md", + "public": true + } + ], "auth": { "Project": [] } @@ -7529,12 +8829,22 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "x-example": "<DATABASE_ID>" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "required": true, + "schema": { + "type": "string", + "x-example": "<COLLECTION_ID>" }, "in": "path" } @@ -7545,56 +8855,90 @@ "schema": { "type": "object", "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "default": false, - "x-example": false + "documentId": { + "type": "string", + "description": "Document 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.", + "default": "", + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "default": false, - "x-example": false + "data": { + "type": "object", + "description": "Document data as JSON object.", + "default": {}, + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>" } } } } } } - }, - "delete": { - "summary": "Delete transaction", - "operationId": "documentsDBDeleteTransaction", + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "documentsDBGetDocument", "tags": [ "documentsDB" ], - "description": "Delete a transaction by its unique ID.", + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", + "method": "getDocument", + "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/delete-transaction.md", + "demo": "documentsdb\/get-document.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "documents.read", "platforms": [ "console", - "server", "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-document.md", "auth": { "Project": [] } @@ -7608,33 +8952,74 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "x-example": "<DATABASE_ID>" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "<COLLECTION_ID>" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<DOCUMENT_ID>" }, "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "<TRANSACTION_ID>" + }, + "in": "query" } ] - } - }, - "\/documentsdb\/transactions\/{transactionId}\/operations": { - "post": { - "summary": "Create operations", - "operationId": "documentsDBCreateOperations", + }, + "put": { + "summary": "Upsert a document", + "operationId": "documentsDBUpsertDocument", "tags": [ "documentsDB" ], - "description": "Create multiple operations in a single transaction.", + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", "responses": { "201": { - "description": "Transaction", + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/document" } } } @@ -7642,23 +9027,56 @@ }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", + "method": "upsertDocument", + "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/create-operations.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", + "demo": "documentsdb\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "server", + "console", "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-operations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/upsert-document.md", + "methods": [ + { + "name": "upsertDocument", + "namespace": "documentsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/upsert-document.md", + "public": true + } + ], "auth": { "Project": [] } @@ -7672,12 +9090,32 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "x-example": "<DATABASE_ID>" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<COLLECTION_ID>" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<DOCUMENT_ID>" }, "in": "path" } @@ -7688,37 +9126,45 @@ "schema": { "type": "object", "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "data": { + "type": "object", + "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", + "default": {}, + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", "items": { - "type": "object" + "type": "string" } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>" } } } } } } - } - }, - "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents": { - "get": { - "summary": "List documents", - "operationId": "documentsDBListDocuments", + }, + "patch": { + "summary": "Update document", + "operationId": "documentsDBUpdateDocument", "tags": [ "documentsDB" ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { "200": { - "description": "Documents List", + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/document" } } } @@ -7726,15 +9172,15 @@ }, "deprecated": false, "x-appwrite": { - "method": "listDocuments", + "method": "updateDocument", "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/list-documents.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "documentsdb\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "client", @@ -7743,7 +9189,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-document.md", "auth": { "Project": [] } @@ -7768,7 +9214,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7777,80 +9223,67 @@ "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, + "name": "documentId", + "description": "Document ID.", + "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" - }, - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true - }, - "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 + "x-example": "<DOCUMENT_ID>" }, - "in": "query" + "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only fields and value pairs to be updated.", + "default": {}, + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>" + } + } + } + } + } + } }, - "post": { - "summary": "Create document", - "operationId": "documentsDBCreateDocument", + "delete": { + "summary": "Delete document", + "operationId": "documentsDBDeleteDocument", "tags": [ "documentsDB" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Delete a document by its unique ID.", "responses": { - "201": { - "description": "Document", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/document" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createDocument", + "method": "deleteDocument", "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/create-document.md", - "rate-limit": 120, + "demo": "documentsdb\/delete-document.md", + "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", @@ -7862,66 +9295,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-document.md", - "methods": [ - { - "name": "createDocument", - "namespace": "documentsDB", - "desc": "Create document", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions" - ], - "required": [ - "databaseId", - "collectionId", - "documentId", - "data" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/document" - } - ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "documentsdb\/create-document.md", - "public": true - }, - { - "name": "createDocuments", - "namespace": "documentsDB", - "desc": "Create documents", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/documentList" - } - ], - "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "documentsdb\/create-documents.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-document.md", "auth": { "Project": [] } @@ -7946,13 +9320,23 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", "x-example": "<COLLECTION_ID>" }, "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<DOCUMENT_ID>" + }, + "in": "path" } ], "requestBody": { @@ -7961,35 +9345,6 @@ "schema": { "type": "object", "properties": { - "documentId": { - "type": "string", - "description": "Document 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.", - "default": "", - "x-example": "<DOCUMENT_ID>" - }, - "data": { - "type": "object", - "description": "Document data as JSON object.", - "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", - "default": [], - "x-example": null, - "items": { - "type": "object" - } - }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", @@ -8002,14 +9357,14 @@ } } }, - "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { - "get": { - "summary": "Get document", - "operationId": "documentsDBGetDocument", + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "documentsDBDecrementDocumentAttribute", "tags": [ "documentsDB" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Decrement a specific column of a row by a given value.", "responses": { "200": { "description": "Document", @@ -8024,24 +9379,24 @@ }, "deprecated": false, "x-appwrite": { - "method": "getDocument", + "method": "decrementDocumentAttribute", "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/get-document.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "documentsdb\/decrement-document-attribute.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ - "console", "client", "server", + "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/decrement-document-attribute.md", "auth": { "Project": [] } @@ -8066,7 +9421,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -8085,39 +9440,56 @@ "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, + "name": "attribute", + "description": "Attribute key.", + "required": true, "schema": { - "type": "string", - "x-example": "<TRANSACTION_ID>" + "type": "string" }, - "in": "query" + "in": "path" } - ] - }, - "put": { - "summary": "Upsert a document", - "operationId": "documentsDBUpsertDocument", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to decrement the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" + }, + "min": { + "type": "number", + "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", + "x-example": null, + "format": "float" + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>" + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "documentsDBIncrementDocumentAttribute", "tags": [ "documentsDB" ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Increment a specific column of a row by a given value.", "responses": { - "201": { + "200": { "description": "Document", "content": { "application\/json": { @@ -8130,56 +9502,24 @@ }, "deprecated": false, "x-appwrite": { - "method": "upsertDocument", + "method": "incrementDocumentAttribute", "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/upsert-document.md", + "demo": "documentsdb\/increment-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", + "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/upsert-document.md", - "methods": [ - { - "name": "upsertDocument", - "namespace": "documentsDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/document" - } - ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "documentsdb\/upsert-document.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/increment-document-attribute.md", "auth": { "Project": [] } @@ -8221,6 +9561,15 @@ "x-example": "<DOCUMENT_ID>" }, "in": "path" + }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -8229,19 +9578,18 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "default": {}, - "x-example": "{}" + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } + "max": { + "type": "number", + "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", + "x-example": null, + "format": "float" }, "transactionId": { "type": "string", @@ -8253,21 +9601,112 @@ } } } + } + }, + "\/functions\/{functionId}\/executions": { + "get": { + "summary": "List executions", + "operationId": "functionsListExecutions", + "tags": [ + "functions" + ], + "description": "Get a list of all the current user function execution logs. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Executions List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/executionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listExecutions", + "group": "executions", + "cookies": false, + "type": "", + "demo": "functions\/list-executions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "executions.read", + "execution.read" + ], + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "functionId", + "description": "Function ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<FUNCTION_ID>" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] }, - "patch": { - "summary": "Update document", - "operationId": "documentsDBUpdateDocument", + "post": { + "summary": "Create execution", + "operationId": "functionsCreateExecution", "tags": [ - "documentsDB" + "functions" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", "responses": { - "200": { - "description": "Document", + "201": { + "description": "Execution", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/execution" } } } @@ -8275,15 +9714,18 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDocument", - "group": "documents", + "method": "createExecution", + "group": "executions", "cookies": false, "type": "", - "demo": "documentsdb\/update-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "functions\/create-execution.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "executions.write", + "execution.write" + ], "platforms": [ "console", "client", @@ -8292,7 +9734,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-document.md", "auth": { "Project": [] } @@ -8306,32 +9747,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DATABASE_ID>" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<COLLECTION_ID>" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "functionId", + "description": "Function ID.", "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "x-example": "<FUNCTION_ID>" }, "in": "path" } @@ -8342,54 +9763,93 @@ "schema": { "type": "object", "properties": { - "data": { + "body": { + "type": "string", + "description": "HTTP body of execution. Default value is empty string.", + "default": "", + "x-example": "<BODY>" + }, + "async": { + "type": "boolean", + "description": "Execute code in the background. Default value is false.", + "default": false, + "x-example": false + }, + "path": { + "type": "string", + "description": "HTTP path of execution. Path can include query params. Default value is \/", + "default": "\/", + "x-example": "<PATH>" + }, + "method": { + "type": "string", + "description": "HTTP method of execution. Default value is POST.", + "default": "POST", + "x-example": "GET", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "x-enum-name": "ExecutionMethod" + }, + "headers": { "type": "object", - "description": "Document data as JSON object. Include only fields and value pairs to be updated.", + "description": "HTTP headers of execution. Defaults to empty.", "default": {}, "x-example": "{}" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "transactionId": { + "scheduledAt": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.", + "x-example": "<SCHEDULED_AT>", + "x-nullable": true } } } } } } - }, - "delete": { - "summary": "Delete document", - "operationId": "documentsDBDeleteDocument", + } + }, + "\/functions\/{functionId}\/executions\/{executionId}": { + "get": { + "summary": "Get execution", + "operationId": "functionsGetExecution", "tags": [ - "documentsDB" + "functions" ], - "description": "Delete a document by its unique ID.", + "description": "Get a function execution log by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Execution", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/execution" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDocument", - "group": "documents", + "method": "getExecution", + "group": "executions", "cookies": false, "type": "", - "demo": "documentsdb\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "functions\/get-execution.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -8398,7 +9858,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-document.md", "auth": { "Project": [] } @@ -8412,69 +9871,96 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DATABASE_ID>" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "functionId", + "description": "Function ID.", "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "x-example": "<FUNCTION_ID>" }, "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "executionId", + "description": "Execution ID.", "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "x-example": "<EXECUTION_ID>" }, "in": "path" } + ] + } + }, + "\/graphql": { + "post": { + "summary": "GraphQL endpoint", + "operationId": "graphqlQuery", + "tags": [ + "graphql" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" - } + "description": "Execute a GraphQL mutation.", + "responses": { + "200": { + "description": "Any", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/any" } } } } - } + }, + "deprecated": false, + "x-appwrite": { + "method": "query", + "group": "graphql", + "cookies": false, + "type": "graphql", + "demo": "graphql\/query.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "url:{url},ip:{ip}", + "scope": "graphql", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ] } }, - "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "documentsDBDecrementDocumentAttribute", + "\/graphql\/mutation": { + "post": { + "summary": "GraphQL endpoint", + "operationId": "graphqlMutation", "tags": [ - "documentsDB" + "graphql" ], - "description": "Decrement a specific column of a row by a given value.", + "description": "Execute a GraphQL mutation.", "responses": { "200": { - "description": "Document", + "description": "Any", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/any" } } } @@ -8482,24 +9968,24 @@ }, "deprecated": false, "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", - "cookies": false, - "type": "", - "demo": "documentsdb\/decrement-document-attribute.md", - "rate-limit": 120, + "method": "mutation", + "group": "graphql", + "cookies": false, + "type": "graphql", + "demo": "graphql\/mutation.md", + "rate-limit": 60, "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "rate-key": "url:{url},ip:{ip}", + "scope": "graphql", "platforms": [ - "client", - "server", "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/decrement-document-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md", "auth": { "Project": [] } @@ -8510,94 +9996,24 @@ "Session": [], "JWT": [] } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DATABASE_ID>" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<COLLECTION_ID>" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DOCUMENT_ID>" - }, - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "min": { - "type": "number", - "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, - "format": "float" - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" - } - } - } - } - } - } + ] } }, - "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { - "patch": { - "summary": "Increment document attribute", - "operationId": "documentsDBIncrementDocumentAttribute", + "\/locale": { + "get": { + "summary": "Get user locale", + "operationId": "localeGet", "tags": [ - "documentsDB" + "locale" ], - "description": "Increment a specific column of a row by a given value.", + "description": "Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))", "responses": { "200": { - "description": "Document", + "description": "Locale", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/locale" } } } @@ -8605,24 +10021,24 @@ }, "deprecated": false, "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", + "method": "get", + "group": null, "cookies": false, "type": "", - "demo": "documentsdb\/increment-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "locale\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "locale.read", "platforms": [ + "console", "client", "server", - "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/increment-document-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md", "auth": { "Project": [] } @@ -8633,94 +10049,24 @@ "Session": [], "JWT": [] } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DATABASE_ID>" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<COLLECTION_ID>" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DOCUMENT_ID>" - }, - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "max": { - "type": "number", - "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, - "format": "float" - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" - } - } - } - } - } - } + ] } }, - "\/functions\/{functionId}\/executions": { + "\/locale\/codes": { "get": { - "summary": "List executions", - "operationId": "functionsListExecutions", + "summary": "List locale codes", + "operationId": "localeListCodes", "tags": [ - "functions" + "locale" ], - "description": "Get a list of all the current user function execution logs. You can use the query params to filter your results.", + "description": "List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).", "responses": { "200": { - "description": "Executions List", + "description": "Locale codes list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/executionList" + "$ref": "#\/components\/schemas\/localeCodeList" } } } @@ -8728,18 +10074,15 @@ }, "deprecated": false, "x-appwrite": { - "method": "listExecutions", - "group": "executions", + "method": "listCodes", + "group": null, "cookies": false, "type": "", - "demo": "functions\/list-executions.md", + "demo": "locale\/list-codes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "executions.read", - "execution.read" - ], + "scope": "locale.read", "platforms": [ "console", "client", @@ -8748,6 +10091,7 @@ ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md", "auth": { "Project": [] } @@ -8756,60 +10100,26 @@ { "Project": [], "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "functionId", - "description": "Function ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<FUNCTION_ID>" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true - }, - "in": "query" + "JWT": [] } ] - }, - "post": { - "summary": "Create execution", - "operationId": "functionsCreateExecution", + } + }, + "\/locale\/continents": { + "get": { + "summary": "List continents", + "operationId": "localeListContinents", "tags": [ - "functions" + "locale" ], - "description": "Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", + "description": "List of all continents. You can use the locale header to get the data in a supported language.", "responses": { - "201": { - "description": "Execution", + "200": { + "description": "Continents List", "content": { - "multipart\/form-data": { + "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/execution" + "$ref": "#\/components\/schemas\/continentList" } } } @@ -8817,18 +10127,15 @@ }, "deprecated": false, "x-appwrite": { - "method": "createExecution", - "group": "executions", + "method": "listContinents", + "group": null, "cookies": false, "type": "", - "demo": "functions\/create-execution.md", + "demo": "locale\/list-continents.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "executions.write", - "execution.write" - ], + "scope": "locale.read", "platforms": [ "console", "client", @@ -8837,6 +10144,7 @@ ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md", "auth": { "Project": [] } @@ -8847,93 +10155,24 @@ "Session": [], "JWT": [] } - ], - "parameters": [ - { - "name": "functionId", - "description": "Function ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<FUNCTION_ID>" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "HTTP body of execution. Default value is empty string.", - "default": "", - "x-example": "<BODY>" - }, - "async": { - "type": "boolean", - "description": "Execute code in the background. Default value is false.", - "default": false, - "x-example": false - }, - "path": { - "type": "string", - "description": "HTTP path of execution. Path can include query params. Default value is \/", - "default": "\/", - "x-example": "<PATH>" - }, - "method": { - "type": "string", - "description": "HTTP method of execution. Default value is POST.", - "default": "POST", - "x-example": "GET", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "x-enum-name": "ExecutionMethod" - }, - "headers": { - "type": "object", - "description": "HTTP headers of execution. Defaults to empty.", - "default": {}, - "x-example": "{}" - }, - "scheduledAt": { - "type": "string", - "description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.", - "x-example": "<SCHEDULED_AT>", - "x-nullable": true - } - } - } - } - } - } + ] } }, - "\/functions\/{functionId}\/executions\/{executionId}": { + "\/locale\/countries": { "get": { - "summary": "Get execution", - "operationId": "functionsGetExecution", + "summary": "List countries", + "operationId": "localeListCountries", "tags": [ - "functions" + "locale" ], - "description": "Get a function execution log by its unique ID.", + "description": "List of all countries. You can use the locale header to get the data in a supported language.", "responses": { "200": { - "description": "Execution", + "description": "Countries List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/execution" + "$ref": "#\/components\/schemas\/countryList" } } } @@ -8941,18 +10180,15 @@ }, "deprecated": false, "x-appwrite": { - "method": "getExecution", - "group": "executions", + "method": "listCountries", + "group": null, "cookies": false, "type": "", - "demo": "functions\/get-execution.md", + "demo": "locale\/list-countries.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "executions.read", - "execution.read" - ], + "scope": "locale.read", "platforms": [ "console", "client", @@ -8961,6 +10197,7 @@ ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md", "auth": { "Project": [] } @@ -8971,46 +10208,24 @@ "Session": [], "JWT": [] } - ], - "parameters": [ - { - "name": "functionId", - "description": "Function ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<FUNCTION_ID>" - }, - "in": "path" - }, - { - "name": "executionId", - "description": "Execution ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<EXECUTION_ID>" - }, - "in": "path" - } ] } }, - "\/graphql": { - "post": { - "summary": "GraphQL endpoint", - "operationId": "graphqlQuery", + "\/locale\/countries\/eu": { + "get": { + "summary": "List EU countries", + "operationId": "localeListCountriesEU", "tags": [ - "graphql" + "locale" ], - "description": "Execute a GraphQL mutation.", + "description": "List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.", "responses": { "200": { - "description": "Any", + "description": "Countries List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/any" + "$ref": "#\/components\/schemas\/countryList" } } } @@ -9018,24 +10233,24 @@ }, "deprecated": false, "x-appwrite": { - "method": "query", - "group": "graphql", + "method": "listCountriesEU", + "group": null, "cookies": false, - "type": "graphql", - "demo": "graphql\/query.md", - "rate-limit": 60, - "rate-time": 60, + "type": "", + "demo": "locale\/list-countries-eu.md", + "rate-limit": 0, + "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "graphql", + "scope": "locale.read", "platforms": [ "console", - "server", "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md", "auth": { "Project": [] } @@ -9049,21 +10264,21 @@ ] } }, - "\/graphql\/mutation": { - "post": { - "summary": "GraphQL endpoint", - "operationId": "graphqlMutation", + "\/locale\/countries\/phones": { + "get": { + "summary": "List countries phone codes", + "operationId": "localeListCountriesPhones", "tags": [ - "graphql" + "locale" ], - "description": "Execute a GraphQL mutation.", + "description": "List of all countries phone codes. You can use the locale header to get the data in a supported language.", "responses": { "200": { - "description": "Any", + "description": "Phones List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/any" + "$ref": "#\/components\/schemas\/phoneList" } } } @@ -9071,24 +10286,24 @@ }, "deprecated": false, "x-appwrite": { - "method": "mutation", - "group": "graphql", + "method": "listCountriesPhones", + "group": null, "cookies": false, - "type": "graphql", - "demo": "graphql\/mutation.md", - "rate-limit": 60, - "rate-time": 60, + "type": "", + "demo": "locale\/list-countries-phones.md", + "rate-limit": 0, + "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "graphql", + "scope": "locale.read", "platforms": [ "console", - "server", "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md", "auth": { "Project": [] } @@ -9102,21 +10317,21 @@ ] } }, - "\/locale": { + "\/locale\/currencies": { "get": { - "summary": "Get user locale", - "operationId": "localeGet", + "summary": "List currencies", + "operationId": "localeListCurrencies", "tags": [ "locale" ], - "description": "Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))", + "description": "List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.", "responses": { "200": { - "description": "Locale", + "description": "Currencies List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/locale" + "$ref": "#\/components\/schemas\/currencyList" } } } @@ -9124,11 +10339,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", + "method": "listCurrencies", "group": null, "cookies": false, "type": "", - "demo": "locale\/get.md", + "demo": "locale\/list-currencies.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9141,7 +10356,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md", "auth": { "Project": [] } @@ -9155,21 +10370,21 @@ ] } }, - "\/locale\/codes": { + "\/locale\/languages": { "get": { - "summary": "List locale codes", - "operationId": "localeListCodes", + "summary": "List languages", + "operationId": "localeListLanguages", "tags": [ "locale" ], - "description": "List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).", + "description": "List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.", "responses": { "200": { - "description": "Locale codes list", + "description": "Languages List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/localeCodeList" + "$ref": "#\/components\/schemas\/languageList" } } } @@ -9177,11 +10392,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "listCodes", + "method": "listLanguages", "group": null, "cookies": false, "type": "", - "demo": "locale\/list-codes.md", + "demo": "locale\/list-languages.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9194,7 +10409,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md", "auth": { "Project": [] } @@ -9208,21 +10423,21 @@ ] } }, - "\/locale\/continents": { - "get": { - "summary": "List continents", - "operationId": "localeListContinents", + "\/messaging\/topics\/{topicId}\/subscribers": { + "post": { + "summary": "Create subscriber", + "operationId": "messagingCreateSubscriber", "tags": [ - "locale" + "messaging" ], - "description": "List of all continents. You can use the locale header to get the data in a supported language.", + "description": "Create a new subscriber.", "responses": { - "200": { - "description": "Continents List", + "201": { + "description": "Subscriber", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/continentList" + "$ref": "#\/components\/schemas\/subscriber" } } } @@ -9230,24 +10445,24 @@ }, "deprecated": false, "x-appwrite": { - "method": "listContinents", - "group": null, + "method": "createSubscriber", + "group": "subscribers", "cookies": false, "type": "", - "demo": "locale\/list-continents.md", + "demo": "messaging\/create-subscriber.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "scope": "subscribers.write", "platforms": [ - "console", - "client", "server", + "client", + "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md", "auth": { "Project": [] } @@ -9255,52 +10470,85 @@ "security": [ { "Project": [], - "Session": [], - "JWT": [] + "JWT": [], + "Session": [] } - ] + ], + "parameters": [ + { + "name": "topicId", + "description": "Topic ID. The topic ID to subscribe to.", + "required": true, + "schema": { + "type": "string", + "x-example": "<TOPIC_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "subscriberId": { + "type": "string", + "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", + "x-example": "<SUBSCRIBER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "targetId": { + "type": "string", + "description": "Target ID. The target ID to link to the specified Topic ID.", + "x-example": "<TARGET_ID>" + } + }, + "required": [ + "subscriberId", + "targetId" + ] + } + } + } + } } }, - "\/locale\/countries": { - "get": { - "summary": "List countries", - "operationId": "localeListCountries", + "\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}": { + "delete": { + "summary": "Delete subscriber", + "operationId": "messagingDeleteSubscriber", "tags": [ - "locale" + "messaging" ], - "description": "List of all countries. You can use the locale header to get the data in a supported language.", + "description": "Delete a subscriber by its unique ID.", "responses": { - "200": { - "description": "Countries List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/countryList" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "listCountries", - "group": null, + "method": "deleteSubscriber", + "group": "subscribers", "cookies": false, "type": "", - "demo": "locale\/list-countries.md", + "demo": "messaging\/delete-subscriber.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "scope": "subscribers.write", "platforms": [ - "console", - "client", "server", + "client", + "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md", "auth": { "Project": [] } @@ -9308,27 +10556,49 @@ "security": [ { "Project": [], - "Session": [], - "JWT": [] + "JWT": [], + "Session": [] + } + ], + "parameters": [ + { + "name": "topicId", + "description": "Topic ID. The topic ID subscribed to.", + "required": true, + "schema": { + "type": "string", + "x-example": "<TOPIC_ID>" + }, + "in": "path" + }, + { + "name": "subscriberId", + "description": "Subscriber ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<SUBSCRIBER_ID>" + }, + "in": "path" } ] } }, - "\/locale\/countries\/eu": { - "get": { - "summary": "List EU countries", - "operationId": "localeListCountriesEU", + "\/oauth2\/{project_id}\/approve": { + "post": { + "summary": "Approve OAuth2", + "operationId": "oauth2Approve", "tags": [ - "locale" + "oauth2" ], - "description": "List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.", + "description": "Approve an OAuth2 grant after the user gives consent. Returns the `redirectUrl` the end user should be sent to. The consent screen may optionally pass enriched `authorization_details` to record the concrete resources the user selected. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", "responses": { "200": { - "description": "Countries List", + "description": "OAuth2 Approve", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/countryList" + "$ref": "#\/components\/schemas\/oauth2Approve" } } } @@ -9336,52 +10606,86 @@ }, "deprecated": false, "x-appwrite": { - "method": "listCountriesEU", + "method": "approve", "group": null, "cookies": false, "type": "", - "demo": "locale\/list-countries-eu.md", + "demo": "oauth2\/approve.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "scope": "oauth2.write", "platforms": [ - "console", "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md", "auth": { - "Project": [] + "ProjectQuery": [] } }, "security": [ { - "Project": [], + "ProjectQuery": [], "Session": [], "JWT": [] } - ] + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROJECT_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "grant_id": { + "type": "string", + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", + "x-example": "<GRANT_ID>" + }, + "authorization_details": { + "type": "string", + "description": "Enriched `authorization_details` the user consented to, replacing what the client requested. Each entry must use a `type` the project accepts. Optional; omit to keep the originally requested details.", + "default": "", + "x-example": "<AUTHORIZATION_DETAILS>" + } + }, + "required": [ + "grant_id" + ] + } + } + } + } } }, - "\/locale\/countries\/phones": { + "\/oauth2\/{project_id}\/authorize": { "get": { - "summary": "List countries phone codes", - "operationId": "localeListCountriesPhones", + "summary": "OAuth2 Authorize", + "operationId": "oauth2Authorize", "tags": [ - "locale" + "oauth2" ], - "description": "List of all countries phone codes. You can use the locale header to get the data in a supported language.", + "description": "Begin the OAuth2 authorization flow. When called without a session, the user is redirected to the consent screen without grant ID. When called with a session, the redirect URL includes param for grant ID. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", "responses": { "200": { - "description": "Phones List", + "description": "OAuth2 Authorize", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/phoneList" + "$ref": "#\/components\/schemas\/oauth2Authorize" } } } @@ -9389,52 +10693,179 @@ }, "deprecated": false, "x-appwrite": { - "method": "listCountriesPhones", + "method": "authorize", "group": null, "cookies": false, "type": "", - "demo": "locale\/list-countries-phones.md", + "demo": "oauth2\/authorize.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "scope": "public", "platforms": [ - "console", "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md", "auth": { - "Project": [] + "ProjectQuery": [] } }, "security": [ { - "Project": [], - "Session": [], - "JWT": [] + "ProjectQuery": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client exists.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROJECT_ID>" + }, + "in": "path" + }, + { + "name": "client_id", + "description": "OAuth2 client ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<CLIENT_ID>" + }, + "in": "query" + }, + { + "name": "redirect_uri", + "description": "Redirect URI where visitor will be redirected after authorization, whether successful or not.", + "required": true, + "schema": { + "type": "string", + "format": "url", + "x-example": "https:\/\/example.com" + }, + "in": "query" + }, + { + "name": "response_type", + "description": "OAuth2 \/ OIDC response type. One of `code` (Authorization Code Flow), `id_token` (Implicit Flow, OIDC login only), or `code id_token` (Hybrid Flow).", + "required": true, + "schema": { + "type": "string", + "x-example": "code" + }, + "in": "query" + }, + { + "name": "scope", + "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`.", + "required": true, + "schema": { + "type": "string", + "x-example": "<SCOPE>" + }, + "in": "query" + }, + { + "name": "state", + "description": "OAuth2 state. You receive this back in the redirect URI.", + "required": false, + "schema": { + "type": "string", + "x-example": "<STATE>", + "default": "" + }, + "in": "query" + }, + { + "name": "nonce", + "description": "OIDC nonce parameter to prevent replay attacks. Required when response_type includes `id_token`.", + "required": false, + "schema": { + "type": "string", + "x-example": "<NONCE>", + "default": "" + }, + "in": "query" + }, + { + "name": "code_challenge", + "description": "PKCE code challenge. Required when OAuth2 app is public.", + "required": false, + "schema": { + "type": "string", + "x-example": "<CODE_CHALLENGE>", + "default": "" + }, + "in": "query" + }, + { + "name": "code_challenge_method", + "description": "PKCE code challenge method. Required when OAuth2 app is public.", + "required": false, + "schema": { + "type": "string", + "x-example": "s256", + "default": "" + }, + "in": "query" + }, + { + "name": "prompt", + "description": "OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.", + "required": false, + "schema": { + "type": "string", + "x-example": "<PROMPT>", + "default": "" + }, + "in": "query" + }, + { + "name": "max_age", + "description": "OIDC max_age paraleter for customization of consent screen. Maximum allowable elapsed time in seconds since the user last authenticated. If exceeded, re-authentication is required.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0 + }, + "in": "query" + }, + { + "name": "authorization_details", + "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", + "required": false, + "schema": { + "type": "string", + "x-example": "<AUTHORIZATION_DETAILS>", + "default": "" + }, + "in": "query" } ] } }, - "\/locale\/currencies": { - "get": { - "summary": "List currencies", - "operationId": "localeListCurrencies", + "\/oauth2\/{project_id}\/grants": { + "post": { + "summary": "Create OAuth2 Grant", + "operationId": "oauth2CreateGrant", "tags": [ - "locale" + "oauth2" ], - "description": "List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.", + "description": "Exchange a device flow user code for an OAuth2 grant. The authenticated user is bound to the pending grant. Pass the returned grant ID to the get grant endpoint to render the consent screen, then to the approve or reject endpoint to complete the flow.", "responses": { - "200": { - "description": "Currencies List", + "201": { + "description": "OAuth2 Grant", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/currencyList" + "$ref": "#\/components\/schemas\/oauth2Grant" } } } @@ -9442,24 +10873,21 @@ }, "deprecated": false, "x-appwrite": { - "method": "listCurrencies", + "method": "createGrant", "group": null, "cookies": false, "type": "", - "demo": "locale\/list-currencies.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "demo": "oauth2\/create-grant.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "ip:{ip},userId:{userId}", + "scope": "oauth2.write", "platforms": [ - "console", "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md", "auth": { "Project": [] } @@ -9470,24 +10898,55 @@ "Session": [], "JWT": [] } - ] + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client exists.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROJECT_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "user_code": { + "type": "string", + "description": "User code displayed on the device.", + "x-example": "<USER_CODE>" + } + }, + "required": [ + "user_code" + ] + } + } + } + } } }, - "\/locale\/languages": { + "\/oauth2\/{project_id}\/grants\/{grant_id}": { "get": { - "summary": "List languages", - "operationId": "localeListLanguages", + "summary": "Get OAuth2 Grant", + "operationId": "oauth2GetGrant", "tags": [ - "locale" + "oauth2" ], - "description": "List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.", + "description": "Get an OAuth2 grant by its ID. Used by the consent screen to display the details of the authorization the user is being asked to approve. A grant can only be read by the user it belongs to, or by server SDK.", "responses": { "200": { - "description": "Languages List", + "description": "OAuth2 Grant", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/languageList" + "$ref": "#\/components\/schemas\/oauth2Grant" } } } @@ -9495,24 +10954,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listLanguages", + "method": "getGrant", "group": null, "cookies": false, "type": "", - "demo": "locale\/list-languages.md", + "demo": "oauth2\/get-grant.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "scope": "oauth2.read", "platforms": [ - "console", "client", "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md", "auth": { "Project": [] } @@ -9523,24 +10980,46 @@ "Session": [], "JWT": [] } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROJECT_ID>" + }, + "in": "path" + }, + { + "name": "grant_id", + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", + "required": true, + "schema": { + "type": "string", + "x-example": "<GRANT_ID>" + }, + "in": "path" + } ] } }, - "\/messaging\/topics\/{topicId}\/subscribers": { + "\/oauth2\/{project_id}\/reject": { "post": { - "summary": "Create subscriber", - "operationId": "messagingCreateSubscriber", + "summary": "Reject OAuth2", + "operationId": "oauth2Reject", "tags": [ - "messaging" + "oauth2" ], - "description": "Create a new subscriber.", + "description": "Reject an OAuth2 grant when the user denies consent. Returns the `redirectUrl` the end user should be sent to with an `access_denied` error. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", "responses": { - "201": { - "description": "Subscriber", + "200": { + "description": "OAuth2 Reject", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/subscriber" + "$ref": "#\/components\/schemas\/oauth2Reject" } } } @@ -9548,43 +11027,40 @@ }, "deprecated": false, "x-appwrite": { - "method": "createSubscriber", - "group": "subscribers", + "method": "reject", + "group": null, "cookies": false, "type": "", - "demo": "messaging\/create-subscriber.md", + "demo": "oauth2\/reject.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "subscribers.write", + "scope": "oauth2.write", "platforms": [ - "server", "client", - "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md", "auth": { - "Project": [] + "ProjectQuery": [] } }, "security": [ { - "Project": [], - "JWT": [], - "Session": [] + "ProjectQuery": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "topicId", - "description": "Topic ID. The topic ID to subscribe to.", + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "x-example": "<PROJECT_ID>" }, "in": "path" } @@ -9595,20 +11071,14 @@ "schema": { "type": "object", "properties": { - "subscriberId": { - "type": "string", - "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", - "x-example": "<SUBSCRIBER_ID>" - }, - "targetId": { + "grant_id": { "type": "string", - "description": "Target ID. The target ID to link to the specified Topic ID.", - "x-example": "<TARGET_ID>" + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", + "x-example": "<GRANT_ID>" } }, "required": [ - "subscriberId", - "targetId" + "grant_id" ] } } @@ -9616,74 +11086,6 @@ } } }, - "\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}": { - "delete": { - "summary": "Delete subscriber", - "operationId": "messagingDeleteSubscriber", - "tags": [ - "messaging" - ], - "description": "Delete a subscriber by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteSubscriber", - "group": "subscribers", - "cookies": false, - "type": "", - "demo": "messaging\/delete-subscriber.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "subscribers.write", - "platforms": [ - "server", - "client", - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "JWT": [], - "Session": [] - } - ], - "parameters": [ - { - "name": "topicId", - "description": "Topic ID. The topic ID subscribed to.", - "required": true, - "schema": { - "type": "string", - "x-example": "<TOPIC_ID>" - }, - "in": "path" - }, - { - "name": "subscriberId", - "description": "Subscriber ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<SUBSCRIBER_ID>" - }, - "in": "path" - } - ] - } - }, "\/presences": { "get": { "summary": "List presences", @@ -10337,7 +11739,10 @@ "type": "string", "description": "File 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.", "x-example": "<FILE_ID>", - "x-upload-id": true + "x-upload-id": true, + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "file": { "type": "string", @@ -10638,14 +12043,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -10717,14 +12124,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -10943,14 +12352,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -11676,7 +13087,10 @@ "type": "string", "description": "Row 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.", "default": "", - "x-example": "<ROW_ID>" + "x-example": "<ROW_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -12594,7 +14008,10 @@ "teamId": { "type": "string", "description": "Team 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.", - "x-example": "<TEAM_ID>" + "x-example": "<TEAM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -14187,7 +15604,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -14440,6 +15860,9 @@ "required": true, "schema": { "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<DOCUMENT_ID>" }, "in": "path" @@ -14728,6 +16151,10 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, + { + "name": "presences", + "description": "The Presences service allows you to create, query, and manage realtime presence state." + }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -15786,10 +17213,40 @@ "description": "User phone number in E.164 format.", "x-example": "+4930901820" }, - "emailVerification": { + "emailVerification": { + "type": "boolean", + "description": "Email verification status.", + "x-example": true + }, + "emailCanonical": { + "type": "string", + "description": "Canonical form of the user email address.", + "x-example": "john@appwrite.io", + "nullable": true + }, + "emailIsFree": { + "type": "boolean", + "description": "Whether the user email is from a free email provider.", + "x-example": true, + "nullable": true + }, + "emailIsDisposable": { + "type": "boolean", + "description": "Whether the user email is from a disposable email provider.", + "x-example": false, + "nullable": true + }, + "emailIsCorporate": { "type": "boolean", - "description": "Email verification status.", - "x-example": true + "description": "Whether the user email is from a corporate domain.", + "x-example": true, + "nullable": true + }, + "emailIsCanonical": { + "type": "boolean", + "description": "Whether the user email is in its canonical form.", + "x-example": true, + "nullable": true }, "phoneVerification": { "type": "boolean", @@ -15873,6 +17330,11 @@ "email": "john@appwrite.io", "phone": "+4930901820", "emailVerification": true, + "emailCanonical": "john@appwrite.io", + "emailIsFree": true, + "emailIsDisposable": false, + "emailIsCorporate": true, + "emailIsCanonical": true, "phoneVerification": true, "mfa": true, "prefs": { @@ -16793,6 +18255,11 @@ "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", "x-example": false }, + "userAccessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, "roles": { "type": "array", "description": "User list of roles", @@ -16818,6 +18285,7 @@ "joined", "confirm", "mfa", + "userAccessedAt", "roles" ], "example": { @@ -16834,6 +18302,7 @@ "joined": "2020-10-15T06:38:00.000+00:00", "confirm": false, "mfa": false, + "userAccessedAt": "2020-10-15T06:38:00.000+00:00", "roles": [ "owner" ] @@ -17164,399 +18633,855 @@ "properties": { "code": { "type": "string", - "description": "Phone code.", - "x-example": "+1" + "description": "Phone code.", + "x-example": "+1" + }, + "countryCode": { + "type": "string", + "description": "Country two-character ISO 3166-1 alpha code.", + "x-example": "US" + }, + "countryName": { + "type": "string", + "description": "Country name.", + "x-example": "United States" + } + }, + "required": [ + "code", + "countryCode", + "countryName" + ], + "example": { + "code": "+1", + "countryCode": "US", + "countryName": "United States" + } + }, + "headers": { + "description": "Headers", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Header name.", + "x-example": "Content-Type" + }, + "value": { + "type": "string", + "description": "Header value.", + "x-example": "application\/json" + } + }, + "required": [ + "name", + "value" + ], + "example": { + "name": "Content-Type", + "value": "application\/json" + } + }, + "mfaChallenge": { + "description": "MFA Challenge", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Token ID.", + "x-example": "bb8ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Token creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "5e5ea5c168bb8" + }, + "expire": { + "type": "string", + "description": "Token expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "$id", + "$createdAt", + "userId", + "expire" + ], + "example": { + "$id": "bb8ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "userId": "5e5ea5c168bb8", + "expire": "2020-10-15T06:38:00.000+00:00" + } + }, + "mfaRecoveryCodes": { + "description": "MFA Recovery Codes", + "type": "object", + "properties": { + "recoveryCodes": { + "type": "array", + "description": "Recovery codes.", + "items": { + "type": "string" + }, + "x-example": [ + "a3kf0-s0cl2", + "s0co1-as98s" + ] + } + }, + "required": [ + "recoveryCodes" + ], + "example": { + "recoveryCodes": [ + "a3kf0-s0cl2", + "s0co1-as98s" + ] + } + }, + "mfaType": { + "description": "MFAType", + "type": "object", + "properties": { + "secret": { + "type": "string", + "description": "Secret token used for TOTP factor.", + "x-example": "[SHARED_SECRET]" + }, + "uri": { + "type": "string", + "description": "URI for authenticator apps.", + "x-example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" + } + }, + "required": [ + "secret", + "uri" + ], + "example": { + "secret": "[SHARED_SECRET]", + "uri": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" + } + }, + "mfaFactors": { + "description": "MFAFactors", + "type": "object", + "properties": { + "totp": { + "type": "boolean", + "description": "Can TOTP be used for MFA challenge for this account.", + "x-example": true + }, + "phone": { + "type": "boolean", + "description": "Can phone (SMS) be used for MFA challenge for this account.", + "x-example": true + }, + "email": { + "type": "boolean", + "description": "Can email be used for MFA challenge for this account.", + "x-example": true + }, + "recoveryCode": { + "type": "boolean", + "description": "Can recovery code be used for MFA challenge for this account.", + "x-example": true + } + }, + "required": [ + "totp", + "phone", + "email", + "recoveryCode" + ], + "example": { + "totp": true, + "phone": true, + "email": true, + "recoveryCode": true + } + }, + "transaction": { + "description": "Transaction", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Transaction ID.", + "x-example": "259125845563242502" + }, + "$createdAt": { + "type": "string", + "description": "Transaction creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Transaction update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "status": { + "type": "string", + "description": "Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.", + "x-example": "pending" + }, + "operations": { + "type": "integer", + "description": "Number of operations in the transaction.", + "x-example": 5, + "format": "int32" + }, + "expiresAt": { + "type": "string", + "description": "Expiration time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "status", + "operations", + "expiresAt" + ], + "example": { + "$id": "259125845563242502", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "status": "pending", + "operations": 5, + "expiresAt": "2020-10-15T06:38:00.000+00:00" + } + }, + "subscriber": { + "description": "Subscriber", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Subscriber ID.", + "x-example": "259125845563242502" + }, + "$createdAt": { + "type": "string", + "description": "Subscriber creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Subscriber update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "countryCode": { + "targetId": { "type": "string", - "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "description": "Target ID.", + "x-example": "259125845563242502" }, - "countryName": { + "target": { + "type": "object", + "description": "Target.", + "x-example": { + "$id": "259125845563242502", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "providerType": "email", + "providerId": "259125845563242502", + "name": "ageon-app-email", + "identifier": "random-mail@email.org", + "userId": "5e5ea5c16897e" + }, + "items": { + "$ref": "#\/components\/schemas\/target" + } + }, + "userId": { "type": "string", - "description": "Country name.", - "x-example": "United States" - } - }, - "required": [ - "code", - "countryCode", - "countryName" - ], - "example": { - "code": "+1", - "countryCode": "US", - "countryName": "United States" - } - }, - "headers": { - "description": "Headers", - "type": "object", - "properties": { - "name": { + "description": "Topic ID.", + "x-example": "5e5ea5c16897e" + }, + "userName": { "type": "string", - "description": "Header name.", - "x-example": "Content-Type" + "description": "User Name.", + "x-example": "Aegon Targaryen" }, - "value": { + "topicId": { "type": "string", - "description": "Header value.", - "x-example": "application\/json" + "description": "Topic ID.", + "x-example": "259125845563242502" + }, + "providerType": { + "type": "string", + "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", + "x-example": "email" } }, "required": [ - "name", - "value" + "$id", + "$createdAt", + "$updatedAt", + "targetId", + "target", + "userId", + "userName", + "topicId", + "providerType" ], "example": { - "name": "Content-Type", - "value": "application\/json" + "$id": "259125845563242502", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "targetId": "259125845563242502", + "target": { + "$id": "259125845563242502", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "providerType": "email", + "providerId": "259125845563242502", + "name": "ageon-app-email", + "identifier": "random-mail@email.org", + "userId": "5e5ea5c16897e" + }, + "userId": "5e5ea5c16897e", + "userName": "Aegon Targaryen", + "topicId": "259125845563242502", + "providerType": "email" } }, - "mfaChallenge": { - "description": "MFA Challenge", + "target": { + "description": "Target", "type": "object", "properties": { "$id": { "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "description": "Target ID.", + "x-example": "259125845563242502" }, "$createdAt": { "type": "string", - "description": "Token creation date in ISO 8601 format.", + "description": "Target creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Target update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, + "name": { + "type": "string", + "description": "Target Name.", + "x-example": "Apple iPhone 12" + }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "x-example": "259125845563242502" }, - "expire": { + "providerId": { "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Provider ID.", + "x-example": "259125845563242502", + "nullable": true + }, + "providerType": { + "type": "string", + "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", + "x-example": "email" + }, + "identifier": { + "type": "string", + "description": "The target identifier.", + "x-example": "token" + }, + "expired": { + "type": "boolean", + "description": "Is the target expired.", + "x-example": false } }, "required": [ "$id", "$createdAt", + "$updatedAt", + "name", "userId", - "expire" + "providerType", + "identifier", + "expired" ], "example": { - "$id": "bb8ea5c16897e", + "$id": "259125845563242502", "$createdAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5ea5c168bb8", - "expire": "2020-10-15T06:38:00.000+00:00" + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "Apple iPhone 12", + "userId": "259125845563242502", + "providerId": "259125845563242502", + "providerType": "email", + "identifier": "token", + "expired": false } }, - "mfaRecoveryCodes": { - "description": "MFA Recovery Codes", + "app": { + "description": "App", "type": "object", "properties": { - "recoveryCodes": { + "$id": { + "type": "string", + "description": "App ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "App creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "App update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "My Application" + }, + "redirectUris": { "type": "array", - "description": "Recovery codes.", + "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", "items": { "type": "string" }, "x-example": [ - "a3kf0-s0cl2", - "s0co1-as98s" + "https:\/\/example.com\/callback" ] - } - }, - "required": [ - "recoveryCodes" - ], - "example": { - "recoveryCodes": [ - "a3kf0-s0cl2", - "s0co1-as98s" - ] - } - }, - "mfaType": { - "description": "MFAType", - "type": "object", - "properties": { - "secret": { - "type": "string", - "description": "Secret token used for TOTP factor.", - "x-example": "[SHARED_SECRET]" }, - "uri": { - "type": "string", - "description": "URI for authenticator apps.", - "x-example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" - } - }, - "required": [ - "secret", - "uri" - ], - "example": { - "secret": "[SHARED_SECRET]", - "uri": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" - } - }, - "mfaFactors": { - "description": "MFAFactors", - "type": "object", - "properties": { - "totp": { + "enabled": { "type": "boolean", - "description": "Can TOTP be used for MFA challenge for this account.", + "description": "Whether the app is enabled or not.", "x-example": true }, - "phone": { - "type": "boolean", - "description": "Can phone (SMS) be used for MFA challenge for this account.", - "x-example": true + "type": { + "type": "string", + "description": "OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot keep a client secret (PKCE required); `confidential` for server-side clients that authenticate with a client secret.", + "x-example": "confidential" }, - "email": { + "deviceFlow": { "type": "boolean", - "description": "Can email be used for MFA challenge for this account.", - "x-example": true + "description": "Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).", + "x-example": false }, - "recoveryCode": { - "type": "boolean", - "description": "Can recovery code be used for MFA challenge for this account.", - "x-example": true + "teamId": { + "type": "string", + "description": "ID of team that owns the application, if owned by team. Otherwise, user ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "userId": { + "type": "string", + "description": "ID of user who owns the application, if owned by user. Otherwise, team ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "secrets": { + "type": "array", + "description": "List of application secrets.", + "items": { + "$ref": "#\/components\/schemas\/appSecret" + }, + "x-example": [] } }, "required": [ - "totp", - "phone", - "email", - "recoveryCode" + "$id", + "$createdAt", + "$updatedAt", + "name", + "redirectUris", + "enabled", + "type", + "deviceFlow", + "teamId", + "userId", + "secrets" ], "example": { - "totp": true, - "phone": true, - "email": true, - "recoveryCode": true + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Application", + "redirectUris": [ + "https:\/\/example.com\/callback" + ], + "enabled": true, + "type": "confidential", + "deviceFlow": false, + "teamId": "5e5ea5c16897e", + "userId": "5e5ea5c16897e", + "secrets": [] } }, - "transaction": { - "description": "Transaction", + "appSecret": { + "description": "AppSecret", "type": "object", "properties": { "$id": { "type": "string", - "description": "Transaction ID.", - "x-example": "259125845563242502" + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Transaction creation time in ISO 8601 format.", + "description": "Secret creation time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Transaction update date in ISO 8601 format.", + "description": "Secret update time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "appId": { "type": "string", - "description": "Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.", - "x-example": "pending" + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" }, - "operations": { - "type": "integer", - "description": "Number of operations in the transaction.", - "x-example": 5, - "format": "int32" + "secret": { + "type": "string", + "description": "Hashed application client secret.", + "x-example": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg" }, - "expiresAt": { + "hint": { "type": "string", - "description": "Expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" + }, + "createdById": { + "type": "string", + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" + }, + "createdByName": { + "type": "string", + "description": "Name of the user who created the secret.", + "x-example": "Walter White" + }, + "lastAccessedAt": { + "type": "string", + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true } }, "required": [ "$id", "$createdAt", "$updatedAt", - "status", - "operations", - "expiresAt" + "appId", + "secret", + "hint", + "createdById", + "createdByName" ], "example": { - "$id": "259125845563242502", + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "status": "pending", - "operations": 5, - "expiresAt": "2020-10-15T06:38:00.000+00:00" + "appId": "5e5ea5c16897e", + "secret": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" } }, - "subscriber": { - "description": "Subscriber", + "appSecretPlaintext": { + "description": "AppSecretPlaintext", "type": "object", "properties": { "$id": { "type": "string", - "description": "Subscriber ID.", - "x-example": "259125845563242502" + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Subscriber creation time in ISO 8601 format.", + "description": "Secret creation time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Subscriber update date in ISO 8601 format.", + "description": "Secret update time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "targetId": { + "appId": { "type": "string", - "description": "Target ID.", - "x-example": "259125845563242502" + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" }, - "target": { - "type": "object", - "description": "Target.", - "x-example": { - "$id": "259125845563242502", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "providerType": "email", - "providerId": "259125845563242502", - "name": "ageon-app-email", - "identifier": "random-mail@email.org", - "userId": "5e5ea5c16897e" - }, - "items": { - "$ref": "#\/components\/schemas\/target" - } + "secret": { + "type": "string", + "description": "Application client secret. Returned in full only when the secret is created; subsequent reads return a masked value.", + "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" }, - "userId": { + "hint": { "type": "string", - "description": "Topic ID.", - "x-example": "5e5ea5c16897e" + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" }, - "userName": { + "createdById": { "type": "string", - "description": "User Name.", - "x-example": "Aegon Targaryen" + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" }, - "topicId": { + "createdByName": { "type": "string", - "description": "Topic ID.", - "x-example": "259125845563242502" + "description": "Name of the user who created the secret.", + "x-example": "Walter White" }, - "providerType": { + "lastAccessedAt": { "type": "string", - "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email" + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true } }, "required": [ "$id", "$createdAt", "$updatedAt", - "targetId", - "target", - "userId", - "userName", - "topicId", - "providerType" + "appId", + "secret", + "hint", + "createdById", + "createdByName" ], "example": { - "$id": "259125845563242502", + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "targetId": "259125845563242502", - "target": { - "$id": "259125845563242502", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "providerType": "email", - "providerId": "259125845563242502", - "name": "ageon-app-email", - "identifier": "random-mail@email.org", - "userId": "5e5ea5c16897e" + "appId": "5e5ea5c16897e", + "secret": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, + "oauth2Authorize": { + "description": "OAuth2 Authorize", + "type": "object", + "properties": { + "grantId": { + "type": "string", + "description": "OAuth2 grant ID. Set when the user must give explicit consent; pass it to the approve or reject endpoint. Empty when a redirect URL is returned instead.", + "x-example": "5e5ea5c16897e" }, - "userId": "5e5ea5c16897e", - "userName": "Aegon Targaryen", - "topicId": "259125845563242502", - "providerType": "email" + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to when the flow can complete without consent. Empty when consent is still required.", + "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "required": [ + "grantId", + "redirectUrl" + ], + "example": { + "grantId": "5e5ea5c16897e", + "redirectUrl": "https:\/\/example.com\/callback?code=abcde&state=fghij" } }, - "target": { - "description": "Target", + "oauth2Approve": { + "description": "OAuth2 Approve", + "type": "object", + "properties": { + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to after the grant is approved, carrying the authorization `code` and\/or `id_token` along with the original `state`.", + "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "required": [ + "redirectUrl" + ], + "example": { + "redirectUrl": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "oauth2Reject": { + "description": "OAuth2 Reject", + "type": "object", + "properties": { + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to after the grant is rejected, carrying an `access_denied` error.", + "x-example": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + } + }, + "required": [ + "redirectUrl" + ], + "example": { + "redirectUrl": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + } + }, + "oauth2Grant": { + "description": "OAuth2 Grant", "type": "object", "properties": { "$id": { "type": "string", - "description": "Target ID.", - "x-example": "259125845563242502" + "description": "Grant ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Target creation time in ISO 8601 format.", + "description": "Grant creation time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Target update date in ISO 8601 format.", + "description": "Grant update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "name": { + "userId": { "type": "string", - "description": "Target Name.", - "x-example": "Apple iPhone 12" + "description": "ID of the user the grant belongs to.", + "x-example": "5e5ea5c16897e" }, - "userId": { + "appId": { "type": "string", - "description": "User ID.", - "x-example": "259125845563242502" + "description": "ID of the OAuth2 client (app) the grant was requested for.", + "x-example": "5e5ea5c16897e" }, - "providerId": { + "scopes": { + "type": "array", + "description": "Requested OAuth2 scopes the user is being asked to consent to.", + "items": { + "type": "string" + }, + "x-example": [ + "openid", + "email", + "profile" + ] + }, + "authorizationDetails": { "type": "string", - "description": "Provider ID.", - "x-example": "259125845563242502", - "nullable": true + "description": "Requested authorization_details the user is being asked to consent to, as a JSON string. Each entry has a `type` plus project-defined fields.", + "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" }, - "providerType": { + "prompt": { "type": "string", - "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email" + "description": "OIDC prompt directive the consent screen should honor. Space-separated list of: login, consent, select_account.", + "x-example": "login" }, - "identifier": { + "redirectUri": { "type": "string", - "description": "The target identifier.", - "x-example": "token" + "description": "Redirect URI the user will be sent to after the flow completes.", + "x-example": "https:\/\/example.com\/callback" }, - "expired": { - "type": "boolean", - "description": "Is the target expired.", - "x-example": false + "authTime": { + "type": "integer", + "description": "Unix timestamp of when the user last authenticated.", + "x-example": 1592981250, + "format": "int32" + }, + "expire": { + "type": "string", + "description": "Grant expiration time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "name", "userId", - "providerType", - "identifier", - "expired" + "appId", + "scopes", + "authorizationDetails", + "prompt", + "redirectUri", + "authTime", + "expire" ], "example": { - "$id": "259125845563242502", + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "Apple iPhone 12", - "userId": "259125845563242502", - "providerId": "259125845563242502", - "providerType": "email", - "identifier": "token", - "expired": false + "userId": "5e5ea5c16897e", + "appId": "5e5ea5c16897e", + "scopes": [ + "openid", + "email", + "profile" + ], + "authorizationDetails": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]", + "prompt": "login", + "redirectUri": "https:\/\/example.com\/callback", + "authTime": 1592981250, + "expire": "2020-10-15T06:38:00.000+00:00" + } + }, + "appsList": { + "description": "Apps list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of apps that matched your query.", + "x-example": 5, + "format": "int32" + }, + "apps": { + "type": "array", + "description": "List of apps.", + "items": { + "$ref": "#\/components\/schemas\/app" + }, + "x-example": "" + } + }, + "required": [ + "total", + "apps" + ], + "example": { + "total": 5, + "apps": "" + } + }, + "appSecretList": { + "description": "App secrets list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of secrets that matched your query.", + "x-example": 5, + "format": "int32" + }, + "secrets": { + "type": "array", + "description": "List of secrets.", + "items": { + "$ref": "#\/components\/schemas\/appSecret" + }, + "x-example": "" + } + }, + "required": [ + "total", + "secrets" + ], + "example": { + "total": 5, + "secrets": "" } } }, @@ -17570,6 +19495,15 @@ "demo": "<YOUR_PROJECT_ID>" } }, + "ProjectQuery": { + "type": "apiKey", + "name": "project", + "description": "Your project ID", + "in": "query", + "x-appwrite": { + "demo": "<YOUR_PROJECT_ID>" + } + }, "JWT": { "type": "apiKey", "name": "X-Appwrite-JWT", diff --git a/specs/1.9.x/open-api3-1.9.x-console.json b/specs/1.9.x/open-api3-1.9.x-console.json index 4de6f49e5..d95039efa 100644 --- a/specs/1.9.x/open-api3-1.9.x-console.json +++ b/specs/1.9.x/open-api3-1.9.x-console.json @@ -141,7 +141,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -152,7 +155,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "name": { "type": "string", @@ -2673,11 +2677,12 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "oldPassword": { "type": "string", - "description": "Current user password. Must be at least 8 chars.", + "description": "Current user password. Max length: 256 chars.", "default": "", "x-example": "password", "format": "password" @@ -3502,7 +3507,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" } }, "required": [ @@ -3805,7 +3811,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -4026,7 +4035,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -4103,7 +4115,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -4411,7 +4426,10 @@ "targetId": { "type": "string", "description": "Target 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.", - "x-example": "<TARGET_ID>" + "x-example": "<TARGET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "identifier": { "type": "string", @@ -4631,7 +4649,10 @@ "userId": { "type": "string", "description": "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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -4718,7 +4739,10 @@ "userId": { "type": "string", "description": "Unique 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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -4952,7 +4976,10 @@ "userId": { "type": "string", "description": "Unique 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. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "phone": { "type": "string", @@ -5480,6 +5507,862 @@ ] } }, + "\/apps": { + "get": { + "summary": "List Applications", + "operationId": "appsList", + "tags": [ + "apps" + ], + "description": "List applications.", + "responses": { + "200": { + "description": "Apps list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appsList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create Application", + "operationId": "appsCreate", + "tags": [ + "apps" + ], + "description": "Create a new application.", + "responses": { + "201": { + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "appId": { + "type": "string", + "description": "Application 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.", + "x-example": "<APP_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + }, + "teamId": { + "type": "string", + "description": "Team unique ID.", + "default": "", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "appId", + "name", + "redirectUris" + ] + } + } + } + } + } + }, + "\/apps\/{appId}": { + "get": { + "summary": "Get Application", + "operationId": "appsGet", + "tags": [ + "apps" + ], + "description": "Get an application by its unique ID.", + "responses": { + "200": { + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update Application", + "operationId": "appsUpdate", + "tags": [ + "apps" + ], + "description": "Update an application by its unique ID.", + "responses": { + "200": { + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete Application", + "operationId": "appsDelete", + "tags": [ + "apps" + ], + "description": "Delete an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/secrets": { + "get": { + "summary": "List Secrets", + "operationId": "appsListSecrets", + "tags": [ + "apps" + ], + "description": "List client secrets for an application.", + "responses": { + "200": { + "description": "App secrets list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appSecretList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listSecrets", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/list-secrets.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create Secret", + "operationId": "appsCreateSecret", + "tags": [ + "apps" + ], + "description": "Create a new client secret for an application.", + "responses": { + "201": { + "description": "AppSecretPlaintext", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appSecretPlaintext" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/create-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/secrets\/{secretId}": { + "get": { + "summary": "Get Secret", + "operationId": "appsGetSecret", + "tags": [ + "apps" + ], + "description": "Get an application client secret by its unique ID.", + "responses": { + "200": { + "description": "AppSecret", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appSecret" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/get-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<SECRET_ID>" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete Secret", + "operationId": "appsDeleteSecret", + "tags": [ + "apps" + ], + "description": "Delete an application client secret by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<SECRET_ID>" + }, + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/team": { + "patch": { + "summary": "Update Team", + "operationId": "appsUpdateTeam", + "tags": [ + "apps" + ], + "description": "Transfer an application to another team by its unique ID.", + "responses": { + "200": { + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTeam", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update-team.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team ID of the team to transfer application to.", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "teamId" + ] + } + } + } + } + } + }, + "\/apps\/{appId}\/tokens": { + "delete": { + "summary": "Delete Tokens", + "operationId": "appsDeleteTokens", + "tags": [ + "apps" + ], + "description": "Revoke all tokens for an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTokens", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-tokens.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ] + } + }, "\/avatars\/browsers\/{code}": { "get": { "summary": "Get browser icon", @@ -5514,7 +6397,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -5522,7 +6406,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5642,7 +6527,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -5650,7 +6536,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5776,7 +6663,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -5784,7 +6672,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5836,7 +6725,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -5844,7 +6734,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6326,7 +7217,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -6334,7 +7226,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6410,7 +7303,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -6418,7 +7312,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6504,7 +7399,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -6512,7 +7408,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6598,7 +7495,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-screenshot.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -6606,7 +7504,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -7563,6 +8462,9 @@ "required": true, "schema": { "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<ARCHIVE_ID>" }, "in": "path" @@ -7696,7 +8598,10 @@ "policyId": { "type": "string", "description": "Policy 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.", - "x-example": "<POLICY_ID>" + "x-example": "<POLICY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -7970,6 +8875,9 @@ "required": true, "schema": { "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<POLICY_ID>" }, "in": "path" @@ -8058,7 +8966,10 @@ "type": "string", "description": "Unique 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.", "default": "", - "x-example": "<NEW_RESOURCE_ID>" + "x-example": "<NEW_RESOURCE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "newResourceName": { "type": "string", @@ -8318,7 +9229,10 @@ "databaseId": { "type": "string", "description": "Database 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -8525,6 +9439,53 @@ } } }, + "\/compute\/databases\/specifications": { + "get": { + "summary": "List dedicated database specifications.", + "operationId": "computeListDatabaseSpecifications", + "tags": [ + "compute" + ], + "description": "List the dedicated database specifications available on the current plan. Each specification reports its resource limits, pricing, and whether it is enabled for the organization.", + "responses": { + "200": { + "description": "SpecificationList", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/dedicatedDatabaseSpecificationList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listDatabaseSpecifications", + "group": "databases", + "cookies": false, + "type": "", + "demo": "compute\/list-database-specifications.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ] + } + }, "\/compute\/databases\/{databaseId}": { "get": { "summary": "Get dedicated database.", @@ -9192,7 +10153,10 @@ "policyId": { "type": "string", "description": "Policy 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.", - "x-example": "<POLICY_ID>" + "x-example": "<POLICY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -9602,7 +10566,10 @@ "type": "string", "description": "Branch 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.", "default": "", - "x-example": "<BRANCH_ID>" + "x-example": "<BRANCH_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "ttl": { "type": "integer", @@ -10013,7 +10980,7 @@ "tags": [ "compute" ], - "description": "Execute SQL through the console-facing Cloud endpoint. Cloud proxies through the edge platform to the per-database SQL API sidecar. Application traffic should bypass cloud entirely and POST directly to the per-database hostname: `https:\/\/db-{project}-{db}.{region}.appwrite.network\/v1\/sql\/execute` with an `X-Appwrite-Key` header \u2014 that path scales to the whole DB fleet without a per-query cloud round-trip. The statement type must be on the database's configured allow-list. Use bound parameters for any user-supplied values \u2014 the API does not interpolate raw strings.", + "description": "Execute SQL through the console-facing Cloud endpoint. Cloud proxies through the edge platform to the per-database SQL API sidecar. Application traffic should bypass cloud entirely and POST directly to the per-database hostname: `https:\/\/db-{project}-{db}.{region}.appwrite.center\/v1\/sql\/execute` with an `X-Appwrite-Key` header \u2014 that path scales to the whole DB fleet without a per-query cloud round-trip. The statement type must be on the database's configured allow-list. Use bound parameters for any user-supplied values \u2014 the API does not interpolate raw strings.", "responses": { "200": { "description": "Execution", @@ -10520,87 +11487,6 @@ } } }, - "\/compute\/databases\/{databaseId}\/insights": { - "get": { - "summary": "Get database performance insights.", - "operationId": "computeGetDatabaseInsights", - "tags": [ - "compute" - ], - "description": "Get query-level performance insights for a dedicated database. Returns top queries by execution time, wait events, and aggregate query statistics.", - "responses": { - "200": { - "description": "PerformanceInsights", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/dedicatedDatabasePerformanceInsights" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getDatabaseInsights", - "group": "databases", - "cookies": false, - "type": "", - "demo": "compute\/get-database-insights.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DATABASE_ID>" - }, - "in": "path" - }, - { - "name": "period", - "description": "Analysis period for performance insights. Allowed values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days).", - "required": false, - "schema": { - "type": "string", - "x-example": "1h", - "default": "1h" - }, - "in": "query" - }, - { - "name": "limit", - "description": "Maximum number of queries to return.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 25 - }, - "in": "query" - } - ] - } - }, "\/compute\/databases\/{databaseId}\/maintenance": { "patch": { "summary": "Update database maintenance window.", @@ -10686,76 +11572,6 @@ } } }, - "\/compute\/databases\/{databaseId}\/metrics": { - "get": { - "summary": "Get database metrics.", - "operationId": "computeGetDatabaseMetrics", - "tags": [ - "compute" - ], - "description": "Get detailed performance metrics for a dedicated database. Returns CPU, memory, storage, IOPS, QPS, and connection metrics.", - "responses": { - "200": { - "description": "DatabaseMetrics", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/dedicatedDatabaseMetrics" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getDatabaseMetrics", - "group": "databases", - "cookies": false, - "type": "", - "demo": "compute\/get-database-metrics.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<DATABASE_ID>" - }, - "in": "path" - }, - { - "name": "period", - "description": "Metrics aggregation period. Allowed values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days), 30d (last 30 days).", - "required": false, - "schema": { - "type": "string", - "x-example": "1h", - "default": "24h" - }, - "in": "query" - } - ] - } - }, "\/compute\/databases\/{databaseId}\/migrations": { "post": { "summary": "Migrate database between shared and dedicated.", @@ -10763,7 +11579,7 @@ "tags": [ "compute" ], - "description": "Migrate a database between shared and dedicated types. Shared to dedicated creates an always-on StatefulSet with external access. Dedicated to shared converts to a serverless pod that scales to zero when idle. Data is preserved during migration.", + "description": "Migrate a database between shared and dedicated types. Shared to dedicated provisions an always-on dedicated instance; dedicated to shared converts to a serverless instance that scales to zero when idle. Data is copied to the target with a brief read-only window during cutover.", "responses": { "200": { "description": "DedicatedDatabase", @@ -10823,6 +11639,12 @@ "type": "string", "description": "Target database type to migrate to. Allowed values: shared (serverless, scales to zero when idle), dedicated (always-on with persistent resources).", "x-example": "shared" + }, + "specification": { + "type": "string", + "description": "Target compute specification to provision when migrating to dedicated. Ignored for shared. Defaults to the database's current specification.", + "x-example": "<SPECIFICATION>", + "x-nullable": true } }, "required": [ @@ -12780,6 +13602,9 @@ "threats", "feedbacks", "sh_installations", + "apps", + "appsecrets", + "oauth2grants", "attributes", "indexes", "functions", @@ -12864,6 +13689,9 @@ "threats", "feedbacks", "sh_installations", + "apps", + "app_secrets", + "oauth2_grants", "attributes", "indexes", "functions", @@ -13390,7 +14218,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -14421,7 +15252,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -19684,7 +20518,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -20295,6 +21132,9 @@ "required": true, "schema": { "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<DOCUMENT_ID>" }, "in": "path" @@ -21845,7 +22685,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -21857,6 +22700,12 @@ "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "specification": { + "type": "string", + "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", + "default": "free", + "x-example": "<SPECIFICATION>" } }, "required": [ @@ -22677,7 +23526,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -23247,7 +24099,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -29350,7 +30205,10 @@ "functionId": { "type": "string", "description": "Function 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.", - "x-example": "<FUNCTION_ID>" + "x-example": "<FUNCTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -29457,7 +30315,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "FunctionRuntime" + "x-enum-name": "Runtime" }, "execute": { "type": "array", @@ -29612,9 +30470,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes" @@ -29947,7 +30808,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "FunctionRuntime" + "x-enum-name": "Runtime" }, "default": [] }, @@ -30373,7 +31234,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "FunctionRuntime" + "x-enum-name": "Runtime" }, "execute": { "type": "array", @@ -30528,9 +31389,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes" @@ -31402,14 +32266,16 @@ "packaging": false, "public": true, "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -31625,7 +32491,7 @@ "201": { "description": "Execution", "content": { - "multipart\/form-data": { + "application\/json": { "schema": { "$ref": "#\/components\/schemas\/execution" } @@ -32113,7 +32979,10 @@ "variableId": { "type": "string", "description": "Variable 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -32582,6 +33451,56 @@ ] } }, + "\/health\/audits-db": { + "get": { + "summary": "Get audits DB", + "operationId": "healthGetAuditsDB", + "tags": [ + "health" + ], + "description": "Check the database that backs the audit and activity store. When the connection is reachable the endpoint returns a passing status with its response time.\n", + "responses": { + "200": { + "description": "Status List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/healthStatusList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getAuditsDB", + "group": null, + "cookies": false, + "type": "", + "demo": "health\/get-audits-db.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "health.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/health\/get-audits-db.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, "\/health\/cache": { "get": { "summary": "Get cache", @@ -35237,7 +36156,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "subject": { "type": "string", @@ -35549,7 +36471,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "title": { "type": "string", @@ -36009,7 +36934,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "content": { "type": "string", @@ -36757,7 +37685,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -37117,7 +38048,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -37357,7 +38291,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -37610,7 +38547,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -37812,7 +38752,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -37946,240 +38889,499 @@ "x-example": false, "x-nullable": true }, - "apiKey": { - "type": "string", - "description": "Resend API key.", - "default": "", - "x-example": "<API_KEY>" - }, - "fromName": { - "type": "string", - "description": "Sender Name.", - "default": "", - "x-example": "<FROM_NAME>" - }, - "fromEmail": { - "type": "string", - "description": "Sender email address.", - "default": "", - "x-example": "email@example.com", - "format": "email" - }, - "replyToName": { - "type": "string", - "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", - "default": "", - "x-example": "<REPLY_TO_NAME>" - }, - "replyToEmail": { - "type": "string", - "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", - "default": "", - "x-example": "<REPLY_TO_EMAIL>" - } - } - } - } - } - } - } - }, - "\/messaging\/providers\/sendgrid": { - "post": { - "summary": "Create Sendgrid provider", - "operationId": "messagingCreateSendgridProvider", - "tags": [ - "messaging" - ], - "description": "Create a new Sendgrid provider.", - "responses": { - "201": { - "description": "Provider", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/provider" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createSendgridProvider", - "group": "providers", - "cookies": false, - "type": "", - "demo": "messaging\/create-sendgrid-provider.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "providers.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "providerId": { - "type": "string", - "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" - }, - "name": { - "type": "string", - "description": "Provider name.", - "x-example": "<NAME>" - }, - "apiKey": { - "type": "string", - "description": "Sendgrid API key.", - "default": "", - "x-example": "<API_KEY>" - }, - "fromName": { - "type": "string", - "description": "Sender Name.", - "default": "", - "x-example": "<FROM_NAME>" - }, - "fromEmail": { - "type": "string", - "description": "Sender email address.", - "default": "", - "x-example": "email@example.com", - "format": "email" - }, - "replyToName": { - "type": "string", - "description": "Name set in the reply to field for the mail. Default value is sender name.", - "default": "", - "x-example": "<REPLY_TO_NAME>" - }, - "replyToEmail": { + "apiKey": { + "type": "string", + "description": "Resend API key.", + "default": "", + "x-example": "<API_KEY>" + }, + "fromName": { + "type": "string", + "description": "Sender Name.", + "default": "", + "x-example": "<FROM_NAME>" + }, + "fromEmail": { + "type": "string", + "description": "Sender email address.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "replyToName": { + "type": "string", + "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", + "default": "", + "x-example": "<REPLY_TO_NAME>" + }, + "replyToEmail": { + "type": "string", + "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", + "default": "", + "x-example": "<REPLY_TO_EMAIL>" + } + } + } + } + } + } + } + }, + "\/messaging\/providers\/sendgrid": { + "post": { + "summary": "Create Sendgrid provider", + "operationId": "messagingCreateSendgridProvider", + "tags": [ + "messaging" + ], + "description": "Create a new Sendgrid provider.", + "responses": { + "201": { + "description": "Provider", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/provider" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSendgridProvider", + "group": "providers", + "cookies": false, + "type": "", + "demo": "messaging\/create-sendgrid-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "providers.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "providerId": { + "type": "string", + "description": "Provider 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.", + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Provider name.", + "x-example": "<NAME>" + }, + "apiKey": { + "type": "string", + "description": "Sendgrid API key.", + "default": "", + "x-example": "<API_KEY>" + }, + "fromName": { + "type": "string", + "description": "Sender Name.", + "default": "", + "x-example": "<FROM_NAME>" + }, + "fromEmail": { + "type": "string", + "description": "Sender email address.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "replyToName": { + "type": "string", + "description": "Name set in the reply to field for the mail. Default value is sender name.", + "default": "", + "x-example": "<REPLY_TO_NAME>" + }, + "replyToEmail": { + "type": "string", + "description": "Email set in the reply to field for the mail. Default value is sender email.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "enabled": { + "type": "boolean", + "description": "Set as enabled.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "providerId", + "name" + ] + } + } + } + } + } + }, + "\/messaging\/providers\/sendgrid\/{providerId}": { + "patch": { + "summary": "Update Sendgrid provider", + "operationId": "messagingUpdateSendgridProvider", + "tags": [ + "messaging" + ], + "description": "Update a Sendgrid provider by its unique ID.", + "responses": { + "200": { + "description": "Provider", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/provider" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSendgridProvider", + "group": "providers", + "cookies": false, + "type": "", + "demo": "messaging\/update-sendgrid-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "providers.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "providerId", + "description": "Provider ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROVIDER_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Provider name.", + "default": "", + "x-example": "<NAME>" + }, + "enabled": { + "type": "boolean", + "description": "Set as enabled.", + "x-example": false, + "x-nullable": true + }, + "apiKey": { + "type": "string", + "description": "Sendgrid API key.", + "default": "", + "x-example": "<API_KEY>" + }, + "fromName": { + "type": "string", + "description": "Sender Name.", + "default": "", + "x-example": "<FROM_NAME>" + }, + "fromEmail": { + "type": "string", + "description": "Sender email address.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "replyToName": { + "type": "string", + "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", + "default": "", + "x-example": "<REPLY_TO_NAME>" + }, + "replyToEmail": { + "type": "string", + "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", + "default": "", + "x-example": "<REPLY_TO_EMAIL>" + } + } + } + } + } + } + } + }, + "\/messaging\/providers\/ses": { + "post": { + "summary": "Create Amazon SES provider", + "operationId": "messagingCreateSesProvider", + "tags": [ + "messaging" + ], + "description": "Create a new Amazon SES provider.", + "responses": { + "201": { + "description": "Provider", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/provider" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSesProvider", + "group": "providers", + "cookies": false, + "type": "", + "demo": "messaging\/create-ses-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "providers.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-ses-provider.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "providerId": { + "type": "string", + "description": "Provider 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.", + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Provider name.", + "x-example": "<NAME>" + }, + "accessKey": { + "type": "string", + "description": "AWS access key ID.", + "default": "", + "x-example": "<ACCESS_KEY>" + }, + "secretKey": { + "type": "string", + "description": "AWS secret access key.", + "default": "", + "x-example": "<SECRET_KEY>" + }, + "region": { + "type": "string", + "description": "AWS region, for example us-east-1.", + "default": "", + "x-example": "<REGION>" + }, + "fromName": { + "type": "string", + "description": "Sender Name.", + "default": "", + "x-example": "<FROM_NAME>" + }, + "fromEmail": { + "type": "string", + "description": "Sender email address.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "replyToName": { + "type": "string", + "description": "Name set in the reply to field for the mail. Default value is sender name.", + "default": "", + "x-example": "<REPLY_TO_NAME>" + }, + "replyToEmail": { + "type": "string", + "description": "Email set in the reply to field for the mail. Default value is sender email.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "enabled": { + "type": "boolean", + "description": "Set as enabled.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "providerId", + "name" + ] + } + } + } + } + } + }, + "\/messaging\/providers\/ses\/{providerId}": { + "patch": { + "summary": "Update Amazon SES provider", + "operationId": "messagingUpdateSesProvider", + "tags": [ + "messaging" + ], + "description": "Update an Amazon SES provider by its unique ID.", + "responses": { + "200": { + "description": "Provider", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/provider" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSesProvider", + "group": "providers", + "cookies": false, + "type": "", + "demo": "messaging\/update-ses-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "providers.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-ses-provider.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "providerId", + "description": "Provider ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROVIDER_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Provider name.", + "default": "", + "x-example": "<NAME>" + }, + "enabled": { + "type": "boolean", + "description": "Set as enabled.", + "x-example": false, + "x-nullable": true + }, + "accessKey": { "type": "string", - "description": "Email set in the reply to field for the mail. Default value is sender email.", + "description": "AWS access key ID.", "default": "", - "x-example": "email@example.com", - "format": "email" + "x-example": "<ACCESS_KEY>" }, - "enabled": { - "type": "boolean", - "description": "Set as enabled.", - "x-example": false, - "x-nullable": true - } - }, - "required": [ - "providerId", - "name" - ] - } - } - } - } - } - }, - "\/messaging\/providers\/sendgrid\/{providerId}": { - "patch": { - "summary": "Update Sendgrid provider", - "operationId": "messagingUpdateSendgridProvider", - "tags": [ - "messaging" - ], - "description": "Update a Sendgrid provider by its unique ID.", - "responses": { - "200": { - "description": "Provider", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/provider" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateSendgridProvider", - "group": "providers", - "cookies": false, - "type": "", - "demo": "messaging\/update-sendgrid-provider.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "providers.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "providerId", - "description": "Provider ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<PROVIDER_ID>" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { + "secretKey": { "type": "string", - "description": "Provider name.", + "description": "AWS secret access key.", "default": "", - "x-example": "<NAME>" - }, - "enabled": { - "type": "boolean", - "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "x-example": "<SECRET_KEY>" }, - "apiKey": { + "region": { "type": "string", - "description": "Sendgrid API key.", + "description": "AWS region, for example us-east-1.", "default": "", - "x-example": "<API_KEY>" + "x-example": "<REGION>" }, "fromName": { "type": "string", @@ -38356,7 +39558,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -38385,7 +39590,8 @@ "type": "string", "description": "Authentication password.", "default": "", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "encryption": { "type": "string", @@ -38631,7 +39837,8 @@ "type": "string", "description": "Authentication password.", "default": "", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "encryption": { "type": "string", @@ -38751,7 +39958,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -38954,7 +40164,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -39157,7 +40370,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -39360,7 +40576,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -39935,7 +41154,10 @@ "topicId": { "type": "string", "description": "Topic ID. Choose a custom Topic ID or a new Topic ID.", - "x-example": "<TOPIC_ID>" + "x-example": "<TOPIC_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -40419,7 +41641,10 @@ "subscriberId": { "type": "string", "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", - "x-example": "<SUBSCRIBER_ID>" + "x-example": "<SUBSCRIBER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "targetId": { "type": "string", @@ -40723,6 +41948,9 @@ "user", "team", "membership", + "auth-methods", + "policies", + "oauth2-provider", "database", "table", "column", @@ -40746,7 +41974,16 @@ "site-deployment", "site-variable", "platform", - "backup-policy" + "api-key", + "webhook", + "smtp", + "backup-policy", + "project-variable", + "project-protocols", + "project-labels", + "project-services", + "project-email-template", + "rule" ], "x-enum-name": "AppwriteMigrationResource" } @@ -40777,7 +42014,7 @@ "skip", "overwrite" ], - "x-enum-name": "MigrationOnDuplicate" + "x-enum-name": "OnDuplicate" } }, "required": [ @@ -40851,6 +42088,9 @@ "user", "team", "membership", + "auth-methods", + "policies", + "oauth2-provider", "database", "table", "column", @@ -40874,7 +42114,16 @@ "site-deployment", "site-variable", "platform", - "backup-policy" + "api-key", + "webhook", + "smtp", + "backup-policy", + "project-variable", + "project-protocols", + "project-labels", + "project-services", + "project-email-template", + "rule" ], "x-enum-name": "AppwriteMigrationResource" } @@ -41119,7 +42368,7 @@ "skip", "overwrite" ], - "x-enum-name": "MigrationOnDuplicate" + "x-enum-name": "OnDuplicate" } }, "required": [ @@ -41487,7 +42736,7 @@ "skip", "overwrite" ], - "x-enum-name": "MigrationOnDuplicate" + "x-enum-name": "OnDuplicate" } }, "required": [ @@ -41603,7 +42852,8 @@ "password": { "type": "string", "description": "Source's Database Password", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "port": { "type": "integer", @@ -41757,7 +43007,8 @@ "required": true, "schema": { "type": "string", - "x-example": "<PASSWORD>" + "format": "password", + "x-example": "password" }, "in": "query" }, @@ -41873,7 +43124,8 @@ "password": { "type": "string", "description": "Source's Database Password", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "port": { "type": "integer", @@ -42017,7 +43269,8 @@ "required": true, "schema": { "type": "string", - "x-example": "<PASSWORD>" + "format": "password", + "x-example": "password" }, "in": "query" }, @@ -42333,7 +43586,10 @@ "keyId": { "type": "string", "description": "Key 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.", - "x-example": "<KEY_ID>" + "x-example": "<KEY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -43097,7 +44353,10 @@ "organizationId": { "type": "string", "description": "Organization 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.", - "x-example": "<ORGANIZATION_ID>" + "x-example": "<ORGANIZATION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -43714,7 +44973,7 @@ "baa", "backup_recovery" ], - "x-enum-name": "OrganizationAddon" + "x-enum-name": "Addon" }, "in": "path" } @@ -44958,7 +46217,7 @@ "method": "getInvoiceDownload", "group": null, "cookies": false, - "type": "", + "type": "location", "demo": "organizations\/get-invoice-download.md", "rate-limit": 0, "rate-time": 3600, @@ -44971,12 +46230,14 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-invoice-download.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -45187,7 +46448,7 @@ "method": "getInvoiceView", "group": null, "cookies": false, - "type": "", + "type": "location", "demo": "organizations\/get-invoice-view.md", "rate-limit": 0, "rate-time": 3600, @@ -45200,12 +46461,14 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-invoice-view.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -47145,7 +48408,10 @@ "keyId": { "type": "string", "description": "Key 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.", - "x-example": "<KEY_ID>" + "x-example": "<KEY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -47249,9 +48515,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes" @@ -47426,9 +48695,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes" @@ -47677,9 +48949,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes" @@ -48243,6 +49518,160 @@ ] } }, + "\/project\/oauth2-server": { + "put": { + "summary": "Update OAuth2 server", + "operationId": "projectUpdateOAuth2Server", + "tags": [ + "project" + ], + "description": "Update the OAuth2 server (OIDC provider) configuration.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Server", + "group": null, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-server.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable the OAuth2 server.", + "x-example": false + }, + "authorizationUrl": { + "type": "string", + "description": "URL to your application with consent screen.", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "scopes": { + "type": "array", + "description": "List of allowed OAuth2 scopes. Maximum of 100 scopes are allowed, each up to 128 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "authorizationDetailsTypes": { + "type": "array", + "description": "List of accepted `authorization_details` types. Maximum of 100 types are allowed, each up to 128 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "accessTokenDuration": { + "type": "integer", + "description": "Access token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 8 hours.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "refreshTokenDuration": { + "type": "integer", + "description": "Refresh token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 1 year.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "publicAccessTokenDuration": { + "type": "integer", + "description": "Access token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 1 hour.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "publicRefreshTokenDuration": { + "type": "integer", + "description": "Refresh token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 30 days.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "confidentialPkce": { + "type": "boolean", + "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", + "x-example": false, + "x-nullable": true + }, + "verificationUrl": { + "type": "string", + "description": "URL to your application page where users enter the device flow user code. Required to enable the Device Authorization Grant.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "userCodeLength": { + "type": "integer", + "description": "Number of characters in the device flow user code, excluding the formatting separator. Shorter codes are easier to type but weaker; pair short codes with short expiry. Leave empty to use default 8.", + "x-example": 6, + "format": "int32", + "x-nullable": true + }, + "userCodeFormat": { + "type": "string", + "description": "Character set for device flow user codes: `numeric` (digits only \u2014 best for numeric keypads and TV remotes), `alphabetic` (letters only), or `alphanumeric` (letters and digits \u2014 highest entropy per character). Defaults to `alphanumeric`.", + "default": "alphanumeric", + "x-example": "numeric" + }, + "deviceCodeDuration": { + "type": "integer", + "description": "Lifetime in seconds of device flow device codes and user codes. Device codes are intentionally short-lived. Leave empty to use default 600.", + "x-example": 60, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "enabled", + "authorizationUrl" + ] + } + } + } + } + } + }, "\/project\/oauth2\/amazon": { "patch": { "summary": "Update project OAuth2 Amazon", @@ -52035,7 +53464,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -52201,7 +53633,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -52367,7 +53802,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -52533,7 +53971,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -52699,7 +54140,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -53319,6 +54763,11 @@ "type": "boolean", "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", "x-example": false + }, + "userAccessedAt": { + "type": "boolean", + "description": "Set to true if you want make user last access time visible to all team members, or false to hide it.", + "x-example": false } } } @@ -53383,159 +54832,248 @@ "schema": { "type": "object", "properties": { - "enabled": { + "enabled": { + "type": "boolean", + "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/project\/policies\/password-history": { + "patch": { + "summary": "Update password history policy", + "operationId": "projectUpdatePasswordHistoryPolicy", + "tags": [ + "project" + ], + "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePasswordHistoryPolicy", + "group": "policies", + "cookies": false, + "type": "", + "demo": "project\/update-password-history-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", + "x-example": 1, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "total" + ] + } + } + } + } + } + }, + "\/project\/policies\/password-personal-data": { + "patch": { + "summary": "Update password personal data policy", + "operationId": "projectUpdatePasswordPersonalDataPolicy", + "tags": [ + "project" + ], + "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePasswordPersonalDataPolicy", + "group": "policies", + "cookies": false, + "type": "", + "demo": "project\/update-password-personal-data-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/project\/policies\/password-strength": { + "patch": { + "summary": "Update password strength policy", + "operationId": "projectUpdatePasswordStrengthPolicy", + "tags": [ + "project" + ], + "description": "Update the password strength requirements for users in the project.", + "responses": { + "200": { + "description": "Policy Password Strength", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/policyPasswordStrength" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePasswordStrengthPolicy", + "group": "policies", + "cookies": false, + "type": "", + "demo": "project\/update-password-strength-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "description": "Minimum password length. Value must be between 8 and 256. Default is 8.", + "x-example": 8, + "format": "int32" + }, + "uppercase": { "type": "boolean", - "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", + "description": "Whether passwords must include at least one uppercase letter.", "x-example": false - } - }, - "required": [ - "enabled" - ] - } - } - } - } - } - }, - "\/project\/policies\/password-history": { - "patch": { - "summary": "Update password history policy", - "operationId": "projectUpdatePasswordHistoryPolicy", - "tags": [ - "project" - ], - "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", - "responses": { - "200": { - "description": "Project", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/project" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updatePasswordHistoryPolicy", - "group": "policies", - "cookies": false, - "type": "", - "demo": "project\/update-password-history-policy.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "policies.write", - "project.policies.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", - "x-example": 1, - "format": "int32", - "x-nullable": true - } - }, - "required": [ - "total" - ] - } - } - } - } - } - }, - "\/project\/policies\/password-personal-data": { - "patch": { - "summary": "Update password personal data policy", - "operationId": "projectUpdatePasswordPersonalDataPolicy", - "tags": [ - "project" - ], - "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", - "responses": { - "200": { - "description": "Project", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/project" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updatePasswordPersonalDataPolicy", - "group": "policies", - "cookies": false, - "type": "", - "demo": "project\/update-password-personal-data-policy.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "policies.write", - "project.policies.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { + }, + "lowercase": { "type": "boolean", - "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", + "description": "Whether passwords must include at least one lowercase letter.", + "x-example": false + }, + "number": { + "type": "boolean", + "description": "Whether passwords must include at least one number.", + "x-example": false + }, + "symbols": { + "type": "boolean", + "description": "Whether passwords must include at least one symbol.", "x-example": false } - }, - "required": [ - "enabled" - ] + } } } } @@ -53912,7 +55450,7 @@ "description": "Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.", "responses": { "200": { - "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy", + "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Strength, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy, or Policy Deny Aliased Email, or Policy Deny Disposable Email, or Policy Deny Free Email", "content": { "application\/json": { "schema": { @@ -53923,6 +55461,9 @@ { "$ref": "#\/components\/schemas\/policyPasswordHistory" }, + { + "$ref": "#\/components\/schemas\/policyPasswordStrength" + }, { "$ref": "#\/components\/schemas\/policyPasswordPersonalData" }, @@ -53943,6 +55484,15 @@ }, { "$ref": "#\/components\/schemas\/policyMembershipPrivacy" + }, + { + "$ref": "#\/components\/schemas\/policyDenyAliasedEmail" + }, + { + "$ref": "#\/components\/schemas\/policyDenyDisposableEmail" + }, + { + "$ref": "#\/components\/schemas\/policyDenyFreeEmail" } ], "discriminator": { @@ -53950,13 +55500,17 @@ "mapping": { "password-dictionary": "#\/components\/schemas\/policyPasswordDictionary", "password-history": "#\/components\/schemas\/policyPasswordHistory", + "password-strength": "#\/components\/schemas\/policyPasswordStrength", "password-personal-data": "#\/components\/schemas\/policyPasswordPersonalData", "session-alert": "#\/components\/schemas\/policySessionAlert", "session-duration": "#\/components\/schemas\/policySessionDuration", "session-invalidation": "#\/components\/schemas\/policySessionInvalidation", "session-limit": "#\/components\/schemas\/policySessionLimit", "user-limit": "#\/components\/schemas\/policyUserLimit", - "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy" + "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy", + "deny-aliased-email": "#\/components\/schemas\/policyDenyAliasedEmail", + "deny-disposable-email": "#\/components\/schemas\/policyDenyDisposableEmail", + "deny-free-email": "#\/components\/schemas\/policyDenyFreeEmail" } } } @@ -53997,7 +55551,7 @@ "parameters": [ { "name": "policyId", - "description": "Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.", + "description": "Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, deny-aliased-email, deny-disposable-email, deny-free-email.", "required": true, "schema": { "type": "string", @@ -54005,13 +55559,17 @@ "enum": [ "password-dictionary", "password-history", + "password-strength", "password-personal-data", "session-alert", "session-duration", "session-invalidation", "session-limit", "user-limit", - "membership-privacy" + "membership-privacy", + "deny-aliased-email", + "deny-disposable-email", + "deny-free-email" ], "x-enum-name": "ProjectPolicyId" }, @@ -54156,7 +55714,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, documentsDB, tablesDB, vectorsDB, locale, health, project, storage, teams, users, vcs, webhooks, tokens, presences, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "schema": { "type": "string", @@ -54166,6 +55724,9 @@ "avatars", "databases", "tablesdb", + "documentsDB", + "tablesDB", + "vectorsDB", "locale", "health", "project", @@ -54173,6 +55734,9 @@ "teams", "users", "vcs", + "webhooks", + "tokens", + "presences", "sites", "functions", "proxy", @@ -54282,7 +55846,8 @@ "password": { "type": "string", "description": "SMTP server password. Pass an empty string to clear a previously set value. This property is stored securely and cannot be read in future (write-only).", - "x-example": "<PASSWORD>", + "x-example": "password", + "format": "password", "x-nullable": true }, "senderEmail": { @@ -55163,7 +56728,10 @@ "variableId": { "type": "string", "description": "Variable unique 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -56149,7 +57717,7 @@ "enum": [ "active" ], - "x-enum-name": "ProjectStatus" + "x-enum-name": "Status" } }, "required": [ @@ -56465,7 +58033,7 @@ }, "\/proxy\/rules\/redirect": { "post": { - "summary": "Create Redirect rule", + "summary": "Create redirect rule", "operationId": "proxyCreateRedirectRule", "tags": [ "proxy" @@ -56537,7 +58105,7 @@ "307", "308" ], - "x-enum-name": "RedirectStatusCode", + "x-enum-name": "StatusCode", "x-enum-keys": [ "MovedPermanently", "Found", @@ -57321,7 +58889,10 @@ "siteId": { "type": "string", "description": "Site 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.", - "x-example": "<SITE_ID>" + "x-example": "<SITE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -57349,7 +58920,7 @@ "vite", "other" ], - "x-enum-name": "SiteFramework" + "x-enum-name": "Framework" }, "enabled": { "type": "boolean", @@ -57494,7 +59065,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "SiteBuildRuntime" + "x-enum-name": "BuildRuntime" }, "adapter": { "type": "string", @@ -57504,7 +59075,7 @@ "static", "ssr" ], - "x-enum-name": "SiteAdapter" + "x-enum-name": "Adapter" }, "installationId": { "type": "string", @@ -57761,7 +59332,7 @@ "vite", "other" ], - "x-enum-name": "SiteFramework" + "x-enum-name": "Framework" }, "default": [] }, @@ -58099,7 +59670,7 @@ "vite", "other" ], - "x-enum-name": "SiteFramework" + "x-enum-name": "Framework" }, "enabled": { "type": "boolean", @@ -58244,7 +59815,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "SiteBuildRuntime" + "x-enum-name": "BuildRuntime" }, "adapter": { "type": "string", @@ -58254,7 +59825,7 @@ "static", "ssr" ], - "x-enum-name": "SiteAdapter" + "x-enum-name": "Adapter" }, "fallbackFile": { "type": "string", @@ -59130,14 +60701,16 @@ "packaging": false, "public": true, "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -59701,7 +61274,10 @@ "variableId": { "type": "string", "description": "Variable 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -60104,7 +61680,10 @@ "bucketId": { "type": "string", "description": "Unique 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.", - "x-example": "<BUCKET_ID>" + "x-example": "<BUCKET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -60623,7 +62202,10 @@ "type": "string", "description": "File 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.", "x-example": "<FILE_ID>", - "x-upload-id": true + "x-upload-id": true, + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "file": { "type": "string", @@ -60927,7 +62509,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -60935,7 +62518,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -61007,7 +62591,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -61015,7 +62600,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -61234,7 +62820,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -61242,7 +62829,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -61576,7 +63164,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -62518,7 +64109,10 @@ "tableId": { "type": "string", "description": "Unique 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.", - "x-example": "<TABLE_ID>" + "x-example": "<TABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -63544,7 +65138,7 @@ }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { "patch": { - "summary": "Update dateTime column", + "summary": "Update datetime column", "operationId": "tablesDBUpdateDatetimeColumn", "tags": [ "tablesDB" @@ -68333,7 +69927,10 @@ "type": "string", "description": "Row 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.", "default": "", - "x-example": "<ROW_ID>" + "x-example": "<ROW_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -69896,7 +71493,10 @@ "teamId": { "type": "string", "description": "Team 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.", - "x-example": "<TEAM_ID>" + "x-example": "<TEAM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -71582,7 +73182,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -71602,7 +73205,8 @@ "type": "string", "description": "Plain text user password. Must be at least 8 chars.", "default": "", - "x-example": null + "x-example": "password", + "format": "password" }, "name": { "type": "string", @@ -71677,7 +73281,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -71766,7 +73373,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -71997,7 +73607,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -72086,7 +73699,10 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. 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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -72175,7 +73791,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -72298,7 +73917,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -72405,7 +74027,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -74040,7 +75665,8 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": null + "x-example": "password", + "format": "password" } }, "required": [ @@ -74407,6 +76033,9 @@ "required": true, "schema": { "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<USER_ID>" }, "in": "path" @@ -74772,7 +76401,10 @@ "targetId": { "type": "string", "description": "Target 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.", - "x-example": "<TARGET_ID>" + "x-example": "<TARGET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "providerType": { "type": "string", @@ -76268,7 +77900,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -76280,6 +77915,12 @@ "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "specification": { + "type": "string", + "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", + "default": "free", + "x-example": "<SPECIFICATION>" } }, "required": [ @@ -76294,7 +77935,7 @@ }, "\/vectorsdb\/embeddings\/text": { "post": { - "summary": "Create Text Embeddings", + "summary": "Create text embeddings", "operationId": "vectorsDBCreateTextEmbeddings", "tags": [ "vectorsDB" @@ -76385,10 +78026,13 @@ "model": { "type": "string", "description": "The embedding model to use for generating vector embeddings.", - "default": "embeddinggemma", - "x-example": "embeddinggemma", + "default": "nomic-embed-text", + "x-example": "nomic-embed-text", "enum": [ - "embeddinggemma" + "nomic-embed-text", + "embedding-gemma", + "all-minilm", + "bge-small" ], "x-enum-name": "EmbeddingModel" } @@ -77296,7 +78940,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -77854,7 +79501,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -78432,6 +80082,9 @@ "required": true, "schema": { "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<DOCUMENT_ID>" }, "in": "path" @@ -79390,7 +81043,10 @@ "webhookId": { "type": "string", "description": "Webhook 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.", - "x-example": "<WEBHOOK_ID>" + "x-example": "<WEBHOOK_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "url": { "type": "string", @@ -79432,7 +81088,8 @@ "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_PASSWORD>" + "x-example": "password", + "format": "password" }, "secret": { "type": "string", @@ -79617,7 +81274,8 @@ "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_PASSWORD>" + "x-example": "password", + "format": "password" } }, "required": [ @@ -79779,6 +81437,18 @@ "name": "tablesdb", "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" }, + { + "name": "documentsDB", + "description": "The DocumentsDB service allows you to create structured collections of documents, query and filter lists of documents." + }, + { + "name": "tablesDB", + "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows." + }, + { + "name": "vectorsDB", + "description": "The VectorsDB service allows you to create vector collections, embeddings, indexes, and documents." + }, { "name": "locale", "description": "The Locale service allows you to customize your app based on your users' location." @@ -79807,6 +81477,18 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, + { + "name": "webhooks", + "description": "The Webhooks service allows you to configure event-driven HTTP callbacks for your project." + }, + { + "name": "tokens", + "description": "The Tokens service allows you to create and manage resource tokens for project resources." + }, + { + "name": "presences", + "description": "The Presences service allows you to create, query, and manage realtime presence state." + }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -79827,6 +81509,14 @@ "name": "console", "description": "The Console service allows you to interact with console relevant information." }, + { + "name": "assistant", + "description": "The Assistant service allows Console users to ask assistant queries." + }, + { + "name": "organization", + "description": "The Organization service allows you to manage organization-level projects." + }, { "name": "migrations", "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." @@ -81027,7 +82717,7 @@ "total": { "type": "integer", "description": "Total number of policies in the given project.", - "x-example": 9, + "x-example": 10, "format": "int32" }, "policies": { @@ -81041,6 +82731,9 @@ { "$ref": "#\/components\/schemas\/policyPasswordHistory" }, + { + "$ref": "#\/components\/schemas\/policyPasswordStrength" + }, { "$ref": "#\/components\/schemas\/policyPasswordPersonalData" }, @@ -81061,6 +82754,15 @@ }, { "$ref": "#\/components\/schemas\/policyMembershipPrivacy" + }, + { + "$ref": "#\/components\/schemas\/policyDenyAliasedEmail" + }, + { + "$ref": "#\/components\/schemas\/policyDenyDisposableEmail" + }, + { + "$ref": "#\/components\/schemas\/policyDenyFreeEmail" } ], "discriminator": { @@ -81068,13 +82770,17 @@ "mapping": { "password-dictionary": "#\/components\/schemas\/policyPasswordDictionary", "password-history": "#\/components\/schemas\/policyPasswordHistory", + "password-strength": "#\/components\/schemas\/policyPasswordStrength", "password-personal-data": "#\/components\/schemas\/policyPasswordPersonalData", "session-alert": "#\/components\/schemas\/policySessionAlert", "session-duration": "#\/components\/schemas\/policySessionDuration", "session-invalidation": "#\/components\/schemas\/policySessionInvalidation", "session-limit": "#\/components\/schemas\/policySessionLimit", "user-limit": "#\/components\/schemas\/policyUserLimit", - "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy" + "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy", + "deny-aliased-email": "#\/components\/schemas\/policyDenyAliasedEmail", + "deny-disposable-email": "#\/components\/schemas\/policyDenyDisposableEmail", + "deny-free-email": "#\/components\/schemas\/policyDenyFreeEmail" } } }, @@ -81086,7 +82792,7 @@ "policies" ], "example": { - "total": 9, + "total": 10, "policies": "" } }, @@ -81679,7 +83385,7 @@ "model": { "type": "string", "description": "Embedding model used to generate embeddings.", - "x-example": "embeddinggemma" + "x-example": "nomic-embed-text" }, "dimension": { "type": "integer", @@ -81713,7 +83419,7 @@ "error" ], "example": { - "model": "embeddinggemma", + "model": "nomic-embed-text", "dimension": 768, "embedding": [ 0.01, @@ -87286,6 +88992,36 @@ "description": "Email verification status.", "x-example": true }, + "emailCanonical": { + "type": "string", + "description": "Canonical form of the user email address.", + "x-example": "john@appwrite.io", + "nullable": true + }, + "emailIsFree": { + "type": "boolean", + "description": "Whether the user email is from a free email provider.", + "x-example": true, + "nullable": true + }, + "emailIsDisposable": { + "type": "boolean", + "description": "Whether the user email is from a disposable email provider.", + "x-example": false, + "nullable": true + }, + "emailIsCorporate": { + "type": "boolean", + "description": "Whether the user email is from a corporate domain.", + "x-example": true, + "nullable": true + }, + "emailIsCanonical": { + "type": "boolean", + "description": "Whether the user email is in its canonical form.", + "x-example": true, + "nullable": true + }, "phoneVerification": { "type": "boolean", "description": "Phone verification status.", @@ -87368,6 +89104,11 @@ "email": "john@appwrite.io", "phone": "+4930901820", "emailVerification": true, + "emailCanonical": "john@appwrite.io", + "emailIsFree": true, + "emailIsDisposable": false, + "emailIsCorporate": true, + "emailIsCanonical": true, "phoneVerification": true, "mfa": true, "prefs": { @@ -88473,6 +90214,11 @@ "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", "x-example": false }, + "userAccessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, "roles": { "type": "array", "description": "User list of roles", @@ -88498,6 +90244,7 @@ "joined", "confirm", "mfa", + "userAccessedAt", "roles" ], "example": { @@ -88514,6 +90261,7 @@ "joined": "2020-10-15T06:38:00.000+00:00", "confirm": false, "mfa": false, + "userAccessedAt": "2020-10-15T06:38:00.000+00:00", "roles": [ "owner" ] @@ -90605,6 +92353,11 @@ "description": "Project team ID.", "x-example": "1592981250" }, + "region": { + "type": "string", + "description": "Project region", + "x-example": "fra" + }, "devKeys": { "type": "array", "description": "Deprecated since 1.9.5: List of dev keys.", @@ -90657,7 +92410,8 @@ "smtpPassword": { "type": "string", "description": "SMTP server password. This property is write-only and always returned empty.", - "x-example": "" + "x-example": "smtp-password", + "format": "password" }, "smtpSecure": { "type": "string", @@ -90714,10 +92468,18 @@ }, "x-example": {} }, - "region": { + "blocks": { + "type": "array", + "description": "Project blocks information", + "items": { + "$ref": "#\/components\/schemas\/block" + }, + "x-example": "" + }, + "consoleAccessedAt": { "type": "string", - "description": "Project region", - "x-example": "fra" + "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, "billingLimits": { "type": "object", @@ -90728,18 +92490,92 @@ }, "nullable": true }, - "blocks": { + "oAuth2ServerEnabled": { + "type": "boolean", + "description": "OAuth2 server status", + "x-example": false + }, + "oAuth2ServerAuthorizationUrl": { + "type": "string", + "description": "OAuth2 server authorization URL", + "x-example": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration" + }, + "oAuth2ServerScopes": { "type": "array", - "description": "Project blocks information", + "description": "OAuth2 server allowed scopes", "items": { - "$ref": "#\/components\/schemas\/block" + "type": "string" }, - "x-example": "" + "x-example": [ + "read", + "write" + ] }, - "consoleAccessedAt": { + "oAuth2ServerAuthorizationDetailsTypes": { + "type": "array", + "description": "OAuth2 server accepted RFC 9396 authorization_details types", + "items": { + "type": "string" + }, + "x-example": [ + "calendar" + ] + }, + "oAuth2ServerAccessTokenDuration": { + "type": "integer", + "description": "OAuth2 server access token duration in seconds for confidential clients", + "x-example": 3600, + "format": "int32" + }, + "oAuth2ServerRefreshTokenDuration": { + "type": "integer", + "description": "OAuth2 server refresh token duration in seconds for confidential clients", + "x-example": 86400, + "format": "int32" + }, + "oAuth2ServerPublicAccessTokenDuration": { + "type": "integer", + "description": "OAuth2 server access token duration in seconds for public clients (SPAs, mobile, native)", + "x-example": 3600, + "format": "int32" + }, + "oAuth2ServerPublicRefreshTokenDuration": { + "type": "integer", + "description": "OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)", + "x-example": 2592000, + "format": "int32" + }, + "oAuth2ServerConfidentialPkce": { + "type": "boolean", + "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", + "x-example": false + }, + "oAuth2ServerVerificationUrl": { "type": "string", - "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "URL to your application page where users enter the device flow user code. Empty when the Device Authorization Grant is not configured.", + "x-example": "https:\/\/cloud.appwrite.io\/device" + }, + "oAuth2ServerUserCodeLength": { + "type": "integer", + "description": "Number of characters in the device flow user code, excluding the formatting separator.", + "x-example": 8, + "format": "int32" + }, + "oAuth2ServerUserCodeFormat": { + "type": "string", + "description": "Character set for device flow user codes: `numeric`, `alphabetic`, or `alphanumeric`.", + "x-example": "alphanumeric" + }, + "oAuth2ServerDeviceCodeDuration": { + "type": "integer", + "description": "Lifetime in seconds of device flow device codes and user codes.", + "x-example": 600, + "format": "int32" + }, + "oAuth2ServerDiscoveryUrl": { + "type": "string", + "description": "OAuth2 server discovery URL", + "x-example": "https:\/\/auth.example.com\/.well-known\/openid-configuration" } }, "required": [ @@ -90748,6 +92584,7 @@ "$updatedAt", "name", "teamId", + "region", "devKeys", "smtpEnabled", "smtpSenderName", @@ -90766,9 +92603,22 @@ "authMethods", "services", "protocols", - "region", "blocks", - "consoleAccessedAt" + "consoleAccessedAt", + "oAuth2ServerEnabled", + "oAuth2ServerAuthorizationUrl", + "oAuth2ServerScopes", + "oAuth2ServerAuthorizationDetailsTypes", + "oAuth2ServerAccessTokenDuration", + "oAuth2ServerRefreshTokenDuration", + "oAuth2ServerPublicAccessTokenDuration", + "oAuth2ServerPublicRefreshTokenDuration", + "oAuth2ServerConfidentialPkce", + "oAuth2ServerVerificationUrl", + "oAuth2ServerUserCodeLength", + "oAuth2ServerUserCodeFormat", + "oAuth2ServerDeviceCodeDuration", + "oAuth2ServerDiscoveryUrl" ], "example": { "$id": "5e5ea5c16897e", @@ -90776,6 +92626,7 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "New Project", "teamId": "1592981250", + "region": "fra", "devKeys": {}, "smtpEnabled": false, "smtpSenderName": "John Appwrite", @@ -90785,7 +92636,7 @@ "smtpHost": "mail.appwrite.io", "smtpPort": 25, "smtpUsername": "emailuser", - "smtpPassword": "", + "smtpPassword": "smtp-password", "smtpSecure": "tls", "pingCount": 1, "pingedAt": "2020-10-15T06:38:00.000+00:00", @@ -90796,10 +92647,28 @@ "authMethods": {}, "services": {}, "protocols": {}, - "region": "fra", - "billingLimits": "", "blocks": "", - "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00", + "billingLimits": "", + "oAuth2ServerEnabled": false, + "oAuth2ServerAuthorizationUrl": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration", + "oAuth2ServerScopes": [ + "read", + "write" + ], + "oAuth2ServerAuthorizationDetailsTypes": [ + "calendar" + ], + "oAuth2ServerAccessTokenDuration": 3600, + "oAuth2ServerRefreshTokenDuration": 86400, + "oAuth2ServerPublicAccessTokenDuration": 3600, + "oAuth2ServerPublicRefreshTokenDuration": 2592000, + "oAuth2ServerConfidentialPkce": false, + "oAuth2ServerVerificationUrl": "https:\/\/cloud.appwrite.io\/device", + "oAuth2ServerUserCodeLength": 8, + "oAuth2ServerUserCodeFormat": "alphanumeric", + "oAuth2ServerDeviceCodeDuration": 600, + "oAuth2ServerDiscoveryUrl": "https:\/\/auth.example.com\/.well-known\/openid-configuration" } }, "projectAuthMethod": { @@ -90849,6 +92718,9 @@ "avatars", "databases", "tablesdb", + "documentsDB", + "tablesDB", + "vectorsDB", "locale", "health", "project", @@ -90856,6 +92728,9 @@ "teams", "users", "vcs", + "webhooks", + "tokens", + "presences", "sites", "functions", "proxy", @@ -90964,7 +92839,8 @@ "authPassword": { "type": "string", "description": "HTTP basic authentication password.", - "x-example": "password" + "x-example": "webhook-password", + "format": "password" }, "secret": { "type": "string", @@ -91015,7 +92891,7 @@ ], "tls": true, "authUsername": "username", - "authPassword": "password", + "authPassword": "webhook-password", "secret": "ad3d581ca230e2b7059c545e5a", "enabled": true, "logs": "Failed to connect to remote server.", @@ -93176,6 +95052,59 @@ "total": 5 } }, + "policyPasswordStrength": { + "description": "Policy Password Strength", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "min": { + "type": "integer", + "description": "Minimum password length required for user passwords.", + "x-example": 12, + "format": "int32" + }, + "uppercase": { + "type": "boolean", + "description": "Whether passwords must include at least one uppercase letter.", + "x-example": true + }, + "lowercase": { + "type": "boolean", + "description": "Whether passwords must include at least one lowercase letter.", + "x-example": true + }, + "number": { + "type": "boolean", + "description": "Whether passwords must include at least one number.", + "x-example": true + }, + "symbols": { + "type": "boolean", + "description": "Whether passwords must include at least one symbol.", + "x-example": true + } + }, + "required": [ + "$id", + "min", + "uppercase", + "lowercase", + "number", + "symbols" + ], + "example": { + "$id": "password-dictionary", + "min": 12, + "uppercase": true, + "lowercase": true, + "number": true, + "symbols": true + } + }, "policyPasswordPersonalData": { "description": "Policy Password Personal Data", "type": "object", @@ -93356,6 +95285,11 @@ "type": "boolean", "description": "Whether user MFA status is visible in memberships.", "x-example": true + }, + "userAccessedAt": { + "type": "boolean", + "description": "Whether user last access time is visible in memberships.", + "x-example": true } }, "required": [ @@ -93364,7 +95298,8 @@ "userEmail", "userPhone", "userName", - "userMFA" + "userMFA", + "userAccessedAt" ], "example": { "$id": "password-dictionary", @@ -93372,7 +95307,8 @@ "userEmail": true, "userPhone": true, "userName": true, - "userMFA": true + "userMFA": true, + "userAccessedAt": true } }, "platformWeb": { @@ -98029,6 +99965,72 @@ "x-example": 5, "format": "int32" }, + "api-key": { + "type": "integer", + "description": "Number of API keys to be migrated.", + "x-example": 5, + "format": "int32" + }, + "project-variable": { + "type": "integer", + "description": "Number of project variables to be migrated.", + "x-example": 5, + "format": "int32" + }, + "webhook": { + "type": "integer", + "description": "Number of webhooks to be migrated.", + "x-example": 5, + "format": "int32" + }, + "auth-methods": { + "type": "integer", + "description": "Number of auth-method configs to be migrated (always 0 or 1 \u2014 the project-level flag bundle).", + "x-example": 1, + "format": "int32" + }, + "project-protocols": { + "type": "integer", + "description": "Number of protocol configs to be migrated (always 0 or 1 \u2014 the project-level REST\/GraphQL\/WebSocket flags).", + "x-example": 1, + "format": "int32" + }, + "project-labels": { + "type": "integer", + "description": "Number of label sets to be migrated (always 0 or 1 \u2014 the project-level RBAC label array).", + "x-example": 1, + "format": "int32" + }, + "project-services": { + "type": "integer", + "description": "Number of service configs to be migrated (always 0 or 1 \u2014 the project-level enable\/disable flags for all 17 services).", + "x-example": 1, + "format": "int32" + }, + "policies": { + "type": "integer", + "description": "Number of policy bundles to be migrated (always 0 or 1 \u2014 the project-level security policies covering password rules, session behavior, user limits, and membership privacy).", + "x-example": 1, + "format": "int32" + }, + "smtp": { + "type": "integer", + "description": "Number of SMTP configurations to be migrated (always 0 or 1 \u2014 the project-level custom SMTP settings; password is not exposed by the source API).", + "x-example": 1, + "format": "int32" + }, + "rule": { + "type": "integer", + "description": "Number of custom-domain proxy rules to be migrated. Auto-generated `.appwrite.network` rules are skipped \u2014 they are recreated by parent Function\/Site migration.", + "x-example": 5, + "format": "int32" + }, + "project-email-template": { + "type": "integer", + "description": "Number of custom email templates to be migrated (one per templateId \u00d7 locale pair).", + "x-example": 7, + "format": "int32" + }, "site": { "type": "integer", "description": "Number of sites to be migrated.", @@ -98070,6 +100072,12 @@ "description": "Version of the Appwrite instance to be migrated.", "x-example": "1.4.0" }, + "oauth2-provider": { + "type": "integer", + "description": "Number of OAuth2 provider configurations to be migrated. Secrets (clientSecret, p8File) are never migrated \u2014 destination admin must re-enter them per provider.", + "x-example": 5, + "format": "int32" + }, "backup-policy": { "type": "integer", "description": "Number of backup policies to be migrated.", @@ -98086,6 +100094,17 @@ "bucket", "function", "platform", + "api-key", + "project-variable", + "webhook", + "auth-methods", + "project-protocols", + "project-labels", + "project-services", + "policies", + "smtp", + "rule", + "project-email-template", "site", "provider", "topic", @@ -98093,6 +100112,7 @@ "message", "size", "version", + "oauth2-provider", "backup-policy" ], "example": { @@ -98104,6 +100124,17 @@ "bucket": 20, "function": 20, "platform": 5, + "api-key": 5, + "project-variable": 5, + "webhook": 5, + "auth-methods": 1, + "project-protocols": 1, + "project-labels": 1, + "project-services": 1, + "policies": 1, + "smtp": 1, + "rule": 5, + "project-email-template": 7, "site": 5, "provider": 5, "topic": 10, @@ -98111,6 +100142,7 @@ "message": 50, "size": 30000, "version": "1.4.0", + "oauth2-provider": 5, "backup-policy": 5 } }, @@ -98500,66 +100532,6 @@ "description": "Hostname.", "x-example": "appwrite.io" }, - "osCode": { - "type": "string", - "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" - }, - "osName": { - "type": "string", - "description": "Operating system name.", - "x-example": "Mac" - }, - "osVersion": { - "type": "string", - "description": "Operating system version.", - "x-example": "Mac" - }, - "clientType": { - "type": "string", - "description": "Client type.", - "x-example": "browser" - }, - "clientCode": { - "type": "string", - "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" - }, - "clientName": { - "type": "string", - "description": "Client name.", - "x-example": "Chrome Mobile iOS" - }, - "clientVersion": { - "type": "string", - "description": "Client version.", - "x-example": "84.0" - }, - "clientEngine": { - "type": "string", - "description": "Client engine name.", - "x-example": "WebKit" - }, - "clientEngineVersion": { - "type": "string", - "description": "Client engine name.", - "x-example": "605.1.15" - }, - "deviceName": { - "type": "string", - "description": "Device name.", - "x-example": "smartphone" - }, - "deviceBrand": { - "type": "string", - "description": "Device brand name.", - "x-example": "Google" - }, - "deviceModel": { - "type": "string", - "description": "Device model name.", - "x-example": "Nexus 5" - }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", @@ -98590,18 +100562,6 @@ "projectId", "teamId", "hostname", - "osCode", - "osName", - "osVersion", - "clientType", - "clientCode", - "clientName", - "clientVersion", - "clientEngine", - "clientEngineVersion", - "deviceName", - "deviceBrand", - "deviceModel", "countryCode", "countryName" ], @@ -98624,18 +100584,6 @@ "projectId": "610fc2f985ee0", "teamId": "610fc2f985ee0", "hostname": "appwrite.io", - "osCode": "Mac", - "osName": "Mac", - "osVersion": "Mac", - "clientType": "browser", - "clientCode": "CM", - "clientName": "Chrome Mobile iOS", - "clientVersion": "84.0", - "clientEngine": "WebKit", - "clientEngineVersion": "605.1.15", - "deviceName": "smartphone", - "deviceBrand": "Google", - "deviceModel": "Nexus 5", "countryCode": "US", "countryName": "United States" } @@ -99877,6 +101825,11 @@ "description": "Does plan support blocking free email addresses.", "x-example": true }, + "supportsProjectSpecificRoles": { + "type": "boolean", + "description": "Does plan support project-specific member roles.", + "x-example": true + }, "backupsEnabled": { "type": "boolean", "description": "Does plan support backup policies.", @@ -100001,6 +101954,7 @@ "supportsDisposableEmailValidation", "supportsCanonicalEmailValidation", "supportsFreeEmailValidation", + "supportsProjectSpecificRoles", "backupsEnabled", "usagePerProject", "supportedAddons", @@ -100064,6 +102018,7 @@ "supportsDisposableEmailValidation": true, "supportsCanonicalEmailValidation": true, "supportsFreeEmailValidation": true, + "supportsProjectSpecificRoles": true, "backupsEnabled": true, "usagePerProject": true, "supportedAddons": null, @@ -100332,7 +102287,7 @@ "branchId": { "type": "string", "description": "Branch identifier.", - "x-example": "branch-a1b2c3d4" + "x-example": "a1b2c3d4" }, "branchName": { "type": "string", @@ -100342,26 +102297,83 @@ "namespace": { "type": "string", "description": "Kubernetes namespace where the branch is deployed.", - "x-example": "branch-a1b2c3d4" + "x-example": "db-myproject-mydb-branch-a1b2c3d4" }, "expiresAt": { "type": "integer", "description": "Unix timestamp when the branch expires.", "x-example": 1711411200, "format": "int32" + }, + "host": { + "type": "string", + "description": "Branch hostname for direct connections.", + "x-example": "db-myproject-mydb-a1b2c3d4.fra.appwrite.center" + }, + "port": { + "type": "integer", + "description": "Branch port.", + "x-example": 5432, + "format": "int32" + }, + "database": { + "type": "string", + "description": "Database name the client sends for routing to the branch.", + "x-example": "db-myproject-mydb-a1b2c3d4" + }, + "username": { + "type": "string", + "description": "Database username. Shared with the parent database.", + "x-example": "appwrite" + }, + "password": { + "type": "string", + "description": "Database password. Shared with the parent database.", + "x-example": "********" + }, + "ssl": { + "type": "boolean", + "description": "Whether SSL is required.", + "x-example": false + }, + "engine": { + "type": "string", + "description": "Database engine. Possible values: postgres, mysql, mariadb, mongodb.", + "x-example": "postgres" + }, + "connectionString": { + "type": "string", + "description": "Full connection string for the branch.", + "x-example": "postgresql:\/\/appwrite:****@db-myproject-mydb-a1b2c3d4.fra.appwrite.center:5432\/db-myproject-mydb-a1b2c3d4?sslmode=disable" } }, "required": [ "branchId", "branchName", "namespace", - "expiresAt" + "expiresAt", + "host", + "port", + "database", + "username", + "password", + "ssl", + "engine", + "connectionString" ], "example": { - "branchId": "branch-a1b2c3d4", + "branchId": "a1b2c3d4", "branchName": "branch-a1b2c3d4", - "namespace": "branch-a1b2c3d4", - "expiresAt": 1711411200 + "namespace": "db-myproject-mydb-branch-a1b2c3d4", + "expiresAt": 1711411200, + "host": "db-myproject-mydb-a1b2c3d4.fra.appwrite.center", + "port": 5432, + "database": "db-myproject-mydb-a1b2c3d4", + "username": "appwrite", + "password": "********", + "ssl": false, + "engine": "postgres", + "connectionString": "postgresql:\/\/appwrite:****@db-myproject-mydb-a1b2c3d4.fra.appwrite.center:5432\/db-myproject-mydb-a1b2c3d4?sslmode=disable" } }, "dedicatedDatabaseBranchList": { @@ -100606,7 +102618,7 @@ "host": { "type": "string", "description": "Database hostname.", - "x-example": "db-myproject-mydb.fra.appwrite.network" + "x-example": "db-myproject-mydb.fra.appwrite.center" }, "port": { "type": "integer", @@ -100629,6 +102641,22 @@ "description": "Database name.", "x-example": "appwrite" }, + "tcpHost": { + "type": "string", + "description": "Database TCP hostname or address.", + "x-example": "db-myproject-mydb.fra.appwrite.center" + }, + "tcpPort": { + "type": "integer", + "description": "Database TCP port.", + "x-example": 5432, + "format": "int32" + }, + "tcpDatabase": { + "type": "string", + "description": "Database name for direct TCP connections.", + "x-example": "appwrite" + }, "engine": { "type": "string", "description": "Database engine. Possible values: postgres, mysql, mariadb, mongodb.", @@ -100637,12 +102665,12 @@ "ssl": { "type": "boolean", "description": "Whether SSL is required.", - "x-example": true + "x-example": false }, "connectionString": { "type": "string", "description": "Full connection string.", - "x-example": "postgresql:\/\/appwrite:****@db-myproject-mydb.fra.appwrite.network:5432\/appwrite?sslmode=require" + "x-example": "postgresql:\/\/appwrite:****@db-myproject-mydb.fra.appwrite.center:5432\/appwrite?sslmode=disable" } }, "required": [ @@ -100652,20 +102680,26 @@ "username", "password", "database", + "tcpHost", + "tcpPort", + "tcpDatabase", "engine", "ssl", "connectionString" ], "example": { "$id": "5e5ea5c16897e", - "host": "db-myproject-mydb.fra.appwrite.network", + "host": "db-myproject-mydb.fra.appwrite.center", "port": 5432, "username": "appwrite", "password": "********", "database": "appwrite", + "tcpHost": "db-myproject-mydb.fra.appwrite.center", + "tcpPort": 5432, + "tcpDatabase": "appwrite", "engine": "postgres", - "ssl": true, - "connectionString": "postgresql:\/\/appwrite:****@db-myproject-mydb.fra.appwrite.network:5432\/appwrite?sslmode=require" + "ssl": false, + "connectionString": "postgresql:\/\/appwrite:****@db-myproject-mydb.fra.appwrite.center:5432\/appwrite?sslmode=disable" } }, "credit": { @@ -100818,103 +102852,6 @@ "available": 5 } }, - "dedicatedDatabaseMetrics": { - "description": "DatabaseMetrics", - "type": "object", - "properties": { - "period": { - "type": "string", - "description": "Metrics aggregation period. Possible values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days), 30d (last 30 days).", - "x-example": "24h" - }, - "cpuPercent": { - "type": "number", - "description": "Average CPU usage percentage.", - "x-example": 45.2, - "format": "double" - }, - "memoryPercent": { - "type": "number", - "description": "Average memory usage percentage.", - "x-example": 62.1, - "format": "double" - }, - "memoryUsedBytes": { - "type": "integer", - "description": "Memory used in bytes.", - "x-example": 536870912, - "format": "int32" - }, - "memoryMaxBytes": { - "type": "integer", - "description": "Maximum memory available in bytes.", - "x-example": 1073741824, - "format": "int32" - }, - "storageUsedBytes": { - "type": "integer", - "description": "Storage used in bytes.", - "x-example": 1073741824, - "format": "int32" - }, - "connectionsActive": { - "type": "integer", - "description": "Current active connections.", - "x-example": 15, - "format": "int32" - }, - "connectionsMax": { - "type": "integer", - "description": "Maximum connections configured.", - "x-example": 100, - "format": "int32" - }, - "iopsRead": { - "type": "number", - "description": "Average read IOPS.", - "x-example": 125.5, - "format": "double" - }, - "iopsWrite": { - "type": "number", - "description": "Average write IOPS.", - "x-example": 45.3, - "format": "double" - }, - "qps": { - "type": "number", - "description": "Queries per second.", - "x-example": 230.7, - "format": "double" - } - }, - "required": [ - "period", - "cpuPercent", - "memoryPercent", - "memoryUsedBytes", - "memoryMaxBytes", - "storageUsedBytes", - "connectionsActive", - "connectionsMax", - "iopsRead", - "iopsWrite", - "qps" - ], - "example": { - "period": "24h", - "cpuPercent": 45.2, - "memoryPercent": 62.1, - "memoryUsedBytes": 536870912, - "memoryMaxBytes": 1073741824, - "storageUsedBytes": 1073741824, - "connectionsActive": 15, - "connectionsMax": 100, - "iopsRead": 125.5, - "iopsWrite": 45.3, - "qps": 230.7 - } - }, "dedicatedDatabase": { "description": "DedicatedDatabase", "type": "object", @@ -100982,7 +102919,7 @@ "hostname": { "type": "string", "description": "Database hostname for connections.", - "x-example": "db-myproject-mydb.fra.appwrite.network" + "x-example": "db-myproject-mydb.fra.appwrite.center" }, "connectionPort": { "type": "integer", @@ -101003,7 +102940,7 @@ "connectionString": { "type": "string", "description": "Full database connection string (URI format).", - "x-example": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.network:5432\/postgres" + "x-example": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.center:5432\/postgres" }, "status": { "type": "string", @@ -101267,11 +103204,11 @@ "version": "16", "specification": "s-2vcpu-2gb", "backend": "edge", - "hostname": "db-myproject-mydb.fra.appwrite.network", + "hostname": "db-myproject-mydb.fra.appwrite.center", "connectionPort": 5432, "connectionUser": "appwrite_user", "connectionPassword": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022", - "connectionString": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.network:5432\/postgres", + "connectionString": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.center:5432\/postgres", "status": "ready", "containerStatus": "active", "lastAccessedAt": "2020-10-15T06:38:00.000+00:00", @@ -103208,149 +105145,6 @@ "failed": false } }, - "dedicatedDatabasePerformanceInsights": { - "description": "PerformanceInsights", - "type": "object", - "properties": { - "topQueries": { - "type": "array", - "description": "Top queries by total execution time.", - "items": { - "$ref": "#\/components\/schemas\/dedicatedDatabasePerformanceInsightsQuery" - }, - "x-example": [] - }, - "waitEvents": { - "type": "array", - "description": "Active wait events.", - "items": { - "$ref": "#\/components\/schemas\/dedicatedDatabasePerformanceInsightsWaitEvent" - }, - "x-example": [] - }, - "totalCalls": { - "type": "integer", - "description": "Total number of query calls.", - "x-example": 150000, - "format": "int32" - }, - "totalTimeMs": { - "type": "number", - "description": "Total query execution time in milliseconds.", - "x-example": 85432.12, - "format": "double" - }, - "avgTimeMs": { - "type": "number", - "description": "Average query execution time in milliseconds.", - "x-example": 0.57, - "format": "double" - } - }, - "required": [ - "topQueries", - "waitEvents", - "totalCalls", - "totalTimeMs", - "avgTimeMs" - ], - "example": { - "topQueries": [], - "waitEvents": [], - "totalCalls": 150000, - "totalTimeMs": 85432.12, - "avgTimeMs": 0.57 - } - }, - "dedicatedDatabasePerformanceInsightsQuery": { - "description": "PerformanceInsightsQuery", - "type": "object", - "properties": { - "query": { - "type": "string", - "description": "The SQL query text.", - "x-example": "SELECT * FROM users WHERE email = $1" - }, - "calls": { - "type": "integer", - "description": "Number of times this query has been executed.", - "x-example": 42, - "format": "int32" - }, - "totalTimeMs": { - "type": "number", - "description": "Total execution time in milliseconds.", - "x-example": 1523.4, - "format": "double" - }, - "meanTimeMs": { - "type": "number", - "description": "Mean execution time in milliseconds.", - "x-example": 36.27, - "format": "double" - }, - "rows": { - "type": "integer", - "description": "Total rows returned or affected.", - "x-example": 1250, - "format": "int32" - } - }, - "required": [ - "query", - "calls", - "totalTimeMs", - "meanTimeMs", - "rows" - ], - "example": { - "query": "SELECT * FROM users WHERE email = $1", - "calls": 42, - "totalTimeMs": 1523.4, - "meanTimeMs": 36.27, - "rows": 1250 - } - }, - "dedicatedDatabasePerformanceInsightsWaitEvent": { - "description": "PerformanceInsightsWaitEvent", - "type": "object", - "properties": { - "event": { - "type": "string", - "description": "Wait event name.", - "x-example": "DataFileRead" - }, - "type": { - "type": "string", - "description": "Wait event type or category.", - "x-example": "IO" - }, - "count": { - "type": "integer", - "description": "Number of occurrences.", - "x-example": 15, - "format": "int32" - }, - "totalWaitMs": { - "type": "number", - "description": "Total wait time in milliseconds.", - "x-example": 234.5, - "format": "double" - } - }, - "required": [ - "event", - "type", - "count", - "totalWaitMs" - ], - "example": { - "event": "DataFileRead", - "type": "IO", - "count": 15, - "totalWaitMs": 234.5 - } - }, "dedicatedDatabasePITRWindows": { "description": "PITRWindows", "type": "object", @@ -103741,6 +105535,78 @@ "enabled": true } }, + "policyDenyAliasedEmail": { + "description": "Policy Deny Aliased Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny aliased email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policyDenyDisposableEmail": { + "description": "Policy Deny Disposable Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny disposable email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policyDenyFreeEmail": { + "description": "Policy Deny Free Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny free email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, "dedicatedDatabasePooler": { "description": "PoolerConfig", "type": "object", @@ -104282,6 +106148,181 @@ "database": "appwrite" } }, + "dedicatedDatabaseSpecification": { + "description": "Specification", + "type": "object", + "properties": { + "slug": { + "type": "string", + "description": "Specification slug. Use this value when creating a dedicated database.", + "x-example": "s-2vcpu-2gb" + }, + "name": { + "type": "string", + "description": "Human readable specification name.", + "x-example": "Standard" + }, + "price": { + "type": "number", + "description": "Monthly price of the specification in USD.", + "x-example": 23, + "format": "double" + }, + "cpu": { + "type": "integer", + "description": "Allocated CPU in millicores.", + "x-example": 2000, + "format": "int32" + }, + "memory": { + "type": "integer", + "description": "Allocated memory in MB.", + "x-example": 2048, + "format": "int32" + }, + "maxConnections": { + "type": "integer", + "description": "Maximum number of concurrent connections.", + "x-example": 200, + "format": "int32" + }, + "includedStorage": { + "type": "integer", + "description": "Included storage in GB before overage charges apply.", + "x-example": 25, + "format": "int32" + }, + "includedBandwidth": { + "type": "integer", + "description": "Included bandwidth in GB before overage charges apply.", + "x-example": 200, + "format": "int32" + }, + "enabled": { + "type": "boolean", + "description": "Whether the specification is available on the current plan.", + "x-example": true + } + }, + "required": [ + "slug", + "name", + "price", + "cpu", + "memory", + "maxConnections", + "includedStorage", + "includedBandwidth", + "enabled" + ], + "example": { + "slug": "s-2vcpu-2gb", + "name": "Standard", + "price": 23, + "cpu": 2000, + "memory": 2048, + "maxConnections": 200, + "includedStorage": 25, + "includedBandwidth": 200, + "enabled": true + } + }, + "dedicatedDatabaseSpecificationList": { + "description": "SpecificationList", + "type": "object", + "properties": { + "specifications": { + "type": "array", + "description": "List of dedicated database specifications.", + "items": { + "$ref": "#\/components\/schemas\/dedicatedDatabaseSpecification" + }, + "x-example": [] + }, + "total": { + "type": "integer", + "description": "Total number of specifications.", + "x-example": 9, + "format": "int32" + }, + "pricing": { + "type": "object", + "description": "Overage and add-on pricing shared across all specifications.", + "x-example": null, + "items": { + "$ref": "#\/components\/schemas\/dedicatedDatabaseSpecificationPricing" + } + } + }, + "required": [ + "specifications", + "total", + "pricing" + ], + "example": { + "specifications": [], + "total": 9, + "pricing": null + } + }, + "dedicatedDatabaseSpecificationPricing": { + "description": "SpecificationPricing", + "type": "object", + "properties": { + "storageOverageRate": { + "type": "number", + "description": "Price per GB of storage above the included amount, per month, in USD.", + "x-example": 0.125, + "format": "double" + }, + "bandwidthOverageRate": { + "type": "number", + "description": "Price per GB of bandwidth above the included amount, per month, in USD.", + "x-example": 0.08, + "format": "double" + }, + "haReplicaRate": { + "type": "number", + "description": "High availability replica price as a fraction of the specification cost.", + "x-example": 0.5, + "format": "double" + }, + "crossRegionReplicaRate": { + "type": "number", + "description": "Cross-region replica price as a fraction of the specification cost.", + "x-example": 0.75, + "format": "double" + }, + "crossRegionRate": { + "type": "number", + "description": "Cross-region transfer price as a fraction of the specification cost.", + "x-example": 0.5, + "format": "double" + }, + "pitrRate": { + "type": "number", + "description": "Point-in-time recovery price as a fraction of the specification cost.", + "x-example": 0.2, + "format": "double" + } + }, + "required": [ + "storageOverageRate", + "bandwidthOverageRate", + "haReplicaRate", + "crossRegionReplicaRate", + "crossRegionRate", + "pitrRate" + ], + "example": { + "storageOverageRate": 0.125, + "bandwidthOverageRate": 0.08, + "haReplicaRate": 0.5, + "crossRegionReplicaRate": 0.75, + "crossRegionRate": 0.5, + "pitrRate": 0.2 + } + }, "databaseStatusConnections": { "description": "Connections", "type": "object", @@ -105167,6 +107208,249 @@ "resourceId": "" } }, + "app": { + "description": "App", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "App ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "App creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "App update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "My Application" + }, + "redirectUris": { + "type": "array", + "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", + "items": { + "type": "string" + }, + "x-example": [ + "https:\/\/example.com\/callback" + ] + }, + "enabled": { + "type": "boolean", + "description": "Whether the app is enabled or not.", + "x-example": true + }, + "type": { + "type": "string", + "description": "OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot keep a client secret (PKCE required); `confidential` for server-side clients that authenticate with a client secret.", + "x-example": "confidential" + }, + "deviceFlow": { + "type": "boolean", + "description": "Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).", + "x-example": false + }, + "teamId": { + "type": "string", + "description": "ID of team that owns the application, if owned by team. Otherwise, user ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "userId": { + "type": "string", + "description": "ID of user who owns the application, if owned by user. Otherwise, team ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "secrets": { + "type": "array", + "description": "List of application secrets.", + "items": { + "$ref": "#\/components\/schemas\/appSecret" + }, + "x-example": [] + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "redirectUris", + "enabled", + "type", + "deviceFlow", + "teamId", + "userId", + "secrets" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Application", + "redirectUris": [ + "https:\/\/example.com\/callback" + ], + "enabled": true, + "type": "confidential", + "deviceFlow": false, + "teamId": "5e5ea5c16897e", + "userId": "5e5ea5c16897e", + "secrets": [] + } + }, + "appSecret": { + "description": "AppSecret", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Secret creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Secret update time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" + }, + "secret": { + "type": "string", + "description": "Hashed application client secret.", + "x-example": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg" + }, + "hint": { + "type": "string", + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" + }, + "createdById": { + "type": "string", + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" + }, + "createdByName": { + "type": "string", + "description": "Name of the user who created the secret.", + "x-example": "Walter White" + }, + "lastAccessedAt": { + "type": "string", + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "secret", + "hint", + "createdById", + "createdByName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "secret": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, + "appSecretPlaintext": { + "description": "AppSecretPlaintext", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Secret creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Secret update time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" + }, + "secret": { + "type": "string", + "description": "Application client secret. Returned in full only when the secret is created; subsequent reads return a masked value.", + "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + }, + "hint": { + "type": "string", + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" + }, + "createdById": { + "type": "string", + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" + }, + "createdByName": { + "type": "string", + "description": "Name of the user who created the secret.", + "x-example": "Walter White" + }, + "lastAccessedAt": { + "type": "string", + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "secret", + "hint", + "createdById", + "createdByName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "secret": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, "activityEventList": { "description": "Activity event list", "type": "object", @@ -105754,6 +108038,62 @@ "total": 5, "gauges": "" } + }, + "appsList": { + "description": "Apps list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of apps that matched your query.", + "x-example": 5, + "format": "int32" + }, + "apps": { + "type": "array", + "description": "List of apps.", + "items": { + "$ref": "#\/components\/schemas\/app" + }, + "x-example": "" + } + }, + "required": [ + "total", + "apps" + ], + "example": { + "total": 5, + "apps": "" + } + }, + "appSecretList": { + "description": "App secrets list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of secrets that matched your query.", + "x-example": 5, + "format": "int32" + }, + "secrets": { + "type": "array", + "description": "List of secrets.", + "items": { + "$ref": "#\/components\/schemas\/appSecret" + }, + "x-example": "" + } + }, + "required": [ + "total", + "secrets" + ], + "example": { + "total": 5, + "secrets": "" + } } }, "securitySchemes": { @@ -105766,6 +108106,15 @@ "demo": "<YOUR_PROJECT_ID>" } }, + "ProjectQuery": { + "type": "apiKey", + "name": "project", + "description": "Your project ID", + "in": "query", + "x-appwrite": { + "demo": "<YOUR_PROJECT_ID>" + } + }, "Key": { "type": "apiKey", "name": "X-Appwrite-Key", diff --git a/specs/1.9.x/open-api3-1.9.x-server.json b/specs/1.9.x/open-api3-1.9.x-server.json index 2e102b795..f589b3f63 100644 --- a/specs/1.9.x/open-api3-1.9.x-server.json +++ b/specs/1.9.x/open-api3-1.9.x-server.json @@ -143,7 +143,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -154,7 +157,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "name": { "type": "string", @@ -1819,11 +1823,12 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "oldPassword": { "type": "string", - "description": "Current user password. Must be at least 8 chars.", + "description": "Current user password. Max length: 256 chars.", "default": "", "x-example": "password", "format": "password" @@ -2192,7 +2197,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" } }, "required": [ @@ -2500,7 +2506,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -2582,7 +2591,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -2660,7 +2672,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -2978,7 +2993,10 @@ "userId": { "type": "string", "description": "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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -3066,7 +3084,10 @@ "userId": { "type": "string", "description": "Unique 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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -3302,7 +3323,10 @@ "userId": { "type": "string", "description": "Unique 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. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "phone": { "type": "string", @@ -3840,6 +3864,873 @@ ] } }, + "\/apps": { + "get": { + "summary": "List Applications", + "operationId": "appsList", + "tags": [ + "apps" + ], + "description": "List applications.", + "responses": { + "200": { + "description": "Apps list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appsList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create Application", + "operationId": "appsCreate", + "tags": [ + "apps" + ], + "description": "Create a new application.", + "responses": { + "201": { + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "appId": { + "type": "string", + "description": "Application 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.", + "x-example": "<APP_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + }, + "teamId": { + "type": "string", + "description": "Team unique ID.", + "default": "", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "appId", + "name", + "redirectUris" + ] + } + } + } + } + } + }, + "\/apps\/{appId}": { + "get": { + "summary": "Get Application", + "operationId": "appsGet", + "tags": [ + "apps" + ], + "description": "Get an application by its unique ID.", + "responses": { + "200": { + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update Application", + "operationId": "appsUpdate", + "tags": [ + "apps" + ], + "description": "Update an application by its unique ID.", + "responses": { + "200": { + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete Application", + "operationId": "appsDelete", + "tags": [ + "apps" + ], + "description": "Delete an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/secrets": { + "get": { + "summary": "List Secrets", + "operationId": "appsListSecrets", + "tags": [ + "apps" + ], + "description": "List client secrets for an application.", + "responses": { + "200": { + "description": "App secrets list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appSecretList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listSecrets", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/list-secrets.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create Secret", + "operationId": "appsCreateSecret", + "tags": [ + "apps" + ], + "description": "Create a new client secret for an application.", + "responses": { + "201": { + "description": "AppSecretPlaintext", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appSecretPlaintext" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/create-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/secrets\/{secretId}": { + "get": { + "summary": "Get Secret", + "operationId": "appsGetSecret", + "tags": [ + "apps" + ], + "description": "Get an application client secret by its unique ID.", + "responses": { + "200": { + "description": "AppSecret", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/appSecret" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/get-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<SECRET_ID>" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete Secret", + "operationId": "appsDeleteSecret", + "tags": [ + "apps" + ], + "description": "Delete an application client secret by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<SECRET_ID>" + }, + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/team": { + "patch": { + "summary": "Update Team", + "operationId": "appsUpdateTeam", + "tags": [ + "apps" + ], + "description": "Transfer an application to another team by its unique ID.", + "responses": { + "200": { + "description": "App", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/app" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTeam", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update-team.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team ID of the team to transfer application to.", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "teamId" + ] + } + } + } + } + } + }, + "\/apps\/{appId}\/tokens": { + "delete": { + "summary": "Delete Tokens", + "operationId": "appsDeleteTokens", + "tags": [ + "apps" + ], + "description": "Revoke all tokens for an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTokens", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-tokens.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<APP_ID>" + }, + "in": "path" + } + ] + } + }, "\/avatars\/browsers\/{code}": { "get": { "summary": "Get browser icon", @@ -3875,7 +4766,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -3883,7 +4775,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4004,7 +4897,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4012,7 +4906,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4139,7 +5034,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4147,7 +5043,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4200,7 +5097,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4208,7 +5106,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4691,7 +5590,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4699,7 +5599,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4776,7 +5677,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4784,7 +5686,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4871,7 +5774,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4879,7 +5783,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4966,7 +5871,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-screenshot.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4974,7 +5880,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5935,6 +6842,9 @@ "required": true, "schema": { "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<ARCHIVE_ID>" }, "in": "path" @@ -6070,7 +6980,10 @@ "policyId": { "type": "string", "description": "Policy 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.", - "x-example": "<POLICY_ID>" + "x-example": "<POLICY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -6347,6 +7260,9 @@ "required": true, "schema": { "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<POLICY_ID>" }, "in": "path" @@ -6436,7 +7352,10 @@ "type": "string", "description": "Unique 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.", "default": "", - "x-example": "<NEW_RESOURCE_ID>" + "x-example": "<NEW_RESOURCE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "newResourceName": { "type": "string", @@ -6799,7 +7718,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -7741,7 +8663,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -13050,7 +13975,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -13668,6 +14596,9 @@ "required": true, "schema": { "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<DOCUMENT_ID>" }, "in": "path" @@ -14725,7 +15656,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -14737,6 +15671,12 @@ "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "specification": { + "type": "string", + "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", + "default": "free", + "x-example": "<SPECIFICATION>" } }, "required": [ @@ -15558,7 +16498,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -16135,7 +17078,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -17744,7 +18690,10 @@ "functionId": { "type": "string", "description": "Function 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.", - "x-example": "<FUNCTION_ID>" + "x-example": "<FUNCTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -17851,7 +18800,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "FunctionRuntime" + "x-enum-name": "Runtime" }, "execute": { "type": "array", @@ -18006,9 +18955,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes" @@ -18424,7 +19376,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "FunctionRuntime" + "x-enum-name": "Runtime" }, "execute": { "type": "array", @@ -18579,9 +19531,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes" @@ -19463,14 +20418,16 @@ "public": true, "auth": { "Project": [], - "Key": [] + "Key": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -19688,7 +20645,7 @@ "201": { "description": "Execution", "content": { - "multipart\/form-data": { + "application\/json": { "schema": { "$ref": "#\/components\/schemas\/execution" } @@ -20100,7 +21057,10 @@ "variableId": { "type": "string", "description": "Variable 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -20576,6 +21536,57 @@ ] } }, + "\/health\/audits-db": { + "get": { + "summary": "Get audits DB", + "operationId": "healthGetAuditsDB", + "tags": [ + "health" + ], + "description": "Check the database that backs the audit and activity store. When the connection is reachable the endpoint returns a passing status with its response time.\n", + "responses": { + "200": { + "description": "Status List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/healthStatusList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getAuditsDB", + "group": null, + "cookies": false, + "type": "", + "demo": "health\/get-audits-db.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "health.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/health\/get-audits-db.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, "\/health\/cache": { "get": { "summary": "Get cache", @@ -22858,7 +23869,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "subject": { "type": "string", @@ -23172,7 +24186,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "title": { "type": "string", @@ -23636,7 +24653,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "content": { "type": "string", @@ -24395,7 +25415,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -24761,7 +25784,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -25005,7 +26031,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -25260,7 +26289,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -25464,7 +26496,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -25695,7 +26730,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -25868,6 +26906,264 @@ } } }, + "\/messaging\/providers\/ses": { + "post": { + "summary": "Create Amazon SES provider", + "operationId": "messagingCreateSesProvider", + "tags": [ + "messaging" + ], + "description": "Create a new Amazon SES provider.", + "responses": { + "201": { + "description": "Provider", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/provider" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSesProvider", + "group": "providers", + "cookies": false, + "type": "", + "demo": "messaging\/create-ses-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "providers.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-ses-provider.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "providerId": { + "type": "string", + "description": "Provider 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.", + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Provider name.", + "x-example": "<NAME>" + }, + "accessKey": { + "type": "string", + "description": "AWS access key ID.", + "default": "", + "x-example": "<ACCESS_KEY>" + }, + "secretKey": { + "type": "string", + "description": "AWS secret access key.", + "default": "", + "x-example": "<SECRET_KEY>" + }, + "region": { + "type": "string", + "description": "AWS region, for example us-east-1.", + "default": "", + "x-example": "<REGION>" + }, + "fromName": { + "type": "string", + "description": "Sender Name.", + "default": "", + "x-example": "<FROM_NAME>" + }, + "fromEmail": { + "type": "string", + "description": "Sender email address.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "replyToName": { + "type": "string", + "description": "Name set in the reply to field for the mail. Default value is sender name.", + "default": "", + "x-example": "<REPLY_TO_NAME>" + }, + "replyToEmail": { + "type": "string", + "description": "Email set in the reply to field for the mail. Default value is sender email.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "enabled": { + "type": "boolean", + "description": "Set as enabled.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "providerId", + "name" + ] + } + } + } + } + } + }, + "\/messaging\/providers\/ses\/{providerId}": { + "patch": { + "summary": "Update Amazon SES provider", + "operationId": "messagingUpdateSesProvider", + "tags": [ + "messaging" + ], + "description": "Update an Amazon SES provider by its unique ID.", + "responses": { + "200": { + "description": "Provider", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/provider" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSesProvider", + "group": "providers", + "cookies": false, + "type": "", + "demo": "messaging\/update-ses-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "providers.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-ses-provider.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "providerId", + "description": "Provider ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROVIDER_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Provider name.", + "default": "", + "x-example": "<NAME>" + }, + "enabled": { + "type": "boolean", + "description": "Set as enabled.", + "x-example": false, + "x-nullable": true + }, + "accessKey": { + "type": "string", + "description": "AWS access key ID.", + "default": "", + "x-example": "<ACCESS_KEY>" + }, + "secretKey": { + "type": "string", + "description": "AWS secret access key.", + "default": "", + "x-example": "<SECRET_KEY>" + }, + "region": { + "type": "string", + "description": "AWS region, for example us-east-1.", + "default": "", + "x-example": "<REGION>" + }, + "fromName": { + "type": "string", + "description": "Sender Name.", + "default": "", + "x-example": "<FROM_NAME>" + }, + "fromEmail": { + "type": "string", + "description": "Sender email address.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "replyToName": { + "type": "string", + "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", + "default": "", + "x-example": "<REPLY_TO_NAME>" + }, + "replyToEmail": { + "type": "string", + "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", + "default": "", + "x-example": "<REPLY_TO_EMAIL>" + } + } + } + } + } + } + } + }, "\/messaging\/providers\/smtp": { "post": { "summary": "Create SMTP provider", @@ -26014,7 +27310,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -26043,7 +27342,8 @@ "type": "string", "description": "Authentication password.", "default": "", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "encryption": { "type": "string", @@ -26292,7 +27592,8 @@ "type": "string", "description": "Authentication password.", "default": "", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "encryption": { "type": "string", @@ -26413,7 +27714,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -26618,7 +27922,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -26823,7 +28130,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -27028,7 +28338,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -27610,7 +28923,10 @@ "topicId": { "type": "string", "description": "Topic ID. Choose a custom Topic ID or a new Topic ID.", - "x-example": "<TOPIC_ID>" + "x-example": "<TOPIC_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -28100,7 +29416,10 @@ "subscriberId": { "type": "string", "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", - "x-example": "<SUBSCRIBER_ID>" + "x-example": "<SUBSCRIBER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "targetId": { "type": "string", @@ -28259,6 +29578,514 @@ ] } }, + "\/oauth2\/{project_id}\/approve": { + "post": { + "summary": "Approve OAuth2", + "operationId": "oauth2Approve", + "tags": [ + "oauth2" + ], + "description": "Approve an OAuth2 grant after the user gives consent. Returns the `redirectUrl` the end user should be sent to. The consent screen may optionally pass enriched `authorization_details` to record the concrete resources the user selected. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", + "responses": { + "200": { + "description": "OAuth2 Approve", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oauth2Approve" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "approve", + "group": null, + "cookies": false, + "type": "", + "demo": "oauth2\/approve.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "ProjectQuery": [], + "Session": [] + } + }, + "security": [ + { + "ProjectQuery": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROJECT_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "grant_id": { + "type": "string", + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", + "x-example": "<GRANT_ID>" + }, + "authorization_details": { + "type": "string", + "description": "Enriched `authorization_details` the user consented to, replacing what the client requested. Each entry must use a `type` the project accepts. Optional; omit to keep the originally requested details.", + "default": "", + "x-example": "<AUTHORIZATION_DETAILS>" + } + }, + "required": [ + "grant_id" + ] + } + } + } + } + } + }, + "\/oauth2\/{project_id}\/authorize": { + "get": { + "summary": "OAuth2 Authorize", + "operationId": "oauth2Authorize", + "tags": [ + "oauth2" + ], + "description": "Begin the OAuth2 authorization flow. When called without a session, the user is redirected to the consent screen without grant ID. When called with a session, the redirect URL includes param for grant ID. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", + "responses": { + "200": { + "description": "OAuth2 Authorize", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oauth2Authorize" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "authorize", + "group": null, + "cookies": false, + "type": "", + "demo": "oauth2\/authorize.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "public", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "ProjectQuery": [], + "Session": [] + } + }, + "security": [ + { + "ProjectQuery": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client exists.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROJECT_ID>" + }, + "in": "path" + }, + { + "name": "client_id", + "description": "OAuth2 client ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<CLIENT_ID>" + }, + "in": "query" + }, + { + "name": "redirect_uri", + "description": "Redirect URI where visitor will be redirected after authorization, whether successful or not.", + "required": true, + "schema": { + "type": "string", + "format": "url", + "x-example": "https:\/\/example.com" + }, + "in": "query" + }, + { + "name": "response_type", + "description": "OAuth2 \/ OIDC response type. One of `code` (Authorization Code Flow), `id_token` (Implicit Flow, OIDC login only), or `code id_token` (Hybrid Flow).", + "required": true, + "schema": { + "type": "string", + "x-example": "code" + }, + "in": "query" + }, + { + "name": "scope", + "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`.", + "required": true, + "schema": { + "type": "string", + "x-example": "<SCOPE>" + }, + "in": "query" + }, + { + "name": "state", + "description": "OAuth2 state. You receive this back in the redirect URI.", + "required": false, + "schema": { + "type": "string", + "x-example": "<STATE>", + "default": "" + }, + "in": "query" + }, + { + "name": "nonce", + "description": "OIDC nonce parameter to prevent replay attacks. Required when response_type includes `id_token`.", + "required": false, + "schema": { + "type": "string", + "x-example": "<NONCE>", + "default": "" + }, + "in": "query" + }, + { + "name": "code_challenge", + "description": "PKCE code challenge. Required when OAuth2 app is public.", + "required": false, + "schema": { + "type": "string", + "x-example": "<CODE_CHALLENGE>", + "default": "" + }, + "in": "query" + }, + { + "name": "code_challenge_method", + "description": "PKCE code challenge method. Required when OAuth2 app is public.", + "required": false, + "schema": { + "type": "string", + "x-example": "s256", + "default": "" + }, + "in": "query" + }, + { + "name": "prompt", + "description": "OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.", + "required": false, + "schema": { + "type": "string", + "x-example": "<PROMPT>", + "default": "" + }, + "in": "query" + }, + { + "name": "max_age", + "description": "OIDC max_age paraleter for customization of consent screen. Maximum allowable elapsed time in seconds since the user last authenticated. If exceeded, re-authentication is required.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0 + }, + "in": "query" + }, + { + "name": "authorization_details", + "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", + "required": false, + "schema": { + "type": "string", + "x-example": "<AUTHORIZATION_DETAILS>", + "default": "" + }, + "in": "query" + } + ] + } + }, + "\/oauth2\/{project_id}\/grants": { + "post": { + "summary": "Create OAuth2 Grant", + "operationId": "oauth2CreateGrant", + "tags": [ + "oauth2" + ], + "description": "Exchange a device flow user code for an OAuth2 grant. The authenticated user is bound to the pending grant. Pass the returned grant ID to the get grant endpoint to render the consent screen, then to the approve or reject endpoint to complete the flow.", + "responses": { + "201": { + "description": "OAuth2 Grant", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oauth2Grant" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createGrant", + "group": null, + "cookies": false, + "type": "", + "demo": "oauth2\/create-grant.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "ip:{ip},userId:{userId}", + "scope": "oauth2.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client exists.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROJECT_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "user_code": { + "type": "string", + "description": "User code displayed on the device.", + "x-example": "<USER_CODE>" + } + }, + "required": [ + "user_code" + ] + } + } + } + } + } + }, + "\/oauth2\/{project_id}\/grants\/{grant_id}": { + "get": { + "summary": "Get OAuth2 Grant", + "operationId": "oauth2GetGrant", + "tags": [ + "oauth2" + ], + "description": "Get an OAuth2 grant by its ID. Used by the consent screen to display the details of the authorization the user is being asked to approve. A grant can only be read by the user it belongs to, or by server SDK.", + "responses": { + "200": { + "description": "OAuth2 Grant", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oauth2Grant" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getGrant", + "group": null, + "cookies": false, + "type": "", + "demo": "oauth2\/get-grant.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROJECT_ID>" + }, + "in": "path" + }, + { + "name": "grant_id", + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", + "required": true, + "schema": { + "type": "string", + "x-example": "<GRANT_ID>" + }, + "in": "path" + } + ] + } + }, + "\/oauth2\/{project_id}\/reject": { + "post": { + "summary": "Reject OAuth2", + "operationId": "oauth2Reject", + "tags": [ + "oauth2" + ], + "description": "Reject an OAuth2 grant when the user denies consent. Returns the `redirectUrl` the end user should be sent to with an `access_denied` error. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", + "responses": { + "200": { + "description": "OAuth2 Reject", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oauth2Reject" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "reject", + "group": null, + "cookies": false, + "type": "", + "demo": "oauth2\/reject.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "ProjectQuery": [], + "Session": [] + } + }, + "security": [ + { + "ProjectQuery": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROJECT_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "grant_id": { + "type": "string", + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", + "x-example": "<GRANT_ID>" + } + }, + "required": [ + "grant_id" + ] + } + } + } + } + } + }, "\/organization\/keys": { "get": { "summary": "List organization keys", @@ -28390,7 +30217,10 @@ "keyId": { "type": "string", "description": "Key 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.", - "x-example": "<KEY_ID>" + "x-example": "<KEY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -29837,7 +31667,10 @@ "keyId": { "type": "string", "description": "Key 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.", - "x-example": "<KEY_ID>" + "x-example": "<KEY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -29941,9 +31774,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes" @@ -30119,9 +31955,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes" @@ -30372,9 +32211,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes" @@ -30946,6 +32788,161 @@ ] } }, + "\/project\/oauth2-server": { + "put": { + "summary": "Update OAuth2 server", + "operationId": "projectUpdateOAuth2Server", + "tags": [ + "project" + ], + "description": "Update the OAuth2 server (OIDC provider) configuration.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Server", + "group": null, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-server.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable the OAuth2 server.", + "x-example": false + }, + "authorizationUrl": { + "type": "string", + "description": "URL to your application with consent screen.", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "scopes": { + "type": "array", + "description": "List of allowed OAuth2 scopes. Maximum of 100 scopes are allowed, each up to 128 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "authorizationDetailsTypes": { + "type": "array", + "description": "List of accepted `authorization_details` types. Maximum of 100 types are allowed, each up to 128 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "accessTokenDuration": { + "type": "integer", + "description": "Access token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 8 hours.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "refreshTokenDuration": { + "type": "integer", + "description": "Refresh token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 1 year.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "publicAccessTokenDuration": { + "type": "integer", + "description": "Access token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 1 hour.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "publicRefreshTokenDuration": { + "type": "integer", + "description": "Refresh token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 30 days.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "confidentialPkce": { + "type": "boolean", + "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", + "x-example": false, + "x-nullable": true + }, + "verificationUrl": { + "type": "string", + "description": "URL to your application page where users enter the device flow user code. Required to enable the Device Authorization Grant.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "userCodeLength": { + "type": "integer", + "description": "Number of characters in the device flow user code, excluding the formatting separator. Shorter codes are easier to type but weaker; pair short codes with short expiry. Leave empty to use default 8.", + "x-example": 6, + "format": "int32", + "x-nullable": true + }, + "userCodeFormat": { + "type": "string", + "description": "Character set for device flow user codes: `numeric` (digits only \u2014 best for numeric keypads and TV remotes), `alphabetic` (letters only), or `alphanumeric` (letters and digits \u2014 highest entropy per character). Defaults to `alphanumeric`.", + "default": "alphanumeric", + "x-example": "numeric" + }, + "deviceCodeDuration": { + "type": "integer", + "description": "Lifetime in seconds of device flow device codes and user codes. Device codes are intentionally short-lived. Leave empty to use default 600.", + "x-example": 60, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "enabled", + "authorizationUrl" + ] + } + } + } + } + } + }, "\/project\/oauth2\/amazon": { "patch": { "summary": "Update project OAuth2 Amazon", @@ -34783,7 +36780,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -34951,7 +36951,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -35119,7 +37122,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -35287,7 +37293,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -35455,7 +37464,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -36083,6 +38095,11 @@ "type": "boolean", "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", "x-example": false + }, + "userAccessedAt": { + "type": "boolean", + "description": "Set to true if you want make user last access time visible to all team members, or false to hide it.", + "x-example": false } } } @@ -36309,6 +38326,96 @@ } } }, + "\/project\/policies\/password-strength": { + "patch": { + "summary": "Update password strength policy", + "operationId": "projectUpdatePasswordStrengthPolicy", + "tags": [ + "project" + ], + "description": "Update the password strength requirements for users in the project.", + "responses": { + "200": { + "description": "Policy Password Strength", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/policyPasswordStrength" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePasswordStrengthPolicy", + "group": "policies", + "cookies": false, + "type": "", + "demo": "project\/update-password-strength-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "description": "Minimum password length. Value must be between 8 and 256. Default is 8.", + "x-example": 8, + "format": "int32" + }, + "uppercase": { + "type": "boolean", + "description": "Whether passwords must include at least one uppercase letter.", + "x-example": false + }, + "lowercase": { + "type": "boolean", + "description": "Whether passwords must include at least one lowercase letter.", + "x-example": false + }, + "number": { + "type": "boolean", + "description": "Whether passwords must include at least one number.", + "x-example": false + }, + "symbols": { + "type": "boolean", + "description": "Whether passwords must include at least one symbol.", + "x-example": false + } + } + } + } + } + } + } + }, "\/project\/policies\/session-alert": { "patch": { "summary": "Update session alert policy", @@ -36684,7 +38791,7 @@ "description": "Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.", "responses": { "200": { - "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy", + "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Strength, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy, or Policy Deny Aliased Email, or Policy Deny Disposable Email, or Policy Deny Free Email", "content": { "application\/json": { "schema": { @@ -36695,6 +38802,9 @@ { "$ref": "#\/components\/schemas\/policyPasswordHistory" }, + { + "$ref": "#\/components\/schemas\/policyPasswordStrength" + }, { "$ref": "#\/components\/schemas\/policyPasswordPersonalData" }, @@ -36715,6 +38825,15 @@ }, { "$ref": "#\/components\/schemas\/policyMembershipPrivacy" + }, + { + "$ref": "#\/components\/schemas\/policyDenyAliasedEmail" + }, + { + "$ref": "#\/components\/schemas\/policyDenyDisposableEmail" + }, + { + "$ref": "#\/components\/schemas\/policyDenyFreeEmail" } ], "discriminator": { @@ -36722,13 +38841,17 @@ "mapping": { "password-dictionary": "#\/components\/schemas\/policyPasswordDictionary", "password-history": "#\/components\/schemas\/policyPasswordHistory", + "password-strength": "#\/components\/schemas\/policyPasswordStrength", "password-personal-data": "#\/components\/schemas\/policyPasswordPersonalData", "session-alert": "#\/components\/schemas\/policySessionAlert", "session-duration": "#\/components\/schemas\/policySessionDuration", "session-invalidation": "#\/components\/schemas\/policySessionInvalidation", "session-limit": "#\/components\/schemas\/policySessionLimit", "user-limit": "#\/components\/schemas\/policyUserLimit", - "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy" + "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy", + "deny-aliased-email": "#\/components\/schemas\/policyDenyAliasedEmail", + "deny-disposable-email": "#\/components\/schemas\/policyDenyDisposableEmail", + "deny-free-email": "#\/components\/schemas\/policyDenyFreeEmail" } } } @@ -36770,7 +38893,7 @@ "parameters": [ { "name": "policyId", - "description": "Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.", + "description": "Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, deny-aliased-email, deny-disposable-email, deny-free-email.", "required": true, "schema": { "type": "string", @@ -36778,13 +38901,17 @@ "enum": [ "password-dictionary", "password-history", + "password-strength", "password-personal-data", "session-alert", "session-duration", "session-invalidation", "session-limit", "user-limit", - "membership-privacy" + "membership-privacy", + "deny-aliased-email", + "deny-disposable-email", + "deny-free-email" ], "x-enum-name": "ProjectPolicyId" }, @@ -36931,7 +39058,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, documentsDB, tablesDB, vectorsDB, locale, health, project, storage, teams, users, vcs, webhooks, tokens, presences, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "schema": { "type": "string", @@ -36941,6 +39068,9 @@ "avatars", "databases", "tablesdb", + "documentsDB", + "tablesDB", + "vectorsDB", "locale", "health", "project", @@ -36948,6 +39078,9 @@ "teams", "users", "vcs", + "webhooks", + "tokens", + "presences", "sites", "functions", "proxy", @@ -37058,7 +39191,8 @@ "password": { "type": "string", "description": "SMTP server password. Pass an empty string to clear a previously set value. This property is stored securely and cannot be read in future (write-only).", - "x-example": "<PASSWORD>", + "x-example": "password", + "format": "password", "x-nullable": true }, "senderEmail": { @@ -37853,7 +39987,10 @@ "variableId": { "type": "string", "description": "Variable unique 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -38315,7 +40452,7 @@ }, "\/proxy\/rules\/redirect": { "post": { - "summary": "Create Redirect rule", + "summary": "Create redirect rule", "operationId": "proxyCreateRedirectRule", "tags": [ "proxy" @@ -38388,7 +40525,7 @@ "307", "308" ], - "x-enum-name": "RedirectStatusCode", + "x-enum-name": "StatusCode", "x-enum-keys": [ "MovedPermanently", "Found", @@ -39183,7 +41320,10 @@ "siteId": { "type": "string", "description": "Site 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.", - "x-example": "<SITE_ID>" + "x-example": "<SITE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -39211,7 +41351,7 @@ "vite", "other" ], - "x-enum-name": "SiteFramework" + "x-enum-name": "Framework" }, "enabled": { "type": "boolean", @@ -39356,7 +41496,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "SiteBuildRuntime" + "x-enum-name": "BuildRuntime" }, "adapter": { "type": "string", @@ -39366,7 +41506,7 @@ "static", "ssr" ], - "x-enum-name": "SiteAdapter" + "x-enum-name": "Adapter" }, "installationId": { "type": "string", @@ -39706,7 +41846,7 @@ "vite", "other" ], - "x-enum-name": "SiteFramework" + "x-enum-name": "Framework" }, "enabled": { "type": "boolean", @@ -39851,7 +41991,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "SiteBuildRuntime" + "x-enum-name": "BuildRuntime" }, "adapter": { "type": "string", @@ -39861,7 +42001,7 @@ "static", "ssr" ], - "x-enum-name": "SiteAdapter" + "x-enum-name": "Adapter" }, "fallbackFile": { "type": "string", @@ -40747,14 +42887,16 @@ "public": true, "auth": { "Project": [], - "Key": [] + "Key": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -41243,7 +43385,10 @@ "variableId": { "type": "string", "description": "Variable 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -41651,7 +43796,10 @@ "bucketId": { "type": "string", "description": "Unique 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.", - "x-example": "<BUCKET_ID>" + "x-example": "<BUCKET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -42175,7 +44323,10 @@ "type": "string", "description": "File 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.", "x-example": "<FILE_ID>", - "x-upload-id": true + "x-upload-id": true, + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "file": { "type": "string", @@ -42483,7 +44634,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -42491,7 +44643,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -42564,7 +44717,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -42572,7 +44726,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -42792,7 +44947,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -42800,7 +44956,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -42982,7 +45139,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -43837,7 +45997,10 @@ "tableId": { "type": "string", "description": "Unique 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.", - "x-example": "<TABLE_ID>" + "x-example": "<TABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -44872,7 +47035,7 @@ }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { "patch": { - "summary": "Update dateTime column", + "summary": "Update datetime column", "operationId": "tablesDBUpdateDatetimeColumn", "tags": [ "tablesDB" @@ -49616,7 +51779,10 @@ "type": "string", "description": "Row 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.", "default": "", - "x-example": "<ROW_ID>" + "x-example": "<ROW_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -50890,7 +53056,10 @@ "teamId": { "type": "string", "description": "Team 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.", - "x-example": "<TEAM_ID>" + "x-example": "<TEAM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -52512,7 +54681,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -52532,7 +54704,8 @@ "type": "string", "description": "Plain text user password. Must be at least 8 chars.", "default": "", - "x-example": null + "x-example": "password", + "format": "password" }, "name": { "type": "string", @@ -52608,7 +54781,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -52698,7 +54874,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -52932,7 +55111,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -53022,7 +55204,10 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. 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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -53112,7 +55297,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -53236,7 +55424,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -53344,7 +55535,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -54940,7 +57134,8 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": null + "x-example": "password", + "format": "password" } }, "required": [ @@ -55312,6 +57507,9 @@ "required": true, "schema": { "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<USER_ID>" }, "in": "path" @@ -55682,7 +57880,10 @@ "targetId": { "type": "string", "description": "Target 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.", - "x-example": "<TARGET_ID>" + "x-example": "<TARGET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "providerType": { "type": "string", @@ -56346,7 +58547,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -56358,6 +58562,12 @@ "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "specification": { + "type": "string", + "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", + "default": "free", + "x-example": "<SPECIFICATION>" } }, "required": [ @@ -56372,7 +58582,7 @@ }, "\/vectorsdb\/embeddings\/text": { "post": { - "summary": "Create Text Embeddings", + "summary": "Create text embeddings", "operationId": "vectorsDBCreateTextEmbeddings", "tags": [ "vectorsDB" @@ -56465,10 +58675,13 @@ "model": { "type": "string", "description": "The embedding model to use for generating vector embeddings.", - "default": "embeddinggemma", - "x-example": "embeddinggemma", + "default": "nomic-embed-text", + "x-example": "nomic-embed-text", "enum": [ - "embeddinggemma" + "nomic-embed-text", + "embedding-gemma", + "all-minilm", + "bge-small" ], "x-enum-name": "EmbeddingModel" } @@ -57292,7 +59505,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -57857,7 +60073,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -58442,6 +60661,9 @@ "required": true, "schema": { "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<DOCUMENT_ID>" }, "in": "path" @@ -59208,7 +61430,10 @@ "webhookId": { "type": "string", "description": "Webhook 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.", - "x-example": "<WEBHOOK_ID>" + "x-example": "<WEBHOOK_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "url": { "type": "string", @@ -59250,7 +61475,8 @@ "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_PASSWORD>" + "x-example": "password", + "format": "password" }, "secret": { "type": "string", @@ -59437,7 +61663,8 @@ "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_PASSWORD>" + "x-example": "password", + "format": "password" } }, "required": [ @@ -59601,6 +61828,18 @@ "name": "tablesdb", "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" }, + { + "name": "documentsDB", + "description": "The DocumentsDB service allows you to create structured collections of documents, query and filter lists of documents." + }, + { + "name": "tablesDB", + "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows." + }, + { + "name": "vectorsDB", + "description": "The VectorsDB service allows you to create vector collections, embeddings, indexes, and documents." + }, { "name": "locale", "description": "The Locale service allows you to customize your app based on your users' location." @@ -59629,6 +61868,18 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, + { + "name": "webhooks", + "description": "The Webhooks service allows you to configure event-driven HTTP callbacks for your project." + }, + { + "name": "tokens", + "description": "The Tokens service allows you to create and manage resource tokens for project resources." + }, + { + "name": "presences", + "description": "The Presences service allows you to create, query, and manage realtime presence state." + }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -59649,6 +61900,10 @@ "name": "console", "description": "The Console service allows you to interact with console relevant information." }, + { + "name": "organization", + "description": "The Organization service allows you to manage organization-level projects." + }, { "name": "migrations", "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." @@ -60639,7 +62894,7 @@ "total": { "type": "integer", "description": "Total number of policies in the given project.", - "x-example": 9, + "x-example": 10, "format": "int32" }, "policies": { @@ -60653,6 +62908,9 @@ { "$ref": "#\/components\/schemas\/policyPasswordHistory" }, + { + "$ref": "#\/components\/schemas\/policyPasswordStrength" + }, { "$ref": "#\/components\/schemas\/policyPasswordPersonalData" }, @@ -60673,6 +62931,15 @@ }, { "$ref": "#\/components\/schemas\/policyMembershipPrivacy" + }, + { + "$ref": "#\/components\/schemas\/policyDenyAliasedEmail" + }, + { + "$ref": "#\/components\/schemas\/policyDenyDisposableEmail" + }, + { + "$ref": "#\/components\/schemas\/policyDenyFreeEmail" } ], "discriminator": { @@ -60680,13 +62947,17 @@ "mapping": { "password-dictionary": "#\/components\/schemas\/policyPasswordDictionary", "password-history": "#\/components\/schemas\/policyPasswordHistory", + "password-strength": "#\/components\/schemas\/policyPasswordStrength", "password-personal-data": "#\/components\/schemas\/policyPasswordPersonalData", "session-alert": "#\/components\/schemas\/policySessionAlert", "session-duration": "#\/components\/schemas\/policySessionDuration", "session-invalidation": "#\/components\/schemas\/policySessionInvalidation", "session-limit": "#\/components\/schemas\/policySessionLimit", "user-limit": "#\/components\/schemas\/policyUserLimit", - "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy" + "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy", + "deny-aliased-email": "#\/components\/schemas\/policyDenyAliasedEmail", + "deny-disposable-email": "#\/components\/schemas\/policyDenyDisposableEmail", + "deny-free-email": "#\/components\/schemas\/policyDenyFreeEmail" } } }, @@ -60698,7 +62969,7 @@ "policies" ], "example": { - "total": 9, + "total": 10, "policies": "" } }, @@ -61207,7 +63478,7 @@ "model": { "type": "string", "description": "Embedding model used to generate embeddings.", - "x-example": "embeddinggemma" + "x-example": "nomic-embed-text" }, "dimension": { "type": "integer", @@ -61241,7 +63512,7 @@ "error" ], "example": { - "model": "embeddinggemma", + "model": "nomic-embed-text", "dimension": 768, "embedding": [ 0.01, @@ -66475,6 +68746,36 @@ "description": "Email verification status.", "x-example": true }, + "emailCanonical": { + "type": "string", + "description": "Canonical form of the user email address.", + "x-example": "john@appwrite.io", + "nullable": true + }, + "emailIsFree": { + "type": "boolean", + "description": "Whether the user email is from a free email provider.", + "x-example": true, + "nullable": true + }, + "emailIsDisposable": { + "type": "boolean", + "description": "Whether the user email is from a disposable email provider.", + "x-example": false, + "nullable": true + }, + "emailIsCorporate": { + "type": "boolean", + "description": "Whether the user email is from a corporate domain.", + "x-example": true, + "nullable": true + }, + "emailIsCanonical": { + "type": "boolean", + "description": "Whether the user email is in its canonical form.", + "x-example": true, + "nullable": true + }, "phoneVerification": { "type": "boolean", "description": "Phone verification status.", @@ -66557,6 +68858,11 @@ "email": "john@appwrite.io", "phone": "+4930901820", "emailVerification": true, + "emailCanonical": "john@appwrite.io", + "emailIsFree": true, + "emailIsDisposable": false, + "emailIsCorporate": true, + "emailIsCanonical": true, "phoneVerification": true, "mfa": true, "prefs": { @@ -67662,6 +69968,11 @@ "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", "x-example": false }, + "userAccessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, "roles": { "type": "array", "description": "User list of roles", @@ -67687,6 +69998,7 @@ "joined", "confirm", "mfa", + "userAccessedAt", "roles" ], "example": { @@ -67703,6 +70015,7 @@ "joined": "2020-10-15T06:38:00.000+00:00", "confirm": false, "mfa": false, + "userAccessedAt": "2020-10-15T06:38:00.000+00:00", "roles": [ "owner" ] @@ -68851,6 +71164,11 @@ "description": "Project team ID.", "x-example": "1592981250" }, + "region": { + "type": "string", + "description": "Project region", + "x-example": "fra" + }, "devKeys": { "type": "array", "description": "Deprecated since 1.9.5: List of dev keys.", @@ -68903,7 +71221,8 @@ "smtpPassword": { "type": "string", "description": "SMTP server password. This property is write-only and always returned empty.", - "x-example": "" + "x-example": "smtp-password", + "format": "password" }, "smtpSecure": { "type": "string", @@ -68960,10 +71279,18 @@ }, "x-example": {} }, - "region": { + "blocks": { + "type": "array", + "description": "Project blocks information", + "items": { + "$ref": "#\/components\/schemas\/block" + }, + "x-example": "" + }, + "consoleAccessedAt": { "type": "string", - "description": "Project region", - "x-example": "fra" + "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, "billingLimits": { "type": "object", @@ -68974,18 +71301,92 @@ }, "nullable": true }, - "blocks": { + "oAuth2ServerEnabled": { + "type": "boolean", + "description": "OAuth2 server status", + "x-example": false + }, + "oAuth2ServerAuthorizationUrl": { + "type": "string", + "description": "OAuth2 server authorization URL", + "x-example": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration" + }, + "oAuth2ServerScopes": { "type": "array", - "description": "Project blocks information", + "description": "OAuth2 server allowed scopes", "items": { - "$ref": "#\/components\/schemas\/block" + "type": "string" }, - "x-example": "" + "x-example": [ + "read", + "write" + ] }, - "consoleAccessedAt": { + "oAuth2ServerAuthorizationDetailsTypes": { + "type": "array", + "description": "OAuth2 server accepted RFC 9396 authorization_details types", + "items": { + "type": "string" + }, + "x-example": [ + "calendar" + ] + }, + "oAuth2ServerAccessTokenDuration": { + "type": "integer", + "description": "OAuth2 server access token duration in seconds for confidential clients", + "x-example": 3600, + "format": "int32" + }, + "oAuth2ServerRefreshTokenDuration": { + "type": "integer", + "description": "OAuth2 server refresh token duration in seconds for confidential clients", + "x-example": 86400, + "format": "int32" + }, + "oAuth2ServerPublicAccessTokenDuration": { + "type": "integer", + "description": "OAuth2 server access token duration in seconds for public clients (SPAs, mobile, native)", + "x-example": 3600, + "format": "int32" + }, + "oAuth2ServerPublicRefreshTokenDuration": { + "type": "integer", + "description": "OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)", + "x-example": 2592000, + "format": "int32" + }, + "oAuth2ServerConfidentialPkce": { + "type": "boolean", + "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", + "x-example": false + }, + "oAuth2ServerVerificationUrl": { "type": "string", - "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "URL to your application page where users enter the device flow user code. Empty when the Device Authorization Grant is not configured.", + "x-example": "https:\/\/cloud.appwrite.io\/device" + }, + "oAuth2ServerUserCodeLength": { + "type": "integer", + "description": "Number of characters in the device flow user code, excluding the formatting separator.", + "x-example": 8, + "format": "int32" + }, + "oAuth2ServerUserCodeFormat": { + "type": "string", + "description": "Character set for device flow user codes: `numeric`, `alphabetic`, or `alphanumeric`.", + "x-example": "alphanumeric" + }, + "oAuth2ServerDeviceCodeDuration": { + "type": "integer", + "description": "Lifetime in seconds of device flow device codes and user codes.", + "x-example": 600, + "format": "int32" + }, + "oAuth2ServerDiscoveryUrl": { + "type": "string", + "description": "OAuth2 server discovery URL", + "x-example": "https:\/\/auth.example.com\/.well-known\/openid-configuration" } }, "required": [ @@ -68994,6 +71395,7 @@ "$updatedAt", "name", "teamId", + "region", "devKeys", "smtpEnabled", "smtpSenderName", @@ -69012,9 +71414,22 @@ "authMethods", "services", "protocols", - "region", "blocks", - "consoleAccessedAt" + "consoleAccessedAt", + "oAuth2ServerEnabled", + "oAuth2ServerAuthorizationUrl", + "oAuth2ServerScopes", + "oAuth2ServerAuthorizationDetailsTypes", + "oAuth2ServerAccessTokenDuration", + "oAuth2ServerRefreshTokenDuration", + "oAuth2ServerPublicAccessTokenDuration", + "oAuth2ServerPublicRefreshTokenDuration", + "oAuth2ServerConfidentialPkce", + "oAuth2ServerVerificationUrl", + "oAuth2ServerUserCodeLength", + "oAuth2ServerUserCodeFormat", + "oAuth2ServerDeviceCodeDuration", + "oAuth2ServerDiscoveryUrl" ], "example": { "$id": "5e5ea5c16897e", @@ -69022,6 +71437,7 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "New Project", "teamId": "1592981250", + "region": "fra", "devKeys": {}, "smtpEnabled": false, "smtpSenderName": "John Appwrite", @@ -69031,7 +71447,7 @@ "smtpHost": "mail.appwrite.io", "smtpPort": 25, "smtpUsername": "emailuser", - "smtpPassword": "", + "smtpPassword": "smtp-password", "smtpSecure": "tls", "pingCount": 1, "pingedAt": "2020-10-15T06:38:00.000+00:00", @@ -69042,10 +71458,28 @@ "authMethods": {}, "services": {}, "protocols": {}, - "region": "fra", - "billingLimits": "", "blocks": "", - "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00", + "billingLimits": "", + "oAuth2ServerEnabled": false, + "oAuth2ServerAuthorizationUrl": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration", + "oAuth2ServerScopes": [ + "read", + "write" + ], + "oAuth2ServerAuthorizationDetailsTypes": [ + "calendar" + ], + "oAuth2ServerAccessTokenDuration": 3600, + "oAuth2ServerRefreshTokenDuration": 86400, + "oAuth2ServerPublicAccessTokenDuration": 3600, + "oAuth2ServerPublicRefreshTokenDuration": 2592000, + "oAuth2ServerConfidentialPkce": false, + "oAuth2ServerVerificationUrl": "https:\/\/cloud.appwrite.io\/device", + "oAuth2ServerUserCodeLength": 8, + "oAuth2ServerUserCodeFormat": "alphanumeric", + "oAuth2ServerDeviceCodeDuration": 600, + "oAuth2ServerDiscoveryUrl": "https:\/\/auth.example.com\/.well-known\/openid-configuration" } }, "projectAuthMethod": { @@ -69095,6 +71529,9 @@ "avatars", "databases", "tablesdb", + "documentsDB", + "tablesDB", + "vectorsDB", "locale", "health", "project", @@ -69102,6 +71539,9 @@ "teams", "users", "vcs", + "webhooks", + "tokens", + "presences", "sites", "functions", "proxy", @@ -69210,7 +71650,8 @@ "authPassword": { "type": "string", "description": "HTTP basic authentication password.", - "x-example": "password" + "x-example": "webhook-password", + "format": "password" }, "secret": { "type": "string", @@ -69261,7 +71702,7 @@ ], "tls": true, "authUsername": "username", - "authPassword": "password", + "authPassword": "webhook-password", "secret": "ad3d581ca230e2b7059c545e5a", "enabled": true, "logs": "Failed to connect to remote server.", @@ -71422,6 +73863,59 @@ "total": 5 } }, + "policyPasswordStrength": { + "description": "Policy Password Strength", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "min": { + "type": "integer", + "description": "Minimum password length required for user passwords.", + "x-example": 12, + "format": "int32" + }, + "uppercase": { + "type": "boolean", + "description": "Whether passwords must include at least one uppercase letter.", + "x-example": true + }, + "lowercase": { + "type": "boolean", + "description": "Whether passwords must include at least one lowercase letter.", + "x-example": true + }, + "number": { + "type": "boolean", + "description": "Whether passwords must include at least one number.", + "x-example": true + }, + "symbols": { + "type": "boolean", + "description": "Whether passwords must include at least one symbol.", + "x-example": true + } + }, + "required": [ + "$id", + "min", + "uppercase", + "lowercase", + "number", + "symbols" + ], + "example": { + "$id": "password-dictionary", + "min": 12, + "uppercase": true, + "lowercase": true, + "number": true, + "symbols": true + } + }, "policyPasswordPersonalData": { "description": "Policy Password Personal Data", "type": "object", @@ -71602,6 +74096,11 @@ "type": "boolean", "description": "Whether user MFA status is visible in memberships.", "x-example": true + }, + "userAccessedAt": { + "type": "boolean", + "description": "Whether user last access time is visible in memberships.", + "x-example": true } }, "required": [ @@ -71610,7 +74109,8 @@ "userEmail", "userPhone", "userName", - "userMFA" + "userMFA", + "userAccessedAt" ], "example": { "$id": "password-dictionary", @@ -71618,7 +74118,8 @@ "userEmail": true, "userPhone": true, "userName": true, - "userMFA": true + "userMFA": true, + "userAccessedAt": true } }, "platformWeb": { @@ -73666,66 +76167,6 @@ "description": "Hostname.", "x-example": "appwrite.io" }, - "osCode": { - "type": "string", - "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" - }, - "osName": { - "type": "string", - "description": "Operating system name.", - "x-example": "Mac" - }, - "osVersion": { - "type": "string", - "description": "Operating system version.", - "x-example": "Mac" - }, - "clientType": { - "type": "string", - "description": "Client type.", - "x-example": "browser" - }, - "clientCode": { - "type": "string", - "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" - }, - "clientName": { - "type": "string", - "description": "Client name.", - "x-example": "Chrome Mobile iOS" - }, - "clientVersion": { - "type": "string", - "description": "Client version.", - "x-example": "84.0" - }, - "clientEngine": { - "type": "string", - "description": "Client engine name.", - "x-example": "WebKit" - }, - "clientEngineVersion": { - "type": "string", - "description": "Client engine name.", - "x-example": "605.1.15" - }, - "deviceName": { - "type": "string", - "description": "Device name.", - "x-example": "smartphone" - }, - "deviceBrand": { - "type": "string", - "description": "Device brand name.", - "x-example": "Google" - }, - "deviceModel": { - "type": "string", - "description": "Device model name.", - "x-example": "Nexus 5" - }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", @@ -73756,18 +76197,6 @@ "projectId", "teamId", "hostname", - "osCode", - "osName", - "osVersion", - "clientType", - "clientCode", - "clientName", - "clientVersion", - "clientEngine", - "clientEngineVersion", - "deviceName", - "deviceBrand", - "deviceModel", "countryCode", "countryName" ], @@ -73790,18 +76219,6 @@ "projectId": "610fc2f985ee0", "teamId": "610fc2f985ee0", "hostname": "appwrite.io", - "osCode": "Mac", - "osName": "Mac", - "osVersion": "Mac", - "clientType": "browser", - "clientCode": "CM", - "clientName": "Chrome Mobile iOS", - "clientVersion": "84.0", - "clientEngine": "WebKit", - "clientEngineVersion": "605.1.15", - "deviceName": "smartphone", - "deviceBrand": "Google", - "deviceModel": "Nexus 5", "countryCode": "US", "countryName": "United States" } @@ -74153,6 +76570,78 @@ "enabled": true } }, + "policyDenyAliasedEmail": { + "description": "Policy Deny Aliased Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny aliased email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policyDenyDisposableEmail": { + "description": "Policy Deny Disposable Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny disposable email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policyDenyFreeEmail": { + "description": "Policy Deny Free Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny free email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, "backupRestoration": { "description": "Restoration", "type": "object", @@ -74373,6 +76862,406 @@ "resourceId": "production" } }, + "app": { + "description": "App", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "App ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "App creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "App update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "My Application" + }, + "redirectUris": { + "type": "array", + "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", + "items": { + "type": "string" + }, + "x-example": [ + "https:\/\/example.com\/callback" + ] + }, + "enabled": { + "type": "boolean", + "description": "Whether the app is enabled or not.", + "x-example": true + }, + "type": { + "type": "string", + "description": "OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot keep a client secret (PKCE required); `confidential` for server-side clients that authenticate with a client secret.", + "x-example": "confidential" + }, + "deviceFlow": { + "type": "boolean", + "description": "Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).", + "x-example": false + }, + "teamId": { + "type": "string", + "description": "ID of team that owns the application, if owned by team. Otherwise, user ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "userId": { + "type": "string", + "description": "ID of user who owns the application, if owned by user. Otherwise, team ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "secrets": { + "type": "array", + "description": "List of application secrets.", + "items": { + "$ref": "#\/components\/schemas\/appSecret" + }, + "x-example": [] + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "redirectUris", + "enabled", + "type", + "deviceFlow", + "teamId", + "userId", + "secrets" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Application", + "redirectUris": [ + "https:\/\/example.com\/callback" + ], + "enabled": true, + "type": "confidential", + "deviceFlow": false, + "teamId": "5e5ea5c16897e", + "userId": "5e5ea5c16897e", + "secrets": [] + } + }, + "appSecret": { + "description": "AppSecret", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Secret creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Secret update time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" + }, + "secret": { + "type": "string", + "description": "Hashed application client secret.", + "x-example": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg" + }, + "hint": { + "type": "string", + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" + }, + "createdById": { + "type": "string", + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" + }, + "createdByName": { + "type": "string", + "description": "Name of the user who created the secret.", + "x-example": "Walter White" + }, + "lastAccessedAt": { + "type": "string", + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "secret", + "hint", + "createdById", + "createdByName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "secret": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, + "appSecretPlaintext": { + "description": "AppSecretPlaintext", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Secret creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Secret update time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" + }, + "secret": { + "type": "string", + "description": "Application client secret. Returned in full only when the secret is created; subsequent reads return a masked value.", + "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + }, + "hint": { + "type": "string", + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" + }, + "createdById": { + "type": "string", + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" + }, + "createdByName": { + "type": "string", + "description": "Name of the user who created the secret.", + "x-example": "Walter White" + }, + "lastAccessedAt": { + "type": "string", + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "secret", + "hint", + "createdById", + "createdByName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "secret": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, + "oauth2Authorize": { + "description": "OAuth2 Authorize", + "type": "object", + "properties": { + "grantId": { + "type": "string", + "description": "OAuth2 grant ID. Set when the user must give explicit consent; pass it to the approve or reject endpoint. Empty when a redirect URL is returned instead.", + "x-example": "5e5ea5c16897e" + }, + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to when the flow can complete without consent. Empty when consent is still required.", + "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "required": [ + "grantId", + "redirectUrl" + ], + "example": { + "grantId": "5e5ea5c16897e", + "redirectUrl": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "oauth2Approve": { + "description": "OAuth2 Approve", + "type": "object", + "properties": { + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to after the grant is approved, carrying the authorization `code` and\/or `id_token` along with the original `state`.", + "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "required": [ + "redirectUrl" + ], + "example": { + "redirectUrl": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "oauth2Reject": { + "description": "OAuth2 Reject", + "type": "object", + "properties": { + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to after the grant is rejected, carrying an `access_denied` error.", + "x-example": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + } + }, + "required": [ + "redirectUrl" + ], + "example": { + "redirectUrl": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + } + }, + "oauth2Grant": { + "description": "OAuth2 Grant", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Grant ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Grant creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Grant update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "userId": { + "type": "string", + "description": "ID of the user the grant belongs to.", + "x-example": "5e5ea5c16897e" + }, + "appId": { + "type": "string", + "description": "ID of the OAuth2 client (app) the grant was requested for.", + "x-example": "5e5ea5c16897e" + }, + "scopes": { + "type": "array", + "description": "Requested OAuth2 scopes the user is being asked to consent to.", + "items": { + "type": "string" + }, + "x-example": [ + "openid", + "email", + "profile" + ] + }, + "authorizationDetails": { + "type": "string", + "description": "Requested authorization_details the user is being asked to consent to, as a JSON string. Each entry has a `type` plus project-defined fields.", + "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + }, + "prompt": { + "type": "string", + "description": "OIDC prompt directive the consent screen should honor. Space-separated list of: login, consent, select_account.", + "x-example": "login" + }, + "redirectUri": { + "type": "string", + "description": "Redirect URI the user will be sent to after the flow completes.", + "x-example": "https:\/\/example.com\/callback" + }, + "authTime": { + "type": "integer", + "description": "Unix timestamp of when the user last authenticated.", + "x-example": 1592981250, + "format": "int32" + }, + "expire": { + "type": "string", + "description": "Grant expiration time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "userId", + "appId", + "scopes", + "authorizationDetails", + "prompt", + "redirectUri", + "authTime", + "expire" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "userId": "5e5ea5c16897e", + "appId": "5e5ea5c16897e", + "scopes": [ + "openid", + "email", + "profile" + ], + "authorizationDetails": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]", + "prompt": "login", + "redirectUri": "https:\/\/example.com\/callback", + "authTime": 1592981250, + "expire": "2020-10-15T06:38:00.000+00:00" + } + }, "activityEventList": { "description": "Activity event list", "type": "object", @@ -74540,6 +77429,62 @@ "total": 5, "gauges": "" } + }, + "appsList": { + "description": "Apps list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of apps that matched your query.", + "x-example": 5, + "format": "int32" + }, + "apps": { + "type": "array", + "description": "List of apps.", + "items": { + "$ref": "#\/components\/schemas\/app" + }, + "x-example": "" + } + }, + "required": [ + "total", + "apps" + ], + "example": { + "total": 5, + "apps": "" + } + }, + "appSecretList": { + "description": "App secrets list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of secrets that matched your query.", + "x-example": 5, + "format": "int32" + }, + "secrets": { + "type": "array", + "description": "List of secrets.", + "items": { + "$ref": "#\/components\/schemas\/appSecret" + }, + "x-example": "" + } + }, + "required": [ + "total", + "secrets" + ], + "example": { + "total": 5, + "secrets": "" + } } }, "securitySchemes": { @@ -74552,6 +77497,15 @@ "demo": "<YOUR_PROJECT_ID>" } }, + "ProjectQuery": { + "type": "apiKey", + "name": "project", + "description": "Your project ID", + "in": "query", + "x-appwrite": { + "demo": "<YOUR_PROJECT_ID>" + } + }, "Key": { "type": "apiKey", "name": "X-Appwrite-Key", diff --git a/specs/1.9.x/swagger2-1.9.x-client.json b/specs/1.9.x/swagger2-1.9.x-client.json index afa1607e6..1c5f702b6 100644 --- a/specs/1.9.x/swagger2-1.9.x-client.json +++ b/specs/1.9.x/swagger2-1.9.x-client.json @@ -38,6 +38,15 @@ "demo": "<YOUR_PROJECT_ID>" } }, + "ProjectQuery": { + "type": "apiKey", + "name": "project", + "description": "Your project ID", + "in": "query", + "x-appwrite": { + "demo": "<YOUR_PROJECT_ID>" + } + }, "JWT": { "type": "apiKey", "name": "X-Appwrite-JWT", @@ -206,7 +215,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -217,7 +229,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "name": { "type": "string", @@ -1876,11 +1889,12 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "oldPassword": { "type": "string", - "description": "Current user password. Must be at least 8 chars.", + "description": "Current user password. Max length: 256 chars.", "default": "", "x-example": "password", "format": "password" @@ -2253,7 +2267,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" } }, "required": [ @@ -2566,7 +2581,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -2831,7 +2849,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -2910,7 +2931,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -3222,7 +3246,10 @@ "targetId": { "type": "string", "description": "Target 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.", - "x-example": "<TARGET_ID>" + "x-example": "<TARGET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "identifier": { "type": "string", @@ -3444,7 +3471,10 @@ "userId": { "type": "string", "description": "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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -3533,7 +3563,10 @@ "userId": { "type": "string", "description": "Unique 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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -3811,7 +3844,10 @@ "userId": { "type": "string", "description": "Unique 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. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "phone": { "type": "string", @@ -4222,37 +4258,37 @@ ] } }, - "\/avatars\/browsers\/{code}": { + "\/apps": { "get": { - "summary": "Get browser icon", - "operationId": "avatarsGetBrowser", + "summary": "List Applications", + "operationId": "appsList", "consumes": [], "produces": [ - "image\/png" + "application\/json" ], "tags": [ - "avatars" + "apps" ], - "description": "You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.", + "description": "List applications.", "responses": { "200": { - "description": "Image", + "description": "Apps list", "schema": { - "type": "file" + "$ref": "#\/definitions\/appsList" } } }, "deprecated": false, "x-appwrite": { - "method": "getBrowser", + "method": "list", "group": null, "cookies": false, - "type": "location", - "demo": "avatars\/get-browser.md", + "type": "", + "demo": "apps\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "avatars.read", + "scope": "apps.read", "platforms": [ "console", "client", @@ -4260,7 +4296,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md", "auth": { "Project": [] } @@ -4274,110 +4309,172 @@ ], "parameters": [ { - "name": "code", - "description": "Browser Code.", - "required": true, - "type": "string", - "x-example": "aa", - "enum": [ - "aa", - "an", - "ch", - "ci", - "cm", - "cr", - "ff", - "sf", - "mf", - "ps", - "oi", - "om", - "op", - "on" - ], - "x-enum-name": "Browser", - "x-enum-keys": [ - "Avant Browser", - "Android WebView Beta", - "Google Chrome", - "Google Chrome (iOS)", - "Google Chrome (Mobile)", - "Chromium", - "Mozilla Firefox", - "Safari", - "Mobile Safari", - "Microsoft Edge", - "Microsoft Edge (iOS)", - "Opera Mini", - "Opera", - "Opera (Next)" - ], - "in": "path" - }, - { - "name": "width", - "description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.", + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 100, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], "in": "query" }, { - "name": "height", - "description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 100, + "type": "boolean", + "x-example": false, + "default": true, "in": "query" - }, + } + ] + }, + "post": { + "summary": "Create Application", + "operationId": "appsCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Create a new application.", + "responses": { + "201": { + "description": "App", + "schema": { + "$ref": "#\/definitions\/app" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": -1, - "default": -1, - "in": "query" + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "appId": { + "type": "string", + "description": "Application 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.", + "x-example": "<APP_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + }, + "teamId": { + "type": "string", + "description": "Team unique ID.", + "default": "", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "appId", + "name", + "redirectUris" + ] + } } ] } }, - "\/avatars\/credit-cards\/{code}": { + "\/apps\/{appId}": { "get": { - "summary": "Get credit card icon", - "operationId": "avatarsGetCreditCard", + "summary": "Get Application", + "operationId": "appsGet", "consumes": [], "produces": [ - "image\/png" + "application\/json" ], "tags": [ - "avatars" + "apps" ], - "description": "The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", + "description": "Get an application by its unique ID.", "responses": { "200": { - "description": "Image", + "description": "App", "schema": { - "type": "file" + "$ref": "#\/definitions\/app" } } }, "deprecated": false, "x-appwrite": { - "method": "getCreditCard", + "method": "get", "group": null, "cookies": false, - "type": "location", - "demo": "avatars\/get-credit-card.md", + "type": "", + "demo": "apps\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "avatars.read", + "scope": "apps.read", "platforms": [ "console", "client", @@ -4385,7 +4482,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md", "auth": { "Project": [] } @@ -4399,116 +4495,210 @@ ], "parameters": [ { - "name": "code", - "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.", + "name": "appId", + "description": "Application unique ID.", "required": true, "type": "string", - "x-example": "amex", - "enum": [ - "amex", - "argencard", - "cabal", - "cencosud", - "diners", - "discover", - "elo", - "hipercard", - "jcb", - "mastercard", - "naranja", - "targeta-shopping", - "unionpay", - "visa", - "mir", - "maestro", - "rupay" - ], - "x-enum-name": "CreditCard", - "x-enum-keys": [ - "American Express", - "Argencard", - "Cabal", - "Cencosud", - "Diners Club", - "Discover", - "Elo", - "Hipercard", - "JCB", - "Mastercard", - "Naranja", - "Tarjeta Shopping", - "Union Pay", - "Visa", - "MIR", - "Maestro", - "Rupay" - ], + "x-example": "<APP_ID>", "in": "path" - }, + } + ] + }, + "put": { + "summary": "Update Application", + "operationId": "appsUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Update an application by its unique ID.", + "responses": { + "200": { + "description": "App", + "schema": { + "$ref": "#\/definitions\/app" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "width", - "description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 100, - "in": "query" - }, + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ { - "name": "height", - "description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 100, - "in": "query" + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" }, { - "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": -1, - "default": -1, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete Application", + "operationId": "appsDelete", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Delete an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" } ] } }, - "\/avatars\/favicon": { + "\/apps\/{appId}\/secrets": { "get": { - "summary": "Get favicon", - "operationId": "avatarsGetFavicon", + "summary": "List Secrets", + "operationId": "appsListSecrets", "consumes": [], "produces": [ - "image\/*" + "application\/json" ], "tags": [ - "avatars" + "apps" ], - "description": "Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n\nThis endpoint does not follow HTTP redirects.", + "description": "List client secrets for an application.", "responses": { "200": { - "description": "Image", + "description": "App secrets list", "schema": { - "type": "file" + "$ref": "#\/definitions\/appSecretList" } } }, "deprecated": false, "x-appwrite": { - "method": "getFavicon", + "method": "listSecrets", "group": null, "cookies": false, - "type": "location", - "demo": "avatars\/get-favicon.md", + "type": "", + "demo": "apps\/list-secrets.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "avatars.read", + "scope": "apps.read", "platforms": [ "console", "client", @@ -4516,7 +4706,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md", "auth": { "Project": [] } @@ -4530,48 +4719,68 @@ ], "parameters": [ { - "name": "url", - "description": "Website URL which you want to fetch the favicon from.", + "name": "appId", + "description": "Application unique ID.", "required": true, "type": "string", - "format": "url", - "x-example": "https:\/\/example.com", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, "in": "query" } ] - } - }, - "\/avatars\/flags\/{code}": { - "get": { - "summary": "Get country flag", - "operationId": "avatarsGetFlag", - "consumes": [], + }, + "post": { + "summary": "Create Secret", + "operationId": "appsCreateSecret", + "consumes": [ + "application\/json" + ], "produces": [ - "image\/png" + "application\/json" ], "tags": [ - "avatars" + "apps" ], - "description": "You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", + "description": "Create a new client secret for an application.", "responses": { - "200": { - "description": "Image", + "201": { + "description": "AppSecretPlaintext", "schema": { - "type": "file" + "$ref": "#\/definitions\/appSecretPlaintext" } } }, "deprecated": false, "x-appwrite": { - "method": "getFlag", + "method": "createSecret", "group": null, "cookies": false, - "type": "location", - "demo": "avatars\/get-flag.md", + "type": "", + "demo": "apps\/create-secret.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "avatars.read", + "scope": "apps.write", "platforms": [ "console", "client", @@ -4579,7 +4788,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md", "auth": { "Project": [] } @@ -4593,41 +4801,705 @@ ], "parameters": [ { - "name": "code", - "description": "Country Code. ISO Alpha-2 country code format.", + "name": "appId", + "description": "Application unique ID.", "required": true, "type": "string", - "x-example": "af", - "enum": [ - "af", - "ao", - "al", - "ad", - "ae", - "ar", - "am", - "ag", - "au", - "at", - "az", - "bi", - "be", - "bj", - "bf", - "bd", - "bg", - "bh", - "bs", - "ba", - "by", - "bz", - "bo", - "br", - "bb", - "bn", - "bt", - "bw", - "cf", + "x-example": "<APP_ID>", + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/secrets\/{secretId}": { + "get": { + "summary": "Get Secret", + "operationId": "appsGetSecret", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Get an application client secret by its unique ID.", + "responses": { + "200": { + "description": "AppSecret", + "schema": { + "$ref": "#\/definitions\/appSecret" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/get-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "type": "string", + "x-example": "<SECRET_ID>", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete Secret", + "operationId": "appsDeleteSecret", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Delete an application client secret by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "type": "string", + "x-example": "<SECRET_ID>", + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/team": { + "patch": { + "summary": "Update Team", + "operationId": "appsUpdateTeam", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Transfer an application to another team by its unique ID.", + "responses": { + "200": { + "description": "App", + "schema": { + "$ref": "#\/definitions\/app" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTeam", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update-team.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team ID of the team to transfer application to.", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "teamId" + ] + } + } + ] + } + }, + "\/apps\/{appId}\/tokens": { + "delete": { + "summary": "Delete Tokens", + "operationId": "appsDeleteTokens", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Revoke all tokens for an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTokens", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-tokens.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + } + ] + } + }, + "\/avatars\/browsers\/{code}": { + "get": { + "summary": "Get browser icon", + "operationId": "avatarsGetBrowser", + "consumes": [], + "produces": [ + "image\/png" + ], + "tags": [ + "avatars" + ], + "description": "You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.", + "responses": { + "200": { + "description": "Image", + "schema": { + "type": "file" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getBrowser", + "group": null, + "cookies": false, + "type": "location", + "demo": "avatars\/get-browser.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "avatars.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md", + "auth": { + "Project": [], + "ImpersonateUserId": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [], + "ImpersonateUserId": [] + } + ], + "parameters": [ + { + "name": "code", + "description": "Browser Code.", + "required": true, + "type": "string", + "x-example": "aa", + "enum": [ + "aa", + "an", + "ch", + "ci", + "cm", + "cr", + "ff", + "sf", + "mf", + "ps", + "oi", + "om", + "op", + "on" + ], + "x-enum-name": "Browser", + "x-enum-keys": [ + "Avant Browser", + "Android WebView Beta", + "Google Chrome", + "Google Chrome (iOS)", + "Google Chrome (Mobile)", + "Chromium", + "Mozilla Firefox", + "Safari", + "Mobile Safari", + "Microsoft Edge", + "Microsoft Edge (iOS)", + "Opera Mini", + "Opera", + "Opera (Next)" + ], + "in": "path" + }, + { + "name": "width", + "description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 100, + "in": "query" + }, + { + "name": "height", + "description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 100, + "in": "query" + }, + { + "name": "quality", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": -1, + "default": -1, + "in": "query" + } + ] + } + }, + "\/avatars\/credit-cards\/{code}": { + "get": { + "summary": "Get credit card icon", + "operationId": "avatarsGetCreditCard", + "consumes": [], + "produces": [ + "image\/png" + ], + "tags": [ + "avatars" + ], + "description": "The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", + "responses": { + "200": { + "description": "Image", + "schema": { + "type": "file" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCreditCard", + "group": null, + "cookies": false, + "type": "location", + "demo": "avatars\/get-credit-card.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "avatars.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md", + "auth": { + "Project": [], + "ImpersonateUserId": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [], + "ImpersonateUserId": [] + } + ], + "parameters": [ + { + "name": "code", + "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.", + "required": true, + "type": "string", + "x-example": "amex", + "enum": [ + "amex", + "argencard", + "cabal", + "cencosud", + "diners", + "discover", + "elo", + "hipercard", + "jcb", + "mastercard", + "naranja", + "targeta-shopping", + "unionpay", + "visa", + "mir", + "maestro", + "rupay" + ], + "x-enum-name": "CreditCard", + "x-enum-keys": [ + "American Express", + "Argencard", + "Cabal", + "Cencosud", + "Diners Club", + "Discover", + "Elo", + "Hipercard", + "JCB", + "Mastercard", + "Naranja", + "Tarjeta Shopping", + "Union Pay", + "Visa", + "MIR", + "Maestro", + "Rupay" + ], + "in": "path" + }, + { + "name": "width", + "description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 100, + "in": "query" + }, + { + "name": "height", + "description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 100, + "in": "query" + }, + { + "name": "quality", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": -1, + "default": -1, + "in": "query" + } + ] + } + }, + "\/avatars\/favicon": { + "get": { + "summary": "Get favicon", + "operationId": "avatarsGetFavicon", + "consumes": [], + "produces": [ + "image\/*" + ], + "tags": [ + "avatars" + ], + "description": "Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n\nThis endpoint does not follow HTTP redirects.", + "responses": { + "200": { + "description": "Image", + "schema": { + "type": "file" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getFavicon", + "group": null, + "cookies": false, + "type": "location", + "demo": "avatars\/get-favicon.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "avatars.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md", + "auth": { + "Project": [], + "ImpersonateUserId": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [], + "ImpersonateUserId": [] + } + ], + "parameters": [ + { + "name": "url", + "description": "Website URL which you want to fetch the favicon from.", + "required": true, + "type": "string", + "format": "url", + "x-example": "https:\/\/example.com", + "in": "query" + } + ] + } + }, + "\/avatars\/flags\/{code}": { + "get": { + "summary": "Get country flag", + "operationId": "avatarsGetFlag", + "consumes": [], + "produces": [ + "image\/png" + ], + "tags": [ + "avatars" + ], + "description": "You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", + "responses": { + "200": { + "description": "Image", + "schema": { + "type": "file" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getFlag", + "group": null, + "cookies": false, + "type": "location", + "demo": "avatars\/get-flag.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "avatars.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md", + "auth": { + "Project": [], + "ImpersonateUserId": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [], + "ImpersonateUserId": [] + } + ], + "parameters": [ + { + "name": "code", + "description": "Country Code. ISO Alpha-2 country code format.", + "required": true, + "type": "string", + "x-example": "af", + "enum": [ + "af", + "ao", + "al", + "ad", + "ae", + "ar", + "am", + "ag", + "au", + "at", + "az", + "bi", + "be", + "bj", + "bf", + "bd", + "bg", + "bh", + "bs", + "ba", + "by", + "bz", + "bo", + "br", + "bb", + "bn", + "bt", + "bw", + "cf", "ca", "ch", "cl", @@ -5068,14 +5940,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5151,14 +6025,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5242,14 +6118,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5333,14 +6211,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-screenshot.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6666,7 +7546,149 @@ ], "description": "Update a transaction, to either commit or roll back its operations.", "responses": { - "200": { + "200": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTransaction", + "group": "transactions", + "cookies": false, + "type": "", + "demo": "databases\/update-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "<TRANSACTION_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "commit": { + "type": "boolean", + "description": "Commit transaction?", + "default": false, + "x-example": false + }, + "rollback": { + "type": "boolean", + "description": "Rollback transaction?", + "default": false, + "x-example": false + } + } + } + } + ] + }, + "delete": { + "summary": "Delete transaction", + "operationId": "databasesDeleteTransaction", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "databases" + ], + "description": "Delete a transaction by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "cookies": false, + "type": "", + "demo": "databases\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "<TRANSACTION_ID>", + "in": "path" + } + ] + } + }, + "\/databases\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "databasesCreateOperations", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Create multiple operations in a single transaction.", + "responses": { + "201": { "description": "Transaction", "schema": { "$ref": "#\/definitions\/transaction" @@ -6675,11 +7697,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", + "method": "createOperations", "group": "transactions", "cookies": false, "type": "", - "demo": "databases\/update-transaction.md", + "demo": "databases\/create-operations.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -6691,7 +7713,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-operations.md", "auth": { "Project": [] } @@ -6718,58 +7740,64 @@ "schema": { "type": "object", "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "default": false, - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "default": false, - "x-example": false + "operations": { + "type": "array", + "description": "Array of staged operations.", + "default": [], + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } } } } } ] - }, - "delete": { - "summary": "Delete transaction", - "operationId": "databasesDeleteTransaction", - "consumes": [ + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "databasesListDocuments", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ "databases" ], - "description": "Delete a transaction by its unique ID.", + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", + "method": "listDocuments", + "group": "documents", "cookies": false, "type": "", - "demo": "databases\/delete-transaction.md", + "demo": "databases\/list-documents.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "documents.read", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.listRows" + }, "auth": { "Project": [] } @@ -6783,20 +7811,65 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "<TRANSACTION_ID>", + "x-example": "<DATABASE_ID>", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "<COLLECTION_ID>", "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "<TRANSACTION_ID>", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" } ] - } - }, - "\/databases\/transactions\/{transactionId}\/operations": { + }, "post": { - "summary": "Create operations", - "operationId": "databasesCreateOperations", + "summary": "Create document", + "operationId": "databasesCreateDocument", "consumes": [ "application\/json" ], @@ -6806,34 +7879,75 @@ "tags": [ "databases" ], - "description": "Create multiple operations in a single transaction.", + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { "201": { - "description": "Transaction", + "description": "Document", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/document" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createOperations", - "group": "transactions", + "method": "createDocument", + "group": "documents", "cookies": false, "type": "", - "demo": "databases\/create-operations.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", + "demo": "databases\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-operations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + }, + "methods": [ + { + "name": "createDocument", + "namespace": "databases", + "desc": "Create document", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", + "demo": "databases\/create-document.md", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + } + } + ], "auth": { "Project": [] } @@ -6847,11 +7961,19 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "<TRANSACTION_ID>", + "x-example": "<DATABASE_ID>", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "required": true, + "type": "string", + "x-example": "<COLLECTION_ID>", "in": "path" }, { @@ -6860,14 +7982,44 @@ "schema": { "type": "object", "properties": { - "operations": { + "documentId": { + "type": "string", + "description": "Document 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.", + "default": "", + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "data": { + "type": "object", + "description": "Document data as JSON object.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + }, + "permissions": { "type": "array", - "description": "Array of staged operations.", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "x-example": null, "items": { "type": "object" } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>", + "x-nullable": true } } } @@ -6875,10 +8027,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { "get": { - "summary": "List documents", - "operationId": "databasesListDocuments", + "summary": "Get document", + "operationId": "databasesGetDocument", "consumes": [], "produces": [ "application\/json" @@ -6886,22 +8038,22 @@ "tags": [ "databases" ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", "responses": { "200": { - "description": "Documents List", + "description": "Document", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/document" } } }, "deprecated": true, "x-appwrite": { - "method": "listDocuments", + "method": "getDocument", "group": "documents", "cookies": false, "type": "", - "demo": "databases\/list-documents.md", + "demo": "databases\/get-document.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -6913,10 +8065,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.listRows" + "replaceWith": "tablesDB.getRow" }, "auth": { "Project": [] @@ -6946,6 +8098,14 @@ "x-example": "<COLLECTION_ID>", "in": "path" }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "<DOCUMENT_ID>", + "in": "path" + }, { "name": "queries", "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", @@ -6965,31 +8125,12 @@ "type": "string", "x-example": "<TRANSACTION_ID>", "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" } ] }, - "post": { - "summary": "Create document", - "operationId": "databasesCreateDocument", + "put": { + "summary": "Upsert a document", + "operationId": "databasesUpsertDocument", "consumes": [ "application\/json" ], @@ -6999,7 +8140,7 @@ "tags": [ "databases" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { "201": { "description": "Document", @@ -7010,11 +8151,11 @@ }, "deprecated": true, "x-appwrite": { - "method": "createDocument", + "method": "upsertDocument", "group": "documents", "cookies": false, "type": "", - "demo": "databases\/create-document.md", + "demo": "databases\/upsert-document.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", @@ -7026,16 +8167,16 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRow" + "replaceWith": "tablesDB.upsertRow" }, "methods": [ { - "name": "createDocument", + "name": "upsertDocument", "namespace": "databases", - "desc": "Create document", + "desc": "", "auth": { "Project": [] }, @@ -7050,8 +8191,7 @@ "required": [ "databaseId", "collectionId", - "documentId", - "data" + "documentId" ], "responses": [ { @@ -7059,12 +8199,12 @@ "model": "#\/definitions\/document" } ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", - "demo": "databases\/create-document.md", + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", + "demo": "databases\/upsert-document.md", "public": true, "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRow" + "replaceWith": "tablesDB.upsertRow" } } ], @@ -7090,48 +8230,44 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "<COLLECTION_ID>", "in": "path" }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, + "x-example": "<DOCUMENT_ID>", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "documentId": { - "type": "string", - "description": "Document 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.", - "default": "", - "x-example": "<DOCUMENT_ID>" - }, "data": { "type": "object", - "description": "Document data as JSON object.", + "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "x-example": "[\"read(\"any\")\"]", "x-nullable": true, "items": { "type": "string" } }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", - "default": [], - "x-example": null, - "items": { - "type": "object" - } - }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", @@ -7142,20 +8278,20 @@ } } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { - "get": { - "summary": "Get document", - "operationId": "databasesGetDocument", - "consumes": [], + }, + "patch": { + "summary": "Update document", + "operationId": "databasesUpdateDocument", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { "200": { "description": "Document", @@ -7166,15 +8302,15 @@ }, "deprecated": true, "x-appwrite": { - "method": "getDocument", + "method": "updateDocument", "group": "documents", "cookies": false, "type": "", - "demo": "databases\/get-document.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "databases\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "client", @@ -7182,10 +8318,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.getRow" + "replaceWith": "tablesDB.updateRow" }, "auth": { "Project": [] @@ -7209,7 +8345,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "<COLLECTION_ID>", @@ -7224,30 +8360,134 @@ "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>", + "x-nullable": true + } + } + } + } + ] + }, + "delete": { + "summary": "Delete document", + "operationId": "databasesDeleteDocument", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "databases" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": true, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "cookies": false, + "type": "", + "demo": "databases\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.deleteRow" }, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, "type": "string", - "x-example": "<TRANSACTION_ID>", - "in": "query" + "x-example": "<DATABASE_ID>", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "<COLLECTION_ID>", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "<DOCUMENT_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>", + "x-nullable": true + } + } + } } ] - }, - "put": { - "summary": "Upsert a document", - "operationId": "databasesUpsertDocument", + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "databasesDecrementDocumentAttribute", "consumes": [ "application\/json" ], @@ -7257,9 +8497,9 @@ "tags": [ "databases" ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", + "description": "Decrement a specific attribute of a document by a given value.", "responses": { - "201": { + "200": { "description": "Document", "schema": { "$ref": "#\/definitions\/document" @@ -7268,63 +8508,27 @@ }, "deprecated": true, "x-appwrite": { - "method": "upsertDocument", + "method": "decrementDocumentAttribute", "group": "documents", "cookies": false, "type": "", - "demo": "databases\/upsert-document.md", + "demo": "databases\/decrement-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" + "replaceWith": "tablesDB.decrementRowColumn" }, - "methods": [ - { - "name": "upsertDocument", - "namespace": "databases", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/document" - } - ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", - "demo": "databases\/upsert-document.md", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" - } - } - ], "auth": { "Project": [] } @@ -7361,26 +8565,32 @@ "x-example": "<DOCUMENT_ID>", "in": "path" }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "min": { + "type": "number", + "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", + "x-example": null, + "format": "float", + "x-nullable": true }, "transactionId": { "type": "string", @@ -7392,10 +8602,12 @@ } } ] - }, + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { "patch": { - "summary": "Update document", - "operationId": "databasesUpdateDocument", + "summary": "Increment document attribute", + "operationId": "databasesIncrementDocumentAttribute", "consumes": [ "application\/json" ], @@ -7405,7 +8617,7 @@ "tags": [ "databases" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Increment a specific attribute of a document by a given value.", "responses": { "200": { "description": "Document", @@ -7416,26 +8628,26 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateDocument", + "method": "incrementDocumentAttribute", "group": "documents", "cookies": false, "type": "", - "demo": "databases\/update-document.md", + "demo": "databases\/increment-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRow" + "replaceWith": "tablesDB.incrementRowColumn" }, "auth": { "Project": [] @@ -7473,26 +8685,32 @@ "x-example": "<DOCUMENT_ID>", "in": "path" }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "max": { + "type": "number", + "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", + "x-example": null, + "format": "float", + "x-nullable": true }, "transactionId": { "type": "string", @@ -7504,46 +8722,113 @@ } } ] + } + }, + "\/documentsdb\/transactions": { + "get": { + "summary": "List transactions", + "operationId": "documentsDBListTransactions", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "List transactions across all databases.", + "responses": { + "200": { + "description": "Transaction List", + "schema": { + "$ref": "#\/definitions\/transactionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTransactions", + "group": "transactions", + "cookies": false, + "type": "", + "demo": "documentsdb\/list-transactions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-transactions.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries).", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + } + ] }, - "delete": { - "summary": "Delete document", - "operationId": "databasesDeleteDocument", + "post": { + "summary": "Create transaction", + "operationId": "documentsDBCreateTransaction", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "databases" + "documentsDB" ], - "description": "Delete a document by its unique ID.", + "description": "Create a new transaction.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "deleteDocument", - "group": "documents", + "method": "createTransaction", + "group": "transactions", "cookies": false, "type": "", - "demo": "databases\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "documentsdb\/create-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": "documents.write", "platforms": [ - "console", - "client", - "server" + "console", + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.deleteRow" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-transaction.md", "auth": { "Project": [] } @@ -7556,41 +8841,18 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "<DATABASE_ID>", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "type": "string", - "x-example": "<COLLECTION_ID>", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "<DOCUMENT_ID>", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "default": 300, + "x-example": 60, + "format": "int32" } } } @@ -7598,51 +8860,45 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "databasesDecrementDocumentAttribute", - "consumes": [ - "application\/json" - ], + "\/documentsdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "documentsDBGetTransaction", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "databases" + "documentsDB" ], - "description": "Decrement a specific attribute of a document by a given value.", + "description": "Get a transaction by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/transaction" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", + "method": "getTransaction", + "group": "transactions", "cookies": false, "type": "", - "demo": "databases\/decrement-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "documentsdb\/get-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", "platforms": [ - "client", + "console", "server", - "console" + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.decrementRowColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-transaction.md", "auth": { "Project": [] } @@ -7656,72 +8912,18 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "<DATABASE_ID>", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "<COLLECTION_ID>", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "<DOCUMENT_ID>", - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", + "x-example": "<TRANSACTION_ID>", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "min": { - "type": "number", - "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true - } - } - } } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + }, "patch": { - "summary": "Increment document attribute", - "operationId": "databasesIncrementDocumentAttribute", + "summary": "Update transaction", + "operationId": "documentsDBUpdateTransaction", "consumes": [ "application\/json" ], @@ -7729,40 +8931,36 @@ "application\/json" ], "tags": [ - "databases" + "documentsDB" ], - "description": "Increment a specific attribute of a document by a given value.", + "description": "Update a transaction, to either commit or roll back its operations.", "responses": { "200": { - "description": "Document", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/transaction" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", + "method": "updateTransaction", + "group": "transactions", "cookies": false, "type": "", - "demo": "databases\/increment-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "documentsdb\/update-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": "documents.write", "platforms": [ - "client", + "console", "server", - "console" + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.incrementRowColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-transaction.md", "auth": { "Project": [] } @@ -7776,34 +8974,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "<DATABASE_ID>", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "<COLLECTION_ID>", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "<DOCUMENT_ID>", - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", + "x-example": "<TRANSACTION_ID>", "in": "path" }, { @@ -7812,63 +8987,50 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "max": { - "type": "number", - "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, - "format": "float", - "x-nullable": true + "commit": { + "type": "boolean", + "description": "Commit transaction?", + "default": false, + "x-example": false }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true - } - } - } - } - ] - } - }, - "\/documentsdb\/transactions": { - "get": { - "summary": "List transactions", - "operationId": "documentsDBListTransactions", - "consumes": [], - "produces": [ + "rollback": { + "type": "boolean", + "description": "Rollback transaction?", + "default": false, + "x-example": false + } + } + } + } + ] + }, + "delete": { + "summary": "Delete transaction", + "operationId": "documentsDBDeleteTransaction", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ "documentsDB" ], - "description": "List transactions across all databases.", + "description": "Delete a transaction by its unique ID.", "responses": { - "200": { - "description": "Transaction List", - "schema": { - "$ref": "#\/definitions\/transactionList" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", + "method": "deleteTransaction", "group": "transactions", "cookies": false, "type": "", - "demo": "documentsdb\/list-transactions.md", + "demo": "documentsdb\/delete-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "documents.write", "platforms": [ "console", "server", @@ -7876,7 +9038,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-transactions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-transaction.md", "auth": { "Project": [] } @@ -7890,22 +9052,20 @@ ], "parameters": [ { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries).", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "<TRANSACTION_ID>", + "in": "path" } ] - }, + } + }, + "\/documentsdb\/transactions\/{transactionId}\/operations": { "post": { - "summary": "Create transaction", - "operationId": "documentsDBCreateTransaction", + "summary": "Create operations", + "operationId": "documentsDBCreateOperations", "consumes": [ "application\/json" ], @@ -7915,7 +9075,7 @@ "tags": [ "documentsDB" ], - "description": "Create a new transaction.", + "description": "Create multiple operations in a single transaction.", "responses": { "201": { "description": "Transaction", @@ -7926,23 +9086,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", + "method": "createOperations", "group": "transactions", "cookies": false, "type": "", - "demo": "documentsdb\/create-transaction.md", + "demo": "documentsdb\/create-operations.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": "documents.write", "platforms": [ - "console", "server", "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-operations.md", "auth": { "Project": [] } @@ -7955,18 +9114,28 @@ } ], "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "<TRANSACTION_ID>", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "default": 300, - "x-example": 60, - "format": "int32" + "operations": { + "type": "array", + "description": "Array of staged operations.", + "default": [], + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } } } } @@ -7974,10 +9143,10 @@ ] } }, - "\/documentsdb\/transactions\/{transactionId}": { + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents": { "get": { - "summary": "Get transaction", - "operationId": "documentsDBGetTransaction", + "summary": "List documents", + "operationId": "documentsDBListDocuments", "consumes": [], "produces": [ "application\/json" @@ -7985,34 +9154,34 @@ "tags": [ "documentsDB" ], - "description": "Get a transaction by its unique ID.", + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", "responses": { "200": { - "description": "Transaction", + "description": "Documents List", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/documentList" } } }, "deprecated": false, "x-appwrite": { - "method": "getTransaction", - "group": "transactions", + "method": "listDocuments", + "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/get-transaction.md", + "demo": "documentsdb\/list-documents.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": "documents.read", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-documents.md", "auth": { "Project": [] } @@ -8026,18 +9195,65 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "<TRANSACTION_ID>", + "x-example": "<DATABASE_ID>", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "<COLLECTION_ID>", "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "<TRANSACTION_ID>", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" } ] }, - "patch": { - "summary": "Update transaction", - "operationId": "documentsDBUpdateTransaction", + "post": { + "summary": "Create document", + "operationId": "documentsDBCreateDocument", "consumes": [ "application\/json" ], @@ -8047,34 +9263,93 @@ "tags": [ "documentsDB" ], - "description": "Update a transaction, to either commit or roll back its operations.", + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", "responses": { - "200": { - "description": "Transaction", + "201": { + "description": "Document", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/document" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", + "method": "createDocument", + "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/update-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", + "demo": "documentsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-document.md", + "methods": [ + { + "name": "createDocument", + "namespace": "documentsDB", + "desc": "Create document", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-document.md", + "public": true + }, + { + "name": "createDocuments", + "namespace": "documentsDB", + "desc": "Create documents", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-documents.md", + "public": true + } + ], "auth": { "Project": [] } @@ -8088,11 +9363,19 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "<DATABASE_ID>", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", "required": true, "type": "string", - "x-example": "<TRANSACTION_ID>", + "x-example": "<COLLECTION_ID>", "in": "path" }, { @@ -8101,58 +9384,88 @@ "schema": { "type": "object", "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "default": false, - "x-example": false + "documentId": { + "type": "string", + "description": "Document 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.", + "default": "", + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "default": false, - "x-example": false + "data": { + "type": "object", + "description": "Document data as JSON object.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>" } } } } ] - }, - "delete": { - "summary": "Delete transaction", - "operationId": "documentsDBDeleteTransaction", - "consumes": [ + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "documentsDBGetDocument", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ "documentsDB" ], - "description": "Delete a transaction by its unique ID.", + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", + "method": "getDocument", + "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/delete-transaction.md", + "demo": "documentsdb\/get-document.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "documents.read", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-document.md", "auth": { "Project": [] } @@ -8166,20 +9479,54 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "<TRANSACTION_ID>", + "x-example": "<DATABASE_ID>", "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "<COLLECTION_ID>", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "<DOCUMENT_ID>", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "<TRANSACTION_ID>", + "in": "query" } ] - } - }, - "\/documentsdb\/transactions\/{transactionId}\/operations": { - "post": { - "summary": "Create operations", - "operationId": "documentsDBCreateOperations", + }, + "put": { + "summary": "Upsert a document", + "operationId": "documentsDBUpsertDocument", "consumes": [ "application\/json" ], @@ -8189,33 +9536,66 @@ "tags": [ "documentsDB" ], - "description": "Create multiple operations in a single transaction.", + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", "responses": { "201": { - "description": "Transaction", + "description": "Document", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/document" } } }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", + "method": "upsertDocument", + "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/create-operations.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", + "demo": "documentsdb\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "server", - "client" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-operations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/upsert-document.md", + "methods": [ + { + "name": "upsertDocument", + "namespace": "documentsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/upsert-document.md", + "public": true + } + ], "auth": { "Project": [] } @@ -8229,11 +9609,27 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "<TRANSACTION_ID>", + "x-example": "<DATABASE_ID>", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "<COLLECTION_ID>", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "<DOCUMENT_ID>", "in": "path" }, { @@ -8242,52 +9638,62 @@ "schema": { "type": "object", "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", + "data": { + "type": "object", + "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", "items": { - "type": "object" + "type": "string" } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>" } } } } ] - } - }, - "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents": { - "get": { - "summary": "List documents", - "operationId": "documentsDBListDocuments", - "consumes": [], + }, + "patch": { + "summary": "Update document", + "operationId": "documentsDBUpdateDocument", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "documentsDB" ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { "200": { - "description": "Documents List", + "description": "Document", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/document" } } }, "deprecated": false, "x-appwrite": { - "method": "listDocuments", + "method": "updateDocument", "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/list-documents.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "documentsdb\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "client", @@ -8295,7 +9701,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-document.md", "auth": { "Project": [] } @@ -8318,82 +9724,74 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "<COLLECTION_ID>", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, + "name": "documentId", + "description": "Document ID.", + "required": true, "type": "string", - "x-example": "<TRANSACTION_ID>", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "x-example": "<DOCUMENT_ID>", + "in": "path" }, { - "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only fields and value pairs to be updated.", + "default": [], + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>" + } + } + } } ] }, - "post": { - "summary": "Create document", - "operationId": "documentsDBCreateDocument", + "delete": { + "summary": "Delete document", + "operationId": "documentsDBDeleteDocument", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "documentsDB" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Delete a document by its unique ID.", "responses": { - "201": { - "description": "Document", - "schema": { - "$ref": "#\/definitions\/document" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createDocument", + "method": "deleteDocument", "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/create-document.md", - "rate-limit": 120, + "demo": "documentsdb\/delete-document.md", + "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", @@ -8404,66 +9802,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-document.md", - "methods": [ - { - "name": "createDocument", - "namespace": "documentsDB", - "desc": "Create document", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions" - ], - "required": [ - "databaseId", - "collectionId", - "documentId", - "data" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/document" - } - ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "documentsdb\/create-document.md", - "public": true - }, - { - "name": "createDocuments", - "namespace": "documentsDB", - "desc": "Create documents", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/documentList" - } - ], - "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "documentsdb\/create-documents.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-document.md", "auth": { "Project": [] } @@ -8486,47 +9825,26 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "<COLLECTION_ID>", "in": "path" }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "<DOCUMENT_ID>", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "documentId": { - "type": "string", - "description": "Document 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.", - "default": "", - "x-example": "<DOCUMENT_ID>" - }, - "data": { - "type": "object", - "description": "Document data as JSON object.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", - "default": [], - "x-example": null, - "items": { - "type": "object" - } - }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", @@ -8538,18 +9856,20 @@ ] } }, - "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { - "get": { - "summary": "Get document", - "operationId": "documentsDBGetDocument", - "consumes": [], + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "documentsDBDecrementDocumentAttribute", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "documentsDB" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Decrement a specific column of a row by a given value.", "responses": { "200": { "description": "Document", @@ -8560,23 +9880,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "getDocument", + "method": "decrementDocumentAttribute", "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/get-document.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "documentsdb\/decrement-document-attribute.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ - "console", "client", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/decrement-document-attribute.md", "auth": { "Project": [] } @@ -8599,7 +9919,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "<COLLECTION_ID>", @@ -8614,30 +9934,46 @@ "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "attribute", + "description": "Attribute key.", + "required": true, + "type": "string", + "in": "path" }, { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, - "type": "string", - "x-example": "<TRANSACTION_ID>", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to decrement the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" + }, + "min": { + "type": "number", + "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", + "x-example": null, + "format": "float" + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "<TRANSACTION_ID>" + } + } + } } ] - }, - "put": { - "summary": "Upsert a document", - "operationId": "documentsDBUpsertDocument", + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "documentsDBIncrementDocumentAttribute", "consumes": [ "application\/json" ], @@ -8647,9 +9983,9 @@ "tags": [ "documentsDB" ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Increment a specific column of a row by a given value.", "responses": { - "201": { + "200": { "description": "Document", "schema": { "$ref": "#\/definitions\/document" @@ -8658,55 +9994,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "upsertDocument", + "method": "incrementDocumentAttribute", "group": "documents", "cookies": false, "type": "", - "demo": "documentsdb\/upsert-document.md", + "demo": "documentsdb\/increment-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/upsert-document.md", - "methods": [ - { - "name": "upsertDocument", - "namespace": "documentsDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/document" - } - ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "documentsdb\/upsert-document.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/increment-document-attribute.md", "auth": { "Project": [] } @@ -8743,25 +10047,31 @@ "x-example": "<DOCUMENT_ID>", "in": "path" }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "default": [], - "x-example": "{}" + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } + "max": { + "type": "number", + "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", + "x-example": null, + "format": "float" }, "transactionId": { "type": "string", @@ -8772,39 +10082,42 @@ } } ] - }, - "patch": { - "summary": "Update document", - "operationId": "documentsDBUpdateDocument", - "consumes": [ - "application\/json" - ], + } + }, + "\/functions\/{functionId}\/executions": { + "get": { + "summary": "List executions", + "operationId": "functionsListExecutions", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "documentsDB" + "functions" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Get a list of all the current user function execution logs. You can use the query params to filter your results.", "responses": { "200": { - "description": "Document", + "description": "Executions List", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/executionList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDocument", - "group": "documents", + "method": "listExecutions", + "group": "executions", "cookies": false, "type": "", - "demo": "documentsdb\/update-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "functions\/list-executions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -8812,7 +10125,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-document.md", "auth": { "Project": [] } @@ -8826,27 +10138,96 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "functionId", + "description": "Function ID.", "required": true, "type": "string", - "x-example": "<DATABASE_ID>", + "x-example": "<FUNCTION_ID>", "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "<COLLECTION_ID>", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "documentId", - "description": "Document ID.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create execution", + "operationId": "functionsCreateExecution", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "functions" + ], + "description": "Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", + "responses": { + "201": { + "description": "Execution", + "schema": { + "$ref": "#\/definitions\/execution" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createExecution", + "group": "executions", + "cookies": false, + "type": "", + "demo": "functions\/create-execution.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "executions.write", + "execution.write" + ], + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "functionId", + "description": "Function ID.", "required": true, "type": "string", - "x-example": "<DOCUMENT_ID>", + "x-example": "<FUNCTION_ID>", "in": "path" }, { @@ -8855,57 +10236,101 @@ "schema": { "type": "object", "properties": { - "data": { + "body": { + "type": "string", + "description": "HTTP body of execution. Default value is empty string.", + "default": "", + "x-example": "<BODY>" + }, + "async": { + "type": "boolean", + "description": "Execute code in the background. Default value is false.", + "default": false, + "x-example": false + }, + "path": { + "type": "string", + "description": "HTTP path of execution. Path can include query params. Default value is \/", + "default": "\/", + "x-example": "<PATH>" + }, + "method": { + "type": "string", + "description": "HTTP method of execution. Default value is POST.", + "default": "POST", + "x-example": "GET", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "x-enum-name": "ExecutionMethod", + "x-enum-keys": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ] + }, + "headers": { "type": "object", - "description": "Document data as JSON object. Include only fields and value pairs to be updated.", + "description": "HTTP headers of execution. Defaults to empty.", "default": [], "x-example": "{}" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "transactionId": { + "scheduledAt": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.", + "x-example": "<SCHEDULED_AT>", + "x-nullable": true } } } } ] - }, - "delete": { - "summary": "Delete document", - "operationId": "documentsDBDeleteDocument", - "consumes": [ + } + }, + "\/functions\/{functionId}\/executions\/{executionId}": { + "get": { + "summary": "Get execution", + "operationId": "functionsGetExecution", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "documentsDB" + "functions" ], - "description": "Delete a document by its unique ID.", + "description": "Get a function execution log by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Execution", + "schema": { + "$ref": "#\/definitions\/execution" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDocument", - "group": "documents", + "method": "getExecution", + "group": "executions", "cookies": false, "type": "", - "demo": "documentsdb\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "functions\/get-execution.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -8913,7 +10338,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-document.md", "auth": { "Project": [] } @@ -8927,50 +10351,28 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "<DATABASE_ID>", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "functionId", + "description": "Function ID.", "required": true, "type": "string", - "x-example": "<COLLECTION_ID>", + "x-example": "<FUNCTION_ID>", "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "executionId", + "description": "Execution ID.", "required": true, "type": "string", - "x-example": "<DOCUMENT_ID>", + "x-example": "<EXECUTION_ID>", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" - } - } - } } ] } }, - "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "documentsDBDecrementDocumentAttribute", + "\/graphql": { + "post": { + "summary": "GraphQL endpoint", + "operationId": "graphqlQuery", "consumes": [ "application\/json" ], @@ -8978,36 +10380,36 @@ "application\/json" ], "tags": [ - "documentsDB" + "graphql" ], - "description": "Decrement a specific column of a row by a given value.", + "description": "Execute a GraphQL mutation.", "responses": { "200": { - "description": "Document", + "description": "Any", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/any" } } }, "deprecated": false, "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", + "method": "query", + "group": "graphql", "cookies": false, - "type": "", - "demo": "documentsdb\/decrement-document-attribute.md", - "rate-limit": 120, + "type": "graphql", + "demo": "graphql\/query.md", + "rate-limit": 60, "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "rate-key": "url:{url},ip:{ip}", + "scope": "graphql", "platforms": [ - "client", + "console", "server", - "console" + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/decrement-document-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md", "auth": { "Project": [] } @@ -9020,71 +10422,31 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "<DATABASE_ID>", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "<COLLECTION_ID>", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "<DOCUMENT_ID>", - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "min": { - "type": "number", - "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, - "format": "float" - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "query": { + "type": "object", + "description": "The query or queries to execute.", + "default": {}, + "x-example": "{}" } - } + }, + "required": [ + "query" + ] } } ] } }, - "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { - "patch": { - "summary": "Increment document attribute", - "operationId": "documentsDBIncrementDocumentAttribute", + "\/graphql\/mutation": { + "post": { + "summary": "GraphQL endpoint", + "operationId": "graphqlMutation", "consumes": [ "application\/json" ], @@ -9092,36 +10454,36 @@ "application\/json" ], "tags": [ - "documentsDB" + "graphql" ], - "description": "Increment a specific column of a row by a given value.", + "description": "Execute a GraphQL mutation.", "responses": { "200": { - "description": "Document", + "description": "Any", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/any" } } }, "deprecated": false, "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", + "method": "mutation", + "group": "graphql", "cookies": false, - "type": "", - "demo": "documentsdb\/increment-document-attribute.md", - "rate-limit": 120, + "type": "graphql", + "demo": "graphql\/mutation.md", + "rate-limit": 60, "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "rate-key": "url:{url},ip:{ip}", + "scope": "graphql", "platforms": [ - "client", + "console", "server", - "console" + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/increment-document-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md", "auth": { "Project": [] } @@ -9134,101 +10496,58 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "<DATABASE_ID>", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "<COLLECTION_ID>", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "<DOCUMENT_ID>", - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "max": { - "type": "number", - "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, - "format": "float" - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "query": { + "type": "object", + "description": "The query or queries to execute.", + "default": {}, + "x-example": "{}" } - } + }, + "required": [ + "query" + ] } } ] } }, - "\/functions\/{functionId}\/executions": { + "\/locale": { "get": { - "summary": "List executions", - "operationId": "functionsListExecutions", + "summary": "Get user locale", + "operationId": "localeGet", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "functions" + "locale" ], - "description": "Get a list of all the current user function execution logs. You can use the query params to filter your results.", + "description": "Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))", "responses": { "200": { - "description": "Executions List", + "description": "Locale", "schema": { - "$ref": "#\/definitions\/executionList" + "$ref": "#\/definitions\/locale" } } }, "deprecated": false, "x-appwrite": { - "method": "listExecutions", - "group": "executions", + "method": "get", + "group": null, "cookies": false, "type": "", - "demo": "functions\/list-executions.md", + "demo": "locale\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "executions.read", - "execution.read" - ], + "scope": "locale.read", "platforms": [ "console", "client", @@ -9236,6 +10555,7 @@ ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md", "auth": { "Project": [] } @@ -9246,74 +10566,40 @@ "Session": [], "JWT": [] } - ], - "parameters": [ - { - "name": "functionId", - "description": "Function ID.", - "required": true, - "type": "string", - "x-example": "<FUNCTION_ID>", - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - } ] - }, - "post": { - "summary": "Create execution", - "operationId": "functionsCreateExecution", - "consumes": [ - "application\/json" - ], + } + }, + "\/locale\/codes": { + "get": { + "summary": "List locale codes", + "operationId": "localeListCodes", + "consumes": [], "produces": [ - "multipart\/form-data" + "application\/json" ], "tags": [ - "functions" + "locale" ], - "description": "Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", + "description": "List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).", "responses": { - "201": { - "description": "Execution", + "200": { + "description": "Locale codes list", "schema": { - "$ref": "#\/definitions\/execution" + "$ref": "#\/definitions\/localeCodeList" } } }, "deprecated": false, "x-appwrite": { - "method": "createExecution", - "group": "executions", + "method": "listCodes", + "group": null, "cookies": false, "type": "", - "demo": "functions\/create-execution.md", + "demo": "locale\/list-codes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "executions.write", - "execution.write" - ], + "scope": "locale.read", "platforms": [ "console", "client", @@ -9321,6 +10607,7 @@ ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md", "auth": { "Project": [] } @@ -9331,117 +10618,92 @@ "Session": [], "JWT": [] } + ] + } + }, + "\/locale\/continents": { + "get": { + "summary": "List continents", + "operationId": "localeListContinents", + "consumes": [], + "produces": [ + "application\/json" ], - "parameters": [ - { - "name": "functionId", - "description": "Function ID.", - "required": true, - "type": "string", - "x-example": "<FUNCTION_ID>", - "in": "path" - }, - { - "name": "payload", - "in": "body", + "tags": [ + "locale" + ], + "description": "List of all continents. You can use the locale header to get the data in a supported language.", + "responses": { + "200": { + "description": "Continents List", "schema": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "HTTP body of execution. Default value is empty string.", - "default": "", - "x-example": "<BODY>" - }, - "async": { - "type": "boolean", - "description": "Execute code in the background. Default value is false.", - "default": false, - "x-example": false - }, - "path": { - "type": "string", - "description": "HTTP path of execution. Path can include query params. Default value is \/", - "default": "\/", - "x-example": "<PATH>" - }, - "method": { - "type": "string", - "description": "HTTP method of execution. Default value is POST.", - "default": "POST", - "x-example": "GET", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "x-enum-name": "ExecutionMethod", - "x-enum-keys": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ] - }, - "headers": { - "type": "object", - "description": "HTTP headers of execution. Defaults to empty.", - "default": [], - "x-example": "{}" - }, - "scheduledAt": { - "type": "string", - "description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.", - "x-example": "<SCHEDULED_AT>", - "x-nullable": true - } - } + "$ref": "#\/definitions\/continentList" } } + }, + "deprecated": false, + "x-appwrite": { + "method": "listContinents", + "group": null, + "cookies": false, + "type": "", + "demo": "locale\/list-continents.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "locale.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } ] } }, - "\/functions\/{functionId}\/executions\/{executionId}": { + "\/locale\/countries": { "get": { - "summary": "Get execution", - "operationId": "functionsGetExecution", + "summary": "List countries", + "operationId": "localeListCountries", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "functions" + "locale" ], - "description": "Get a function execution log by its unique ID.", + "description": "List of all countries. You can use the locale header to get the data in a supported language.", "responses": { "200": { - "description": "Execution", + "description": "Countries List", "schema": { - "$ref": "#\/definitions\/execution" + "$ref": "#\/definitions\/countryList" } } }, "deprecated": false, "x-appwrite": { - "method": "getExecution", - "group": "executions", + "method": "listCountries", + "group": null, "cookies": false, "type": "", - "demo": "functions\/get-execution.md", + "demo": "locale\/list-countries.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "executions.read", - "execution.read" - ], + "scope": "locale.read", "platforms": [ "console", "client", @@ -9449,6 +10711,7 @@ ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md", "auth": { "Project": [] } @@ -9459,68 +10722,48 @@ "Session": [], "JWT": [] } - ], - "parameters": [ - { - "name": "functionId", - "description": "Function ID.", - "required": true, - "type": "string", - "x-example": "<FUNCTION_ID>", - "in": "path" - }, - { - "name": "executionId", - "description": "Execution ID.", - "required": true, - "type": "string", - "x-example": "<EXECUTION_ID>", - "in": "path" - } ] } }, - "\/graphql": { - "post": { - "summary": "GraphQL endpoint", - "operationId": "graphqlQuery", - "consumes": [ - "application\/json" - ], + "\/locale\/countries\/eu": { + "get": { + "summary": "List EU countries", + "operationId": "localeListCountriesEU", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "graphql" + "locale" ], - "description": "Execute a GraphQL mutation.", + "description": "List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.", "responses": { "200": { - "description": "Any", + "description": "Countries List", "schema": { - "$ref": "#\/definitions\/any" + "$ref": "#\/definitions\/countryList" } } }, "deprecated": false, "x-appwrite": { - "method": "query", - "group": "graphql", + "method": "listCountriesEU", + "group": null, "cookies": false, - "type": "graphql", - "demo": "graphql\/query.md", - "rate-limit": 60, - "rate-time": 60, + "type": "", + "demo": "locale\/list-countries-eu.md", + "rate-limit": 0, + "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "graphql", + "scope": "locale.read", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md", "auth": { "Project": [] } @@ -9531,70 +10774,48 @@ "Session": [], "JWT": [] } - ], - "parameters": [ - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "query": { - "type": "object", - "description": "The query or queries to execute.", - "default": {}, - "x-example": "{}" - } - }, - "required": [ - "query" - ] - } - } ] } }, - "\/graphql\/mutation": { - "post": { - "summary": "GraphQL endpoint", - "operationId": "graphqlMutation", - "consumes": [ - "application\/json" - ], + "\/locale\/countries\/phones": { + "get": { + "summary": "List countries phone codes", + "operationId": "localeListCountriesPhones", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "graphql" + "locale" ], - "description": "Execute a GraphQL mutation.", + "description": "List of all countries phone codes. You can use the locale header to get the data in a supported language.", "responses": { "200": { - "description": "Any", + "description": "Phones List", "schema": { - "$ref": "#\/definitions\/any" + "$ref": "#\/definitions\/phoneList" } } }, "deprecated": false, "x-appwrite": { - "method": "mutation", - "group": "graphql", + "method": "listCountriesPhones", + "group": null, "cookies": false, - "type": "graphql", - "demo": "graphql\/mutation.md", - "rate-limit": 60, - "rate-time": 60, + "type": "", + "demo": "locale\/list-countries-phones.md", + "rate-limit": 0, + "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "graphql", + "scope": "locale.read", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md", "auth": { "Project": [] } @@ -9605,33 +10826,65 @@ "Session": [], "JWT": [] } + ] + } + }, + "\/locale\/currencies": { + "get": { + "summary": "List currencies", + "operationId": "localeListCurrencies", + "consumes": [], + "produces": [ + "application\/json" ], - "parameters": [ - { - "name": "payload", - "in": "body", + "tags": [ + "locale" + ], + "description": "List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.", + "responses": { + "200": { + "description": "Currencies List", "schema": { - "type": "object", - "properties": { - "query": { - "type": "object", - "description": "The query or queries to execute.", - "default": {}, - "x-example": "{}" - } - }, - "required": [ - "query" - ] + "$ref": "#\/definitions\/currencyList" } } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCurrencies", + "group": null, + "cookies": false, + "type": "", + "demo": "locale\/list-currencies.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "locale.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } ] } }, - "\/locale": { + "\/locale\/languages": { "get": { - "summary": "Get user locale", - "operationId": "localeGet", + "summary": "List languages", + "operationId": "localeListLanguages", "consumes": [], "produces": [ "application\/json" @@ -9639,22 +10892,22 @@ "tags": [ "locale" ], - "description": "Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))", + "description": "List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.", "responses": { "200": { - "description": "Locale", + "description": "Languages List", "schema": { - "$ref": "#\/definitions\/locale" + "$ref": "#\/definitions\/languageList" } } }, "deprecated": false, "x-appwrite": { - "method": "get", + "method": "listLanguages", "group": null, "cookies": false, "type": "", - "demo": "locale\/get.md", + "demo": "locale\/list-languages.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9666,7 +10919,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md", "auth": { "Project": [] } @@ -9680,45 +10933,47 @@ ] } }, - "\/locale\/codes": { - "get": { - "summary": "List locale codes", - "operationId": "localeListCodes", - "consumes": [], + "\/messaging\/topics\/{topicId}\/subscribers": { + "post": { + "summary": "Create subscriber", + "operationId": "messagingCreateSubscriber", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "locale" + "messaging" ], - "description": "List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).", + "description": "Create a new subscriber.", "responses": { - "200": { - "description": "Locale codes list", + "201": { + "description": "Subscriber", "schema": { - "$ref": "#\/definitions\/localeCodeList" + "$ref": "#\/definitions\/subscriber" } } }, "deprecated": false, "x-appwrite": { - "method": "listCodes", - "group": null, + "method": "createSubscriber", + "group": "subscribers", "cookies": false, "type": "", - "demo": "locale\/list-codes.md", + "demo": "messaging\/create-subscriber.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "scope": "subscribers.write", "platforms": [ - "console", + "server", "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md", "auth": { "Project": [] } @@ -9726,51 +10981,84 @@ "security": [ { "Project": [], - "Session": [], - "JWT": [] + "JWT": [], + "Session": [] + } + ], + "parameters": [ + { + "name": "topicId", + "description": "Topic ID. The topic ID to subscribe to.", + "required": true, + "type": "string", + "x-example": "<TOPIC_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "subscriberId": { + "type": "string", + "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", + "x-example": "<SUBSCRIBER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "targetId": { + "type": "string", + "description": "Target ID. The target ID to link to the specified Topic ID.", + "x-example": "<TARGET_ID>" + } + }, + "required": [ + "subscriberId", + "targetId" + ] + } } ] } }, - "\/locale\/continents": { - "get": { - "summary": "List continents", - "operationId": "localeListContinents", - "consumes": [], - "produces": [ + "\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}": { + "delete": { + "summary": "Delete subscriber", + "operationId": "messagingDeleteSubscriber", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ - "locale" + "messaging" ], - "description": "List of all continents. You can use the locale header to get the data in a supported language.", + "description": "Delete a subscriber by its unique ID.", "responses": { - "200": { - "description": "Continents List", - "schema": { - "$ref": "#\/definitions\/continentList" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "listContinents", - "group": null, + "method": "deleteSubscriber", + "group": "subscribers", "cookies": false, "type": "", - "demo": "locale\/list-continents.md", + "demo": "messaging\/delete-subscriber.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "scope": "subscribers.write", "platforms": [ - "console", + "server", "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md", "auth": { "Project": [] } @@ -9778,155 +11066,310 @@ "security": [ { "Project": [], - "Session": [], - "JWT": [] + "JWT": [], + "Session": [] + } + ], + "parameters": [ + { + "name": "topicId", + "description": "Topic ID. The topic ID subscribed to.", + "required": true, + "type": "string", + "x-example": "<TOPIC_ID>", + "in": "path" + }, + { + "name": "subscriberId", + "description": "Subscriber ID.", + "required": true, + "type": "string", + "x-example": "<SUBSCRIBER_ID>", + "in": "path" } ] } }, - "\/locale\/countries": { - "get": { - "summary": "List countries", - "operationId": "localeListCountries", - "consumes": [], + "\/oauth2\/{project_id}\/approve": { + "post": { + "summary": "Approve OAuth2", + "operationId": "oauth2Approve", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "locale" + "oauth2" ], - "description": "List of all countries. You can use the locale header to get the data in a supported language.", + "description": "Approve an OAuth2 grant after the user gives consent. Returns the `redirectUrl` the end user should be sent to. The consent screen may optionally pass enriched `authorization_details` to record the concrete resources the user selected. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", "responses": { "200": { - "description": "Countries List", + "description": "OAuth2 Approve", "schema": { - "$ref": "#\/definitions\/countryList" + "$ref": "#\/definitions\/oauth2Approve" } } }, "deprecated": false, "x-appwrite": { - "method": "listCountries", + "method": "approve", "group": null, "cookies": false, "type": "", - "demo": "locale\/list-countries.md", + "demo": "oauth2\/approve.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "scope": "oauth2.write", "platforms": [ - "console", "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md", "auth": { - "Project": [] + "ProjectQuery": [] } }, "security": [ { - "Project": [], + "ProjectQuery": [], "Session": [], "JWT": [] } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "required": true, + "type": "string", + "x-example": "<PROJECT_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "grant_id": { + "type": "string", + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", + "x-example": "<GRANT_ID>" + }, + "authorization_details": { + "type": "string", + "description": "Enriched `authorization_details` the user consented to, replacing what the client requested. Each entry must use a `type` the project accepts. Optional; omit to keep the originally requested details.", + "default": "", + "x-example": "<AUTHORIZATION_DETAILS>" + } + }, + "required": [ + "grant_id" + ] + } + } ] } }, - "\/locale\/countries\/eu": { + "\/oauth2\/{project_id}\/authorize": { "get": { - "summary": "List EU countries", - "operationId": "localeListCountriesEU", + "summary": "OAuth2 Authorize", + "operationId": "oauth2Authorize", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "locale" + "oauth2" ], - "description": "List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.", + "description": "Begin the OAuth2 authorization flow. When called without a session, the user is redirected to the consent screen without grant ID. When called with a session, the redirect URL includes param for grant ID. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", "responses": { "200": { - "description": "Countries List", + "description": "OAuth2 Authorize", "schema": { - "$ref": "#\/definitions\/countryList" + "$ref": "#\/definitions\/oauth2Authorize" } } }, "deprecated": false, "x-appwrite": { - "method": "listCountriesEU", + "method": "authorize", "group": null, "cookies": false, "type": "", - "demo": "locale\/list-countries-eu.md", + "demo": "oauth2\/authorize.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "scope": "public", "platforms": [ - "console", "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md", "auth": { - "Project": [] + "ProjectQuery": [] } }, "security": [ { - "Project": [], + "ProjectQuery": [], "Session": [], "JWT": [] } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client exists.", + "required": true, + "type": "string", + "x-example": "<PROJECT_ID>", + "in": "path" + }, + { + "name": "client_id", + "description": "OAuth2 client ID.", + "required": true, + "type": "string", + "x-example": "<CLIENT_ID>", + "in": "query" + }, + { + "name": "redirect_uri", + "description": "Redirect URI where visitor will be redirected after authorization, whether successful or not.", + "required": true, + "type": "string", + "format": "url", + "x-example": "https:\/\/example.com", + "in": "query" + }, + { + "name": "response_type", + "description": "OAuth2 \/ OIDC response type. One of `code` (Authorization Code Flow), `id_token` (Implicit Flow, OIDC login only), or `code id_token` (Hybrid Flow).", + "required": true, + "type": "string", + "x-example": "code", + "in": "query" + }, + { + "name": "scope", + "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`.", + "required": true, + "type": "string", + "x-example": "<SCOPE>", + "in": "query" + }, + { + "name": "state", + "description": "OAuth2 state. You receive this back in the redirect URI.", + "required": false, + "type": "string", + "x-example": "<STATE>", + "default": "", + "in": "query" + }, + { + "name": "nonce", + "description": "OIDC nonce parameter to prevent replay attacks. Required when response_type includes `id_token`.", + "required": false, + "type": "string", + "x-example": "<NONCE>", + "default": "", + "in": "query" + }, + { + "name": "code_challenge", + "description": "PKCE code challenge. Required when OAuth2 app is public.", + "required": false, + "type": "string", + "x-example": "<CODE_CHALLENGE>", + "default": "", + "in": "query" + }, + { + "name": "code_challenge_method", + "description": "PKCE code challenge method. Required when OAuth2 app is public.", + "required": false, + "type": "string", + "x-example": "s256", + "default": "", + "in": "query" + }, + { + "name": "prompt", + "description": "OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.", + "required": false, + "type": "string", + "x-example": "<PROMPT>", + "default": "", + "in": "query" + }, + { + "name": "max_age", + "description": "OIDC max_age paraleter for customization of consent screen. Maximum allowable elapsed time in seconds since the user last authenticated. If exceeded, re-authentication is required.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "in": "query" + }, + { + "name": "authorization_details", + "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", + "required": false, + "type": "string", + "x-example": "<AUTHORIZATION_DETAILS>", + "default": "", + "in": "query" + } ] } }, - "\/locale\/countries\/phones": { - "get": { - "summary": "List countries phone codes", - "operationId": "localeListCountriesPhones", - "consumes": [], + "\/oauth2\/{project_id}\/grants": { + "post": { + "summary": "Create OAuth2 Grant", + "operationId": "oauth2CreateGrant", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "locale" + "oauth2" ], - "description": "List of all countries phone codes. You can use the locale header to get the data in a supported language.", + "description": "Exchange a device flow user code for an OAuth2 grant. The authenticated user is bound to the pending grant. Pass the returned grant ID to the get grant endpoint to render the consent screen, then to the approve or reject endpoint to complete the flow.", "responses": { - "200": { - "description": "Phones List", + "201": { + "description": "OAuth2 Grant", "schema": { - "$ref": "#\/definitions\/phoneList" + "$ref": "#\/definitions\/oauth2Grant" } } }, "deprecated": false, "x-appwrite": { - "method": "listCountriesPhones", + "method": "createGrant", "group": null, "cookies": false, "type": "", - "demo": "locale\/list-countries-phones.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "demo": "oauth2\/create-grant.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "ip:{ip},userId:{userId}", + "scope": "oauth2.write", "platforms": [ - "console", "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md", "auth": { "Project": [] } @@ -9937,100 +11380,73 @@ "Session": [], "JWT": [] } - ] - } - }, - "\/locale\/currencies": { - "get": { - "summary": "List currencies", - "operationId": "localeListCurrencies", - "consumes": [], - "produces": [ - "application\/json" ], - "tags": [ - "locale" - ], - "description": "List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.", - "responses": { - "200": { - "description": "Currencies List", + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client exists.", + "required": true, + "type": "string", + "x-example": "<PROJECT_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", "schema": { - "$ref": "#\/definitions\/currencyList" + "type": "object", + "properties": { + "user_code": { + "type": "string", + "description": "User code displayed on the device.", + "x-example": "<USER_CODE>" + } + }, + "required": [ + "user_code" + ] } } - }, - "deprecated": false, - "x-appwrite": { - "method": "listCurrencies", - "group": null, - "cookies": false, - "type": "", - "demo": "locale\/list-currencies.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", - "platforms": [ - "console", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } ] } }, - "\/locale\/languages": { + "\/oauth2\/{project_id}\/grants\/{grant_id}": { "get": { - "summary": "List languages", - "operationId": "localeListLanguages", + "summary": "Get OAuth2 Grant", + "operationId": "oauth2GetGrant", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "locale" + "oauth2" ], - "description": "List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.", + "description": "Get an OAuth2 grant by its ID. Used by the consent screen to display the details of the authorization the user is being asked to approve. A grant can only be read by the user it belongs to, or by server SDK.", "responses": { "200": { - "description": "Languages List", + "description": "OAuth2 Grant", "schema": { - "$ref": "#\/definitions\/languageList" + "$ref": "#\/definitions\/oauth2Grant" } } }, "deprecated": false, "x-appwrite": { - "method": "listLanguages", + "method": "getGrant", "group": null, "cookies": false, "type": "", - "demo": "locale\/list-languages.md", + "demo": "oauth2\/get-grant.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "locale.read", + "scope": "oauth2.read", "platforms": [ - "console", "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md", "auth": { "Project": [] } @@ -10041,13 +11457,31 @@ "Session": [], "JWT": [] } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "required": true, + "type": "string", + "x-example": "<PROJECT_ID>", + "in": "path" + }, + { + "name": "grant_id", + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", + "required": true, + "type": "string", + "x-example": "<GRANT_ID>", + "in": "path" + } ] } }, - "\/messaging\/topics\/{topicId}\/subscribers": { + "\/oauth2\/{project_id}\/reject": { "post": { - "summary": "Create subscriber", - "operationId": "messagingCreateSubscriber", + "summary": "Reject OAuth2", + "operationId": "oauth2Reject", "consumes": [ "application\/json" ], @@ -10055,54 +11489,52 @@ "application\/json" ], "tags": [ - "messaging" + "oauth2" ], - "description": "Create a new subscriber.", + "description": "Reject an OAuth2 grant when the user denies consent. Returns the `redirectUrl` the end user should be sent to with an `access_denied` error. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", "responses": { - "201": { - "description": "Subscriber", + "200": { + "description": "OAuth2 Reject", "schema": { - "$ref": "#\/definitions\/subscriber" + "$ref": "#\/definitions\/oauth2Reject" } } }, "deprecated": false, "x-appwrite": { - "method": "createSubscriber", - "group": "subscribers", + "method": "reject", + "group": null, "cookies": false, "type": "", - "demo": "messaging\/create-subscriber.md", + "demo": "oauth2\/reject.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "subscribers.write", + "scope": "oauth2.write", "platforms": [ - "server", "client", - "console" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md", "auth": { - "Project": [] + "ProjectQuery": [] } }, "security": [ { - "Project": [], - "JWT": [], - "Session": [] + "ProjectQuery": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "topicId", - "description": "Topic ID. The topic ID to subscribe to.", + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", "required": true, "type": "string", - "x-example": "<TOPIC_ID>", + "x-example": "<PROJECT_ID>", "in": "path" }, { @@ -10111,93 +11543,20 @@ "schema": { "type": "object", "properties": { - "subscriberId": { - "type": "string", - "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", - "x-example": "<SUBSCRIBER_ID>" - }, - "targetId": { + "grant_id": { "type": "string", - "description": "Target ID. The target ID to link to the specified Topic ID.", - "x-example": "<TARGET_ID>" + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", + "x-example": "<GRANT_ID>" } }, "required": [ - "subscriberId", - "targetId" + "grant_id" ] } } ] } }, - "\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}": { - "delete": { - "summary": "Delete subscriber", - "operationId": "messagingDeleteSubscriber", - "consumes": [ - "application\/json" - ], - "produces": [], - "tags": [ - "messaging" - ], - "description": "Delete a subscriber by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteSubscriber", - "group": "subscribers", - "cookies": false, - "type": "", - "demo": "messaging\/delete-subscriber.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "subscribers.write", - "platforms": [ - "server", - "client", - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "JWT": [], - "Session": [] - } - ], - "parameters": [ - { - "name": "topicId", - "description": "Topic ID. The topic ID subscribed to.", - "required": true, - "type": "string", - "x-example": "<TOPIC_ID>", - "in": "path" - }, - { - "name": "subscriberId", - "description": "Subscriber ID.", - "required": true, - "type": "string", - "x-example": "<SUBSCRIBER_ID>", - "in": "path" - } - ] - } - }, "\/presences": { "get": { "summary": "List presences", @@ -10826,6 +12185,9 @@ "required": true, "x-upload-id": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<FILE_ID>", "in": "formData" }, @@ -11119,14 +12481,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -11198,14 +12562,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -11422,14 +12788,16 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Session": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -12124,7 +13492,10 @@ "type": "string", "description": "Row 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.", "default": "", - "x-example": "<ROW_ID>" + "x-example": "<ROW_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -12990,7 +14361,10 @@ "teamId": { "type": "string", "description": "Team 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.", - "x-example": "<TEAM_ID>" + "x-example": "<TEAM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -14523,7 +15897,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -14761,6 +16138,9 @@ "description": "Document ID.", "required": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<DOCUMENT_ID>", "in": "path" }, @@ -15034,6 +16414,10 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, + { + "name": "presences", + "description": "The Presences service allows you to create, query, and manage realtime presence state." + }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -16065,15 +17449,45 @@ "description": "User email address.", "x-example": "john@appwrite.io" }, - "phone": { - "type": "string", - "description": "User phone number in E.164 format.", - "x-example": "+4930901820" + "phone": { + "type": "string", + "description": "User phone number in E.164 format.", + "x-example": "+4930901820" + }, + "emailVerification": { + "type": "boolean", + "description": "Email verification status.", + "x-example": true + }, + "emailCanonical": { + "type": "string", + "description": "Canonical form of the user email address.", + "x-example": "john@appwrite.io", + "x-nullable": true + }, + "emailIsFree": { + "type": "boolean", + "description": "Whether the user email is from a free email provider.", + "x-example": true, + "x-nullable": true + }, + "emailIsDisposable": { + "type": "boolean", + "description": "Whether the user email is from a disposable email provider.", + "x-example": false, + "x-nullable": true + }, + "emailIsCorporate": { + "type": "boolean", + "description": "Whether the user email is from a corporate domain.", + "x-example": true, + "x-nullable": true }, - "emailVerification": { + "emailIsCanonical": { "type": "boolean", - "description": "Email verification status.", - "x-example": true + "description": "Whether the user email is in its canonical form.", + "x-example": true, + "x-nullable": true }, "phoneVerification": { "type": "boolean", @@ -16159,6 +17573,11 @@ "email": "john@appwrite.io", "phone": "+4930901820", "emailVerification": true, + "emailCanonical": "john@appwrite.io", + "emailIsFree": true, + "emailIsDisposable": false, + "emailIsCorporate": true, + "emailIsCanonical": true, "phoneVerification": true, "mfa": true, "prefs": { @@ -17080,6 +18499,11 @@ "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", "x-example": false }, + "userAccessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, "roles": { "type": "array", "description": "User list of roles", @@ -17105,6 +18529,7 @@ "joined", "confirm", "mfa", + "userAccessedAt", "roles" ], "example": { @@ -17121,6 +18546,7 @@ "joined": "2020-10-15T06:38:00.000+00:00", "confirm": false, "mfa": false, + "userAccessedAt": "2020-10-15T06:38:00.000+00:00", "roles": [ "owner" ] @@ -17453,400 +18879,859 @@ "properties": { "code": { "type": "string", - "description": "Phone code.", - "x-example": "+1" + "description": "Phone code.", + "x-example": "+1" + }, + "countryCode": { + "type": "string", + "description": "Country two-character ISO 3166-1 alpha code.", + "x-example": "US" + }, + "countryName": { + "type": "string", + "description": "Country name.", + "x-example": "United States" + } + }, + "required": [ + "code", + "countryCode", + "countryName" + ], + "example": { + "code": "+1", + "countryCode": "US", + "countryName": "United States" + } + }, + "headers": { + "description": "Headers", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Header name.", + "x-example": "Content-Type" + }, + "value": { + "type": "string", + "description": "Header value.", + "x-example": "application\/json" + } + }, + "required": [ + "name", + "value" + ], + "example": { + "name": "Content-Type", + "value": "application\/json" + } + }, + "mfaChallenge": { + "description": "MFA Challenge", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Token ID.", + "x-example": "bb8ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Token creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "5e5ea5c168bb8" + }, + "expire": { + "type": "string", + "description": "Token expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "$id", + "$createdAt", + "userId", + "expire" + ], + "example": { + "$id": "bb8ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "userId": "5e5ea5c168bb8", + "expire": "2020-10-15T06:38:00.000+00:00" + } + }, + "mfaRecoveryCodes": { + "description": "MFA Recovery Codes", + "type": "object", + "properties": { + "recoveryCodes": { + "type": "array", + "description": "Recovery codes.", + "items": { + "type": "string" + }, + "x-example": [ + "a3kf0-s0cl2", + "s0co1-as98s" + ] + } + }, + "required": [ + "recoveryCodes" + ], + "example": { + "recoveryCodes": [ + "a3kf0-s0cl2", + "s0co1-as98s" + ] + } + }, + "mfaType": { + "description": "MFAType", + "type": "object", + "properties": { + "secret": { + "type": "string", + "description": "Secret token used for TOTP factor.", + "x-example": "[SHARED_SECRET]" + }, + "uri": { + "type": "string", + "description": "URI for authenticator apps.", + "x-example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" + } + }, + "required": [ + "secret", + "uri" + ], + "example": { + "secret": "[SHARED_SECRET]", + "uri": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" + } + }, + "mfaFactors": { + "description": "MFAFactors", + "type": "object", + "properties": { + "totp": { + "type": "boolean", + "description": "Can TOTP be used for MFA challenge for this account.", + "x-example": true + }, + "phone": { + "type": "boolean", + "description": "Can phone (SMS) be used for MFA challenge for this account.", + "x-example": true + }, + "email": { + "type": "boolean", + "description": "Can email be used for MFA challenge for this account.", + "x-example": true + }, + "recoveryCode": { + "type": "boolean", + "description": "Can recovery code be used for MFA challenge for this account.", + "x-example": true + } + }, + "required": [ + "totp", + "phone", + "email", + "recoveryCode" + ], + "example": { + "totp": true, + "phone": true, + "email": true, + "recoveryCode": true + } + }, + "transaction": { + "description": "Transaction", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Transaction ID.", + "x-example": "259125845563242502" + }, + "$createdAt": { + "type": "string", + "description": "Transaction creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Transaction update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "status": { + "type": "string", + "description": "Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.", + "x-example": "pending" + }, + "operations": { + "type": "integer", + "description": "Number of operations in the transaction.", + "x-example": 5, + "format": "int32" + }, + "expiresAt": { + "type": "string", + "description": "Expiration time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "status", + "operations", + "expiresAt" + ], + "example": { + "$id": "259125845563242502", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "status": "pending", + "operations": 5, + "expiresAt": "2020-10-15T06:38:00.000+00:00" + } + }, + "subscriber": { + "description": "Subscriber", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Subscriber ID.", + "x-example": "259125845563242502" + }, + "$createdAt": { + "type": "string", + "description": "Subscriber creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Subscriber update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "countryCode": { + "targetId": { "type": "string", - "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "description": "Target ID.", + "x-example": "259125845563242502" }, - "countryName": { + "target": { + "type": "object", + "description": "Target.", + "x-example": { + "$id": "259125845563242502", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "providerType": "email", + "providerId": "259125845563242502", + "name": "ageon-app-email", + "identifier": "random-mail@email.org", + "userId": "5e5ea5c16897e" + }, + "items": { + "type": "object", + "$ref": "#\/definitions\/target" + } + }, + "userId": { "type": "string", - "description": "Country name.", - "x-example": "United States" - } - }, - "required": [ - "code", - "countryCode", - "countryName" - ], - "example": { - "code": "+1", - "countryCode": "US", - "countryName": "United States" - } - }, - "headers": { - "description": "Headers", - "type": "object", - "properties": { - "name": { + "description": "Topic ID.", + "x-example": "5e5ea5c16897e" + }, + "userName": { "type": "string", - "description": "Header name.", - "x-example": "Content-Type" + "description": "User Name.", + "x-example": "Aegon Targaryen" }, - "value": { + "topicId": { "type": "string", - "description": "Header value.", - "x-example": "application\/json" + "description": "Topic ID.", + "x-example": "259125845563242502" + }, + "providerType": { + "type": "string", + "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", + "x-example": "email" } }, "required": [ - "name", - "value" + "$id", + "$createdAt", + "$updatedAt", + "targetId", + "target", + "userId", + "userName", + "topicId", + "providerType" ], "example": { - "name": "Content-Type", - "value": "application\/json" + "$id": "259125845563242502", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "targetId": "259125845563242502", + "target": { + "$id": "259125845563242502", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "providerType": "email", + "providerId": "259125845563242502", + "name": "ageon-app-email", + "identifier": "random-mail@email.org", + "userId": "5e5ea5c16897e" + }, + "userId": "5e5ea5c16897e", + "userName": "Aegon Targaryen", + "topicId": "259125845563242502", + "providerType": "email" } }, - "mfaChallenge": { - "description": "MFA Challenge", + "target": { + "description": "Target", "type": "object", "properties": { "$id": { "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "description": "Target ID.", + "x-example": "259125845563242502" }, "$createdAt": { "type": "string", - "description": "Token creation date in ISO 8601 format.", + "description": "Target creation time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, + "$updatedAt": { + "type": "string", + "description": "Target update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Target Name.", + "x-example": "Apple iPhone 12" + }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "x-example": "259125845563242502" }, - "expire": { + "providerId": { "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Provider ID.", + "x-example": "259125845563242502", + "x-nullable": true + }, + "providerType": { + "type": "string", + "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", + "x-example": "email" + }, + "identifier": { + "type": "string", + "description": "The target identifier.", + "x-example": "token" + }, + "expired": { + "type": "boolean", + "description": "Is the target expired.", + "x-example": false } }, "required": [ "$id", "$createdAt", + "$updatedAt", + "name", "userId", - "expire" + "providerType", + "identifier", + "expired" ], "example": { - "$id": "bb8ea5c16897e", + "$id": "259125845563242502", "$createdAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5ea5c168bb8", - "expire": "2020-10-15T06:38:00.000+00:00" + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "Apple iPhone 12", + "userId": "259125845563242502", + "providerId": "259125845563242502", + "providerType": "email", + "identifier": "token", + "expired": false } }, - "mfaRecoveryCodes": { - "description": "MFA Recovery Codes", + "app": { + "description": "App", "type": "object", "properties": { - "recoveryCodes": { + "$id": { + "type": "string", + "description": "App ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "App creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "App update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "My Application" + }, + "redirectUris": { "type": "array", - "description": "Recovery codes.", + "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", "items": { "type": "string" }, "x-example": [ - "a3kf0-s0cl2", - "s0co1-as98s" + "https:\/\/example.com\/callback" ] - } - }, - "required": [ - "recoveryCodes" - ], - "example": { - "recoveryCodes": [ - "a3kf0-s0cl2", - "s0co1-as98s" - ] - } - }, - "mfaType": { - "description": "MFAType", - "type": "object", - "properties": { - "secret": { - "type": "string", - "description": "Secret token used for TOTP factor.", - "x-example": "[SHARED_SECRET]" }, - "uri": { - "type": "string", - "description": "URI for authenticator apps.", - "x-example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" - } - }, - "required": [ - "secret", - "uri" - ], - "example": { - "secret": "[SHARED_SECRET]", - "uri": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" - } - }, - "mfaFactors": { - "description": "MFAFactors", - "type": "object", - "properties": { - "totp": { + "enabled": { "type": "boolean", - "description": "Can TOTP be used for MFA challenge for this account.", + "description": "Whether the app is enabled or not.", "x-example": true }, - "phone": { - "type": "boolean", - "description": "Can phone (SMS) be used for MFA challenge for this account.", - "x-example": true + "type": { + "type": "string", + "description": "OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot keep a client secret (PKCE required); `confidential` for server-side clients that authenticate with a client secret.", + "x-example": "confidential" }, - "email": { + "deviceFlow": { "type": "boolean", - "description": "Can email be used for MFA challenge for this account.", - "x-example": true + "description": "Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).", + "x-example": false }, - "recoveryCode": { - "type": "boolean", - "description": "Can recovery code be used for MFA challenge for this account.", - "x-example": true + "teamId": { + "type": "string", + "description": "ID of team that owns the application, if owned by team. Otherwise, user ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "userId": { + "type": "string", + "description": "ID of user who owns the application, if owned by user. Otherwise, team ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "secrets": { + "type": "array", + "description": "List of application secrets.", + "items": { + "type": "object", + "$ref": "#\/definitions\/appSecret" + }, + "x-example": [] } }, "required": [ - "totp", - "phone", - "email", - "recoveryCode" + "$id", + "$createdAt", + "$updatedAt", + "name", + "redirectUris", + "enabled", + "type", + "deviceFlow", + "teamId", + "userId", + "secrets" ], "example": { - "totp": true, - "phone": true, - "email": true, - "recoveryCode": true + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Application", + "redirectUris": [ + "https:\/\/example.com\/callback" + ], + "enabled": true, + "type": "confidential", + "deviceFlow": false, + "teamId": "5e5ea5c16897e", + "userId": "5e5ea5c16897e", + "secrets": [] } }, - "transaction": { - "description": "Transaction", + "appSecret": { + "description": "AppSecret", "type": "object", "properties": { "$id": { "type": "string", - "description": "Transaction ID.", - "x-example": "259125845563242502" + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Transaction creation time in ISO 8601 format.", + "description": "Secret creation time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Transaction update date in ISO 8601 format.", + "description": "Secret update time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "appId": { "type": "string", - "description": "Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.", - "x-example": "pending" + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" }, - "operations": { - "type": "integer", - "description": "Number of operations in the transaction.", - "x-example": 5, - "format": "int32" + "secret": { + "type": "string", + "description": "Hashed application client secret.", + "x-example": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg" }, - "expiresAt": { + "hint": { "type": "string", - "description": "Expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" + }, + "createdById": { + "type": "string", + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" + }, + "createdByName": { + "type": "string", + "description": "Name of the user who created the secret.", + "x-example": "Walter White" + }, + "lastAccessedAt": { + "type": "string", + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true } }, "required": [ "$id", "$createdAt", "$updatedAt", - "status", - "operations", - "expiresAt" + "appId", + "secret", + "hint", + "createdById", + "createdByName" ], "example": { - "$id": "259125845563242502", + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "status": "pending", - "operations": 5, - "expiresAt": "2020-10-15T06:38:00.000+00:00" + "appId": "5e5ea5c16897e", + "secret": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" } }, - "subscriber": { - "description": "Subscriber", + "appSecretPlaintext": { + "description": "AppSecretPlaintext", "type": "object", "properties": { "$id": { "type": "string", - "description": "Subscriber ID.", - "x-example": "259125845563242502" + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Subscriber creation time in ISO 8601 format.", + "description": "Secret creation time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Subscriber update date in ISO 8601 format.", + "description": "Secret update time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "targetId": { + "appId": { "type": "string", - "description": "Target ID.", - "x-example": "259125845563242502" + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" }, - "target": { - "type": "object", - "description": "Target.", - "x-example": { - "$id": "259125845563242502", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "providerType": "email", - "providerId": "259125845563242502", - "name": "ageon-app-email", - "identifier": "random-mail@email.org", - "userId": "5e5ea5c16897e" - }, - "items": { - "type": "object", - "$ref": "#\/definitions\/target" - } + "secret": { + "type": "string", + "description": "Application client secret. Returned in full only when the secret is created; subsequent reads return a masked value.", + "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" }, - "userId": { + "hint": { "type": "string", - "description": "Topic ID.", - "x-example": "5e5ea5c16897e" + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" }, - "userName": { + "createdById": { "type": "string", - "description": "User Name.", - "x-example": "Aegon Targaryen" + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" }, - "topicId": { + "createdByName": { "type": "string", - "description": "Topic ID.", - "x-example": "259125845563242502" + "description": "Name of the user who created the secret.", + "x-example": "Walter White" }, - "providerType": { + "lastAccessedAt": { "type": "string", - "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email" + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true } }, "required": [ "$id", "$createdAt", "$updatedAt", - "targetId", - "target", - "userId", - "userName", - "topicId", - "providerType" + "appId", + "secret", + "hint", + "createdById", + "createdByName" ], "example": { - "$id": "259125845563242502", + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "targetId": "259125845563242502", - "target": { - "$id": "259125845563242502", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "providerType": "email", - "providerId": "259125845563242502", - "name": "ageon-app-email", - "identifier": "random-mail@email.org", - "userId": "5e5ea5c16897e" + "appId": "5e5ea5c16897e", + "secret": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, + "oauth2Authorize": { + "description": "OAuth2 Authorize", + "type": "object", + "properties": { + "grantId": { + "type": "string", + "description": "OAuth2 grant ID. Set when the user must give explicit consent; pass it to the approve or reject endpoint. Empty when a redirect URL is returned instead.", + "x-example": "5e5ea5c16897e" }, - "userId": "5e5ea5c16897e", - "userName": "Aegon Targaryen", - "topicId": "259125845563242502", - "providerType": "email" + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to when the flow can complete without consent. Empty when consent is still required.", + "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "required": [ + "grantId", + "redirectUrl" + ], + "example": { + "grantId": "5e5ea5c16897e", + "redirectUrl": "https:\/\/example.com\/callback?code=abcde&state=fghij" } }, - "target": { - "description": "Target", + "oauth2Approve": { + "description": "OAuth2 Approve", + "type": "object", + "properties": { + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to after the grant is approved, carrying the authorization `code` and\/or `id_token` along with the original `state`.", + "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "required": [ + "redirectUrl" + ], + "example": { + "redirectUrl": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "oauth2Reject": { + "description": "OAuth2 Reject", + "type": "object", + "properties": { + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to after the grant is rejected, carrying an `access_denied` error.", + "x-example": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + } + }, + "required": [ + "redirectUrl" + ], + "example": { + "redirectUrl": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + } + }, + "oauth2Grant": { + "description": "OAuth2 Grant", "type": "object", "properties": { "$id": { "type": "string", - "description": "Target ID.", - "x-example": "259125845563242502" + "description": "Grant ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Target creation time in ISO 8601 format.", + "description": "Grant creation time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Target update date in ISO 8601 format.", + "description": "Grant update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "name": { + "userId": { "type": "string", - "description": "Target Name.", - "x-example": "Apple iPhone 12" + "description": "ID of the user the grant belongs to.", + "x-example": "5e5ea5c16897e" }, - "userId": { + "appId": { "type": "string", - "description": "User ID.", - "x-example": "259125845563242502" + "description": "ID of the OAuth2 client (app) the grant was requested for.", + "x-example": "5e5ea5c16897e" }, - "providerId": { + "scopes": { + "type": "array", + "description": "Requested OAuth2 scopes the user is being asked to consent to.", + "items": { + "type": "string" + }, + "x-example": [ + "openid", + "email", + "profile" + ] + }, + "authorizationDetails": { "type": "string", - "description": "Provider ID.", - "x-example": "259125845563242502", - "x-nullable": true + "description": "Requested authorization_details the user is being asked to consent to, as a JSON string. Each entry has a `type` plus project-defined fields.", + "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" }, - "providerType": { + "prompt": { "type": "string", - "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email" + "description": "OIDC prompt directive the consent screen should honor. Space-separated list of: login, consent, select_account.", + "x-example": "login" }, - "identifier": { + "redirectUri": { "type": "string", - "description": "The target identifier.", - "x-example": "token" + "description": "Redirect URI the user will be sent to after the flow completes.", + "x-example": "https:\/\/example.com\/callback" }, - "expired": { - "type": "boolean", - "description": "Is the target expired.", - "x-example": false + "authTime": { + "type": "integer", + "description": "Unix timestamp of when the user last authenticated.", + "x-example": 1592981250, + "format": "int32" + }, + "expire": { + "type": "string", + "description": "Grant expiration time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "name", "userId", - "providerType", - "identifier", - "expired" + "appId", + "scopes", + "authorizationDetails", + "prompt", + "redirectUri", + "authTime", + "expire" ], "example": { - "$id": "259125845563242502", + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "Apple iPhone 12", - "userId": "259125845563242502", - "providerId": "259125845563242502", - "providerType": "email", - "identifier": "token", - "expired": false + "userId": "5e5ea5c16897e", + "appId": "5e5ea5c16897e", + "scopes": [ + "openid", + "email", + "profile" + ], + "authorizationDetails": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]", + "prompt": "login", + "redirectUri": "https:\/\/example.com\/callback", + "authTime": 1592981250, + "expire": "2020-10-15T06:38:00.000+00:00" + } + }, + "appsList": { + "description": "Apps list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of apps that matched your query.", + "x-example": 5, + "format": "int32" + }, + "apps": { + "type": "array", + "description": "List of apps.", + "items": { + "type": "object", + "$ref": "#\/definitions\/app" + }, + "x-example": "" + } + }, + "required": [ + "total", + "apps" + ], + "example": { + "total": 5, + "apps": "" + } + }, + "appSecretList": { + "description": "App secrets list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of secrets that matched your query.", + "x-example": 5, + "format": "int32" + }, + "secrets": { + "type": "array", + "description": "List of secrets.", + "items": { + "type": "object", + "$ref": "#\/definitions\/appSecret" + }, + "x-example": "" + } + }, + "required": [ + "total", + "secrets" + ], + "example": { + "total": 5, + "secrets": "" } } }, diff --git a/specs/1.9.x/swagger2-1.9.x-console.json b/specs/1.9.x/swagger2-1.9.x-console.json index 4b5bb6753..e838d8687 100644 --- a/specs/1.9.x/swagger2-1.9.x-console.json +++ b/specs/1.9.x/swagger2-1.9.x-console.json @@ -38,6 +38,15 @@ "demo": "<YOUR_PROJECT_ID>" } }, + "ProjectQuery": { + "type": "apiKey", + "name": "project", + "description": "Your project ID", + "in": "query", + "x-appwrite": { + "demo": "<YOUR_PROJECT_ID>" + } + }, "Key": { "type": "apiKey", "name": "X-Appwrite-Key", @@ -230,7 +239,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -241,7 +253,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "name": { "type": "string", @@ -2803,11 +2816,12 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "oldPassword": { "type": "string", - "description": "Current user password. Must be at least 8 chars.", + "description": "Current user password. Max length: 256 chars.", "default": "", "x-example": "password", "format": "password" @@ -3640,7 +3654,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" } }, "required": [ @@ -3953,7 +3968,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -4218,7 +4236,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -4297,7 +4318,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -4609,7 +4633,10 @@ "targetId": { "type": "string", "description": "Target 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.", - "x-example": "<TARGET_ID>" + "x-example": "<TARGET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "identifier": { "type": "string", @@ -4831,7 +4858,10 @@ "userId": { "type": "string", "description": "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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -4920,7 +4950,10 @@ "userId": { "type": "string", "description": "Unique 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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -5198,7 +5231,10 @@ "userId": { "type": "string", "description": "Unique 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. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "phone": { "type": "string", @@ -5729,6 +5765,845 @@ ] } }, + "\/apps": { + "get": { + "summary": "List Applications", + "operationId": "appsList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "List applications.", + "responses": { + "200": { + "description": "Apps list", + "schema": { + "$ref": "#\/definitions\/appsList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create Application", + "operationId": "appsCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Create a new application.", + "responses": { + "201": { + "description": "App", + "schema": { + "$ref": "#\/definitions\/app" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "appId": { + "type": "string", + "description": "Application 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.", + "x-example": "<APP_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + }, + "teamId": { + "type": "string", + "description": "Team unique ID.", + "default": "", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "appId", + "name", + "redirectUris" + ] + } + } + ] + } + }, + "\/apps\/{appId}": { + "get": { + "summary": "Get Application", + "operationId": "appsGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Get an application by its unique ID.", + "responses": { + "200": { + "description": "App", + "schema": { + "$ref": "#\/definitions\/app" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + } + ] + }, + "put": { + "summary": "Update Application", + "operationId": "appsUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Update an application by its unique ID.", + "responses": { + "200": { + "description": "App", + "schema": { + "$ref": "#\/definitions\/app" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete Application", + "operationId": "appsDelete", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Delete an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/secrets": { + "get": { + "summary": "List Secrets", + "operationId": "appsListSecrets", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "List client secrets for an application.", + "responses": { + "200": { + "description": "App secrets list", + "schema": { + "$ref": "#\/definitions\/appSecretList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listSecrets", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/list-secrets.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create Secret", + "operationId": "appsCreateSecret", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Create a new client secret for an application.", + "responses": { + "201": { + "description": "AppSecretPlaintext", + "schema": { + "$ref": "#\/definitions\/appSecretPlaintext" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/create-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/secrets\/{secretId}": { + "get": { + "summary": "Get Secret", + "operationId": "appsGetSecret", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Get an application client secret by its unique ID.", + "responses": { + "200": { + "description": "AppSecret", + "schema": { + "$ref": "#\/definitions\/appSecret" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/get-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "type": "string", + "x-example": "<SECRET_ID>", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete Secret", + "operationId": "appsDeleteSecret", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Delete an application client secret by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "type": "string", + "x-example": "<SECRET_ID>", + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/team": { + "patch": { + "summary": "Update Team", + "operationId": "appsUpdateTeam", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Transfer an application to another team by its unique ID.", + "responses": { + "200": { + "description": "App", + "schema": { + "$ref": "#\/definitions\/app" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTeam", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update-team.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team ID of the team to transfer application to.", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "teamId" + ] + } + } + ] + } + }, + "\/apps\/{appId}\/tokens": { + "delete": { + "summary": "Delete Tokens", + "operationId": "appsDeleteTokens", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Revoke all tokens for an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTokens", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-tokens.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + } + ] + } + }, "\/avatars\/browsers\/{code}": { "get": { "summary": "Get browser icon", @@ -5769,7 +6644,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -5777,7 +6653,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5895,7 +6772,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -5903,7 +6781,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6027,7 +6906,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -6035,7 +6915,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6091,7 +6972,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -6099,7 +6981,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6579,7 +7462,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -6587,7 +7471,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6663,7 +7548,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -6671,7 +7557,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6755,7 +7642,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -6763,7 +7651,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6847,7 +7736,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-screenshot.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -6855,7 +7745,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -8242,6 +9133,9 @@ "description": "Policy 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.", "required": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<ARCHIVE_ID>", "in": "path" } @@ -8376,7 +9270,10 @@ "policyId": { "type": "string", "description": "Policy 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.", - "x-example": "<POLICY_ID>" + "x-example": "<POLICY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -8659,6 +9556,9 @@ "description": "Policy 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.", "required": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<POLICY_ID>", "in": "path" } @@ -8758,7 +9658,10 @@ "type": "string", "description": "Unique 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.", "default": "", - "x-example": "<NEW_RESOURCE_ID>" + "x-example": "<NEW_RESOURCE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "newResourceName": { "type": "string", @@ -9016,7 +9919,10 @@ "databaseId": { "type": "string", "description": "Database 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -9222,6 +10128,53 @@ ] } }, + "\/compute\/databases\/specifications": { + "get": { + "summary": "List dedicated database specifications.", + "operationId": "computeListDatabaseSpecifications", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "compute" + ], + "description": "List the dedicated database specifications available on the current plan. Each specification reports its resource limits, pricing, and whether it is enabled for the organization.", + "responses": { + "200": { + "description": "SpecificationList", + "schema": { + "$ref": "#\/definitions\/dedicatedDatabaseSpecificationList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listDatabaseSpecifications", + "group": "databases", + "cookies": false, + "type": "", + "demo": "compute\/list-database-specifications.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ] + } + }, "\/compute\/databases\/{databaseId}": { "get": { "summary": "Get dedicated database.", @@ -9880,7 +10833,10 @@ "policyId": { "type": "string", "description": "Policy 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.", - "x-example": "<POLICY_ID>" + "x-example": "<POLICY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -10282,7 +11238,10 @@ "type": "string", "description": "Branch 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.", "default": "", - "x-example": "<BRANCH_ID>" + "x-example": "<BRANCH_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "ttl": { "type": "integer", @@ -10692,7 +11651,7 @@ "tags": [ "compute" ], - "description": "Execute SQL through the console-facing Cloud endpoint. Cloud proxies through the edge platform to the per-database SQL API sidecar. Application traffic should bypass cloud entirely and POST directly to the per-database hostname: `https:\/\/db-{project}-{db}.{region}.appwrite.network\/v1\/sql\/execute` with an `X-Appwrite-Key` header \u2014 that path scales to the whole DB fleet without a per-query cloud round-trip. The statement type must be on the database's configured allow-list. Use bound parameters for any user-supplied values \u2014 the API does not interpolate raw strings.", + "description": "Execute SQL through the console-facing Cloud endpoint. Cloud proxies through the edge platform to the per-database SQL API sidecar. Application traffic should bypass cloud entirely and POST directly to the per-database hostname: `https:\/\/db-{project}-{db}.{region}.appwrite.center\/v1\/sql\/execute` with an `X-Appwrite-Key` header \u2014 that path scales to the whole DB fleet without a per-query cloud round-trip. The statement type must be on the database's configured allow-list. Use bound parameters for any user-supplied values \u2014 the API does not interpolate raw strings.", "responses": { "200": { "description": "Execution", @@ -10968,249 +11927,53 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Extension name (e.g., pgvector, postgis, uuid-ossp).", - "x-example": "<NAME>" - } - }, - "required": [ - "name" - ] - } - } - ] - } - }, - "\/compute\/databases\/{databaseId}\/extensions\/{extensionName}": { - "delete": { - "summary": "Uninstall a database extension.", - "operationId": "computeDeleteDatabaseExtension", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "compute" - ], - "description": "Uninstall a database extension from a PostgreSQL database. The uninstall runs asynchronously; poll the extensions list endpoint for status.", - "responses": { - "202": { - "description": "DedicatedDatabase", - "schema": { - "$ref": "#\/definitions\/dedicatedDatabase" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteDatabaseExtension", - "group": "databases", - "cookies": false, - "type": "", - "demo": "compute\/delete-database-extension.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "<DATABASE_ID>", - "in": "path" - }, - { - "name": "extensionName", - "description": "Extension name to uninstall.", - "required": true, - "type": "string", - "x-example": "<EXTENSION_NAME>", - "in": "path" - } - ] - } - }, - "\/compute\/databases\/{databaseId}\/ha": { - "get": { - "summary": "Get HA status.", - "operationId": "computeGetDatabaseHAStatus", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "compute" - ], - "description": "Get high availability status for a dedicated database. Returns replica statuses, replication lag, and sync mode.", - "responses": { - "200": { - "description": "HAStatus", - "schema": { - "$ref": "#\/definitions\/dedicatedDatabaseHAStatus" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getDatabaseHAStatus", - "group": "databases", - "cookies": false, - "type": "", - "demo": "compute\/get-database-ha-status.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "<DATABASE_ID>", - "in": "path" - } - ] - } - }, - "\/compute\/databases\/{databaseId}\/ha\/failovers": { - "post": { - "summary": "Trigger manual failover.", - "operationId": "computeCreateDatabaseFailover", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "compute" - ], - "description": "Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.", - "responses": { - "202": { - "description": "DedicatedDatabase", - "schema": { - "$ref": "#\/definitions\/dedicatedDatabase" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createDatabaseFailover", - "group": "databases", - "cookies": false, - "type": "", - "demo": "compute\/create-database-failover.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "<DATABASE_ID>", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "targetReplicaId": { + "name": { "type": "string", - "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "description": "Extension name (e.g., pgvector, postgis, uuid-ossp).", + "x-example": "<NAME>" } - } + }, + "required": [ + "name" + ] } } ] } }, - "\/compute\/databases\/{databaseId}\/insights": { - "get": { - "summary": "Get database performance insights.", - "operationId": "computeGetDatabaseInsights", - "consumes": [], + "\/compute\/databases\/{databaseId}\/extensions\/{extensionName}": { + "delete": { + "summary": "Uninstall a database extension.", + "operationId": "computeDeleteDatabaseExtension", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "compute" ], - "description": "Get query-level performance insights for a dedicated database. Returns top queries by execution time, wait events, and aggregate query statistics.", + "description": "Uninstall a database extension from a PostgreSQL database. The uninstall runs asynchronously; poll the extensions list endpoint for status.", "responses": { - "200": { - "description": "PerformanceInsights", + "202": { + "description": "DedicatedDatabase", "schema": { - "$ref": "#\/definitions\/dedicatedDatabasePerformanceInsights" + "$ref": "#\/definitions\/dedicatedDatabase" } } }, "deprecated": false, "x-appwrite": { - "method": "getDatabaseInsights", + "method": "deleteDatabaseExtension", "group": "databases", "cookies": false, "type": "", - "demo": "compute\/get-database-insights.md", + "demo": "compute\/delete-database-extension.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "databases.write", "platforms": [ "console" ], @@ -11235,30 +11998,77 @@ "in": "path" }, { - "name": "period", - "description": "Analysis period for performance insights. Allowed values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days).", - "required": false, + "name": "extensionName", + "description": "Extension name to uninstall.", + "required": true, "type": "string", - "x-example": "1h", - "default": "1h", - "in": "query" - }, + "x-example": "<EXTENSION_NAME>", + "in": "path" + } + ] + } + }, + "\/compute\/databases\/{databaseId}\/ha": { + "get": { + "summary": "Get HA status.", + "operationId": "computeGetDatabaseHAStatus", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "compute" + ], + "description": "Get high availability status for a dedicated database. Returns replica statuses, replication lag, and sync mode.", + "responses": { + "200": { + "description": "HAStatus", + "schema": { + "$ref": "#\/definitions\/dedicatedDatabaseHAStatus" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getDatabaseHAStatus", + "group": "databases", + "cookies": false, + "type": "", + "demo": "compute\/get-database-ha-status.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "limit", - "description": "Maximum number of queries to return.", - "required": false, - "type": "integer", - "format": "int32", - "default": 25, - "in": "query" + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "<DATABASE_ID>", + "in": "path" } ] } }, - "\/compute\/databases\/{databaseId}\/maintenance": { - "patch": { - "summary": "Update database maintenance window.", - "operationId": "computeUpdateDatabaseMaintenanceWindow", + "\/compute\/databases\/{databaseId}\/ha\/failovers": { + "post": { + "summary": "Trigger manual failover.", + "operationId": "computeCreateDatabaseFailover", "consumes": [ "application\/json" ], @@ -11268,9 +12078,9 @@ "tags": [ "compute" ], - "description": "Update the maintenance window for a dedicated database. Maintenance operations like minor version upgrades will be performed during this window.", + "description": "Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.", "responses": { - "200": { + "202": { "description": "DedicatedDatabase", "schema": { "$ref": "#\/definitions\/dedicatedDatabase" @@ -11279,11 +12089,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDatabaseMaintenanceWindow", + "method": "createDatabaseFailover", "group": "databases", "cookies": false, "type": "", - "demo": "compute\/update-database-maintenance-window.md", + "demo": "compute\/create-database-failover.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11317,58 +12127,51 @@ "schema": { "type": "object", "properties": { - "day": { + "targetReplicaId": { "type": "string", - "description": "Day of the week for the maintenance window. Allowed values: sun, mon, tue, wed, thu, fri, sat.", - "x-example": "sun" - }, - "hourUtc": { - "type": "integer", - "description": "Hour in UTC (0-23) for maintenance window start.", - "x-example": 0, - "format": "int32" + "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", + "x-example": "<TARGET_REPLICA_ID>", + "x-nullable": true } - }, - "required": [ - "day", - "hourUtc" - ] + } } } ] } }, - "\/compute\/databases\/{databaseId}\/metrics": { - "get": { - "summary": "Get database metrics.", - "operationId": "computeGetDatabaseMetrics", - "consumes": [], + "\/compute\/databases\/{databaseId}\/maintenance": { + "patch": { + "summary": "Update database maintenance window.", + "operationId": "computeUpdateDatabaseMaintenanceWindow", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "compute" ], - "description": "Get detailed performance metrics for a dedicated database. Returns CPU, memory, storage, IOPS, QPS, and connection metrics.", + "description": "Update the maintenance window for a dedicated database. Maintenance operations like minor version upgrades will be performed during this window.", "responses": { "200": { - "description": "DatabaseMetrics", + "description": "DedicatedDatabase", "schema": { - "$ref": "#\/definitions\/dedicatedDatabaseMetrics" + "$ref": "#\/definitions\/dedicatedDatabase" } } }, "deprecated": false, "x-appwrite": { - "method": "getDatabaseMetrics", + "method": "updateDatabaseMaintenanceWindow", "group": "databases", "cookies": false, "type": "", - "demo": "compute\/get-database-metrics.md", + "demo": "compute\/update-database-maintenance-window.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "databases.write", "platforms": [ "console" ], @@ -11393,13 +12196,28 @@ "in": "path" }, { - "name": "period", - "description": "Metrics aggregation period. Allowed values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days), 30d (last 30 days).", - "required": false, - "type": "string", - "x-example": "1h", - "default": "24h", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "day": { + "type": "string", + "description": "Day of the week for the maintenance window. Allowed values: sun, mon, tue, wed, thu, fri, sat.", + "x-example": "sun" + }, + "hourUtc": { + "type": "integer", + "description": "Hour in UTC (0-23) for maintenance window start.", + "x-example": 0, + "format": "int32" + } + }, + "required": [ + "day", + "hourUtc" + ] + } } ] } @@ -11417,7 +12235,7 @@ "tags": [ "compute" ], - "description": "Migrate a database between shared and dedicated types. Shared to dedicated creates an always-on StatefulSet with external access. Dedicated to shared converts to a serverless pod that scales to zero when idle. Data is preserved during migration.", + "description": "Migrate a database between shared and dedicated types. Shared to dedicated provisions an always-on dedicated instance; dedicated to shared converts to a serverless instance that scales to zero when idle. Data is copied to the target with a brief read-only window during cutover.", "responses": { "200": { "description": "DedicatedDatabase", @@ -11470,6 +12288,12 @@ "type": "string", "description": "Target database type to migrate to. Allowed values: shared (serverless, scales to zero when idle), dedicated (always-on with persistent resources).", "x-example": "shared" + }, + "specification": { + "type": "string", + "description": "Target compute specification to provision when migrating to dedicated. Ignored for shared. Defaults to the database's current specification.", + "x-example": "<SPECIFICATION>", + "x-nullable": true } }, "required": [ @@ -13370,6 +14194,9 @@ "threats", "feedbacks", "sh_installations", + "apps", + "appsecrets", + "oauth2grants", "attributes", "indexes", "functions", @@ -13454,6 +14281,9 @@ "threats", "feedbacks", "sh_installations", + "apps", + "app_secrets", + "oauth2_grants", "attributes", "indexes", "functions", @@ -14109,7 +14939,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -15118,7 +15951,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -20135,7 +20971,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -20719,6 +21558,9 @@ "description": "Document ID.", "required": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<DOCUMENT_ID>", "in": "path" }, @@ -22202,7 +23044,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -22214,6 +23059,12 @@ "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "specification": { + "type": "string", + "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", + "default": "free", + "x-example": "<SPECIFICATION>" } }, "required": [ @@ -23015,7 +23866,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -23560,7 +24414,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -29490,7 +30347,10 @@ "functionId": { "type": "string", "description": "Function 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.", - "x-example": "<FUNCTION_ID>" + "x-example": "<FUNCTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -29597,7 +30457,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "FunctionRuntime", + "x-enum-name": "Runtime", "x-enum-keys": [ "node-14.5", "node-16.0", @@ -29848,9 +30708,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes", @@ -29945,9 +30808,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ] } @@ -30278,7 +31144,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "FunctionRuntime", + "x-enum-name": "Runtime", "x-enum-keys": [ "node-14.5", "node-16.0", @@ -30794,7 +31660,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "FunctionRuntime", + "x-enum-name": "Runtime", "x-enum-keys": [ "node-14.5", "node-16.0", @@ -31045,9 +31911,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes", @@ -31142,9 +32011,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ] } @@ -32005,14 +32877,16 @@ "packaging": false, "public": true, "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -32214,7 +33088,7 @@ "application\/json" ], "produces": [ - "multipart\/form-data" + "application\/json" ], "tags": [ "functions" @@ -32697,7 +33571,10 @@ "variableId": { "type": "string", "description": "Variable 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -33199,6 +34076,56 @@ ] } }, + "\/health\/audits-db": { + "get": { + "summary": "Get audits DB", + "operationId": "healthGetAuditsDB", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "health" + ], + "description": "Check the database that backs the audit and activity store. When the connection is reachable the endpoint returns a passing status with its response time.\n", + "responses": { + "200": { + "description": "Status List", + "schema": { + "$ref": "#\/definitions\/healthStatusList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getAuditsDB", + "group": null, + "cookies": false, + "type": "", + "demo": "health\/get-audits-db.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "health.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/health\/get-audits-db.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, "\/health\/cache": { "get": { "summary": "Get cache", @@ -35867,7 +36794,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "subject": { "type": "string", @@ -36179,7 +37109,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "title": { "type": "string", @@ -36649,7 +37582,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "content": { "type": "string", @@ -37382,7 +38318,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -37742,7 +38681,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -37984,7 +38926,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -38169,98 +39114,320 @@ "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" - } - } - } - } - ] - } - }, - "\/messaging\/providers\/msg91": { - "post": { - "summary": "Create Msg91 provider", - "operationId": "messagingCreateMsg91Provider", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "messaging" - ], - "description": "Create a new MSG91 provider.", - "responses": { - "201": { - "description": "Provider", - "schema": { - "$ref": "#\/definitions\/provider" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createMsg91Provider", - "group": "providers", - "cookies": false, - "type": "", - "demo": "messaging\/create-msg-91-provider.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "providers.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "providerId": { - "type": "string", - "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" - }, - "name": { - "type": "string", - "description": "Provider name.", - "x-example": "<NAME>" - }, - "templateId": { - "type": "string", - "description": "Msg91 template ID", - "default": "", - "x-example": "<TEMPLATE_ID>" - }, - "senderId": { - "type": "string", - "description": "Msg91 sender ID.", - "default": "", - "x-example": "<SENDER_ID>" - }, - "authKey": { - "type": "string", - "description": "Msg91 auth key.", - "default": "", - "x-example": "<AUTH_KEY>" + "x-example": "<REPLY_TO_EMAIL>" + } + } + } + } + ] + } + }, + "\/messaging\/providers\/msg91": { + "post": { + "summary": "Create Msg91 provider", + "operationId": "messagingCreateMsg91Provider", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "messaging" + ], + "description": "Create a new MSG91 provider.", + "responses": { + "201": { + "description": "Provider", + "schema": { + "$ref": "#\/definitions\/provider" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createMsg91Provider", + "group": "providers", + "cookies": false, + "type": "", + "demo": "messaging\/create-msg-91-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "providers.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "providerId": { + "type": "string", + "description": "Provider 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.", + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Provider name.", + "x-example": "<NAME>" + }, + "templateId": { + "type": "string", + "description": "Msg91 template ID", + "default": "", + "x-example": "<TEMPLATE_ID>" + }, + "senderId": { + "type": "string", + "description": "Msg91 sender ID.", + "default": "", + "x-example": "<SENDER_ID>" + }, + "authKey": { + "type": "string", + "description": "Msg91 auth key.", + "default": "", + "x-example": "<AUTH_KEY>" + }, + "enabled": { + "type": "boolean", + "description": "Set as enabled.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "providerId", + "name" + ] + } + } + ] + } + }, + "\/messaging\/providers\/msg91\/{providerId}": { + "patch": { + "summary": "Update Msg91 provider", + "operationId": "messagingUpdateMsg91Provider", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "messaging" + ], + "description": "Update a MSG91 provider by its unique ID.", + "responses": { + "200": { + "description": "Provider", + "schema": { + "$ref": "#\/definitions\/provider" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateMsg91Provider", + "group": "providers", + "cookies": false, + "type": "", + "demo": "messaging\/update-msg-91-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "providers.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "providerId", + "description": "Provider ID.", + "required": true, + "type": "string", + "x-example": "<PROVIDER_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Provider name.", + "default": "", + "x-example": "<NAME>" + }, + "enabled": { + "type": "boolean", + "description": "Set as enabled.", + "x-example": false, + "x-nullable": true + }, + "templateId": { + "type": "string", + "description": "Msg91 template ID.", + "default": "", + "x-example": "<TEMPLATE_ID>" + }, + "senderId": { + "type": "string", + "description": "Msg91 sender ID.", + "default": "", + "x-example": "<SENDER_ID>" + }, + "authKey": { + "type": "string", + "description": "Msg91 auth key.", + "default": "", + "x-example": "<AUTH_KEY>" + } + } + } + } + ] + } + }, + "\/messaging\/providers\/resend": { + "post": { + "summary": "Create Resend provider", + "operationId": "messagingCreateResendProvider", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "messaging" + ], + "description": "Create a new Resend provider.", + "responses": { + "201": { + "description": "Provider", + "schema": { + "$ref": "#\/definitions\/provider" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createResendProvider", + "group": "providers", + "cookies": false, + "type": "", + "demo": "messaging\/create-resend-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "providers.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-resend-provider.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "providerId": { + "type": "string", + "description": "Provider 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.", + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Provider name.", + "x-example": "<NAME>" + }, + "apiKey": { + "type": "string", + "description": "Resend API key.", + "default": "", + "x-example": "<API_KEY>" + }, + "fromName": { + "type": "string", + "description": "Sender Name.", + "default": "", + "x-example": "<FROM_NAME>" + }, + "fromEmail": { + "type": "string", + "description": "Sender email address.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "replyToName": { + "type": "string", + "description": "Name set in the reply to field for the mail. Default value is sender name.", + "default": "", + "x-example": "<REPLY_TO_NAME>" + }, + "replyToEmail": { + "type": "string", + "description": "Email set in the reply to field for the mail. Default value is sender email.", + "default": "", + "x-example": "email@example.com", + "format": "email" }, "enabled": { "type": "boolean", @@ -38278,10 +39445,10 @@ ] } }, - "\/messaging\/providers\/msg91\/{providerId}": { + "\/messaging\/providers\/resend\/{providerId}": { "patch": { - "summary": "Update Msg91 provider", - "operationId": "messagingUpdateMsg91Provider", + "summary": "Update Resend provider", + "operationId": "messagingUpdateResendProvider", "consumes": [ "application\/json" ], @@ -38291,7 +39458,7 @@ "tags": [ "messaging" ], - "description": "Update a MSG91 provider by its unique ID.", + "description": "Update a Resend provider by its unique ID.", "responses": { "200": { "description": "Provider", @@ -38302,11 +39469,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMsg91Provider", + "method": "updateResendProvider", "group": "providers", "cookies": false, "type": "", - "demo": "messaging\/update-msg-91-provider.md", + "demo": "messaging\/update-resend-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -38317,7 +39484,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-resend-provider.md", "auth": { "Project": [] } @@ -38355,23 +39522,36 @@ "x-example": false, "x-nullable": true }, - "templateId": { + "apiKey": { "type": "string", - "description": "Msg91 template ID.", + "description": "Resend API key.", "default": "", - "x-example": "<TEMPLATE_ID>" + "x-example": "<API_KEY>" }, - "senderId": { + "fromName": { "type": "string", - "description": "Msg91 sender ID.", + "description": "Sender Name.", "default": "", - "x-example": "<SENDER_ID>" + "x-example": "<FROM_NAME>" }, - "authKey": { + "fromEmail": { "type": "string", - "description": "Msg91 auth key.", + "description": "Sender email address.", "default": "", - "x-example": "<AUTH_KEY>" + "x-example": "email@example.com", + "format": "email" + }, + "replyToName": { + "type": "string", + "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", + "default": "", + "x-example": "<REPLY_TO_NAME>" + }, + "replyToEmail": { + "type": "string", + "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", + "default": "", + "x-example": "<REPLY_TO_EMAIL>" } } } @@ -38379,10 +39559,10 @@ ] } }, - "\/messaging\/providers\/resend": { + "\/messaging\/providers\/sendgrid": { "post": { - "summary": "Create Resend provider", - "operationId": "messagingCreateResendProvider", + "summary": "Create Sendgrid provider", + "operationId": "messagingCreateSendgridProvider", "consumes": [ "application\/json" ], @@ -38392,7 +39572,7 @@ "tags": [ "messaging" ], - "description": "Create a new Resend provider.", + "description": "Create a new Sendgrid provider.", "responses": { "201": { "description": "Provider", @@ -38403,11 +39583,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "createResendProvider", + "method": "createSendgridProvider", "group": "providers", "cookies": false, "type": "", - "demo": "messaging\/create-resend-provider.md", + "demo": "messaging\/create-sendgrid-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -38418,7 +39598,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-resend-provider.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md", "auth": { "Project": [] } @@ -38439,7 +39619,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -38448,7 +39631,7 @@ }, "apiKey": { "type": "string", - "description": "Resend API key.", + "description": "Sendgrid API key.", "default": "", "x-example": "<API_KEY>" }, @@ -38494,10 +39677,10 @@ ] } }, - "\/messaging\/providers\/resend\/{providerId}": { + "\/messaging\/providers\/sendgrid\/{providerId}": { "patch": { - "summary": "Update Resend provider", - "operationId": "messagingUpdateResendProvider", + "summary": "Update Sendgrid provider", + "operationId": "messagingUpdateSendgridProvider", "consumes": [ "application\/json" ], @@ -38507,7 +39690,7 @@ "tags": [ "messaging" ], - "description": "Update a Resend provider by its unique ID.", + "description": "Update a Sendgrid provider by its unique ID.", "responses": { "200": { "description": "Provider", @@ -38518,11 +39701,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateResendProvider", + "method": "updateSendgridProvider", "group": "providers", "cookies": false, "type": "", - "demo": "messaging\/update-resend-provider.md", + "demo": "messaging\/update-sendgrid-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -38533,7 +39716,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-resend-provider.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md", "auth": { "Project": [] } @@ -38573,7 +39756,7 @@ }, "apiKey": { "type": "string", - "description": "Resend API key.", + "description": "Sendgrid API key.", "default": "", "x-example": "<API_KEY>" }, @@ -38608,10 +39791,10 @@ ] } }, - "\/messaging\/providers\/sendgrid": { + "\/messaging\/providers\/ses": { "post": { - "summary": "Create Sendgrid provider", - "operationId": "messagingCreateSendgridProvider", + "summary": "Create Amazon SES provider", + "operationId": "messagingCreateSesProvider", "consumes": [ "application\/json" ], @@ -38621,7 +39804,7 @@ "tags": [ "messaging" ], - "description": "Create a new Sendgrid provider.", + "description": "Create a new Amazon SES provider.", "responses": { "201": { "description": "Provider", @@ -38632,11 +39815,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "createSendgridProvider", + "method": "createSesProvider", "group": "providers", "cookies": false, "type": "", - "demo": "messaging\/create-sendgrid-provider.md", + "demo": "messaging\/create-ses-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -38647,7 +39830,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-ses-provider.md", "auth": { "Project": [] } @@ -38668,18 +39851,33 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", "description": "Provider name.", "x-example": "<NAME>" }, - "apiKey": { + "accessKey": { "type": "string", - "description": "Sendgrid API key.", + "description": "AWS access key ID.", "default": "", - "x-example": "<API_KEY>" + "x-example": "<ACCESS_KEY>" + }, + "secretKey": { + "type": "string", + "description": "AWS secret access key.", + "default": "", + "x-example": "<SECRET_KEY>" + }, + "region": { + "type": "string", + "description": "AWS region, for example us-east-1.", + "default": "", + "x-example": "<REGION>" }, "fromName": { "type": "string", @@ -38723,10 +39921,10 @@ ] } }, - "\/messaging\/providers\/sendgrid\/{providerId}": { + "\/messaging\/providers\/ses\/{providerId}": { "patch": { - "summary": "Update Sendgrid provider", - "operationId": "messagingUpdateSendgridProvider", + "summary": "Update Amazon SES provider", + "operationId": "messagingUpdateSesProvider", "consumes": [ "application\/json" ], @@ -38736,7 +39934,7 @@ "tags": [ "messaging" ], - "description": "Update a Sendgrid provider by its unique ID.", + "description": "Update an Amazon SES provider by its unique ID.", "responses": { "200": { "description": "Provider", @@ -38747,11 +39945,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSendgridProvider", + "method": "updateSesProvider", "group": "providers", "cookies": false, "type": "", - "demo": "messaging\/update-sendgrid-provider.md", + "demo": "messaging\/update-ses-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -38762,7 +39960,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-ses-provider.md", "auth": { "Project": [] } @@ -38800,11 +39998,23 @@ "x-example": false, "x-nullable": true }, - "apiKey": { + "accessKey": { "type": "string", - "description": "Sendgrid API key.", + "description": "AWS access key ID.", "default": "", - "x-example": "<API_KEY>" + "x-example": "<ACCESS_KEY>" + }, + "secretKey": { + "type": "string", + "description": "AWS secret access key.", + "default": "", + "x-example": "<SECRET_KEY>" + }, + "region": { + "type": "string", + "description": "AWS region, for example us-east-1.", + "default": "", + "x-example": "<REGION>" }, "fromName": { "type": "string", @@ -38983,7 +40193,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -39012,7 +40225,8 @@ "type": "string", "description": "Authentication password.", "default": "", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "encryption": { "type": "string", @@ -39261,7 +40475,8 @@ "type": "string", "description": "Authentication password.", "default": "", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "encryption": { "type": "string", @@ -39388,7 +40603,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -39591,7 +40809,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -39794,7 +41015,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -39997,7 +41221,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -40557,7 +41784,10 @@ "topicId": { "type": "string", "description": "Topic ID. Choose a custom Topic ID or a new Topic ID.", - "x-example": "<TOPIC_ID>" + "x-example": "<TOPIC_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -41024,7 +42254,10 @@ "subscriberId": { "type": "string", "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", - "x-example": "<SUBSCRIBER_ID>" + "x-example": "<SUBSCRIBER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "targetId": { "type": "string", @@ -41320,6 +42553,9 @@ "user", "team", "membership", + "auth-methods", + "policies", + "oauth2-provider", "database", "table", "column", @@ -41343,13 +42579,25 @@ "site-deployment", "site-variable", "platform", - "backup-policy" + "api-key", + "webhook", + "smtp", + "backup-policy", + "project-variable", + "project-protocols", + "project-labels", + "project-services", + "project-email-template", + "rule" ], "x-enum-name": "AppwriteMigrationResource", "x-enum-keys": [ "user", "team", "membership", + "auth-methods", + "policies", + "oauth2-provider", "database", "table", "column", @@ -41373,7 +42621,16 @@ "site-deployment", "site-variable", "platform", - "backup-policy" + "api-key", + "webhook", + "smtp", + "backup-policy", + "project-variable", + "project-protocols", + "project-labels", + "project-services", + "project-email-template", + "rule" ] } }, @@ -41403,7 +42660,7 @@ "skip", "overwrite" ], - "x-enum-name": "MigrationOnDuplicate", + "x-enum-name": "OnDuplicate", "x-enum-keys": [ "fail", "skip", @@ -41481,6 +42738,9 @@ "user", "team", "membership", + "auth-methods", + "policies", + "oauth2-provider", "database", "table", "column", @@ -41504,13 +42764,25 @@ "site-deployment", "site-variable", "platform", - "backup-policy" + "api-key", + "webhook", + "smtp", + "backup-policy", + "project-variable", + "project-protocols", + "project-labels", + "project-services", + "project-email-template", + "rule" ], "x-enum-name": "AppwriteMigrationResource", "x-enum-keys": [ "user", "team", "membership", + "auth-methods", + "policies", + "oauth2-provider", "database", "table", "column", @@ -41534,7 +42806,16 @@ "site-deployment", "site-variable", "platform", - "backup-policy" + "api-key", + "webhook", + "smtp", + "backup-policy", + "project-variable", + "project-protocols", + "project-labels", + "project-services", + "project-email-template", + "rule" ] }, "in": "query" @@ -41776,7 +43057,7 @@ "skip", "overwrite" ], - "x-enum-name": "MigrationOnDuplicate", + "x-enum-name": "OnDuplicate", "x-enum-keys": [ "fail", "skip", @@ -42176,7 +43457,7 @@ "skip", "overwrite" ], - "x-enum-name": "MigrationOnDuplicate", + "x-enum-name": "OnDuplicate", "x-enum-keys": [ "fail", "skip", @@ -42312,7 +43593,8 @@ "password": { "type": "string", "description": "Source's Database Password", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "port": { "type": "integer", @@ -42466,7 +43748,8 @@ "description": "Source's Database Password.", "required": true, "type": "string", - "x-example": "<PASSWORD>", + "format": "password", + "x-example": "password", "in": "query" }, { @@ -42595,7 +43878,8 @@ "password": { "type": "string", "description": "Source's Database Password", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "port": { "type": "integer", @@ -42741,7 +44025,8 @@ "description": "Source's Database Password.", "required": true, "type": "string", - "x-example": "<PASSWORD>", + "format": "password", + "x-example": "password", "in": "query" }, { @@ -43054,7 +44339,10 @@ "keyId": { "type": "string", "description": "Key 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.", - "x-example": "<KEY_ID>" + "x-example": "<KEY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -43840,7 +45128,10 @@ "organizationId": { "type": "string", "description": "Organization 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.", - "x-example": "<ORGANIZATION_ID>" + "x-example": "<ORGANIZATION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -44461,7 +45752,7 @@ "baa", "backup_recovery" ], - "x-enum-name": "OrganizationAddon", + "x-enum-name": "Addon", "x-enum-keys": [ "baa", "backup_recovery" @@ -45669,7 +46960,7 @@ "method": "getInvoiceDownload", "group": null, "cookies": false, - "type": "", + "type": "location", "demo": "organizations\/get-invoice-download.md", "rate-limit": 0, "rate-time": 3600, @@ -45682,12 +46973,14 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-invoice-download.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -45888,7 +47181,7 @@ "method": "getInvoiceView", "group": null, "cookies": false, - "type": "", + "type": "location", "demo": "organizations\/get-invoice-view.md", "rate-limit": 0, "rate-time": 3600, @@ -45901,12 +47194,14 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-invoice-view.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -47808,7 +49103,10 @@ "keyId": { "type": "string", "description": "Key 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.", - "x-example": "<KEY_ID>" + "x-example": "<KEY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -47912,9 +49210,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes", @@ -48009,9 +49310,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ] } @@ -48187,9 +49491,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes", @@ -48284,9 +49591,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ] } @@ -48530,9 +49840,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes", @@ -48627,9 +49940,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ] } @@ -49189,6 +50505,162 @@ ] } }, + "\/project\/oauth2-server": { + "put": { + "summary": "Update OAuth2 server", + "operationId": "projectUpdateOAuth2Server", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update the OAuth2 server (OIDC provider) configuration.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Server", + "group": null, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-server.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable the OAuth2 server.", + "x-example": false + }, + "authorizationUrl": { + "type": "string", + "description": "URL to your application with consent screen.", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "scopes": { + "type": "array", + "description": "List of allowed OAuth2 scopes. Maximum of 100 scopes are allowed, each up to 128 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "authorizationDetailsTypes": { + "type": "array", + "description": "List of accepted `authorization_details` types. Maximum of 100 types are allowed, each up to 128 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "accessTokenDuration": { + "type": "integer", + "description": "Access token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 8 hours.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "refreshTokenDuration": { + "type": "integer", + "description": "Refresh token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 1 year.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "publicAccessTokenDuration": { + "type": "integer", + "description": "Access token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 1 hour.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "publicRefreshTokenDuration": { + "type": "integer", + "description": "Refresh token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 30 days.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "confidentialPkce": { + "type": "boolean", + "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", + "x-example": false, + "x-nullable": true + }, + "verificationUrl": { + "type": "string", + "description": "URL to your application page where users enter the device flow user code. Required to enable the Device Authorization Grant.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "userCodeLength": { + "type": "integer", + "description": "Number of characters in the device flow user code, excluding the formatting separator. Shorter codes are easier to type but weaker; pair short codes with short expiry. Leave empty to use default 8.", + "x-example": 6, + "format": "int32", + "x-nullable": true + }, + "userCodeFormat": { + "type": "string", + "description": "Character set for device flow user codes: `numeric` (digits only \u2014 best for numeric keypads and TV remotes), `alphabetic` (letters only), or `alphanumeric` (letters and digits \u2014 highest entropy per character). Defaults to `alphanumeric`.", + "default": "alphanumeric", + "x-example": "numeric" + }, + "deviceCodeDuration": { + "type": "integer", + "description": "Lifetime in seconds of device flow device codes and user codes. Device codes are intentionally short-lived. Leave empty to use default 600.", + "x-example": 60, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "enabled", + "authorizationUrl" + ] + } + } + ] + } + }, "\/project\/oauth2\/amazon": { "patch": { "summary": "Update project OAuth2 Amazon", @@ -53113,7 +54585,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -53279,7 +54754,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -53445,7 +54923,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -53611,7 +55092,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -53777,7 +55261,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -54376,41 +55863,194 @@ "schema": { "type": "object", "properties": { - "userId": { - "type": "boolean", - "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", - "x-example": false - }, - "userEmail": { - "type": "boolean", - "description": "Set to true if you want make user email visible to all team members, or false to hide it.", - "x-example": false - }, - "userPhone": { - "type": "boolean", - "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", - "x-example": false - }, - "userName": { - "type": "boolean", - "description": "Set to true if you want make user name visible to all team members, or false to hide it.", - "x-example": false - }, - "userMFA": { - "type": "boolean", - "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", - "x-example": false + "userId": { + "type": "boolean", + "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", + "x-example": false + }, + "userEmail": { + "type": "boolean", + "description": "Set to true if you want make user email visible to all team members, or false to hide it.", + "x-example": false + }, + "userPhone": { + "type": "boolean", + "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", + "x-example": false + }, + "userName": { + "type": "boolean", + "description": "Set to true if you want make user name visible to all team members, or false to hide it.", + "x-example": false + }, + "userMFA": { + "type": "boolean", + "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", + "x-example": false + }, + "userAccessedAt": { + "type": "boolean", + "description": "Set to true if you want make user last access time visible to all team members, or false to hide it.", + "x-example": false + } + } + } + } + ] + } + }, + "\/project\/policies\/password-dictionary": { + "patch": { + "summary": "Update password dictionary policy", + "operationId": "projectUpdatePasswordDictionaryPolicy", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePasswordDictionaryPolicy", + "group": "policies", + "cookies": false, + "type": "", + "demo": "project\/update-password-dictionary-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, + "\/project\/policies\/password-history": { + "patch": { + "summary": "Update password history policy", + "operationId": "projectUpdatePasswordHistoryPolicy", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePasswordHistoryPolicy", + "group": "policies", + "cookies": false, + "type": "", + "demo": "project\/update-password-history-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", + "x-example": 1, + "format": "int32", + "x-nullable": true } - } + }, + "required": [ + "total" + ] } } ] } }, - "\/project\/policies\/password-dictionary": { + "\/project\/policies\/password-personal-data": { "patch": { - "summary": "Update password dictionary policy", - "operationId": "projectUpdatePasswordDictionaryPolicy", + "summary": "Update password personal data policy", + "operationId": "projectUpdatePasswordPersonalDataPolicy", "consumes": [ "application\/json" ], @@ -54420,7 +56060,7 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", + "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", "responses": { "200": { "description": "Project", @@ -54431,11 +56071,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordDictionaryPolicy", + "method": "updatePasswordPersonalDataPolicy", "group": "policies", "cookies": false, "type": "", - "demo": "project\/update-password-dictionary-policy.md", + "demo": "project\/update-password-personal-data-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -54468,7 +56108,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", + "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", "x-example": false } }, @@ -54480,10 +56120,10 @@ ] } }, - "\/project\/policies\/password-history": { + "\/project\/policies\/password-strength": { "patch": { - "summary": "Update password history policy", - "operationId": "projectUpdatePasswordHistoryPolicy", + "summary": "Update password strength policy", + "operationId": "projectUpdatePasswordStrengthPolicy", "consumes": [ "application\/json" ], @@ -54493,22 +56133,22 @@ "tags": [ "project" ], - "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", + "description": "Update the password strength requirements for users in the project.", "responses": { "200": { - "description": "Project", + "description": "Policy Password Strength", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/policyPasswordStrength" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordHistoryPolicy", + "method": "updatePasswordStrengthPolicy", "group": "policies", "cookies": false, "type": "", - "demo": "project\/update-password-history-policy.md", + "demo": "project\/update-password-strength-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -54539,90 +56179,33 @@ "schema": { "type": "object", "properties": { - "total": { + "min": { "type": "integer", - "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", - "x-example": 1, - "format": "int32", - "x-nullable": true - } - }, - "required": [ - "total" - ] - } - } - ] - } - }, - "\/project\/policies\/password-personal-data": { - "patch": { - "summary": "Update password personal data policy", - "operationId": "projectUpdatePasswordPersonalDataPolicy", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "project" - ], - "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", - "responses": { - "200": { - "description": "Project", - "schema": { - "$ref": "#\/definitions\/project" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updatePasswordPersonalDataPolicy", - "group": "policies", - "cookies": false, - "type": "", - "demo": "project\/update-password-personal-data-policy.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "policies.write", - "project.policies.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "enabled": { + "description": "Minimum password length. Value must be between 8 and 256. Default is 8.", + "x-example": 8, + "format": "int32" + }, + "uppercase": { "type": "boolean", - "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", + "description": "Whether passwords must include at least one uppercase letter.", + "x-example": false + }, + "lowercase": { + "type": "boolean", + "description": "Whether passwords must include at least one lowercase letter.", + "x-example": false + }, + "number": { + "type": "boolean", + "description": "Whether passwords must include at least one number.", + "x-example": false + }, + "symbols": { + "type": "boolean", + "description": "Whether passwords must include at least one symbol.", "x-example": false } - }, - "required": [ - "enabled" - ] + } } } ] @@ -55012,7 +56595,7 @@ "description": "Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.", "responses": { "200": { - "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy", + "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Strength, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy, or Policy Deny Aliased Email, or Policy Deny Disposable Email, or Policy Deny Free Email", "schema": { "x-oneOf": [ { @@ -55021,6 +56604,9 @@ { "$ref": "#\/definitions\/policyPasswordHistory" }, + { + "$ref": "#\/definitions\/policyPasswordStrength" + }, { "$ref": "#\/definitions\/policyPasswordPersonalData" }, @@ -55041,6 +56627,15 @@ }, { "$ref": "#\/definitions\/policyMembershipPrivacy" + }, + { + "$ref": "#\/definitions\/policyDenyAliasedEmail" + }, + { + "$ref": "#\/definitions\/policyDenyDisposableEmail" + }, + { + "$ref": "#\/definitions\/policyDenyFreeEmail" } ], "x-discriminator": { @@ -55048,13 +56643,17 @@ "mapping": { "password-dictionary": "#\/definitions\/policyPasswordDictionary", "password-history": "#\/definitions\/policyPasswordHistory", + "password-strength": "#\/definitions\/policyPasswordStrength", "password-personal-data": "#\/definitions\/policyPasswordPersonalData", "session-alert": "#\/definitions\/policySessionAlert", "session-duration": "#\/definitions\/policySessionDuration", "session-invalidation": "#\/definitions\/policySessionInvalidation", "session-limit": "#\/definitions\/policySessionLimit", "user-limit": "#\/definitions\/policyUserLimit", - "membership-privacy": "#\/definitions\/policyMembershipPrivacy" + "membership-privacy": "#\/definitions\/policyMembershipPrivacy", + "deny-aliased-email": "#\/definitions\/policyDenyAliasedEmail", + "deny-disposable-email": "#\/definitions\/policyDenyDisposableEmail", + "deny-free-email": "#\/definitions\/policyDenyFreeEmail" } } } @@ -55093,32 +56692,40 @@ "parameters": [ { "name": "policyId", - "description": "Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.", + "description": "Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, deny-aliased-email, deny-disposable-email, deny-free-email.", "required": true, "type": "string", "x-example": "password-dictionary", "enum": [ "password-dictionary", "password-history", + "password-strength", "password-personal-data", "session-alert", "session-duration", "session-invalidation", "session-limit", "user-limit", - "membership-privacy" + "membership-privacy", + "deny-aliased-email", + "deny-disposable-email", + "deny-free-email" ], "x-enum-name": "ProjectPolicyId", "x-enum-keys": [ "password-dictionary", "password-history", + "password-strength", "password-personal-data", "session-alert", "session-duration", "session-invalidation", "session-limit", "user-limit", - "membership-privacy" + "membership-privacy", + "deny-aliased-email", + "deny-disposable-email", + "deny-free-email" ], "in": "path" } @@ -55266,7 +56873,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, documentsDB, tablesDB, vectorsDB, locale, health, project, storage, teams, users, vcs, webhooks, tokens, presences, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "type": "string", "x-example": "account", @@ -55275,6 +56882,9 @@ "avatars", "databases", "tablesdb", + "documentsDB", + "tablesDB", + "vectorsDB", "locale", "health", "project", @@ -55282,6 +56892,9 @@ "teams", "users", "vcs", + "webhooks", + "tokens", + "presences", "sites", "functions", "proxy", @@ -55296,6 +56909,9 @@ "avatars", "databases", "tablesdb", + "documentsDB", + "tablesDB", + "vectorsDB", "locale", "health", "project", @@ -55303,6 +56919,9 @@ "teams", "users", "vcs", + "webhooks", + "tokens", + "presences", "sites", "functions", "proxy", @@ -55411,7 +57030,8 @@ "password": { "type": "string", "description": "SMTP server password. Pass an empty string to clear a previously set value. This property is stored securely and cannot be read in future (write-only).", - "x-example": "<PASSWORD>", + "x-example": "password", + "format": "password", "x-nullable": true }, "senderEmail": { @@ -56572,7 +58192,10 @@ "variableId": { "type": "string", "description": "Variable unique 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -57545,7 +59168,7 @@ "enum": [ "active" ], - "x-enum-name": "ProjectStatus", + "x-enum-name": "Status", "x-enum-keys": [ "active" ] @@ -57862,7 +59485,7 @@ }, "\/proxy\/rules\/redirect": { "post": { - "summary": "Create Redirect rule", + "summary": "Create redirect rule", "operationId": "proxyCreateRedirectRule", "consumes": [ "application\/json" @@ -57937,7 +59560,7 @@ "307", "308" ], - "x-enum-name": "RedirectStatusCode", + "x-enum-name": "StatusCode", "x-enum-keys": [ "MovedPermanently", "Found", @@ -58708,7 +60331,10 @@ "siteId": { "type": "string", "description": "Site 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.", - "x-example": "<SITE_ID>" + "x-example": "<SITE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -58736,7 +60362,7 @@ "vite", "other" ], - "x-enum-name": "SiteFramework", + "x-enum-name": "Framework", "x-enum-keys": [ "analog", "angular", @@ -58898,7 +60524,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "SiteBuildRuntime", + "x-enum-name": "BuildRuntime", "x-enum-keys": [ "node-14.5", "node-16.0", @@ -59004,7 +60630,7 @@ "static", "ssr" ], - "x-enum-name": "SiteAdapter", + "x-enum-name": "Adapter", "x-enum-keys": [ "static", "ssr" @@ -59264,7 +60890,7 @@ "vite", "other" ], - "x-enum-name": "SiteFramework", + "x-enum-name": "Framework", "x-enum-keys": [ "analog", "angular", @@ -59617,7 +61243,7 @@ "vite", "other" ], - "x-enum-name": "SiteFramework", + "x-enum-name": "Framework", "x-enum-keys": [ "analog", "angular", @@ -59779,7 +61405,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "SiteBuildRuntime", + "x-enum-name": "BuildRuntime", "x-enum-keys": [ "node-14.5", "node-16.0", @@ -59885,7 +61511,7 @@ "static", "ssr" ], - "x-enum-name": "SiteAdapter", + "x-enum-name": "Adapter", "x-enum-keys": [ "static", "ssr" @@ -60759,14 +62385,16 @@ "packaging": false, "public": true, "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -61309,7 +62937,10 @@ "variableId": { "type": "string", "description": "Variable 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -61701,7 +63332,10 @@ "bucketId": { "type": "string", "description": "Unique 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.", - "x-example": "<BUCKET_ID>" + "x-example": "<BUCKET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -62213,6 +63847,9 @@ "required": true, "x-upload-id": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<FILE_ID>", "in": "formData" }, @@ -62509,7 +64146,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -62517,7 +64155,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -62589,7 +64228,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -62597,7 +64237,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -62814,7 +64455,8 @@ "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { - "Project": [] + "Project": [], + "ImpersonateUserId": [] } }, "security": [ @@ -62822,7 +64464,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -63142,7 +64785,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -64062,7 +65708,10 @@ "tableId": { "type": "string", "description": "Unique 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.", - "x-example": "<TABLE_ID>" + "x-example": "<TABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -65048,7 +66697,7 @@ }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { "patch": { - "summary": "Update dateTime column", + "summary": "Update datetime column", "operationId": "tablesDBUpdateDatetimeColumn", "consumes": [ "application\/json" @@ -69617,7 +71266,10 @@ "type": "string", "description": "Row 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.", "default": "", - "x-example": "<ROW_ID>" + "x-example": "<ROW_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -71099,7 +72751,10 @@ "teamId": { "type": "string", "description": "Team 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.", - "x-example": "<TEAM_ID>" + "x-example": "<TEAM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -72724,7 +74379,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -72744,7 +74402,8 @@ "type": "string", "description": "Plain text user password. Must be at least 8 chars.", "default": "", - "x-example": null + "x-example": "password", + "format": "password" }, "name": { "type": "string", @@ -72821,7 +74480,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -72912,7 +74574,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -73142,7 +74807,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -73233,7 +74901,10 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. 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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -73324,7 +74995,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -73449,7 +75123,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -73558,7 +75235,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -75182,7 +76862,8 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": null + "x-example": "password", + "format": "password" } }, "required": [ @@ -75540,6 +77221,9 @@ "description": "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.", "required": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<USER_ID>", "in": "path" } @@ -75898,7 +77582,10 @@ "targetId": { "type": "string", "description": "Target 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.", - "x-example": "<TARGET_ID>" + "x-example": "<TARGET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "providerType": { "type": "string", @@ -77357,7 +79044,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -77369,6 +79059,12 @@ "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "specification": { + "type": "string", + "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", + "default": "free", + "x-example": "<SPECIFICATION>" } }, "required": [ @@ -77382,7 +79078,7 @@ }, "\/vectorsdb\/embeddings\/text": { "post": { - "summary": "Create Text Embeddings", + "summary": "Create text embeddings", "operationId": "vectorsDBCreateTextEmbeddings", "consumes": [ "application\/json" @@ -77475,14 +79171,20 @@ "model": { "type": "string", "description": "The embedding model to use for generating vector embeddings.", - "default": "embeddinggemma", - "x-example": "embeddinggemma", + "default": "nomic-embed-text", + "x-example": "nomic-embed-text", "enum": [ - "embeddinggemma" + "nomic-embed-text", + "embedding-gemma", + "all-minilm", + "bge-small" ], "x-enum-name": "EmbeddingModel", "x-enum-keys": [ - "embeddinggemma" + "nomic-embed-text", + "embedding-gemma", + "all-minilm", + "bge-small" ] } }, @@ -78367,7 +80069,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -78900,7 +80605,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -79451,6 +81159,9 @@ "description": "Document ID.", "required": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<DOCUMENT_ID>", "in": "path" }, @@ -80377,7 +82088,10 @@ "webhookId": { "type": "string", "description": "Webhook 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.", - "x-example": "<WEBHOOK_ID>" + "x-example": "<WEBHOOK_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "url": { "type": "string", @@ -80419,7 +82133,8 @@ "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_PASSWORD>" + "x-example": "password", + "format": "password" }, "secret": { "type": "string", @@ -80600,7 +82315,8 @@ "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_PASSWORD>" + "x-example": "password", + "format": "password" } }, "required": [ @@ -80761,6 +82477,18 @@ "name": "tablesdb", "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" }, + { + "name": "documentsDB", + "description": "The DocumentsDB service allows you to create structured collections of documents, query and filter lists of documents." + }, + { + "name": "tablesDB", + "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows." + }, + { + "name": "vectorsDB", + "description": "The VectorsDB service allows you to create vector collections, embeddings, indexes, and documents." + }, { "name": "locale", "description": "The Locale service allows you to customize your app based on your users' location." @@ -80789,6 +82517,18 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, + { + "name": "webhooks", + "description": "The Webhooks service allows you to configure event-driven HTTP callbacks for your project." + }, + { + "name": "tokens", + "description": "The Tokens service allows you to create and manage resource tokens for project resources." + }, + { + "name": "presences", + "description": "The Presences service allows you to create, query, and manage realtime presence state." + }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -80809,6 +82549,14 @@ "name": "console", "description": "The Console service allows you to interact with console relevant information." }, + { + "name": "assistant", + "description": "The Assistant service allows Console users to ask assistant queries." + }, + { + "name": "organization", + "description": "The Organization service allows you to manage organization-level projects." + }, { "name": "migrations", "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." @@ -82010,7 +83758,7 @@ "total": { "type": "integer", "description": "Total number of policies in the given project.", - "x-example": 9, + "x-example": 10, "format": "int32" }, "policies": { @@ -82024,6 +83772,9 @@ { "$ref": "#\/definitions\/policyPasswordHistory" }, + { + "$ref": "#\/definitions\/policyPasswordStrength" + }, { "$ref": "#\/definitions\/policyPasswordPersonalData" }, @@ -82044,6 +83795,15 @@ }, { "$ref": "#\/definitions\/policyMembershipPrivacy" + }, + { + "$ref": "#\/definitions\/policyDenyAliasedEmail" + }, + { + "$ref": "#\/definitions\/policyDenyDisposableEmail" + }, + { + "$ref": "#\/definitions\/policyDenyFreeEmail" } ], "x-discriminator": { @@ -82051,13 +83811,17 @@ "mapping": { "password-dictionary": "#\/definitions\/policyPasswordDictionary", "password-history": "#\/definitions\/policyPasswordHistory", + "password-strength": "#\/definitions\/policyPasswordStrength", "password-personal-data": "#\/definitions\/policyPasswordPersonalData", "session-alert": "#\/definitions\/policySessionAlert", "session-duration": "#\/definitions\/policySessionDuration", "session-invalidation": "#\/definitions\/policySessionInvalidation", "session-limit": "#\/definitions\/policySessionLimit", "user-limit": "#\/definitions\/policyUserLimit", - "membership-privacy": "#\/definitions\/policyMembershipPrivacy" + "membership-privacy": "#\/definitions\/policyMembershipPrivacy", + "deny-aliased-email": "#\/definitions\/policyDenyAliasedEmail", + "deny-disposable-email": "#\/definitions\/policyDenyDisposableEmail", + "deny-free-email": "#\/definitions\/policyDenyFreeEmail" } } }, @@ -82069,7 +83833,7 @@ "policies" ], "example": { - "total": 9, + "total": 10, "policies": "" } }, @@ -82682,7 +84446,7 @@ "model": { "type": "string", "description": "Embedding model used to generate embeddings.", - "x-example": "embeddinggemma" + "x-example": "nomic-embed-text" }, "dimension": { "type": "integer", @@ -82716,7 +84480,7 @@ "error" ], "example": { - "model": "embeddinggemma", + "model": "nomic-embed-text", "dimension": 768, "embedding": [ 0.01, @@ -88308,6 +90072,36 @@ "description": "Email verification status.", "x-example": true }, + "emailCanonical": { + "type": "string", + "description": "Canonical form of the user email address.", + "x-example": "john@appwrite.io", + "x-nullable": true + }, + "emailIsFree": { + "type": "boolean", + "description": "Whether the user email is from a free email provider.", + "x-example": true, + "x-nullable": true + }, + "emailIsDisposable": { + "type": "boolean", + "description": "Whether the user email is from a disposable email provider.", + "x-example": false, + "x-nullable": true + }, + "emailIsCorporate": { + "type": "boolean", + "description": "Whether the user email is from a corporate domain.", + "x-example": true, + "x-nullable": true + }, + "emailIsCanonical": { + "type": "boolean", + "description": "Whether the user email is in its canonical form.", + "x-example": true, + "x-nullable": true + }, "phoneVerification": { "type": "boolean", "description": "Phone verification status.", @@ -88392,6 +90186,11 @@ "email": "john@appwrite.io", "phone": "+4930901820", "emailVerification": true, + "emailCanonical": "john@appwrite.io", + "emailIsFree": true, + "emailIsDisposable": false, + "emailIsCorporate": true, + "emailIsCanonical": true, "phoneVerification": true, "mfa": true, "prefs": { @@ -89498,6 +91297,11 @@ "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", "x-example": false }, + "userAccessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, "roles": { "type": "array", "description": "User list of roles", @@ -89523,6 +91327,7 @@ "joined", "confirm", "mfa", + "userAccessedAt", "roles" ], "example": { @@ -89539,6 +91344,7 @@ "joined": "2020-10-15T06:38:00.000+00:00", "confirm": false, "mfa": false, + "userAccessedAt": "2020-10-15T06:38:00.000+00:00", "roles": [ "owner" ] @@ -91641,6 +93447,11 @@ "description": "Project team ID.", "x-example": "1592981250" }, + "region": { + "type": "string", + "description": "Project region", + "x-example": "fra" + }, "devKeys": { "type": "array", "description": "Deprecated since 1.9.5: List of dev keys.", @@ -91694,7 +93505,8 @@ "smtpPassword": { "type": "string", "description": "SMTP server password. This property is write-only and always returned empty.", - "x-example": "" + "x-example": "smtp-password", + "format": "password" }, "smtpSecure": { "type": "string", @@ -91754,10 +93566,19 @@ }, "x-example": {} }, - "region": { + "blocks": { + "type": "array", + "description": "Project blocks information", + "items": { + "type": "object", + "$ref": "#\/definitions\/block" + }, + "x-example": "" + }, + "consoleAccessedAt": { "type": "string", - "description": "Project region", - "x-example": "fra" + "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, "billingLimits": { "type": "object", @@ -91769,19 +93590,92 @@ }, "x-nullable": true }, - "blocks": { + "oAuth2ServerEnabled": { + "type": "boolean", + "description": "OAuth2 server status", + "x-example": false + }, + "oAuth2ServerAuthorizationUrl": { + "type": "string", + "description": "OAuth2 server authorization URL", + "x-example": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration" + }, + "oAuth2ServerScopes": { "type": "array", - "description": "Project blocks information", + "description": "OAuth2 server allowed scopes", "items": { - "type": "object", - "$ref": "#\/definitions\/block" + "type": "string" }, - "x-example": "" + "x-example": [ + "read", + "write" + ] }, - "consoleAccessedAt": { + "oAuth2ServerAuthorizationDetailsTypes": { + "type": "array", + "description": "OAuth2 server accepted RFC 9396 authorization_details types", + "items": { + "type": "string" + }, + "x-example": [ + "calendar" + ] + }, + "oAuth2ServerAccessTokenDuration": { + "type": "integer", + "description": "OAuth2 server access token duration in seconds for confidential clients", + "x-example": 3600, + "format": "int32" + }, + "oAuth2ServerRefreshTokenDuration": { + "type": "integer", + "description": "OAuth2 server refresh token duration in seconds for confidential clients", + "x-example": 86400, + "format": "int32" + }, + "oAuth2ServerPublicAccessTokenDuration": { + "type": "integer", + "description": "OAuth2 server access token duration in seconds for public clients (SPAs, mobile, native)", + "x-example": 3600, + "format": "int32" + }, + "oAuth2ServerPublicRefreshTokenDuration": { + "type": "integer", + "description": "OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)", + "x-example": 2592000, + "format": "int32" + }, + "oAuth2ServerConfidentialPkce": { + "type": "boolean", + "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", + "x-example": false + }, + "oAuth2ServerVerificationUrl": { "type": "string", - "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "URL to your application page where users enter the device flow user code. Empty when the Device Authorization Grant is not configured.", + "x-example": "https:\/\/cloud.appwrite.io\/device" + }, + "oAuth2ServerUserCodeLength": { + "type": "integer", + "description": "Number of characters in the device flow user code, excluding the formatting separator.", + "x-example": 8, + "format": "int32" + }, + "oAuth2ServerUserCodeFormat": { + "type": "string", + "description": "Character set for device flow user codes: `numeric`, `alphabetic`, or `alphanumeric`.", + "x-example": "alphanumeric" + }, + "oAuth2ServerDeviceCodeDuration": { + "type": "integer", + "description": "Lifetime in seconds of device flow device codes and user codes.", + "x-example": 600, + "format": "int32" + }, + "oAuth2ServerDiscoveryUrl": { + "type": "string", + "description": "OAuth2 server discovery URL", + "x-example": "https:\/\/auth.example.com\/.well-known\/openid-configuration" } }, "required": [ @@ -91790,6 +93684,7 @@ "$updatedAt", "name", "teamId", + "region", "devKeys", "smtpEnabled", "smtpSenderName", @@ -91808,9 +93703,22 @@ "authMethods", "services", "protocols", - "region", "blocks", - "consoleAccessedAt" + "consoleAccessedAt", + "oAuth2ServerEnabled", + "oAuth2ServerAuthorizationUrl", + "oAuth2ServerScopes", + "oAuth2ServerAuthorizationDetailsTypes", + "oAuth2ServerAccessTokenDuration", + "oAuth2ServerRefreshTokenDuration", + "oAuth2ServerPublicAccessTokenDuration", + "oAuth2ServerPublicRefreshTokenDuration", + "oAuth2ServerConfidentialPkce", + "oAuth2ServerVerificationUrl", + "oAuth2ServerUserCodeLength", + "oAuth2ServerUserCodeFormat", + "oAuth2ServerDeviceCodeDuration", + "oAuth2ServerDiscoveryUrl" ], "example": { "$id": "5e5ea5c16897e", @@ -91818,6 +93726,7 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "New Project", "teamId": "1592981250", + "region": "fra", "devKeys": {}, "smtpEnabled": false, "smtpSenderName": "John Appwrite", @@ -91827,7 +93736,7 @@ "smtpHost": "mail.appwrite.io", "smtpPort": 25, "smtpUsername": "emailuser", - "smtpPassword": "", + "smtpPassword": "smtp-password", "smtpSecure": "tls", "pingCount": 1, "pingedAt": "2020-10-15T06:38:00.000+00:00", @@ -91838,10 +93747,28 @@ "authMethods": {}, "services": {}, "protocols": {}, - "region": "fra", - "billingLimits": "", "blocks": "", - "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00", + "billingLimits": "", + "oAuth2ServerEnabled": false, + "oAuth2ServerAuthorizationUrl": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration", + "oAuth2ServerScopes": [ + "read", + "write" + ], + "oAuth2ServerAuthorizationDetailsTypes": [ + "calendar" + ], + "oAuth2ServerAccessTokenDuration": 3600, + "oAuth2ServerRefreshTokenDuration": 86400, + "oAuth2ServerPublicAccessTokenDuration": 3600, + "oAuth2ServerPublicRefreshTokenDuration": 2592000, + "oAuth2ServerConfidentialPkce": false, + "oAuth2ServerVerificationUrl": "https:\/\/cloud.appwrite.io\/device", + "oAuth2ServerUserCodeLength": 8, + "oAuth2ServerUserCodeFormat": "alphanumeric", + "oAuth2ServerDeviceCodeDuration": 600, + "oAuth2ServerDiscoveryUrl": "https:\/\/auth.example.com\/.well-known\/openid-configuration" } }, "projectAuthMethod": { @@ -91891,6 +93818,9 @@ "avatars", "databases", "tablesdb", + "documentsDB", + "tablesDB", + "vectorsDB", "locale", "health", "project", @@ -91898,6 +93828,9 @@ "teams", "users", "vcs", + "webhooks", + "tokens", + "presences", "sites", "functions", "proxy", @@ -92006,7 +93939,8 @@ "authPassword": { "type": "string", "description": "HTTP basic authentication password.", - "x-example": "password" + "x-example": "webhook-password", + "format": "password" }, "secret": { "type": "string", @@ -92057,7 +93991,7 @@ ], "tls": true, "authUsername": "username", - "authPassword": "password", + "authPassword": "webhook-password", "secret": "ad3d581ca230e2b7059c545e5a", "enabled": true, "logs": "Failed to connect to remote server.", @@ -94218,6 +96152,59 @@ "total": 5 } }, + "policyPasswordStrength": { + "description": "Policy Password Strength", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "min": { + "type": "integer", + "description": "Minimum password length required for user passwords.", + "x-example": 12, + "format": "int32" + }, + "uppercase": { + "type": "boolean", + "description": "Whether passwords must include at least one uppercase letter.", + "x-example": true + }, + "lowercase": { + "type": "boolean", + "description": "Whether passwords must include at least one lowercase letter.", + "x-example": true + }, + "number": { + "type": "boolean", + "description": "Whether passwords must include at least one number.", + "x-example": true + }, + "symbols": { + "type": "boolean", + "description": "Whether passwords must include at least one symbol.", + "x-example": true + } + }, + "required": [ + "$id", + "min", + "uppercase", + "lowercase", + "number", + "symbols" + ], + "example": { + "$id": "password-dictionary", + "min": 12, + "uppercase": true, + "lowercase": true, + "number": true, + "symbols": true + } + }, "policyPasswordPersonalData": { "description": "Policy Password Personal Data", "type": "object", @@ -94398,6 +96385,11 @@ "type": "boolean", "description": "Whether user MFA status is visible in memberships.", "x-example": true + }, + "userAccessedAt": { + "type": "boolean", + "description": "Whether user last access time is visible in memberships.", + "x-example": true } }, "required": [ @@ -94406,7 +96398,8 @@ "userEmail", "userPhone", "userName", - "userMFA" + "userMFA", + "userAccessedAt" ], "example": { "$id": "password-dictionary", @@ -94414,7 +96407,8 @@ "userEmail": true, "userPhone": true, "userName": true, - "userMFA": true + "userMFA": true, + "userAccessedAt": true } }, "platformWeb": { @@ -99197,6 +101191,72 @@ "x-example": 5, "format": "int32" }, + "api-key": { + "type": "integer", + "description": "Number of API keys to be migrated.", + "x-example": 5, + "format": "int32" + }, + "project-variable": { + "type": "integer", + "description": "Number of project variables to be migrated.", + "x-example": 5, + "format": "int32" + }, + "webhook": { + "type": "integer", + "description": "Number of webhooks to be migrated.", + "x-example": 5, + "format": "int32" + }, + "auth-methods": { + "type": "integer", + "description": "Number of auth-method configs to be migrated (always 0 or 1 \u2014 the project-level flag bundle).", + "x-example": 1, + "format": "int32" + }, + "project-protocols": { + "type": "integer", + "description": "Number of protocol configs to be migrated (always 0 or 1 \u2014 the project-level REST\/GraphQL\/WebSocket flags).", + "x-example": 1, + "format": "int32" + }, + "project-labels": { + "type": "integer", + "description": "Number of label sets to be migrated (always 0 or 1 \u2014 the project-level RBAC label array).", + "x-example": 1, + "format": "int32" + }, + "project-services": { + "type": "integer", + "description": "Number of service configs to be migrated (always 0 or 1 \u2014 the project-level enable\/disable flags for all 17 services).", + "x-example": 1, + "format": "int32" + }, + "policies": { + "type": "integer", + "description": "Number of policy bundles to be migrated (always 0 or 1 \u2014 the project-level security policies covering password rules, session behavior, user limits, and membership privacy).", + "x-example": 1, + "format": "int32" + }, + "smtp": { + "type": "integer", + "description": "Number of SMTP configurations to be migrated (always 0 or 1 \u2014 the project-level custom SMTP settings; password is not exposed by the source API).", + "x-example": 1, + "format": "int32" + }, + "rule": { + "type": "integer", + "description": "Number of custom-domain proxy rules to be migrated. Auto-generated `.appwrite.network` rules are skipped \u2014 they are recreated by parent Function\/Site migration.", + "x-example": 5, + "format": "int32" + }, + "project-email-template": { + "type": "integer", + "description": "Number of custom email templates to be migrated (one per templateId \u00d7 locale pair).", + "x-example": 7, + "format": "int32" + }, "site": { "type": "integer", "description": "Number of sites to be migrated.", @@ -99238,6 +101298,12 @@ "description": "Version of the Appwrite instance to be migrated.", "x-example": "1.4.0" }, + "oauth2-provider": { + "type": "integer", + "description": "Number of OAuth2 provider configurations to be migrated. Secrets (clientSecret, p8File) are never migrated \u2014 destination admin must re-enter them per provider.", + "x-example": 5, + "format": "int32" + }, "backup-policy": { "type": "integer", "description": "Number of backup policies to be migrated.", @@ -99254,6 +101320,17 @@ "bucket", "function", "platform", + "api-key", + "project-variable", + "webhook", + "auth-methods", + "project-protocols", + "project-labels", + "project-services", + "policies", + "smtp", + "rule", + "project-email-template", "site", "provider", "topic", @@ -99261,6 +101338,7 @@ "message", "size", "version", + "oauth2-provider", "backup-policy" ], "example": { @@ -99272,6 +101350,17 @@ "bucket": 20, "function": 20, "platform": 5, + "api-key": 5, + "project-variable": 5, + "webhook": 5, + "auth-methods": 1, + "project-protocols": 1, + "project-labels": 1, + "project-services": 1, + "policies": 1, + "smtp": 1, + "rule": 5, + "project-email-template": 7, "site": 5, "provider": 5, "topic": 10, @@ -99279,6 +101368,7 @@ "message": 50, "size": 30000, "version": "1.4.0", + "oauth2-provider": 5, "backup-policy": 5 } }, @@ -99671,66 +101761,6 @@ "description": "Hostname.", "x-example": "appwrite.io" }, - "osCode": { - "type": "string", - "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" - }, - "osName": { - "type": "string", - "description": "Operating system name.", - "x-example": "Mac" - }, - "osVersion": { - "type": "string", - "description": "Operating system version.", - "x-example": "Mac" - }, - "clientType": { - "type": "string", - "description": "Client type.", - "x-example": "browser" - }, - "clientCode": { - "type": "string", - "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" - }, - "clientName": { - "type": "string", - "description": "Client name.", - "x-example": "Chrome Mobile iOS" - }, - "clientVersion": { - "type": "string", - "description": "Client version.", - "x-example": "84.0" - }, - "clientEngine": { - "type": "string", - "description": "Client engine name.", - "x-example": "WebKit" - }, - "clientEngineVersion": { - "type": "string", - "description": "Client engine name.", - "x-example": "605.1.15" - }, - "deviceName": { - "type": "string", - "description": "Device name.", - "x-example": "smartphone" - }, - "deviceBrand": { - "type": "string", - "description": "Device brand name.", - "x-example": "Google" - }, - "deviceModel": { - "type": "string", - "description": "Device model name.", - "x-example": "Nexus 5" - }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", @@ -99761,18 +101791,6 @@ "projectId", "teamId", "hostname", - "osCode", - "osName", - "osVersion", - "clientType", - "clientCode", - "clientName", - "clientVersion", - "clientEngine", - "clientEngineVersion", - "deviceName", - "deviceBrand", - "deviceModel", "countryCode", "countryName" ], @@ -99795,18 +101813,6 @@ "projectId": "610fc2f985ee0", "teamId": "610fc2f985ee0", "hostname": "appwrite.io", - "osCode": "Mac", - "osName": "Mac", - "osVersion": "Mac", - "clientType": "browser", - "clientCode": "CM", - "clientName": "Chrome Mobile iOS", - "clientVersion": "84.0", - "clientEngine": "WebKit", - "clientEngineVersion": "605.1.15", - "deviceName": "smartphone", - "deviceBrand": "Google", - "deviceModel": "Nexus 5", "countryCode": "US", "countryName": "United States" } @@ -101054,6 +103060,11 @@ "description": "Does plan support blocking free email addresses.", "x-example": true }, + "supportsProjectSpecificRoles": { + "type": "boolean", + "description": "Does plan support project-specific member roles.", + "x-example": true + }, "backupsEnabled": { "type": "boolean", "description": "Does plan support backup policies.", @@ -101181,6 +103192,7 @@ "supportsDisposableEmailValidation", "supportsCanonicalEmailValidation", "supportsFreeEmailValidation", + "supportsProjectSpecificRoles", "backupsEnabled", "usagePerProject", "supportedAddons", @@ -101244,6 +103256,7 @@ "supportsDisposableEmailValidation": true, "supportsCanonicalEmailValidation": true, "supportsFreeEmailValidation": true, + "supportsProjectSpecificRoles": true, "backupsEnabled": true, "usagePerProject": true, "supportedAddons": null, @@ -101515,7 +103528,7 @@ "branchId": { "type": "string", "description": "Branch identifier.", - "x-example": "branch-a1b2c3d4" + "x-example": "a1b2c3d4" }, "branchName": { "type": "string", @@ -101525,26 +103538,83 @@ "namespace": { "type": "string", "description": "Kubernetes namespace where the branch is deployed.", - "x-example": "branch-a1b2c3d4" + "x-example": "db-myproject-mydb-branch-a1b2c3d4" }, "expiresAt": { "type": "integer", "description": "Unix timestamp when the branch expires.", "x-example": 1711411200, "format": "int32" + }, + "host": { + "type": "string", + "description": "Branch hostname for direct connections.", + "x-example": "db-myproject-mydb-a1b2c3d4.fra.appwrite.center" + }, + "port": { + "type": "integer", + "description": "Branch port.", + "x-example": 5432, + "format": "int32" + }, + "database": { + "type": "string", + "description": "Database name the client sends for routing to the branch.", + "x-example": "db-myproject-mydb-a1b2c3d4" + }, + "username": { + "type": "string", + "description": "Database username. Shared with the parent database.", + "x-example": "appwrite" + }, + "password": { + "type": "string", + "description": "Database password. Shared with the parent database.", + "x-example": "********" + }, + "ssl": { + "type": "boolean", + "description": "Whether SSL is required.", + "x-example": false + }, + "engine": { + "type": "string", + "description": "Database engine. Possible values: postgres, mysql, mariadb, mongodb.", + "x-example": "postgres" + }, + "connectionString": { + "type": "string", + "description": "Full connection string for the branch.", + "x-example": "postgresql:\/\/appwrite:****@db-myproject-mydb-a1b2c3d4.fra.appwrite.center:5432\/db-myproject-mydb-a1b2c3d4?sslmode=disable" } }, "required": [ "branchId", "branchName", "namespace", - "expiresAt" + "expiresAt", + "host", + "port", + "database", + "username", + "password", + "ssl", + "engine", + "connectionString" ], "example": { - "branchId": "branch-a1b2c3d4", + "branchId": "a1b2c3d4", "branchName": "branch-a1b2c3d4", - "namespace": "branch-a1b2c3d4", - "expiresAt": 1711411200 + "namespace": "db-myproject-mydb-branch-a1b2c3d4", + "expiresAt": 1711411200, + "host": "db-myproject-mydb-a1b2c3d4.fra.appwrite.center", + "port": 5432, + "database": "db-myproject-mydb-a1b2c3d4", + "username": "appwrite", + "password": "********", + "ssl": false, + "engine": "postgres", + "connectionString": "postgresql:\/\/appwrite:****@db-myproject-mydb-a1b2c3d4.fra.appwrite.center:5432\/db-myproject-mydb-a1b2c3d4?sslmode=disable" } }, "dedicatedDatabaseBranchList": { @@ -101791,7 +103861,7 @@ "host": { "type": "string", "description": "Database hostname.", - "x-example": "db-myproject-mydb.fra.appwrite.network" + "x-example": "db-myproject-mydb.fra.appwrite.center" }, "port": { "type": "integer", @@ -101814,6 +103884,22 @@ "description": "Database name.", "x-example": "appwrite" }, + "tcpHost": { + "type": "string", + "description": "Database TCP hostname or address.", + "x-example": "db-myproject-mydb.fra.appwrite.center" + }, + "tcpPort": { + "type": "integer", + "description": "Database TCP port.", + "x-example": 5432, + "format": "int32" + }, + "tcpDatabase": { + "type": "string", + "description": "Database name for direct TCP connections.", + "x-example": "appwrite" + }, "engine": { "type": "string", "description": "Database engine. Possible values: postgres, mysql, mariadb, mongodb.", @@ -101822,12 +103908,12 @@ "ssl": { "type": "boolean", "description": "Whether SSL is required.", - "x-example": true + "x-example": false }, "connectionString": { "type": "string", "description": "Full connection string.", - "x-example": "postgresql:\/\/appwrite:****@db-myproject-mydb.fra.appwrite.network:5432\/appwrite?sslmode=require" + "x-example": "postgresql:\/\/appwrite:****@db-myproject-mydb.fra.appwrite.center:5432\/appwrite?sslmode=disable" } }, "required": [ @@ -101837,20 +103923,26 @@ "username", "password", "database", + "tcpHost", + "tcpPort", + "tcpDatabase", "engine", "ssl", "connectionString" ], "example": { "$id": "5e5ea5c16897e", - "host": "db-myproject-mydb.fra.appwrite.network", + "host": "db-myproject-mydb.fra.appwrite.center", "port": 5432, "username": "appwrite", "password": "********", "database": "appwrite", + "tcpHost": "db-myproject-mydb.fra.appwrite.center", + "tcpPort": 5432, + "tcpDatabase": "appwrite", "engine": "postgres", - "ssl": true, - "connectionString": "postgresql:\/\/appwrite:****@db-myproject-mydb.fra.appwrite.network:5432\/appwrite?sslmode=require" + "ssl": false, + "connectionString": "postgresql:\/\/appwrite:****@db-myproject-mydb.fra.appwrite.center:5432\/appwrite?sslmode=disable" } }, "credit": { @@ -102004,103 +104096,6 @@ "available": 5 } }, - "dedicatedDatabaseMetrics": { - "description": "DatabaseMetrics", - "type": "object", - "properties": { - "period": { - "type": "string", - "description": "Metrics aggregation period. Possible values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days), 30d (last 30 days).", - "x-example": "24h" - }, - "cpuPercent": { - "type": "number", - "description": "Average CPU usage percentage.", - "x-example": 45.2, - "format": "double" - }, - "memoryPercent": { - "type": "number", - "description": "Average memory usage percentage.", - "x-example": 62.1, - "format": "double" - }, - "memoryUsedBytes": { - "type": "integer", - "description": "Memory used in bytes.", - "x-example": 536870912, - "format": "int32" - }, - "memoryMaxBytes": { - "type": "integer", - "description": "Maximum memory available in bytes.", - "x-example": 1073741824, - "format": "int32" - }, - "storageUsedBytes": { - "type": "integer", - "description": "Storage used in bytes.", - "x-example": 1073741824, - "format": "int32" - }, - "connectionsActive": { - "type": "integer", - "description": "Current active connections.", - "x-example": 15, - "format": "int32" - }, - "connectionsMax": { - "type": "integer", - "description": "Maximum connections configured.", - "x-example": 100, - "format": "int32" - }, - "iopsRead": { - "type": "number", - "description": "Average read IOPS.", - "x-example": 125.5, - "format": "double" - }, - "iopsWrite": { - "type": "number", - "description": "Average write IOPS.", - "x-example": 45.3, - "format": "double" - }, - "qps": { - "type": "number", - "description": "Queries per second.", - "x-example": 230.7, - "format": "double" - } - }, - "required": [ - "period", - "cpuPercent", - "memoryPercent", - "memoryUsedBytes", - "memoryMaxBytes", - "storageUsedBytes", - "connectionsActive", - "connectionsMax", - "iopsRead", - "iopsWrite", - "qps" - ], - "example": { - "period": "24h", - "cpuPercent": 45.2, - "memoryPercent": 62.1, - "memoryUsedBytes": 536870912, - "memoryMaxBytes": 1073741824, - "storageUsedBytes": 1073741824, - "connectionsActive": 15, - "connectionsMax": 100, - "iopsRead": 125.5, - "iopsWrite": 45.3, - "qps": 230.7 - } - }, "dedicatedDatabase": { "description": "DedicatedDatabase", "type": "object", @@ -102168,7 +104163,7 @@ "hostname": { "type": "string", "description": "Database hostname for connections.", - "x-example": "db-myproject-mydb.fra.appwrite.network" + "x-example": "db-myproject-mydb.fra.appwrite.center" }, "connectionPort": { "type": "integer", @@ -102189,7 +104184,7 @@ "connectionString": { "type": "string", "description": "Full database connection string (URI format).", - "x-example": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.network:5432\/postgres" + "x-example": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.center:5432\/postgres" }, "status": { "type": "string", @@ -102453,11 +104448,11 @@ "version": "16", "specification": "s-2vcpu-2gb", "backend": "edge", - "hostname": "db-myproject-mydb.fra.appwrite.network", + "hostname": "db-myproject-mydb.fra.appwrite.center", "connectionPort": 5432, "connectionUser": "appwrite_user", "connectionPassword": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022", - "connectionString": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.network:5432\/postgres", + "connectionString": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.center:5432\/postgres", "status": "ready", "containerStatus": "active", "lastAccessedAt": "2020-10-15T06:38:00.000+00:00", @@ -104409,151 +106404,6 @@ "failed": false } }, - "dedicatedDatabasePerformanceInsights": { - "description": "PerformanceInsights", - "type": "object", - "properties": { - "topQueries": { - "type": "array", - "description": "Top queries by total execution time.", - "items": { - "type": "object", - "$ref": "#\/definitions\/dedicatedDatabasePerformanceInsightsQuery" - }, - "x-example": [] - }, - "waitEvents": { - "type": "array", - "description": "Active wait events.", - "items": { - "type": "object", - "$ref": "#\/definitions\/dedicatedDatabasePerformanceInsightsWaitEvent" - }, - "x-example": [] - }, - "totalCalls": { - "type": "integer", - "description": "Total number of query calls.", - "x-example": 150000, - "format": "int32" - }, - "totalTimeMs": { - "type": "number", - "description": "Total query execution time in milliseconds.", - "x-example": 85432.12, - "format": "double" - }, - "avgTimeMs": { - "type": "number", - "description": "Average query execution time in milliseconds.", - "x-example": 0.57, - "format": "double" - } - }, - "required": [ - "topQueries", - "waitEvents", - "totalCalls", - "totalTimeMs", - "avgTimeMs" - ], - "example": { - "topQueries": [], - "waitEvents": [], - "totalCalls": 150000, - "totalTimeMs": 85432.12, - "avgTimeMs": 0.57 - } - }, - "dedicatedDatabasePerformanceInsightsQuery": { - "description": "PerformanceInsightsQuery", - "type": "object", - "properties": { - "query": { - "type": "string", - "description": "The SQL query text.", - "x-example": "SELECT * FROM users WHERE email = $1" - }, - "calls": { - "type": "integer", - "description": "Number of times this query has been executed.", - "x-example": 42, - "format": "int32" - }, - "totalTimeMs": { - "type": "number", - "description": "Total execution time in milliseconds.", - "x-example": 1523.4, - "format": "double" - }, - "meanTimeMs": { - "type": "number", - "description": "Mean execution time in milliseconds.", - "x-example": 36.27, - "format": "double" - }, - "rows": { - "type": "integer", - "description": "Total rows returned or affected.", - "x-example": 1250, - "format": "int32" - } - }, - "required": [ - "query", - "calls", - "totalTimeMs", - "meanTimeMs", - "rows" - ], - "example": { - "query": "SELECT * FROM users WHERE email = $1", - "calls": 42, - "totalTimeMs": 1523.4, - "meanTimeMs": 36.27, - "rows": 1250 - } - }, - "dedicatedDatabasePerformanceInsightsWaitEvent": { - "description": "PerformanceInsightsWaitEvent", - "type": "object", - "properties": { - "event": { - "type": "string", - "description": "Wait event name.", - "x-example": "DataFileRead" - }, - "type": { - "type": "string", - "description": "Wait event type or category.", - "x-example": "IO" - }, - "count": { - "type": "integer", - "description": "Number of occurrences.", - "x-example": 15, - "format": "int32" - }, - "totalWaitMs": { - "type": "number", - "description": "Total wait time in milliseconds.", - "x-example": 234.5, - "format": "double" - } - }, - "required": [ - "event", - "type", - "count", - "totalWaitMs" - ], - "example": { - "event": "DataFileRead", - "type": "IO", - "count": 15, - "totalWaitMs": 234.5 - } - }, "dedicatedDatabasePITRWindows": { "description": "PITRWindows", "type": "object", @@ -104942,6 +106792,78 @@ "enabled": true } }, + "policyDenyAliasedEmail": { + "description": "Policy Deny Aliased Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny aliased email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policyDenyDisposableEmail": { + "description": "Policy Deny Disposable Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny disposable email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policyDenyFreeEmail": { + "description": "Policy Deny Free Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny free email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, "dedicatedDatabasePooler": { "description": "PoolerConfig", "type": "object", @@ -105487,6 +107409,183 @@ "database": "appwrite" } }, + "dedicatedDatabaseSpecification": { + "description": "Specification", + "type": "object", + "properties": { + "slug": { + "type": "string", + "description": "Specification slug. Use this value when creating a dedicated database.", + "x-example": "s-2vcpu-2gb" + }, + "name": { + "type": "string", + "description": "Human readable specification name.", + "x-example": "Standard" + }, + "price": { + "type": "number", + "description": "Monthly price of the specification in USD.", + "x-example": 23, + "format": "double" + }, + "cpu": { + "type": "integer", + "description": "Allocated CPU in millicores.", + "x-example": 2000, + "format": "int32" + }, + "memory": { + "type": "integer", + "description": "Allocated memory in MB.", + "x-example": 2048, + "format": "int32" + }, + "maxConnections": { + "type": "integer", + "description": "Maximum number of concurrent connections.", + "x-example": 200, + "format": "int32" + }, + "includedStorage": { + "type": "integer", + "description": "Included storage in GB before overage charges apply.", + "x-example": 25, + "format": "int32" + }, + "includedBandwidth": { + "type": "integer", + "description": "Included bandwidth in GB before overage charges apply.", + "x-example": 200, + "format": "int32" + }, + "enabled": { + "type": "boolean", + "description": "Whether the specification is available on the current plan.", + "x-example": true + } + }, + "required": [ + "slug", + "name", + "price", + "cpu", + "memory", + "maxConnections", + "includedStorage", + "includedBandwidth", + "enabled" + ], + "example": { + "slug": "s-2vcpu-2gb", + "name": "Standard", + "price": 23, + "cpu": 2000, + "memory": 2048, + "maxConnections": 200, + "includedStorage": 25, + "includedBandwidth": 200, + "enabled": true + } + }, + "dedicatedDatabaseSpecificationList": { + "description": "SpecificationList", + "type": "object", + "properties": { + "specifications": { + "type": "array", + "description": "List of dedicated database specifications.", + "items": { + "type": "object", + "$ref": "#\/definitions\/dedicatedDatabaseSpecification" + }, + "x-example": [] + }, + "total": { + "type": "integer", + "description": "Total number of specifications.", + "x-example": 9, + "format": "int32" + }, + "pricing": { + "type": "object", + "description": "Overage and add-on pricing shared across all specifications.", + "x-example": null, + "items": { + "type": "object", + "$ref": "#\/definitions\/dedicatedDatabaseSpecificationPricing" + } + } + }, + "required": [ + "specifications", + "total", + "pricing" + ], + "example": { + "specifications": [], + "total": 9, + "pricing": null + } + }, + "dedicatedDatabaseSpecificationPricing": { + "description": "SpecificationPricing", + "type": "object", + "properties": { + "storageOverageRate": { + "type": "number", + "description": "Price per GB of storage above the included amount, per month, in USD.", + "x-example": 0.125, + "format": "double" + }, + "bandwidthOverageRate": { + "type": "number", + "description": "Price per GB of bandwidth above the included amount, per month, in USD.", + "x-example": 0.08, + "format": "double" + }, + "haReplicaRate": { + "type": "number", + "description": "High availability replica price as a fraction of the specification cost.", + "x-example": 0.5, + "format": "double" + }, + "crossRegionReplicaRate": { + "type": "number", + "description": "Cross-region replica price as a fraction of the specification cost.", + "x-example": 0.75, + "format": "double" + }, + "crossRegionRate": { + "type": "number", + "description": "Cross-region transfer price as a fraction of the specification cost.", + "x-example": 0.5, + "format": "double" + }, + "pitrRate": { + "type": "number", + "description": "Point-in-time recovery price as a fraction of the specification cost.", + "x-example": 0.2, + "format": "double" + } + }, + "required": [ + "storageOverageRate", + "bandwidthOverageRate", + "haReplicaRate", + "crossRegionReplicaRate", + "crossRegionRate", + "pitrRate" + ], + "example": { + "storageOverageRate": 0.125, + "bandwidthOverageRate": 0.08, + "haReplicaRate": 0.5, + "crossRegionReplicaRate": 0.75, + "crossRegionRate": 0.5, + "pitrRate": 0.2 + } + }, "databaseStatusConnections": { "description": "Connections", "type": "object", @@ -106401,6 +108500,250 @@ "resourceId": "" } }, + "app": { + "description": "App", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "App ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "App creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "App update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "My Application" + }, + "redirectUris": { + "type": "array", + "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", + "items": { + "type": "string" + }, + "x-example": [ + "https:\/\/example.com\/callback" + ] + }, + "enabled": { + "type": "boolean", + "description": "Whether the app is enabled or not.", + "x-example": true + }, + "type": { + "type": "string", + "description": "OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot keep a client secret (PKCE required); `confidential` for server-side clients that authenticate with a client secret.", + "x-example": "confidential" + }, + "deviceFlow": { + "type": "boolean", + "description": "Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).", + "x-example": false + }, + "teamId": { + "type": "string", + "description": "ID of team that owns the application, if owned by team. Otherwise, user ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "userId": { + "type": "string", + "description": "ID of user who owns the application, if owned by user. Otherwise, team ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "secrets": { + "type": "array", + "description": "List of application secrets.", + "items": { + "type": "object", + "$ref": "#\/definitions\/appSecret" + }, + "x-example": [] + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "redirectUris", + "enabled", + "type", + "deviceFlow", + "teamId", + "userId", + "secrets" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Application", + "redirectUris": [ + "https:\/\/example.com\/callback" + ], + "enabled": true, + "type": "confidential", + "deviceFlow": false, + "teamId": "5e5ea5c16897e", + "userId": "5e5ea5c16897e", + "secrets": [] + } + }, + "appSecret": { + "description": "AppSecret", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Secret creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Secret update time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" + }, + "secret": { + "type": "string", + "description": "Hashed application client secret.", + "x-example": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg" + }, + "hint": { + "type": "string", + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" + }, + "createdById": { + "type": "string", + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" + }, + "createdByName": { + "type": "string", + "description": "Name of the user who created the secret.", + "x-example": "Walter White" + }, + "lastAccessedAt": { + "type": "string", + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "secret", + "hint", + "createdById", + "createdByName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "secret": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, + "appSecretPlaintext": { + "description": "AppSecretPlaintext", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Secret creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Secret update time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" + }, + "secret": { + "type": "string", + "description": "Application client secret. Returned in full only when the secret is created; subsequent reads return a masked value.", + "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + }, + "hint": { + "type": "string", + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" + }, + "createdById": { + "type": "string", + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" + }, + "createdByName": { + "type": "string", + "description": "Name of the user who created the secret.", + "x-example": "Walter White" + }, + "lastAccessedAt": { + "type": "string", + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "secret", + "hint", + "createdById", + "createdByName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "secret": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, "activityEventList": { "description": "Activity event list", "type": "object", @@ -107009,6 +109352,64 @@ "total": 5, "gauges": "" } + }, + "appsList": { + "description": "Apps list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of apps that matched your query.", + "x-example": 5, + "format": "int32" + }, + "apps": { + "type": "array", + "description": "List of apps.", + "items": { + "type": "object", + "$ref": "#\/definitions\/app" + }, + "x-example": "" + } + }, + "required": [ + "total", + "apps" + ], + "example": { + "total": 5, + "apps": "" + } + }, + "appSecretList": { + "description": "App secrets list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of secrets that matched your query.", + "x-example": 5, + "format": "int32" + }, + "secrets": { + "type": "array", + "description": "List of secrets.", + "items": { + "type": "object", + "$ref": "#\/definitions\/appSecret" + }, + "x-example": "" + } + }, + "required": [ + "total", + "secrets" + ], + "example": { + "total": 5, + "secrets": "" + } } }, "externalDocs": { diff --git a/specs/1.9.x/swagger2-1.9.x-server.json b/specs/1.9.x/swagger2-1.9.x-server.json index 45decc2db..eac966fce 100644 --- a/specs/1.9.x/swagger2-1.9.x-server.json +++ b/specs/1.9.x/swagger2-1.9.x-server.json @@ -38,6 +38,15 @@ "demo": "<YOUR_PROJECT_ID>" } }, + "ProjectQuery": { + "type": "apiKey", + "name": "project", + "description": "Your project ID", + "in": "query", + "x-appwrite": { + "demo": "<YOUR_PROJECT_ID>" + } + }, "Key": { "type": "apiKey", "name": "X-Appwrite-Key", @@ -223,7 +232,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -234,7 +246,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "name": { "type": "string", @@ -1928,11 +1941,12 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": null + "x-example": "password", + "format": "password" }, "oldPassword": { "type": "string", - "description": "Current user password. Must be at least 8 chars.", + "description": "Current user password. Max length: 256 chars.", "default": "", "x-example": "password", "format": "password" @@ -2310,7 +2324,8 @@ "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": null + "x-example": "password", + "format": "password" } }, "required": [ @@ -2628,7 +2643,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -2712,7 +2730,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -2792,7 +2813,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "secret": { "type": "string", @@ -3114,7 +3138,10 @@ "userId": { "type": "string", "description": "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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -3204,7 +3231,10 @@ "userId": { "type": "string", "description": "Unique 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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -3484,7 +3514,10 @@ "userId": { "type": "string", "description": "Unique 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. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "phone": { "type": "string", @@ -4025,6 +4058,856 @@ ] } }, + "\/apps": { + "get": { + "summary": "List Applications", + "operationId": "appsList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "List applications.", + "responses": { + "200": { + "description": "Apps list", + "schema": { + "$ref": "#\/definitions\/appsList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create Application", + "operationId": "appsCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Create a new application.", + "responses": { + "201": { + "description": "App", + "schema": { + "$ref": "#\/definitions\/app" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "appId": { + "type": "string", + "description": "Application 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.", + "x-example": "<APP_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + }, + "teamId": { + "type": "string", + "description": "Team unique ID.", + "default": "", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "appId", + "name", + "redirectUris" + ] + } + } + ] + } + }, + "\/apps\/{appId}": { + "get": { + "summary": "Get Application", + "operationId": "appsGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Get an application by its unique ID.", + "responses": { + "200": { + "description": "App", + "schema": { + "$ref": "#\/definitions\/app" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + } + ] + }, + "put": { + "summary": "Update Application", + "operationId": "appsUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Update an application by its unique ID.", + "responses": { + "200": { + "description": "App", + "schema": { + "$ref": "#\/definitions\/app" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Application name.", + "x-example": "<NAME>" + }, + "enabled": { + "type": "boolean", + "description": "Is application enabled?", + "default": true, + "x-example": false + }, + "redirectUris": { + "type": "array", + "description": "Redirect URIs (array of valid URLs).", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", + "default": "confidential", + "x-example": "public" + }, + "deviceFlow": { + "type": "boolean", + "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", + "default": false, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete Application", + "operationId": "appsDelete", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Delete an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/secrets": { + "get": { + "summary": "List Secrets", + "operationId": "appsListSecrets", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "List client secrets for an application.", + "responses": { + "200": { + "description": "App secrets list", + "schema": { + "$ref": "#\/definitions\/appSecretList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listSecrets", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/list-secrets.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create Secret", + "operationId": "appsCreateSecret", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Create a new client secret for an application.", + "responses": { + "201": { + "description": "AppSecretPlaintext", + "schema": { + "$ref": "#\/definitions\/appSecretPlaintext" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/create-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/secrets\/{secretId}": { + "get": { + "summary": "Get Secret", + "operationId": "appsGetSecret", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Get an application client secret by its unique ID.", + "responses": { + "200": { + "description": "AppSecret", + "schema": { + "$ref": "#\/definitions\/appSecret" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/get-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "type": "string", + "x-example": "<SECRET_ID>", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete Secret", + "operationId": "appsDeleteSecret", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Delete an application client secret by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteSecret", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "secretId", + "description": "Secret unique ID.", + "required": true, + "type": "string", + "x-example": "<SECRET_ID>", + "in": "path" + } + ] + } + }, + "\/apps\/{appId}\/team": { + "patch": { + "summary": "Update Team", + "operationId": "appsUpdateTeam", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Transfer an application to another team by its unique ID.", + "responses": { + "200": { + "description": "App", + "schema": { + "$ref": "#\/definitions\/app" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTeam", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/update-team.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team ID of the team to transfer application to.", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "teamId" + ] + } + } + ] + } + }, + "\/apps\/{appId}\/tokens": { + "delete": { + "summary": "Delete Tokens", + "operationId": "appsDeleteTokens", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "apps" + ], + "description": "Revoke all tokens for an application by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTokens", + "group": null, + "cookies": false, + "type": "", + "demo": "apps\/delete-tokens.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "apps.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "appId", + "description": "Application unique ID.", + "required": true, + "type": "string", + "x-example": "<APP_ID>", + "in": "path" + } + ] + } + }, "\/avatars\/browsers\/{code}": { "get": { "summary": "Get browser icon", @@ -4066,7 +4949,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4074,7 +4958,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4193,7 +5078,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4201,7 +5087,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4326,7 +5213,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4334,7 +5222,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4391,7 +5280,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4399,7 +5289,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4880,7 +5771,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4888,7 +5780,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -4965,7 +5858,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -4973,7 +5867,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5058,7 +5953,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -5066,7 +5962,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -5151,7 +6048,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-screenshot.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -5159,7 +6057,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -6550,6 +7449,9 @@ "description": "Policy 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.", "required": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<ARCHIVE_ID>", "in": "path" } @@ -6686,7 +7588,10 @@ "policyId": { "type": "string", "description": "Policy 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.", - "x-example": "<POLICY_ID>" + "x-example": "<POLICY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -6972,6 +7877,9 @@ "description": "Policy 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.", "required": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<POLICY_ID>", "in": "path" } @@ -7072,7 +7980,10 @@ "type": "string", "description": "Unique 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.", "default": "", - "x-example": "<NEW_RESOURCE_ID>" + "x-example": "<NEW_RESOURCE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "newResourceName": { "type": "string", @@ -7429,7 +8340,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -8351,7 +9265,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -13414,7 +14331,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -14005,6 +14925,9 @@ "description": "Document ID.", "required": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<DOCUMENT_ID>", "in": "path" }, @@ -15020,7 +15943,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -15032,6 +15958,12 @@ "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "specification": { + "type": "string", + "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", + "default": "free", + "x-example": "<SPECIFICATION>" } }, "required": [ @@ -15833,7 +16765,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -16385,7 +17320,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -17922,7 +18860,10 @@ "functionId": { "type": "string", "description": "Function 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.", - "x-example": "<FUNCTION_ID>" + "x-example": "<FUNCTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -18029,7 +18970,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "FunctionRuntime", + "x-enum-name": "Runtime", "x-enum-keys": [ "node-14.5", "node-16.0", @@ -18280,9 +19221,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes", @@ -18377,9 +19321,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ] } @@ -18790,7 +19737,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "FunctionRuntime", + "x-enum-name": "Runtime", "x-enum-keys": [ "node-14.5", "node-16.0", @@ -19041,9 +19988,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes", @@ -19138,9 +20088,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ] } @@ -20011,14 +20964,16 @@ "public": true, "auth": { "Project": [], - "Key": [] + "Key": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -20222,7 +21177,7 @@ "application\/json" ], "produces": [ - "multipart\/form-data" + "application\/json" ], "tags": [ "functions" @@ -20633,7 +21588,10 @@ "variableId": { "type": "string", "description": "Variable 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -21142,6 +22100,57 @@ ] } }, + "\/health\/audits-db": { + "get": { + "summary": "Get audits DB", + "operationId": "healthGetAuditsDB", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "health" + ], + "description": "Check the database that backs the audit and activity store. When the connection is reachable the endpoint returns a passing status with its response time.\n", + "responses": { + "200": { + "description": "Status List", + "schema": { + "$ref": "#\/definitions\/healthStatusList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getAuditsDB", + "group": null, + "cookies": false, + "type": "", + "demo": "health\/get-audits-db.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "health.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/health\/get-audits-db.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, "\/health\/cache": { "get": { "summary": "Get cache", @@ -23381,7 +24390,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "subject": { "type": "string", @@ -23695,7 +24707,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "title": { "type": "string", @@ -24169,7 +25184,10 @@ "messageId": { "type": "string", "description": "Message 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.", - "x-example": "<MESSAGE_ID>" + "x-example": "<MESSAGE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "content": { "type": "string", @@ -24913,7 +25931,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -25279,7 +26300,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -25525,7 +26549,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -25664,54 +26691,261 @@ "default": "", "x-example": "<NAME>" }, - "apiKey": { - "type": "string", - "description": "Mailgun API Key.", - "default": "", - "x-example": "<API_KEY>" - }, - "domain": { - "type": "string", - "description": "Mailgun Domain.", - "default": "", - "x-example": "<DOMAIN>" - }, - "isEuRegion": { - "type": "boolean", - "description": "Set as EU region.", - "x-example": false, - "x-nullable": true - }, + "apiKey": { + "type": "string", + "description": "Mailgun API Key.", + "default": "", + "x-example": "<API_KEY>" + }, + "domain": { + "type": "string", + "description": "Mailgun Domain.", + "default": "", + "x-example": "<DOMAIN>" + }, + "isEuRegion": { + "type": "boolean", + "description": "Set as EU region.", + "x-example": false, + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "Set as enabled.", + "x-example": false, + "x-nullable": true + }, + "fromName": { + "type": "string", + "description": "Sender Name.", + "default": "", + "x-example": "<FROM_NAME>" + }, + "fromEmail": { + "type": "string", + "description": "Sender email address.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "replyToName": { + "type": "string", + "description": "Name set in the reply to field for the mail. Default value is sender name.", + "default": "", + "x-example": "<REPLY_TO_NAME>" + }, + "replyToEmail": { + "type": "string", + "description": "Email set in the reply to field for the mail. Default value is sender email.", + "default": "", + "x-example": "<REPLY_TO_EMAIL>" + } + } + } + } + ] + } + }, + "\/messaging\/providers\/msg91": { + "post": { + "summary": "Create Msg91 provider", + "operationId": "messagingCreateMsg91Provider", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "messaging" + ], + "description": "Create a new MSG91 provider.", + "responses": { + "201": { + "description": "Provider", + "schema": { + "$ref": "#\/definitions\/provider" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createMsg91Provider", + "group": "providers", + "cookies": false, + "type": "", + "demo": "messaging\/create-msg-91-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "providers.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "providerId": { + "type": "string", + "description": "Provider 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.", + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } + }, + "name": { + "type": "string", + "description": "Provider name.", + "x-example": "<NAME>" + }, + "templateId": { + "type": "string", + "description": "Msg91 template ID", + "default": "", + "x-example": "<TEMPLATE_ID>" + }, + "senderId": { + "type": "string", + "description": "Msg91 sender ID.", + "default": "", + "x-example": "<SENDER_ID>" + }, + "authKey": { + "type": "string", + "description": "Msg91 auth key.", + "default": "", + "x-example": "<AUTH_KEY>" + }, + "enabled": { + "type": "boolean", + "description": "Set as enabled.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "providerId", + "name" + ] + } + } + ] + } + }, + "\/messaging\/providers\/msg91\/{providerId}": { + "patch": { + "summary": "Update Msg91 provider", + "operationId": "messagingUpdateMsg91Provider", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "messaging" + ], + "description": "Update a MSG91 provider by its unique ID.", + "responses": { + "200": { + "description": "Provider", + "schema": { + "$ref": "#\/definitions\/provider" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateMsg91Provider", + "group": "providers", + "cookies": false, + "type": "", + "demo": "messaging\/update-msg-91-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "providers.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "providerId", + "description": "Provider ID.", + "required": true, + "type": "string", + "x-example": "<PROVIDER_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Provider name.", + "default": "", + "x-example": "<NAME>" + }, "enabled": { "type": "boolean", "description": "Set as enabled.", "x-example": false, "x-nullable": true }, - "fromName": { - "type": "string", - "description": "Sender Name.", - "default": "", - "x-example": "<FROM_NAME>" - }, - "fromEmail": { + "templateId": { "type": "string", - "description": "Sender email address.", + "description": "Msg91 template ID.", "default": "", - "x-example": "email@example.com", - "format": "email" + "x-example": "<TEMPLATE_ID>" }, - "replyToName": { + "senderId": { "type": "string", - "description": "Name set in the reply to field for the mail. Default value is sender name.", + "description": "Msg91 sender ID.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "x-example": "<SENDER_ID>" }, - "replyToEmail": { + "authKey": { "type": "string", - "description": "Email set in the reply to field for the mail. Default value is sender email.", + "description": "Msg91 auth key.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" + "x-example": "<AUTH_KEY>" } } } @@ -25719,10 +26953,10 @@ ] } }, - "\/messaging\/providers\/msg91": { + "\/messaging\/providers\/resend": { "post": { - "summary": "Create Msg91 provider", - "operationId": "messagingCreateMsg91Provider", + "summary": "Create Resend provider", + "operationId": "messagingCreateResendProvider", "consumes": [ "application\/json" ], @@ -25732,7 +26966,7 @@ "tags": [ "messaging" ], - "description": "Create a new MSG91 provider.", + "description": "Create a new Resend provider.", "responses": { "201": { "description": "Provider", @@ -25743,11 +26977,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "createMsg91Provider", + "method": "createResendProvider", "group": "providers", "cookies": false, "type": "", - "demo": "messaging\/create-msg-91-provider.md", + "demo": "messaging\/create-resend-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -25758,7 +26992,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-resend-provider.md", "auth": { "Project": [], "Key": [] @@ -25780,30 +27014,47 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", "description": "Provider name.", "x-example": "<NAME>" }, - "templateId": { + "apiKey": { "type": "string", - "description": "Msg91 template ID", + "description": "Resend API key.", "default": "", - "x-example": "<TEMPLATE_ID>" + "x-example": "<API_KEY>" }, - "senderId": { + "fromName": { "type": "string", - "description": "Msg91 sender ID.", + "description": "Sender Name.", "default": "", - "x-example": "<SENDER_ID>" + "x-example": "<FROM_NAME>" }, - "authKey": { + "fromEmail": { "type": "string", - "description": "Msg91 auth key.", + "description": "Sender email address.", "default": "", - "x-example": "<AUTH_KEY>" + "x-example": "email@example.com", + "format": "email" + }, + "replyToName": { + "type": "string", + "description": "Name set in the reply to field for the mail. Default value is sender name.", + "default": "", + "x-example": "<REPLY_TO_NAME>" + }, + "replyToEmail": { + "type": "string", + "description": "Email set in the reply to field for the mail. Default value is sender email.", + "default": "", + "x-example": "email@example.com", + "format": "email" }, "enabled": { "type": "boolean", @@ -25821,10 +27072,10 @@ ] } }, - "\/messaging\/providers\/msg91\/{providerId}": { + "\/messaging\/providers\/resend\/{providerId}": { "patch": { - "summary": "Update Msg91 provider", - "operationId": "messagingUpdateMsg91Provider", + "summary": "Update Resend provider", + "operationId": "messagingUpdateResendProvider", "consumes": [ "application\/json" ], @@ -25834,7 +27085,7 @@ "tags": [ "messaging" ], - "description": "Update a MSG91 provider by its unique ID.", + "description": "Update a Resend provider by its unique ID.", "responses": { "200": { "description": "Provider", @@ -25845,11 +27096,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMsg91Provider", + "method": "updateResendProvider", "group": "providers", "cookies": false, "type": "", - "demo": "messaging\/update-msg-91-provider.md", + "demo": "messaging\/update-resend-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -25860,7 +27111,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-resend-provider.md", "auth": { "Project": [], "Key": [] @@ -25899,23 +27150,36 @@ "x-example": false, "x-nullable": true }, - "templateId": { + "apiKey": { "type": "string", - "description": "Msg91 template ID.", + "description": "Resend API key.", "default": "", - "x-example": "<TEMPLATE_ID>" + "x-example": "<API_KEY>" }, - "senderId": { + "fromName": { "type": "string", - "description": "Msg91 sender ID.", + "description": "Sender Name.", "default": "", - "x-example": "<SENDER_ID>" + "x-example": "<FROM_NAME>" }, - "authKey": { + "fromEmail": { "type": "string", - "description": "Msg91 auth key.", + "description": "Sender email address.", "default": "", - "x-example": "<AUTH_KEY>" + "x-example": "email@example.com", + "format": "email" + }, + "replyToName": { + "type": "string", + "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", + "default": "", + "x-example": "<REPLY_TO_NAME>" + }, + "replyToEmail": { + "type": "string", + "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", + "default": "", + "x-example": "<REPLY_TO_EMAIL>" } } } @@ -25923,10 +27187,10 @@ ] } }, - "\/messaging\/providers\/resend": { + "\/messaging\/providers\/sendgrid": { "post": { - "summary": "Create Resend provider", - "operationId": "messagingCreateResendProvider", + "summary": "Create Sendgrid provider", + "operationId": "messagingCreateSendgridProvider", "consumes": [ "application\/json" ], @@ -25936,7 +27200,7 @@ "tags": [ "messaging" ], - "description": "Create a new Resend provider.", + "description": "Create a new Sendgrid provider.", "responses": { "201": { "description": "Provider", @@ -25947,11 +27211,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "createResendProvider", + "method": "createSendgridProvider", "group": "providers", "cookies": false, "type": "", - "demo": "messaging\/create-resend-provider.md", + "demo": "messaging\/create-sendgrid-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -25962,7 +27226,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-resend-provider.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md", "auth": { "Project": [], "Key": [] @@ -25984,7 +27248,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -25993,7 +27260,7 @@ }, "apiKey": { "type": "string", - "description": "Resend API key.", + "description": "Sendgrid API key.", "default": "", "x-example": "<API_KEY>" }, @@ -26039,10 +27306,10 @@ ] } }, - "\/messaging\/providers\/resend\/{providerId}": { + "\/messaging\/providers\/sendgrid\/{providerId}": { "patch": { - "summary": "Update Resend provider", - "operationId": "messagingUpdateResendProvider", + "summary": "Update Sendgrid provider", + "operationId": "messagingUpdateSendgridProvider", "consumes": [ "application\/json" ], @@ -26052,7 +27319,7 @@ "tags": [ "messaging" ], - "description": "Update a Resend provider by its unique ID.", + "description": "Update a Sendgrid provider by its unique ID.", "responses": { "200": { "description": "Provider", @@ -26063,11 +27330,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateResendProvider", + "method": "updateSendgridProvider", "group": "providers", "cookies": false, "type": "", - "demo": "messaging\/update-resend-provider.md", + "demo": "messaging\/update-sendgrid-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -26078,7 +27345,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-resend-provider.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md", "auth": { "Project": [], "Key": [] @@ -26119,7 +27386,7 @@ }, "apiKey": { "type": "string", - "description": "Resend API key.", + "description": "Sendgrid API key.", "default": "", "x-example": "<API_KEY>" }, @@ -26154,10 +27421,10 @@ ] } }, - "\/messaging\/providers\/sendgrid": { + "\/messaging\/providers\/ses": { "post": { - "summary": "Create Sendgrid provider", - "operationId": "messagingCreateSendgridProvider", + "summary": "Create Amazon SES provider", + "operationId": "messagingCreateSesProvider", "consumes": [ "application\/json" ], @@ -26167,7 +27434,7 @@ "tags": [ "messaging" ], - "description": "Create a new Sendgrid provider.", + "description": "Create a new Amazon SES provider.", "responses": { "201": { "description": "Provider", @@ -26178,11 +27445,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "createSendgridProvider", + "method": "createSesProvider", "group": "providers", "cookies": false, "type": "", - "demo": "messaging\/create-sendgrid-provider.md", + "demo": "messaging\/create-ses-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -26193,7 +27460,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-ses-provider.md", "auth": { "Project": [], "Key": [] @@ -26215,18 +27482,33 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", "description": "Provider name.", "x-example": "<NAME>" }, - "apiKey": { + "accessKey": { "type": "string", - "description": "Sendgrid API key.", + "description": "AWS access key ID.", "default": "", - "x-example": "<API_KEY>" + "x-example": "<ACCESS_KEY>" + }, + "secretKey": { + "type": "string", + "description": "AWS secret access key.", + "default": "", + "x-example": "<SECRET_KEY>" + }, + "region": { + "type": "string", + "description": "AWS region, for example us-east-1.", + "default": "", + "x-example": "<REGION>" }, "fromName": { "type": "string", @@ -26270,10 +27552,10 @@ ] } }, - "\/messaging\/providers\/sendgrid\/{providerId}": { + "\/messaging\/providers\/ses\/{providerId}": { "patch": { - "summary": "Update Sendgrid provider", - "operationId": "messagingUpdateSendgridProvider", + "summary": "Update Amazon SES provider", + "operationId": "messagingUpdateSesProvider", "consumes": [ "application\/json" ], @@ -26283,7 +27565,7 @@ "tags": [ "messaging" ], - "description": "Update a Sendgrid provider by its unique ID.", + "description": "Update an Amazon SES provider by its unique ID.", "responses": { "200": { "description": "Provider", @@ -26294,11 +27576,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSendgridProvider", + "method": "updateSesProvider", "group": "providers", "cookies": false, "type": "", - "demo": "messaging\/update-sendgrid-provider.md", + "demo": "messaging\/update-ses-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -26309,7 +27591,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-ses-provider.md", "auth": { "Project": [], "Key": [] @@ -26348,11 +27630,23 @@ "x-example": false, "x-nullable": true }, - "apiKey": { + "accessKey": { "type": "string", - "description": "Sendgrid API key.", + "description": "AWS access key ID.", "default": "", - "x-example": "<API_KEY>" + "x-example": "<ACCESS_KEY>" + }, + "secretKey": { + "type": "string", + "description": "AWS secret access key.", + "default": "", + "x-example": "<SECRET_KEY>" + }, + "region": { + "type": "string", + "description": "AWS region, for example us-east-1.", + "default": "", + "x-example": "<REGION>" }, "fromName": { "type": "string", @@ -26534,7 +27828,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -26563,7 +27860,8 @@ "type": "string", "description": "Authentication password.", "default": "", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "encryption": { "type": "string", @@ -26815,7 +28113,8 @@ "type": "string", "description": "Authentication password.", "default": "", - "x-example": "<PASSWORD>" + "x-example": "password", + "format": "password" }, "encryption": { "type": "string", @@ -26943,7 +28242,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -27148,7 +28450,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -27353,7 +28658,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -27558,7 +28866,10 @@ "providerId": { "type": "string", "description": "Provider 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.", - "x-example": "<PROVIDER_ID>" + "x-example": "<PROVIDER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -28125,7 +29436,10 @@ "topicId": { "type": "string", "description": "Topic ID. Choose a custom Topic ID or a new Topic ID.", - "x-example": "<TOPIC_ID>" + "x-example": "<TOPIC_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -28598,7 +29912,10 @@ "subscriberId": { "type": "string", "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", - "x-example": "<SUBSCRIBER_ID>" + "x-example": "<SUBSCRIBER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "targetId": { "type": "string", @@ -28682,71 +29999,544 @@ "in": "path" } ] - }, - "delete": { - "summary": "Delete subscriber", - "operationId": "messagingDeleteSubscriber", + }, + "delete": { + "summary": "Delete subscriber", + "operationId": "messagingDeleteSubscriber", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "messaging" + ], + "description": "Delete a subscriber by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteSubscriber", + "group": "subscribers", + "cookies": false, + "type": "", + "demo": "messaging\/delete-subscriber.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "subscribers.write", + "platforms": [ + "server", + "client", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md", + "auth": { + "Project": [], + "JWT": [] + } + }, + "security": [ + { + "Project": [], + "JWT": [], + "Session": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "topicId", + "description": "Topic ID. The topic ID subscribed to.", + "required": true, + "type": "string", + "x-example": "<TOPIC_ID>", + "in": "path" + }, + { + "name": "subscriberId", + "description": "Subscriber ID.", + "required": true, + "type": "string", + "x-example": "<SUBSCRIBER_ID>", + "in": "path" + } + ] + } + }, + "\/oauth2\/{project_id}\/approve": { + "post": { + "summary": "Approve OAuth2", + "operationId": "oauth2Approve", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "messaging" + "oauth2" ], - "description": "Delete a subscriber by its unique ID.", + "description": "Approve an OAuth2 grant after the user gives consent. Returns the `redirectUrl` the end user should be sent to. The consent screen may optionally pass enriched `authorization_details` to record the concrete resources the user selected. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2 Approve", + "schema": { + "$ref": "#\/definitions\/oauth2Approve" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteSubscriber", - "group": "subscribers", + "method": "approve", + "group": null, "cookies": false, "type": "", - "demo": "messaging\/delete-subscriber.md", + "demo": "oauth2\/approve.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "subscribers.write", + "scope": "oauth2.write", "platforms": [ - "server", "client", - "console" + "server" + ], + "packaging": false, + "public": true, + "auth": { + "ProjectQuery": [], + "Session": [] + } + }, + "security": [ + { + "ProjectQuery": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "required": true, + "type": "string", + "x-example": "<PROJECT_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "grant_id": { + "type": "string", + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", + "x-example": "<GRANT_ID>" + }, + "authorization_details": { + "type": "string", + "description": "Enriched `authorization_details` the user consented to, replacing what the client requested. Each entry must use a `type` the project accepts. Optional; omit to keep the originally requested details.", + "default": "", + "x-example": "<AUTHORIZATION_DETAILS>" + } + }, + "required": [ + "grant_id" + ] + } + } + ] + } + }, + "\/oauth2\/{project_id}\/authorize": { + "get": { + "summary": "OAuth2 Authorize", + "operationId": "oauth2Authorize", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "oauth2" + ], + "description": "Begin the OAuth2 authorization flow. When called without a session, the user is redirected to the consent screen without grant ID. When called with a session, the redirect URL includes param for grant ID. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", + "responses": { + "200": { + "description": "OAuth2 Authorize", + "schema": { + "$ref": "#\/definitions\/oauth2Authorize" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "authorize", + "group": null, + "cookies": false, + "type": "", + "demo": "oauth2\/authorize.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "public", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "ProjectQuery": [], + "Session": [] + } + }, + "security": [ + { + "ProjectQuery": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client exists.", + "required": true, + "type": "string", + "x-example": "<PROJECT_ID>", + "in": "path" + }, + { + "name": "client_id", + "description": "OAuth2 client ID.", + "required": true, + "type": "string", + "x-example": "<CLIENT_ID>", + "in": "query" + }, + { + "name": "redirect_uri", + "description": "Redirect URI where visitor will be redirected after authorization, whether successful or not.", + "required": true, + "type": "string", + "format": "url", + "x-example": "https:\/\/example.com", + "in": "query" + }, + { + "name": "response_type", + "description": "OAuth2 \/ OIDC response type. One of `code` (Authorization Code Flow), `id_token` (Implicit Flow, OIDC login only), or `code id_token` (Hybrid Flow).", + "required": true, + "type": "string", + "x-example": "code", + "in": "query" + }, + { + "name": "scope", + "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`.", + "required": true, + "type": "string", + "x-example": "<SCOPE>", + "in": "query" + }, + { + "name": "state", + "description": "OAuth2 state. You receive this back in the redirect URI.", + "required": false, + "type": "string", + "x-example": "<STATE>", + "default": "", + "in": "query" + }, + { + "name": "nonce", + "description": "OIDC nonce parameter to prevent replay attacks. Required when response_type includes `id_token`.", + "required": false, + "type": "string", + "x-example": "<NONCE>", + "default": "", + "in": "query" + }, + { + "name": "code_challenge", + "description": "PKCE code challenge. Required when OAuth2 app is public.", + "required": false, + "type": "string", + "x-example": "<CODE_CHALLENGE>", + "default": "", + "in": "query" + }, + { + "name": "code_challenge_method", + "description": "PKCE code challenge method. Required when OAuth2 app is public.", + "required": false, + "type": "string", + "x-example": "s256", + "default": "", + "in": "query" + }, + { + "name": "prompt", + "description": "OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.", + "required": false, + "type": "string", + "x-example": "<PROMPT>", + "default": "", + "in": "query" + }, + { + "name": "max_age", + "description": "OIDC max_age paraleter for customization of consent screen. Maximum allowable elapsed time in seconds since the user last authenticated. If exceeded, re-authentication is required.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "in": "query" + }, + { + "name": "authorization_details", + "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", + "required": false, + "type": "string", + "x-example": "<AUTHORIZATION_DETAILS>", + "default": "", + "in": "query" + } + ] + } + }, + "\/oauth2\/{project_id}\/grants": { + "post": { + "summary": "Create OAuth2 Grant", + "operationId": "oauth2CreateGrant", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "oauth2" + ], + "description": "Exchange a device flow user code for an OAuth2 grant. The authenticated user is bound to the pending grant. Pass the returned grant ID to the get grant endpoint to render the consent screen, then to the approve or reject endpoint to complete the flow.", + "responses": { + "201": { + "description": "OAuth2 Grant", + "schema": { + "$ref": "#\/definitions\/oauth2Grant" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createGrant", + "group": null, + "cookies": false, + "type": "", + "demo": "oauth2\/create-grant.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "ip:{ip},userId:{userId}", + "scope": "oauth2.write", + "platforms": [ + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md", "auth": { "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], "JWT": [] } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client exists.", + "required": true, + "type": "string", + "x-example": "<PROJECT_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "user_code": { + "type": "string", + "description": "User code displayed on the device.", + "x-example": "<USER_CODE>" + } + }, + "required": [ + "user_code" + ] + } + } + ] + } + }, + "\/oauth2\/{project_id}\/grants\/{grant_id}": { + "get": { + "summary": "Get OAuth2 Grant", + "operationId": "oauth2GetGrant", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "oauth2" + ], + "description": "Get an OAuth2 grant by its ID. Used by the consent screen to display the details of the authorization the user is being asked to approve. A grant can only be read by the user it belongs to, or by server SDK.", + "responses": { + "200": { + "description": "OAuth2 Grant", + "schema": { + "$ref": "#\/definitions\/oauth2Grant" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getGrant", + "group": null, + "cookies": false, + "type": "", + "demo": "oauth2\/get-grant.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.read", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Session": [] + } }, "security": [ { "Project": [], - "JWT": [], "Session": [], + "JWT": [], "Key": [] } ], "parameters": [ { - "name": "topicId", - "description": "Topic ID. The topic ID subscribed to.", + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", "required": true, "type": "string", - "x-example": "<TOPIC_ID>", + "x-example": "<PROJECT_ID>", "in": "path" }, { - "name": "subscriberId", - "description": "Subscriber ID.", + "name": "grant_id", + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", "required": true, "type": "string", - "x-example": "<SUBSCRIBER_ID>", + "x-example": "<GRANT_ID>", + "in": "path" + } + ] + } + }, + "\/oauth2\/{project_id}\/reject": { + "post": { + "summary": "Reject OAuth2", + "operationId": "oauth2Reject", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "oauth2" + ], + "description": "Reject an OAuth2 grant when the user denies consent. Returns the `redirectUrl` the end user should be sent to with an `access_denied` error. You can pass Accept header of `application\/json` to receive a JSON response instead of a redirect.", + "responses": { + "200": { + "description": "OAuth2 Reject", + "schema": { + "$ref": "#\/definitions\/oauth2Reject" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "reject", + "group": null, + "cookies": false, + "type": "", + "demo": "oauth2\/reject.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "ProjectQuery": [], + "Session": [] + } + }, + "security": [ + { + "ProjectQuery": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "project_id", + "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "required": true, + "type": "string", + "x-example": "<PROJECT_ID>", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "grant_id": { + "type": "string", + "description": "Grant ID made during authorization, provided to consent screen in URL search params.", + "x-example": "<GRANT_ID>" + } + }, + "required": [ + "grant_id" + ] + } } ] } @@ -28882,7 +30672,10 @@ "keyId": { "type": "string", "description": "Key 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.", - "x-example": "<KEY_ID>" + "x-example": "<KEY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -30349,7 +32142,10 @@ "keyId": { "type": "string", "description": "Key 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.", - "x-example": "<KEY_ID>" + "x-example": "<KEY_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -30453,9 +32249,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes", @@ -30550,9 +32349,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ] } @@ -30729,9 +32531,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes", @@ -30826,9 +32631,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ] } @@ -31074,9 +32882,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ], "x-enum-name": "ProjectKeyScopes", @@ -31171,9 +32982,12 @@ "archives.write", "restorations.read", "restorations.write", + "dedicatedDatabases.execute", "domains.read", "domains.write", "events.read", + "apps.read", + "apps.write", "usage.read" ] } @@ -31741,6 +33555,163 @@ ] } }, + "\/project\/oauth2-server": { + "put": { + "summary": "Update OAuth2 server", + "operationId": "projectUpdateOAuth2Server", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update the OAuth2 server (OIDC provider) configuration.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Server", + "group": null, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-server.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable the OAuth2 server.", + "x-example": false + }, + "authorizationUrl": { + "type": "string", + "description": "URL to your application with consent screen.", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "scopes": { + "type": "array", + "description": "List of allowed OAuth2 scopes. Maximum of 100 scopes are allowed, each up to 128 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "authorizationDetailsTypes": { + "type": "array", + "description": "List of accepted `authorization_details` types. Maximum of 100 types are allowed, each up to 128 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "accessTokenDuration": { + "type": "integer", + "description": "Access token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 8 hours.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "refreshTokenDuration": { + "type": "integer", + "description": "Refresh token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 1 year.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "publicAccessTokenDuration": { + "type": "integer", + "description": "Access token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 1 hour.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "publicRefreshTokenDuration": { + "type": "integer", + "description": "Refresh token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 30 days.", + "x-example": 60, + "format": "int32", + "x-nullable": true + }, + "confidentialPkce": { + "type": "boolean", + "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", + "x-example": false, + "x-nullable": true + }, + "verificationUrl": { + "type": "string", + "description": "URL to your application page where users enter the device flow user code. Required to enable the Device Authorization Grant.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "userCodeLength": { + "type": "integer", + "description": "Number of characters in the device flow user code, excluding the formatting separator. Shorter codes are easier to type but weaker; pair short codes with short expiry. Leave empty to use default 8.", + "x-example": 6, + "format": "int32", + "x-nullable": true + }, + "userCodeFormat": { + "type": "string", + "description": "Character set for device flow user codes: `numeric` (digits only \u2014 best for numeric keypads and TV remotes), `alphabetic` (letters only), or `alphanumeric` (letters and digits \u2014 highest entropy per character). Defaults to `alphanumeric`.", + "default": "alphanumeric", + "x-example": "numeric" + }, + "deviceCodeDuration": { + "type": "integer", + "description": "Lifetime in seconds of device flow device codes and user codes. Device codes are intentionally short-lived. Leave empty to use default 600.", + "x-example": 60, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "enabled", + "authorizationUrl" + ] + } + } + ] + } + }, "\/project\/oauth2\/amazon": { "patch": { "summary": "Update project OAuth2 Amazon", @@ -35710,7 +37681,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -35878,7 +37852,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -36046,7 +38023,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -36214,7 +38194,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -36382,7 +38365,10 @@ "platformId": { "type": "string", "description": "Platform 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.", - "x-example": "<PLATFORM_ID>" + "x-example": "<PLATFORM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -37013,6 +38999,11 @@ "type": "boolean", "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", "x-example": false + }, + "userAccessedAt": { + "type": "boolean", + "description": "Set to true if you want make user last access time visible to all team members, or false to hide it.", + "x-example": false } } } @@ -37244,6 +39235,98 @@ ] } }, + "\/project\/policies\/password-strength": { + "patch": { + "summary": "Update password strength policy", + "operationId": "projectUpdatePasswordStrengthPolicy", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update the password strength requirements for users in the project.", + "responses": { + "200": { + "description": "Policy Password Strength", + "schema": { + "$ref": "#\/definitions\/policyPasswordStrength" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePasswordStrengthPolicy", + "group": "policies", + "cookies": false, + "type": "", + "demo": "project\/update-password-strength-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "description": "Minimum password length. Value must be between 8 and 256. Default is 8.", + "x-example": 8, + "format": "int32" + }, + "uppercase": { + "type": "boolean", + "description": "Whether passwords must include at least one uppercase letter.", + "x-example": false + }, + "lowercase": { + "type": "boolean", + "description": "Whether passwords must include at least one lowercase letter.", + "x-example": false + }, + "number": { + "type": "boolean", + "description": "Whether passwords must include at least one number.", + "x-example": false + }, + "symbols": { + "type": "boolean", + "description": "Whether passwords must include at least one symbol.", + "x-example": false + } + } + } + } + ] + } + }, "\/project\/policies\/session-alert": { "patch": { "summary": "Update session alert policy", @@ -37633,7 +39716,7 @@ "description": "Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.", "responses": { "200": { - "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy", + "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Strength, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy, or Policy Deny Aliased Email, or Policy Deny Disposable Email, or Policy Deny Free Email", "schema": { "x-oneOf": [ { @@ -37642,6 +39725,9 @@ { "$ref": "#\/definitions\/policyPasswordHistory" }, + { + "$ref": "#\/definitions\/policyPasswordStrength" + }, { "$ref": "#\/definitions\/policyPasswordPersonalData" }, @@ -37662,6 +39748,15 @@ }, { "$ref": "#\/definitions\/policyMembershipPrivacy" + }, + { + "$ref": "#\/definitions\/policyDenyAliasedEmail" + }, + { + "$ref": "#\/definitions\/policyDenyDisposableEmail" + }, + { + "$ref": "#\/definitions\/policyDenyFreeEmail" } ], "x-discriminator": { @@ -37669,13 +39764,17 @@ "mapping": { "password-dictionary": "#\/definitions\/policyPasswordDictionary", "password-history": "#\/definitions\/policyPasswordHistory", + "password-strength": "#\/definitions\/policyPasswordStrength", "password-personal-data": "#\/definitions\/policyPasswordPersonalData", "session-alert": "#\/definitions\/policySessionAlert", "session-duration": "#\/definitions\/policySessionDuration", "session-invalidation": "#\/definitions\/policySessionInvalidation", "session-limit": "#\/definitions\/policySessionLimit", "user-limit": "#\/definitions\/policyUserLimit", - "membership-privacy": "#\/definitions\/policyMembershipPrivacy" + "membership-privacy": "#\/definitions\/policyMembershipPrivacy", + "deny-aliased-email": "#\/definitions\/policyDenyAliasedEmail", + "deny-disposable-email": "#\/definitions\/policyDenyDisposableEmail", + "deny-free-email": "#\/definitions\/policyDenyFreeEmail" } } } @@ -37715,32 +39814,40 @@ "parameters": [ { "name": "policyId", - "description": "Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.", + "description": "Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, deny-aliased-email, deny-disposable-email, deny-free-email.", "required": true, "type": "string", "x-example": "password-dictionary", "enum": [ "password-dictionary", "password-history", + "password-strength", "password-personal-data", "session-alert", "session-duration", "session-invalidation", "session-limit", "user-limit", - "membership-privacy" + "membership-privacy", + "deny-aliased-email", + "deny-disposable-email", + "deny-free-email" ], "x-enum-name": "ProjectPolicyId", "x-enum-keys": [ "password-dictionary", "password-history", + "password-strength", "password-personal-data", "session-alert", "session-duration", "session-invalidation", "session-limit", "user-limit", - "membership-privacy" + "membership-privacy", + "deny-aliased-email", + "deny-disposable-email", + "deny-free-email" ], "in": "path" } @@ -37890,7 +39997,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, documentsDB, tablesDB, vectorsDB, locale, health, project, storage, teams, users, vcs, webhooks, tokens, presences, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "type": "string", "x-example": "account", @@ -37899,6 +40006,9 @@ "avatars", "databases", "tablesdb", + "documentsDB", + "tablesDB", + "vectorsDB", "locale", "health", "project", @@ -37906,6 +40016,9 @@ "teams", "users", "vcs", + "webhooks", + "tokens", + "presences", "sites", "functions", "proxy", @@ -37920,6 +40033,9 @@ "avatars", "databases", "tablesdb", + "documentsDB", + "tablesDB", + "vectorsDB", "locale", "health", "project", @@ -37927,6 +40043,9 @@ "teams", "users", "vcs", + "webhooks", + "tokens", + "presences", "sites", "functions", "proxy", @@ -38036,7 +40155,8 @@ "password": { "type": "string", "description": "SMTP server password. Pass an empty string to clear a previously set value. This property is stored securely and cannot be read in future (write-only).", - "x-example": "<PASSWORD>", + "x-example": "password", + "format": "password", "x-nullable": true }, "senderEmail": { @@ -39117,7 +41237,10 @@ "variableId": { "type": "string", "description": "Variable unique 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -39577,7 +41700,7 @@ }, "\/proxy\/rules\/redirect": { "post": { - "summary": "Create Redirect rule", + "summary": "Create redirect rule", "operationId": "proxyCreateRedirectRule", "consumes": [ "application\/json" @@ -39653,7 +41776,7 @@ "307", "308" ], - "x-enum-name": "RedirectStatusCode", + "x-enum-name": "StatusCode", "x-enum-keys": [ "MovedPermanently", "Found", @@ -40435,7 +42558,10 @@ "siteId": { "type": "string", "description": "Site 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.", - "x-example": "<SITE_ID>" + "x-example": "<SITE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -40463,7 +42589,7 @@ "vite", "other" ], - "x-enum-name": "SiteFramework", + "x-enum-name": "Framework", "x-enum-keys": [ "analog", "angular", @@ -40625,7 +42751,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "SiteBuildRuntime", + "x-enum-name": "BuildRuntime", "x-enum-keys": [ "node-14.5", "node-16.0", @@ -40731,7 +42857,7 @@ "static", "ssr" ], - "x-enum-name": "SiteAdapter", + "x-enum-name": "Adapter", "x-enum-keys": [ "static", "ssr" @@ -41071,7 +43197,7 @@ "vite", "other" ], - "x-enum-name": "SiteFramework", + "x-enum-name": "Framework", "x-enum-keys": [ "analog", "angular", @@ -41233,7 +43359,7 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "SiteBuildRuntime", + "x-enum-name": "BuildRuntime", "x-enum-keys": [ "node-14.5", "node-16.0", @@ -41339,7 +43465,7 @@ "static", "ssr" ], - "x-enum-name": "SiteAdapter", + "x-enum-name": "Adapter", "x-enum-keys": [ "static", "ssr" @@ -42223,14 +44349,16 @@ "public": true, "auth": { "Project": [], - "Key": [] + "Key": [], + "ImpersonateUserId": [] } }, "security": [ { "Project": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -42702,7 +44830,10 @@ "variableId": { "type": "string", "description": "Variable 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.", - "x-example": "<VARIABLE_ID>" + "x-example": "<VARIABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "key": { "type": "string", @@ -43099,7 +45230,10 @@ "bucketId": { "type": "string", "description": "Unique 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.", - "x-example": "<BUCKET_ID>" + "x-example": "<BUCKET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -43616,6 +45750,9 @@ "required": true, "x-upload-id": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<FILE_ID>", "in": "formData" }, @@ -43916,7 +46053,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -43924,7 +46062,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -43997,7 +46136,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -44005,7 +46145,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -44223,7 +46364,8 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { "Project": [], - "Session": [] + "Session": [], + "ImpersonateUserId": [] } }, "security": [ @@ -44231,7 +46373,8 @@ "Project": [], "Session": [], "Key": [], - "JWT": [] + "JWT": [], + "ImpersonateUserId": [] } ], "parameters": [ @@ -44405,7 +46548,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -45240,7 +47386,10 @@ "tableId": { "type": "string", "description": "Unique 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.", - "x-example": "<TABLE_ID>" + "x-example": "<TABLE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -46235,7 +48384,7 @@ }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { "patch": { - "summary": "Update dateTime column", + "summary": "Update datetime column", "operationId": "tablesDBUpdateDatetimeColumn", "consumes": [ "application\/json" @@ -50764,7 +52913,10 @@ "type": "string", "description": "Row 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.", "default": "", - "x-example": "<ROW_ID>" + "x-example": "<ROW_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -51974,7 +54126,10 @@ "teamId": { "type": "string", "description": "Team 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.", - "x-example": "<TEAM_ID>" + "x-example": "<TEAM_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -53540,7 +55695,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -53560,7 +55718,8 @@ "type": "string", "description": "Plain text user password. Must be at least 8 chars.", "default": "", - "x-example": null + "x-example": "password", + "format": "password" }, "name": { "type": "string", @@ -53638,7 +55797,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -53730,7 +55892,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -53963,7 +56128,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -54055,7 +56223,10 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. 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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -54147,7 +56318,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -54273,7 +56447,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -54383,7 +56560,10 @@ "userId": { "type": "string", "description": "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.", - "x-example": "<USER_ID>" + "x-example": "<USER_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "email": { "type": "string", @@ -55965,7 +58145,8 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": null + "x-example": "password", + "format": "password" } }, "required": [ @@ -56328,6 +58509,9 @@ "description": "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.", "required": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<USER_ID>", "in": "path" } @@ -56691,7 +58875,10 @@ "targetId": { "type": "string", "description": "Target 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.", - "x-example": "<TARGET_ID>" + "x-example": "<TARGET_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "providerType": { "type": "string", @@ -57345,7 +59532,10 @@ "databaseId": { "type": "string", "description": "Unique 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.", - "x-example": "<DATABASE_ID>" + "x-example": "<DATABASE_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -57357,6 +59547,12 @@ "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "specification": { + "type": "string", + "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", + "default": "free", + "x-example": "<SPECIFICATION>" } }, "required": [ @@ -57370,7 +59566,7 @@ }, "\/vectorsdb\/embeddings\/text": { "post": { - "summary": "Create Text Embeddings", + "summary": "Create text embeddings", "operationId": "vectorsDBCreateTextEmbeddings", "consumes": [ "application\/json" @@ -57465,14 +59661,20 @@ "model": { "type": "string", "description": "The embedding model to use for generating vector embeddings.", - "default": "embeddinggemma", - "x-example": "embeddinggemma", + "default": "nomic-embed-text", + "x-example": "nomic-embed-text", "enum": [ - "embeddinggemma" + "nomic-embed-text", + "embedding-gemma", + "all-minilm", + "bge-small" ], "x-enum-name": "EmbeddingModel", "x-enum-keys": [ - "embeddinggemma" + "nomic-embed-text", + "embedding-gemma", + "all-minilm", + "bge-small" ] } }, @@ -58275,7 +60477,10 @@ "collectionId": { "type": "string", "description": "Unique 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.", - "x-example": "<COLLECTION_ID>" + "x-example": "<COLLECTION_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "name": { "type": "string", @@ -58815,7 +61020,10 @@ "type": "string", "description": "Document 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.", "default": "", - "x-example": "<DOCUMENT_ID>" + "x-example": "<DOCUMENT_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "data": { "type": "object", @@ -59373,6 +61581,9 @@ "description": "Document ID.", "required": true, "type": "string", + "x-appwrite": { + "idGenerator": "ID.unique" + }, "x-example": "<DOCUMENT_ID>", "in": "path" }, @@ -60117,7 +62328,10 @@ "webhookId": { "type": "string", "description": "Webhook 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.", - "x-example": "<WEBHOOK_ID>" + "x-example": "<WEBHOOK_ID>", + "x-appwrite": { + "idGenerator": "ID.unique" + } }, "url": { "type": "string", @@ -60159,7 +62373,8 @@ "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_PASSWORD>" + "x-example": "password", + "format": "password" }, "secret": { "type": "string", @@ -60342,7 +62557,8 @@ "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_PASSWORD>" + "x-example": "password", + "format": "password" } }, "required": [ @@ -60505,6 +62721,18 @@ "name": "tablesdb", "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" }, + { + "name": "documentsDB", + "description": "The DocumentsDB service allows you to create structured collections of documents, query and filter lists of documents." + }, + { + "name": "tablesDB", + "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows." + }, + { + "name": "vectorsDB", + "description": "The VectorsDB service allows you to create vector collections, embeddings, indexes, and documents." + }, { "name": "locale", "description": "The Locale service allows you to customize your app based on your users' location." @@ -60533,6 +62761,18 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, + { + "name": "webhooks", + "description": "The Webhooks service allows you to configure event-driven HTTP callbacks for your project." + }, + { + "name": "tokens", + "description": "The Tokens service allows you to create and manage resource tokens for project resources." + }, + { + "name": "presences", + "description": "The Presences service allows you to create, query, and manage realtime presence state." + }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -60553,6 +62793,10 @@ "name": "console", "description": "The Console service allows you to interact with console relevant information." }, + { + "name": "organization", + "description": "The Organization service allows you to manage organization-level projects." + }, { "name": "migrations", "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." @@ -61537,7 +63781,7 @@ "total": { "type": "integer", "description": "Total number of policies in the given project.", - "x-example": 9, + "x-example": 10, "format": "int32" }, "policies": { @@ -61551,6 +63795,9 @@ { "$ref": "#\/definitions\/policyPasswordHistory" }, + { + "$ref": "#\/definitions\/policyPasswordStrength" + }, { "$ref": "#\/definitions\/policyPasswordPersonalData" }, @@ -61571,6 +63818,15 @@ }, { "$ref": "#\/definitions\/policyMembershipPrivacy" + }, + { + "$ref": "#\/definitions\/policyDenyAliasedEmail" + }, + { + "$ref": "#\/definitions\/policyDenyDisposableEmail" + }, + { + "$ref": "#\/definitions\/policyDenyFreeEmail" } ], "x-discriminator": { @@ -61578,13 +63834,17 @@ "mapping": { "password-dictionary": "#\/definitions\/policyPasswordDictionary", "password-history": "#\/definitions\/policyPasswordHistory", + "password-strength": "#\/definitions\/policyPasswordStrength", "password-personal-data": "#\/definitions\/policyPasswordPersonalData", "session-alert": "#\/definitions\/policySessionAlert", "session-duration": "#\/definitions\/policySessionDuration", "session-invalidation": "#\/definitions\/policySessionInvalidation", "session-limit": "#\/definitions\/policySessionLimit", "user-limit": "#\/definitions\/policyUserLimit", - "membership-privacy": "#\/definitions\/policyMembershipPrivacy" + "membership-privacy": "#\/definitions\/policyMembershipPrivacy", + "deny-aliased-email": "#\/definitions\/policyDenyAliasedEmail", + "deny-disposable-email": "#\/definitions\/policyDenyDisposableEmail", + "deny-free-email": "#\/definitions\/policyDenyFreeEmail" } } }, @@ -61596,7 +63856,7 @@ "policies" ], "example": { - "total": 9, + "total": 10, "policies": "" } }, @@ -62122,7 +64382,7 @@ "model": { "type": "string", "description": "Embedding model used to generate embeddings.", - "x-example": "embeddinggemma" + "x-example": "nomic-embed-text" }, "dimension": { "type": "integer", @@ -62156,7 +64416,7 @@ "error" ], "example": { - "model": "embeddinggemma", + "model": "nomic-embed-text", "dimension": 768, "embedding": [ 0.01, @@ -67393,6 +69653,36 @@ "description": "Email verification status.", "x-example": true }, + "emailCanonical": { + "type": "string", + "description": "Canonical form of the user email address.", + "x-example": "john@appwrite.io", + "x-nullable": true + }, + "emailIsFree": { + "type": "boolean", + "description": "Whether the user email is from a free email provider.", + "x-example": true, + "x-nullable": true + }, + "emailIsDisposable": { + "type": "boolean", + "description": "Whether the user email is from a disposable email provider.", + "x-example": false, + "x-nullable": true + }, + "emailIsCorporate": { + "type": "boolean", + "description": "Whether the user email is from a corporate domain.", + "x-example": true, + "x-nullable": true + }, + "emailIsCanonical": { + "type": "boolean", + "description": "Whether the user email is in its canonical form.", + "x-example": true, + "x-nullable": true + }, "phoneVerification": { "type": "boolean", "description": "Phone verification status.", @@ -67477,6 +69767,11 @@ "email": "john@appwrite.io", "phone": "+4930901820", "emailVerification": true, + "emailCanonical": "john@appwrite.io", + "emailIsFree": true, + "emailIsDisposable": false, + "emailIsCorporate": true, + "emailIsCanonical": true, "phoneVerification": true, "mfa": true, "prefs": { @@ -68583,6 +70878,11 @@ "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", "x-example": false }, + "userAccessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, "roles": { "type": "array", "description": "User list of roles", @@ -68608,6 +70908,7 @@ "joined", "confirm", "mfa", + "userAccessedAt", "roles" ], "example": { @@ -68624,6 +70925,7 @@ "joined": "2020-10-15T06:38:00.000+00:00", "confirm": false, "mfa": false, + "userAccessedAt": "2020-10-15T06:38:00.000+00:00", "roles": [ "owner" ] @@ -69777,6 +72079,11 @@ "description": "Project team ID.", "x-example": "1592981250" }, + "region": { + "type": "string", + "description": "Project region", + "x-example": "fra" + }, "devKeys": { "type": "array", "description": "Deprecated since 1.9.5: List of dev keys.", @@ -69830,7 +72137,8 @@ "smtpPassword": { "type": "string", "description": "SMTP server password. This property is write-only and always returned empty.", - "x-example": "" + "x-example": "smtp-password", + "format": "password" }, "smtpSecure": { "type": "string", @@ -69890,10 +72198,19 @@ }, "x-example": {} }, - "region": { + "blocks": { + "type": "array", + "description": "Project blocks information", + "items": { + "type": "object", + "$ref": "#\/definitions\/block" + }, + "x-example": "" + }, + "consoleAccessedAt": { "type": "string", - "description": "Project region", - "x-example": "fra" + "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, "billingLimits": { "type": "object", @@ -69905,19 +72222,92 @@ }, "x-nullable": true }, - "blocks": { + "oAuth2ServerEnabled": { + "type": "boolean", + "description": "OAuth2 server status", + "x-example": false + }, + "oAuth2ServerAuthorizationUrl": { + "type": "string", + "description": "OAuth2 server authorization URL", + "x-example": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration" + }, + "oAuth2ServerScopes": { "type": "array", - "description": "Project blocks information", + "description": "OAuth2 server allowed scopes", "items": { - "type": "object", - "$ref": "#\/definitions\/block" + "type": "string" }, - "x-example": "" + "x-example": [ + "read", + "write" + ] }, - "consoleAccessedAt": { + "oAuth2ServerAuthorizationDetailsTypes": { + "type": "array", + "description": "OAuth2 server accepted RFC 9396 authorization_details types", + "items": { + "type": "string" + }, + "x-example": [ + "calendar" + ] + }, + "oAuth2ServerAccessTokenDuration": { + "type": "integer", + "description": "OAuth2 server access token duration in seconds for confidential clients", + "x-example": 3600, + "format": "int32" + }, + "oAuth2ServerRefreshTokenDuration": { + "type": "integer", + "description": "OAuth2 server refresh token duration in seconds for confidential clients", + "x-example": 86400, + "format": "int32" + }, + "oAuth2ServerPublicAccessTokenDuration": { + "type": "integer", + "description": "OAuth2 server access token duration in seconds for public clients (SPAs, mobile, native)", + "x-example": 3600, + "format": "int32" + }, + "oAuth2ServerPublicRefreshTokenDuration": { + "type": "integer", + "description": "OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)", + "x-example": 2592000, + "format": "int32" + }, + "oAuth2ServerConfidentialPkce": { + "type": "boolean", + "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", + "x-example": false + }, + "oAuth2ServerVerificationUrl": { "type": "string", - "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "URL to your application page where users enter the device flow user code. Empty when the Device Authorization Grant is not configured.", + "x-example": "https:\/\/cloud.appwrite.io\/device" + }, + "oAuth2ServerUserCodeLength": { + "type": "integer", + "description": "Number of characters in the device flow user code, excluding the formatting separator.", + "x-example": 8, + "format": "int32" + }, + "oAuth2ServerUserCodeFormat": { + "type": "string", + "description": "Character set for device flow user codes: `numeric`, `alphabetic`, or `alphanumeric`.", + "x-example": "alphanumeric" + }, + "oAuth2ServerDeviceCodeDuration": { + "type": "integer", + "description": "Lifetime in seconds of device flow device codes and user codes.", + "x-example": 600, + "format": "int32" + }, + "oAuth2ServerDiscoveryUrl": { + "type": "string", + "description": "OAuth2 server discovery URL", + "x-example": "https:\/\/auth.example.com\/.well-known\/openid-configuration" } }, "required": [ @@ -69926,6 +72316,7 @@ "$updatedAt", "name", "teamId", + "region", "devKeys", "smtpEnabled", "smtpSenderName", @@ -69944,9 +72335,22 @@ "authMethods", "services", "protocols", - "region", "blocks", - "consoleAccessedAt" + "consoleAccessedAt", + "oAuth2ServerEnabled", + "oAuth2ServerAuthorizationUrl", + "oAuth2ServerScopes", + "oAuth2ServerAuthorizationDetailsTypes", + "oAuth2ServerAccessTokenDuration", + "oAuth2ServerRefreshTokenDuration", + "oAuth2ServerPublicAccessTokenDuration", + "oAuth2ServerPublicRefreshTokenDuration", + "oAuth2ServerConfidentialPkce", + "oAuth2ServerVerificationUrl", + "oAuth2ServerUserCodeLength", + "oAuth2ServerUserCodeFormat", + "oAuth2ServerDeviceCodeDuration", + "oAuth2ServerDiscoveryUrl" ], "example": { "$id": "5e5ea5c16897e", @@ -69954,6 +72358,7 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "New Project", "teamId": "1592981250", + "region": "fra", "devKeys": {}, "smtpEnabled": false, "smtpSenderName": "John Appwrite", @@ -69963,7 +72368,7 @@ "smtpHost": "mail.appwrite.io", "smtpPort": 25, "smtpUsername": "emailuser", - "smtpPassword": "", + "smtpPassword": "smtp-password", "smtpSecure": "tls", "pingCount": 1, "pingedAt": "2020-10-15T06:38:00.000+00:00", @@ -69974,10 +72379,28 @@ "authMethods": {}, "services": {}, "protocols": {}, - "region": "fra", - "billingLimits": "", "blocks": "", - "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00", + "billingLimits": "", + "oAuth2ServerEnabled": false, + "oAuth2ServerAuthorizationUrl": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration", + "oAuth2ServerScopes": [ + "read", + "write" + ], + "oAuth2ServerAuthorizationDetailsTypes": [ + "calendar" + ], + "oAuth2ServerAccessTokenDuration": 3600, + "oAuth2ServerRefreshTokenDuration": 86400, + "oAuth2ServerPublicAccessTokenDuration": 3600, + "oAuth2ServerPublicRefreshTokenDuration": 2592000, + "oAuth2ServerConfidentialPkce": false, + "oAuth2ServerVerificationUrl": "https:\/\/cloud.appwrite.io\/device", + "oAuth2ServerUserCodeLength": 8, + "oAuth2ServerUserCodeFormat": "alphanumeric", + "oAuth2ServerDeviceCodeDuration": 600, + "oAuth2ServerDiscoveryUrl": "https:\/\/auth.example.com\/.well-known\/openid-configuration" } }, "projectAuthMethod": { @@ -70027,6 +72450,9 @@ "avatars", "databases", "tablesdb", + "documentsDB", + "tablesDB", + "vectorsDB", "locale", "health", "project", @@ -70034,6 +72460,9 @@ "teams", "users", "vcs", + "webhooks", + "tokens", + "presences", "sites", "functions", "proxy", @@ -70142,7 +72571,8 @@ "authPassword": { "type": "string", "description": "HTTP basic authentication password.", - "x-example": "password" + "x-example": "webhook-password", + "format": "password" }, "secret": { "type": "string", @@ -70193,7 +72623,7 @@ ], "tls": true, "authUsername": "username", - "authPassword": "password", + "authPassword": "webhook-password", "secret": "ad3d581ca230e2b7059c545e5a", "enabled": true, "logs": "Failed to connect to remote server.", @@ -72354,6 +74784,59 @@ "total": 5 } }, + "policyPasswordStrength": { + "description": "Policy Password Strength", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "min": { + "type": "integer", + "description": "Minimum password length required for user passwords.", + "x-example": 12, + "format": "int32" + }, + "uppercase": { + "type": "boolean", + "description": "Whether passwords must include at least one uppercase letter.", + "x-example": true + }, + "lowercase": { + "type": "boolean", + "description": "Whether passwords must include at least one lowercase letter.", + "x-example": true + }, + "number": { + "type": "boolean", + "description": "Whether passwords must include at least one number.", + "x-example": true + }, + "symbols": { + "type": "boolean", + "description": "Whether passwords must include at least one symbol.", + "x-example": true + } + }, + "required": [ + "$id", + "min", + "uppercase", + "lowercase", + "number", + "symbols" + ], + "example": { + "$id": "password-dictionary", + "min": 12, + "uppercase": true, + "lowercase": true, + "number": true, + "symbols": true + } + }, "policyPasswordPersonalData": { "description": "Policy Password Personal Data", "type": "object", @@ -72534,6 +75017,11 @@ "type": "boolean", "description": "Whether user MFA status is visible in memberships.", "x-example": true + }, + "userAccessedAt": { + "type": "boolean", + "description": "Whether user last access time is visible in memberships.", + "x-example": true } }, "required": [ @@ -72542,7 +75030,8 @@ "userEmail", "userPhone", "userName", - "userMFA" + "userMFA", + "userAccessedAt" ], "example": { "$id": "password-dictionary", @@ -72550,7 +75039,8 @@ "userEmail": true, "userPhone": true, "userName": true, - "userMFA": true + "userMFA": true, + "userAccessedAt": true } }, "platformWeb": { @@ -74604,66 +77094,6 @@ "description": "Hostname.", "x-example": "appwrite.io" }, - "osCode": { - "type": "string", - "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" - }, - "osName": { - "type": "string", - "description": "Operating system name.", - "x-example": "Mac" - }, - "osVersion": { - "type": "string", - "description": "Operating system version.", - "x-example": "Mac" - }, - "clientType": { - "type": "string", - "description": "Client type.", - "x-example": "browser" - }, - "clientCode": { - "type": "string", - "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" - }, - "clientName": { - "type": "string", - "description": "Client name.", - "x-example": "Chrome Mobile iOS" - }, - "clientVersion": { - "type": "string", - "description": "Client version.", - "x-example": "84.0" - }, - "clientEngine": { - "type": "string", - "description": "Client engine name.", - "x-example": "WebKit" - }, - "clientEngineVersion": { - "type": "string", - "description": "Client engine name.", - "x-example": "605.1.15" - }, - "deviceName": { - "type": "string", - "description": "Device name.", - "x-example": "smartphone" - }, - "deviceBrand": { - "type": "string", - "description": "Device brand name.", - "x-example": "Google" - }, - "deviceModel": { - "type": "string", - "description": "Device model name.", - "x-example": "Nexus 5" - }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", @@ -74694,18 +77124,6 @@ "projectId", "teamId", "hostname", - "osCode", - "osName", - "osVersion", - "clientType", - "clientCode", - "clientName", - "clientVersion", - "clientEngine", - "clientEngineVersion", - "deviceName", - "deviceBrand", - "deviceModel", "countryCode", "countryName" ], @@ -74728,18 +77146,6 @@ "projectId": "610fc2f985ee0", "teamId": "610fc2f985ee0", "hostname": "appwrite.io", - "osCode": "Mac", - "osName": "Mac", - "osVersion": "Mac", - "clientType": "browser", - "clientCode": "CM", - "clientName": "Chrome Mobile iOS", - "clientVersion": "84.0", - "clientEngine": "WebKit", - "clientEngineVersion": "605.1.15", - "deviceName": "smartphone", - "deviceBrand": "Google", - "deviceModel": "Nexus 5", "countryCode": "US", "countryName": "United States" } @@ -75091,6 +77497,78 @@ "enabled": true } }, + "policyDenyAliasedEmail": { + "description": "Policy Deny Aliased Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny aliased email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policyDenyDisposableEmail": { + "description": "Policy Deny Disposable Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny disposable email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policyDenyFreeEmail": { + "description": "Policy Deny Free Email", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "enabled": { + "type": "boolean", + "description": "Whether the deny free email policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, "backupRestoration": { "description": "Restoration", "type": "object", @@ -75311,6 +77789,407 @@ "resourceId": "production" } }, + "app": { + "description": "App", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "App ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "App creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "App update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Application name.", + "x-example": "My Application" + }, + "redirectUris": { + "type": "array", + "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", + "items": { + "type": "string" + }, + "x-example": [ + "https:\/\/example.com\/callback" + ] + }, + "enabled": { + "type": "boolean", + "description": "Whether the app is enabled or not.", + "x-example": true + }, + "type": { + "type": "string", + "description": "OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot keep a client secret (PKCE required); `confidential` for server-side clients that authenticate with a client secret.", + "x-example": "confidential" + }, + "deviceFlow": { + "type": "boolean", + "description": "Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).", + "x-example": false + }, + "teamId": { + "type": "string", + "description": "ID of team that owns the application, if owned by team. Otherwise, user ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "userId": { + "type": "string", + "description": "ID of user who owns the application, if owned by user. Otherwise, team ID will be used.", + "x-example": "5e5ea5c16897e" + }, + "secrets": { + "type": "array", + "description": "List of application secrets.", + "items": { + "type": "object", + "$ref": "#\/definitions\/appSecret" + }, + "x-example": [] + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "redirectUris", + "enabled", + "type", + "deviceFlow", + "teamId", + "userId", + "secrets" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Application", + "redirectUris": [ + "https:\/\/example.com\/callback" + ], + "enabled": true, + "type": "confidential", + "deviceFlow": false, + "teamId": "5e5ea5c16897e", + "userId": "5e5ea5c16897e", + "secrets": [] + } + }, + "appSecret": { + "description": "AppSecret", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Secret creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Secret update time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" + }, + "secret": { + "type": "string", + "description": "Hashed application client secret.", + "x-example": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg" + }, + "hint": { + "type": "string", + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" + }, + "createdById": { + "type": "string", + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" + }, + "createdByName": { + "type": "string", + "description": "Name of the user who created the secret.", + "x-example": "Walter White" + }, + "lastAccessedAt": { + "type": "string", + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "secret", + "hint", + "createdById", + "createdByName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "secret": "$argon2i$v=19$m=16,t=2,p=1$MTIzMTIzMTIzMTIzMQ$3\/ZUl3IWERBO2RIm5rHltg", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, + "appSecretPlaintext": { + "description": "AppSecretPlaintext", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Secret ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Secret creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Secret update time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "Application ID this secret belongs to.", + "x-example": "5e5ea5c16897e" + }, + "secret": { + "type": "string", + "description": "Application client secret. Returned in full only when the secret is created; subsequent reads return a masked value.", + "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + }, + "hint": { + "type": "string", + "description": "Last few characters of the client secret, used to help identify it.", + "x-example": "f5c6c7" + }, + "createdById": { + "type": "string", + "description": "ID of the user who created the secret.", + "x-example": "5e5ea5c16897e" + }, + "createdByName": { + "type": "string", + "description": "Name of the user who created the secret.", + "x-example": "Walter White" + }, + "lastAccessedAt": { + "type": "string", + "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "secret", + "hint", + "createdById", + "createdByName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "secret": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a", + "hint": "f5c6c7", + "createdById": "5e5ea5c16897e", + "createdByName": "Walter White", + "lastAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, + "oauth2Authorize": { + "description": "OAuth2 Authorize", + "type": "object", + "properties": { + "grantId": { + "type": "string", + "description": "OAuth2 grant ID. Set when the user must give explicit consent; pass it to the approve or reject endpoint. Empty when a redirect URL is returned instead.", + "x-example": "5e5ea5c16897e" + }, + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to when the flow can complete without consent. Empty when consent is still required.", + "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "required": [ + "grantId", + "redirectUrl" + ], + "example": { + "grantId": "5e5ea5c16897e", + "redirectUrl": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "oauth2Approve": { + "description": "OAuth2 Approve", + "type": "object", + "properties": { + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to after the grant is approved, carrying the authorization `code` and\/or `id_token` along with the original `state`.", + "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "required": [ + "redirectUrl" + ], + "example": { + "redirectUrl": "https:\/\/example.com\/callback?code=abcde&state=fghij" + } + }, + "oauth2Reject": { + "description": "OAuth2 Reject", + "type": "object", + "properties": { + "redirectUrl": { + "type": "string", + "description": "URL the end user should be redirected to after the grant is rejected, carrying an `access_denied` error.", + "x-example": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + } + }, + "required": [ + "redirectUrl" + ], + "example": { + "redirectUrl": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + } + }, + "oauth2Grant": { + "description": "OAuth2 Grant", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Grant ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Grant creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Grant update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "userId": { + "type": "string", + "description": "ID of the user the grant belongs to.", + "x-example": "5e5ea5c16897e" + }, + "appId": { + "type": "string", + "description": "ID of the OAuth2 client (app) the grant was requested for.", + "x-example": "5e5ea5c16897e" + }, + "scopes": { + "type": "array", + "description": "Requested OAuth2 scopes the user is being asked to consent to.", + "items": { + "type": "string" + }, + "x-example": [ + "openid", + "email", + "profile" + ] + }, + "authorizationDetails": { + "type": "string", + "description": "Requested authorization_details the user is being asked to consent to, as a JSON string. Each entry has a `type` plus project-defined fields.", + "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + }, + "prompt": { + "type": "string", + "description": "OIDC prompt directive the consent screen should honor. Space-separated list of: login, consent, select_account.", + "x-example": "login" + }, + "redirectUri": { + "type": "string", + "description": "Redirect URI the user will be sent to after the flow completes.", + "x-example": "https:\/\/example.com\/callback" + }, + "authTime": { + "type": "integer", + "description": "Unix timestamp of when the user last authenticated.", + "x-example": 1592981250, + "format": "int32" + }, + "expire": { + "type": "string", + "description": "Grant expiration time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "userId", + "appId", + "scopes", + "authorizationDetails", + "prompt", + "redirectUri", + "authTime", + "expire" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "userId": "5e5ea5c16897e", + "appId": "5e5ea5c16897e", + "scopes": [ + "openid", + "email", + "profile" + ], + "authorizationDetails": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]", + "prompt": "login", + "redirectUri": "https:\/\/example.com\/callback", + "authTime": 1592981250, + "expire": "2020-10-15T06:38:00.000+00:00" + } + }, "activityEventList": { "description": "Activity event list", "type": "object", @@ -75484,6 +78363,64 @@ "total": 5, "gauges": "" } + }, + "appsList": { + "description": "Apps list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of apps that matched your query.", + "x-example": 5, + "format": "int32" + }, + "apps": { + "type": "array", + "description": "List of apps.", + "items": { + "type": "object", + "$ref": "#\/definitions\/app" + }, + "x-example": "" + } + }, + "required": [ + "total", + "apps" + ], + "example": { + "total": 5, + "apps": "" + } + }, + "appSecretList": { + "description": "App secrets list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of secrets that matched your query.", + "x-example": 5, + "format": "int32" + }, + "secrets": { + "type": "array", + "description": "List of secrets.", + "items": { + "type": "object", + "$ref": "#\/definitions\/appSecret" + }, + "x-example": "" + } + }, + "required": [ + "total", + "secrets" + ], + "example": { + "total": 5, + "secrets": "" + } } }, "externalDocs": {