From e4686b6bf60d33f57f85c4ff49c2f883cd2d48dd Mon Sep 17 00:00:00 2001 From: root Date: Fri, 20 Mar 2026 03:16:46 +0000 Subject: [PATCH] feat: update API specs for version 1.8.x --- .../java/databases/list-documents.md | 1 + .../client-android/java/tablesdb/list-rows.md | 1 + .../kotlin/databases/list-documents.md | 1 + .../kotlin/tablesdb/list-rows.md | 1 + .../examples/databases/list-documents.md | 3 +- .../examples/tablesdb/list-rows.md | 3 +- .../examples/databases/list-documents.md | 1 + .../examples/tablesdb/list-rows.md | 1 + .../examples/databases/list-documents.md | 3 +- .../examples/tablesdb/list-rows.md | 3 +- .../examples/databases/list-documents.md | 3 +- .../client-web/examples/tablesdb/list-rows.md | 3 +- .../examples/sites/create-deployment.md | 3 +- .../console-cli/examples/webhooks/create.md | 7 + .../console-cli/examples/webhooks/delete.md | 4 + .../console-cli/examples/webhooks/get.md | 4 + .../console-cli/examples/webhooks/list.md | 3 + .../examples/webhooks/update-signature.md | 4 + .../console-cli/examples/webhooks/update.md | 7 + .../examples/databases/list-documents.md | 3 +- .../examples/domains/create-purchase.md | 2 +- .../examples/domains/create-transfer-in.md | 18 + .../examples/domains/create-transfer-out.md | 16 + .../examples/domains/get-transfer-status.md | 15 + .../examples/domains/update-purchase.md | 16 + .../examples/domains/update-transfer-in.md | 16 + .../console-web/examples/functions/create.md | 4 +- .../console-web/examples/functions/update.md | 4 +- .../migrations/create-appwrite-migration.md | 4 +- .../migrations/create-firebase-migration.md | 4 +- .../migrations/create-n-host-migration.md | 4 +- .../migrations/create-supabase-migration.md | 4 +- .../migrations/get-appwrite-report.md | 4 +- .../migrations/get-firebase-report.md | 4 +- .../examples/migrations/get-n-host-report.md | 4 +- .../migrations/get-supabase-report.md | 4 +- .../examples/sites/create-deployment.md | 4 +- .../console-web/examples/sites/create.md | 5 +- .../console-web/examples/sites/update.md | 5 +- .../examples/tablesdb/list-rows.md | 3 +- .../console-web/examples/webhooks/create.md | 22 + .../console-web/examples/webhooks/delete.md | 15 + .../console-web/examples/webhooks/get.md | 15 + .../console-web/examples/webhooks/list.md | 16 + .../examples/webhooks/update-signature.md | 15 + .../console-web/examples/webhooks/update.md | 22 + .../examples/databases/list-documents.md | 1 + .../server-dart/examples/functions/create.md | 4 +- .../server-dart/examples/functions/update.md | 4 +- .../examples/sites/create-deployment.md | 2 +- .../server-dart/examples/sites/create.md | 5 +- .../server-dart/examples/sites/update.md | 5 +- .../examples/tablesdb/list-rows.md | 1 + .../server-dart/examples/webhooks/create.md | 21 + .../server-dart/examples/webhooks/delete.md | 14 + .../server-dart/examples/webhooks/get.md | 14 + .../server-dart/examples/webhooks/list.md | 15 + .../examples/webhooks/update-signature.md | 14 + .../server-dart/examples/webhooks/update.md | 21 + .../examples/databases/list-documents.md | 3 +- .../examples/functions/create.md | 4 +- .../examples/functions/update.md | 4 +- .../examples/sites/create-deployment.md | 4 +- .../server-dotnet/examples/sites/create.md | 5 +- .../server-dotnet/examples/sites/update.md | 5 +- .../examples/tablesdb/list-rows.md | 3 +- .../server-dotnet/examples/webhooks/create.md | 22 + .../server-dotnet/examples/webhooks/delete.md | 15 + .../server-dotnet/examples/webhooks/get.md | 15 + .../server-dotnet/examples/webhooks/list.md | 16 + .../examples/webhooks/update-signature.md | 15 + .../server-dotnet/examples/webhooks/update.md | 22 + .../examples/databases/list-documents.md | 1 + .../server-go/examples/functions/create.md | 4 +- .../server-go/examples/functions/update.md | 4 +- .../examples/sites/create-deployment.md | 2 +- .../1.8.x/server-go/examples/sites/create.md | 5 +- .../1.8.x/server-go/examples/sites/update.md | 5 +- .../server-go/examples/tablesdb/list-rows.md | 1 + .../server-go/examples/webhooks/create.md | 28 + .../server-go/examples/webhooks/delete.md | 21 + .../1.8.x/server-go/examples/webhooks/get.md | 21 + .../1.8.x/server-go/examples/webhooks/list.md | 22 + .../examples/webhooks/update-signature.md | 21 + .../server-go/examples/webhooks/update.md | 28 + .../examples/functions/create.md | 8 +- .../functions/update-function-deployment.md | 4 +- .../examples/functions/update.md | 8 +- .../examples/sites/create-deployment.md | 2 +- .../server-graphql/examples/sites/create.md | 10 +- .../examples/sites/update-site-deployment.md | 5 +- .../server-graphql/examples/sites/update.md | 10 +- .../examples/webhooks/create.md | 28 + .../examples/webhooks/delete.md | 9 + .../server-graphql/examples/webhooks/get.md | 2 + .../server-graphql/examples/webhooks/list.md | 2 + .../examples/webhooks/update-signature.md | 21 + .../examples/webhooks/update.md | 28 + .../java/databases/list-documents.md | 1 + .../server-kotlin/java/functions/create.md | 4 +- .../server-kotlin/java/functions/update.md | 4 +- .../java/sites/create-deployment.md | 2 +- .../1.8.x/server-kotlin/java/sites/create.md | 5 +- .../1.8.x/server-kotlin/java/sites/update.md | 5 +- .../server-kotlin/java/tablesdb/list-rows.md | 1 + .../server-kotlin/java/webhooks/create.md | 32 + .../server-kotlin/java/webhooks/delete.md | 25 + .../1.8.x/server-kotlin/java/webhooks/get.md | 25 + .../1.8.x/server-kotlin/java/webhooks/list.md | 26 + .../java/webhooks/update-signature.md | 25 + .../server-kotlin/java/webhooks/update.md | 32 + .../kotlin/databases/list-documents.md | 3 +- .../server-kotlin/kotlin/functions/create.md | 4 +- .../server-kotlin/kotlin/functions/update.md | 4 +- .../kotlin/sites/create-deployment.md | 4 +- .../server-kotlin/kotlin/sites/create.md | 5 +- .../server-kotlin/kotlin/sites/update.md | 5 +- .../kotlin/tablesdb/list-rows.md | 3 +- .../server-kotlin/kotlin/webhooks/create.md | 23 + .../server-kotlin/kotlin/webhooks/delete.md | 16 + .../server-kotlin/kotlin/webhooks/get.md | 16 + .../server-kotlin/kotlin/webhooks/list.md | 17 + .../kotlin/webhooks/update-signature.md | 16 + .../server-kotlin/kotlin/webhooks/update.md | 23 + .../examples/databases/list-documents.md | 3 +- .../examples/functions/create.md | 4 +- .../examples/functions/update.md | 4 +- .../examples/sites/create-deployment.md | 4 +- .../server-nodejs/examples/sites/create.md | 5 +- .../server-nodejs/examples/sites/update.md | 5 +- .../examples/tablesdb/list-rows.md | 3 +- .../server-nodejs/examples/webhooks/create.md | 21 + .../server-nodejs/examples/webhooks/delete.md | 14 + .../server-nodejs/examples/webhooks/get.md | 14 + .../server-nodejs/examples/webhooks/list.md | 15 + .../examples/webhooks/update-signature.md | 14 + .../server-nodejs/examples/webhooks/update.md | 21 + .../examples/databases/list-documents.md | 3 +- .../server-php/examples/functions/create.md | 4 +- .../server-php/examples/functions/update.md | 4 +- .../examples/sites/create-deployment.md | 4 +- .../1.8.x/server-php/examples/sites/create.md | 5 +- .../1.8.x/server-php/examples/sites/update.md | 5 +- .../server-php/examples/tablesdb/list-rows.md | 3 +- .../server-php/examples/webhooks/create.md | 23 + .../server-php/examples/webhooks/delete.md | 16 + .../1.8.x/server-php/examples/webhooks/get.md | 16 + .../server-php/examples/webhooks/list.md | 17 + .../examples/webhooks/update-signature.md | 16 + .../server-php/examples/webhooks/update.md | 23 + .../account/create-anonymous-session.md | 5 +- .../account/create-email-password-session.md | 5 +- .../examples/account/create-email-token.md | 5 +- .../account/create-email-verification.md | 5 +- .../examples/account/create-jwt.md | 5 +- .../account/create-magic-url-token.md | 5 +- .../account/create-mfa-authenticator.md | 5 +- .../examples/account/create-mfa-challenge.md | 5 +- .../account/create-mfa-recovery-codes.md | 5 +- .../examples/account/create-o-auth-2-token.md | 2 +- .../examples/account/create-phone-token.md | 5 +- .../account/create-phone-verification.md | 5 +- .../examples/account/create-recovery.md | 5 +- .../examples/account/create-session.md | 5 +- .../examples/account/create-verification.md | 5 +- .../server-python/examples/account/create.md | 5 +- .../account/get-mfa-recovery-codes.md | 5 +- .../examples/account/get-prefs.md | 5 +- .../examples/account/get-session.md | 5 +- .../server-python/examples/account/get.md | 5 +- .../examples/account/list-identities.md | 5 +- .../examples/account/list-logs.md | 5 +- .../examples/account/list-mfa-factors.md | 5 +- .../examples/account/list-sessions.md | 5 +- .../account/update-email-verification.md | 5 +- .../examples/account/update-email.md | 5 +- .../account/update-magic-url-session.md | 5 +- .../account/update-mfa-authenticator.md | 5 +- .../examples/account/update-mfa-challenge.md | 5 +- .../account/update-mfa-recovery-codes.md | 5 +- .../examples/account/update-mfa.md | 5 +- .../examples/account/update-name.md | 5 +- .../examples/account/update-password.md | 5 +- .../examples/account/update-phone-session.md | 5 +- .../account/update-phone-verification.md | 5 +- .../examples/account/update-phone.md | 5 +- .../examples/account/update-prefs.md | 5 +- .../examples/account/update-recovery.md | 5 +- .../examples/account/update-session.md | 5 +- .../examples/account/update-status.md | 5 +- .../examples/account/update-verification.md | 5 +- .../examples/activities/get-event.md | 5 +- .../examples/activities/list-events.md | 5 +- .../examples/avatars/get-browser.md | 2 +- .../examples/avatars/get-credit-card.md | 2 +- .../examples/avatars/get-favicon.md | 2 +- .../examples/avatars/get-flag.md | 2 +- .../examples/avatars/get-image.md | 2 +- .../examples/avatars/get-initials.md | 2 +- .../server-python/examples/avatars/get-qr.md | 2 +- .../examples/avatars/get-screenshot.md | 2 +- .../examples/backups/create-archive.md | 5 +- .../examples/backups/create-policy.md | 5 +- .../examples/backups/create-restoration.md | 5 +- .../examples/backups/get-archive.md | 5 +- .../examples/backups/get-policy.md | 5 +- .../examples/backups/get-restoration.md | 5 +- .../examples/backups/list-archives.md | 5 +- .../examples/backups/list-policies.md | 5 +- .../examples/backups/list-restorations.md | 5 +- .../examples/backups/update-policy.md | 5 +- .../databases/create-boolean-attribute.md | 5 +- .../examples/databases/create-collection.md | 5 +- .../databases/create-datetime-attribute.md | 5 +- .../examples/databases/create-document.md | 5 +- .../examples/databases/create-documents.md | 5 +- .../databases/create-email-attribute.md | 5 +- .../databases/create-enum-attribute.md | 5 +- .../databases/create-float-attribute.md | 5 +- .../examples/databases/create-index.md | 5 +- .../databases/create-integer-attribute.md | 5 +- .../examples/databases/create-ip-attribute.md | 5 +- .../databases/create-line-attribute.md | 5 +- .../databases/create-longtext-attribute.md | 5 +- .../databases/create-mediumtext-attribute.md | 5 +- .../examples/databases/create-operations.md | 5 +- .../databases/create-point-attribute.md | 5 +- .../databases/create-polygon-attribute.md | 5 +- .../create-relationship-attribute.md | 5 +- .../databases/create-string-attribute.md | 5 +- .../databases/create-text-attribute.md | 5 +- .../examples/databases/create-transaction.md | 5 +- .../databases/create-url-attribute.md | 5 +- .../databases/create-varchar-attribute.md | 5 +- .../examples/databases/create.md | 5 +- .../databases/decrement-document-attribute.md | 5 +- .../examples/databases/delete-documents.md | 5 +- .../examples/databases/get-attribute.md | 15 +- .../examples/databases/get-collection.md | 5 +- .../examples/databases/get-document.md | 5 +- .../examples/databases/get-index.md | 5 +- .../examples/databases/get-transaction.md | 5 +- .../server-python/examples/databases/get.md | 5 +- .../databases/increment-document-attribute.md | 5 +- .../examples/databases/list-attributes.md | 5 +- .../examples/databases/list-collections.md | 5 +- .../examples/databases/list-documents.md | 8 +- .../examples/databases/list-indexes.md | 5 +- .../examples/databases/list-transactions.md | 5 +- .../server-python/examples/databases/list.md | 5 +- .../databases/update-boolean-attribute.md | 5 +- .../examples/databases/update-collection.md | 5 +- .../databases/update-datetime-attribute.md | 5 +- .../examples/databases/update-document.md | 5 +- .../examples/databases/update-documents.md | 5 +- .../databases/update-email-attribute.md | 5 +- .../databases/update-enum-attribute.md | 5 +- .../databases/update-float-attribute.md | 5 +- .../databases/update-integer-attribute.md | 5 +- .../examples/databases/update-ip-attribute.md | 5 +- .../databases/update-line-attribute.md | 5 +- .../databases/update-longtext-attribute.md | 5 +- .../databases/update-mediumtext-attribute.md | 5 +- .../databases/update-point-attribute.md | 5 +- .../databases/update-polygon-attribute.md | 5 +- .../update-relationship-attribute.md | 5 +- .../databases/update-string-attribute.md | 5 +- .../databases/update-text-attribute.md | 5 +- .../examples/databases/update-transaction.md | 5 +- .../databases/update-url-attribute.md | 5 +- .../databases/update-varchar-attribute.md | 5 +- .../examples/databases/update.md | 5 +- .../examples/databases/upsert-document.md | 5 +- .../examples/databases/upsert-documents.md | 5 +- .../examples/functions/create-deployment.md | 5 +- .../functions/create-duplicate-deployment.md | 5 +- .../examples/functions/create-execution.md | 5 +- .../functions/create-template-deployment.md | 5 +- .../examples/functions/create-variable.md | 5 +- .../functions/create-vcs-deployment.md | 5 +- .../examples/functions/create.md | 9 +- .../functions/get-deployment-download.md | 2 +- .../examples/functions/get-deployment.md | 5 +- .../examples/functions/get-execution.md | 5 +- .../examples/functions/get-variable.md | 5 +- .../server-python/examples/functions/get.md | 5 +- .../examples/functions/list-deployments.md | 5 +- .../examples/functions/list-executions.md | 5 +- .../examples/functions/list-runtimes.md | 5 +- .../examples/functions/list-specifications.md | 5 +- .../examples/functions/list-variables.md | 5 +- .../server-python/examples/functions/list.md | 5 +- .../functions/update-deployment-status.md | 5 +- .../functions/update-function-deployment.md | 5 +- .../examples/functions/update-variable.md | 5 +- .../examples/functions/update.md | 9 +- .../examples/health/get-antivirus.md | 5 +- .../examples/health/get-cache.md | 5 +- .../examples/health/get-certificate.md | 5 +- .../examples/health/get-console-pausing.md | 5 +- .../server-python/examples/health/get-db.md | 5 +- .../examples/health/get-failed-jobs.md | 5 +- .../examples/health/get-pub-sub.md | 5 +- .../examples/health/get-queue-audits.md | 5 +- .../examples/health/get-queue-builds.md | 5 +- .../examples/health/get-queue-certificates.md | 5 +- .../examples/health/get-queue-databases.md | 5 +- .../examples/health/get-queue-deletes.md | 5 +- .../examples/health/get-queue-functions.md | 5 +- .../examples/health/get-queue-logs.md | 5 +- .../examples/health/get-queue-mails.md | 5 +- .../examples/health/get-queue-messaging.md | 5 +- .../examples/health/get-queue-migrations.md | 5 +- .../health/get-queue-stats-resources.md | 5 +- .../examples/health/get-queue-usage.md | 5 +- .../examples/health/get-queue-webhooks.md | 5 +- .../examples/health/get-storage-local.md | 5 +- .../examples/health/get-storage.md | 5 +- .../server-python/examples/health/get-time.md | 5 +- .../server-python/examples/health/get.md | 5 +- .../server-python/examples/locale/get.md | 5 +- .../examples/locale/list-codes.md | 5 +- .../examples/locale/list-continents.md | 5 +- .../examples/locale/list-countries-eu.md | 5 +- .../examples/locale/list-countries-phones.md | 5 +- .../examples/locale/list-countries.md | 5 +- .../examples/locale/list-currencies.md | 5 +- .../examples/locale/list-languages.md | 5 +- .../messaging/create-apns-provider.md | 5 +- .../examples/messaging/create-email.md | 5 +- .../examples/messaging/create-fcm-provider.md | 5 +- .../messaging/create-mailgun-provider.md | 5 +- .../messaging/create-msg-91-provider.md | 5 +- .../examples/messaging/create-push.md | 5 +- .../messaging/create-resend-provider.md | 5 +- .../messaging/create-sendgrid-provider.md | 5 +- .../examples/messaging/create-sms.md | 5 +- .../messaging/create-smtp-provider.md | 5 +- .../examples/messaging/create-subscriber.md | 5 +- .../messaging/create-telesign-provider.md | 5 +- .../messaging/create-textmagic-provider.md | 5 +- .../examples/messaging/create-topic.md | 5 +- .../messaging/create-twilio-provider.md | 5 +- .../messaging/create-vonage-provider.md | 5 +- .../examples/messaging/get-message.md | 5 +- .../examples/messaging/get-provider.md | 5 +- .../examples/messaging/get-subscriber.md | 5 +- .../examples/messaging/get-topic.md | 5 +- .../examples/messaging/list-message-logs.md | 5 +- .../examples/messaging/list-messages.md | 5 +- .../examples/messaging/list-provider-logs.md | 5 +- .../examples/messaging/list-providers.md | 5 +- .../messaging/list-subscriber-logs.md | 5 +- .../examples/messaging/list-subscribers.md | 5 +- .../examples/messaging/list-targets.md | 5 +- .../examples/messaging/list-topic-logs.md | 5 +- .../examples/messaging/list-topics.md | 5 +- .../messaging/update-apns-provider.md | 5 +- .../examples/messaging/update-email.md | 5 +- .../examples/messaging/update-fcm-provider.md | 5 +- .../messaging/update-mailgun-provider.md | 5 +- .../messaging/update-msg-91-provider.md | 5 +- .../examples/messaging/update-push.md | 5 +- .../messaging/update-resend-provider.md | 5 +- .../messaging/update-sendgrid-provider.md | 5 +- .../examples/messaging/update-sms.md | 5 +- .../messaging/update-smtp-provider.md | 5 +- .../messaging/update-telesign-provider.md | 5 +- .../messaging/update-textmagic-provider.md | 5 +- .../examples/messaging/update-topic.md | 5 +- .../messaging/update-twilio-provider.md | 5 +- .../messaging/update-vonage-provider.md | 5 +- .../examples/sites/create-deployment.md | 9 +- .../sites/create-duplicate-deployment.md | 5 +- .../sites/create-template-deployment.md | 5 +- .../examples/sites/create-variable.md | 5 +- .../examples/sites/create-vcs-deployment.md | 5 +- .../server-python/examples/sites/create.md | 10 +- .../examples/sites/get-deployment-download.md | 2 +- .../examples/sites/get-deployment.md | 5 +- .../server-python/examples/sites/get-log.md | 5 +- .../examples/sites/get-variable.md | 5 +- .../1.8.x/server-python/examples/sites/get.md | 5 +- .../examples/sites/list-deployments.md | 5 +- .../examples/sites/list-frameworks.md | 5 +- .../server-python/examples/sites/list-logs.md | 5 +- .../examples/sites/list-specifications.md | 5 +- .../examples/sites/list-variables.md | 5 +- .../server-python/examples/sites/list.md | 5 +- .../sites/update-deployment-status.md | 5 +- .../examples/sites/update-site-deployment.md | 5 +- .../examples/sites/update-variable.md | 5 +- .../server-python/examples/sites/update.md | 10 +- .../examples/storage/create-bucket.md | 5 +- .../examples/storage/create-file.md | 5 +- .../examples/storage/get-bucket.md | 5 +- .../examples/storage/get-file-download.md | 2 +- .../examples/storage/get-file-preview.md | 2 +- .../examples/storage/get-file-view.md | 2 +- .../examples/storage/get-file.md | 5 +- .../examples/storage/list-buckets.md | 5 +- .../examples/storage/list-files.md | 5 +- .../examples/storage/update-bucket.md | 5 +- .../examples/storage/update-file.md | 5 +- .../tablesdb/create-boolean-column.md | 5 +- .../tablesdb/create-datetime-column.md | 5 +- .../examples/tablesdb/create-email-column.md | 5 +- .../examples/tablesdb/create-enum-column.md | 5 +- .../examples/tablesdb/create-float-column.md | 5 +- .../examples/tablesdb/create-index.md | 5 +- .../tablesdb/create-integer-column.md | 5 +- .../examples/tablesdb/create-ip-column.md | 5 +- .../examples/tablesdb/create-line-column.md | 5 +- .../tablesdb/create-longtext-column.md | 5 +- .../tablesdb/create-mediumtext-column.md | 5 +- .../examples/tablesdb/create-operations.md | 5 +- .../examples/tablesdb/create-point-column.md | 5 +- .../tablesdb/create-polygon-column.md | 5 +- .../tablesdb/create-relationship-column.md | 5 +- .../examples/tablesdb/create-row.md | 5 +- .../examples/tablesdb/create-rows.md | 5 +- .../examples/tablesdb/create-string-column.md | 5 +- .../examples/tablesdb/create-table.md | 5 +- .../examples/tablesdb/create-text-column.md | 5 +- .../examples/tablesdb/create-transaction.md | 5 +- .../examples/tablesdb/create-url-column.md | 5 +- .../tablesdb/create-varchar-column.md | 5 +- .../server-python/examples/tablesdb/create.md | 5 +- .../examples/tablesdb/decrement-row-column.md | 5 +- .../examples/tablesdb/delete-rows.md | 5 +- .../examples/tablesdb/get-column.md | 15 +- .../examples/tablesdb/get-index.md | 5 +- .../examples/tablesdb/get-row.md | 5 +- .../examples/tablesdb/get-table.md | 5 +- .../examples/tablesdb/get-transaction.md | 5 +- .../server-python/examples/tablesdb/get.md | 5 +- .../examples/tablesdb/increment-row-column.md | 5 +- .../examples/tablesdb/list-columns.md | 5 +- .../examples/tablesdb/list-indexes.md | 5 +- .../examples/tablesdb/list-rows.md | 8 +- .../examples/tablesdb/list-tables.md | 5 +- .../examples/tablesdb/list-transactions.md | 5 +- .../server-python/examples/tablesdb/list.md | 5 +- .../tablesdb/update-boolean-column.md | 5 +- .../tablesdb/update-datetime-column.md | 5 +- .../examples/tablesdb/update-email-column.md | 5 +- .../examples/tablesdb/update-enum-column.md | 5 +- .../examples/tablesdb/update-float-column.md | 5 +- .../tablesdb/update-integer-column.md | 5 +- .../examples/tablesdb/update-ip-column.md | 5 +- .../examples/tablesdb/update-line-column.md | 5 +- .../tablesdb/update-longtext-column.md | 5 +- .../tablesdb/update-mediumtext-column.md | 5 +- .../examples/tablesdb/update-point-column.md | 5 +- .../tablesdb/update-polygon-column.md | 5 +- .../tablesdb/update-relationship-column.md | 5 +- .../examples/tablesdb/update-row.md | 5 +- .../examples/tablesdb/update-rows.md | 5 +- .../examples/tablesdb/update-string-column.md | 5 +- .../examples/tablesdb/update-table.md | 5 +- .../examples/tablesdb/update-text-column.md | 5 +- .../examples/tablesdb/update-transaction.md | 5 +- .../examples/tablesdb/update-url-column.md | 5 +- .../tablesdb/update-varchar-column.md | 5 +- .../server-python/examples/tablesdb/update.md | 5 +- .../examples/tablesdb/upsert-row.md | 5 +- .../examples/tablesdb/upsert-rows.md | 5 +- .../examples/teams/create-membership.md | 5 +- .../server-python/examples/teams/create.md | 5 +- .../examples/teams/get-membership.md | 5 +- .../server-python/examples/teams/get-prefs.md | 5 +- .../1.8.x/server-python/examples/teams/get.md | 5 +- .../examples/teams/list-memberships.md | 5 +- .../server-python/examples/teams/list.md | 5 +- .../teams/update-membership-status.md | 5 +- .../examples/teams/update-membership.md | 5 +- .../examples/teams/update-name.md | 5 +- .../examples/teams/update-prefs.md | 5 +- .../examples/tokens/create-file-token.md | 5 +- .../server-python/examples/tokens/get.md | 5 +- .../server-python/examples/tokens/list.md | 5 +- .../server-python/examples/tokens/update.md | 5 +- .../examples/users/create-argon-2-user.md | 5 +- .../examples/users/create-bcrypt-user.md | 5 +- .../examples/users/create-jwt.md | 5 +- .../examples/users/create-md-5-user.md | 5 +- .../users/create-mfa-recovery-codes.md | 5 +- .../examples/users/create-ph-pass-user.md | 5 +- .../users/create-scrypt-modified-user.md | 5 +- .../examples/users/create-scrypt-user.md | 5 +- .../examples/users/create-session.md | 5 +- .../examples/users/create-sha-user.md | 5 +- .../examples/users/create-target.md | 5 +- .../examples/users/create-token.md | 5 +- .../server-python/examples/users/create.md | 5 +- .../examples/users/get-mfa-recovery-codes.md | 5 +- .../server-python/examples/users/get-prefs.md | 5 +- .../examples/users/get-target.md | 5 +- .../1.8.x/server-python/examples/users/get.md | 5 +- .../examples/users/list-identities.md | 5 +- .../server-python/examples/users/list-logs.md | 5 +- .../examples/users/list-memberships.md | 5 +- .../examples/users/list-mfa-factors.md | 5 +- .../examples/users/list-sessions.md | 5 +- .../examples/users/list-targets.md | 5 +- .../server-python/examples/users/list.md | 5 +- .../users/update-email-verification.md | 5 +- .../examples/users/update-email.md | 5 +- .../examples/users/update-labels.md | 5 +- .../users/update-mfa-recovery-codes.md | 5 +- .../examples/users/update-mfa.md | 5 +- .../examples/users/update-name.md | 5 +- .../examples/users/update-password.md | 5 +- .../users/update-phone-verification.md | 5 +- .../examples/users/update-phone.md | 5 +- .../examples/users/update-prefs.md | 5 +- .../examples/users/update-status.md | 5 +- .../examples/users/update-target.md | 5 +- .../server-python/examples/webhooks/create.md | 25 + .../server-python/examples/webhooks/delete.md | 15 + .../server-python/examples/webhooks/get.md | 18 + .../server-python/examples/webhooks/list.md | 19 + .../examples/webhooks/update-signature.md | 18 + .../server-python/examples/webhooks/update.md | 25 + .../update-relationship-attribute.md | 2 +- .../server-rest/examples/functions/create.md | 4 +- .../server-rest/examples/functions/update.md | 4 +- .../server-rest/examples/sites/create.md | 5 +- .../server-rest/examples/sites/update.md | 5 +- .../server-rest/examples/webhooks/create.md | 19 + .../server-rest/examples/webhooks/delete.md | 9 + .../server-rest/examples/webhooks/get.md | 7 + .../server-rest/examples/webhooks/list.md | 7 + .../examples/webhooks/update-signature.md | 9 + .../server-rest/examples/webhooks/update.md | 18 + .../examples/databases/list-documents.md | 3 +- .../server-ruby/examples/functions/create.md | 4 +- .../server-ruby/examples/functions/update.md | 4 +- .../examples/sites/create-deployment.md | 4 +- .../server-ruby/examples/sites/create.md | 5 +- .../server-ruby/examples/sites/update.md | 5 +- .../examples/tablesdb/list-rows.md | 3 +- .../server-ruby/examples/webhooks/create.md | 23 + .../server-ruby/examples/webhooks/delete.md | 16 + .../server-ruby/examples/webhooks/get.md | 16 + .../server-ruby/examples/webhooks/list.md | 17 + .../examples/webhooks/update-signature.md | 16 + .../server-ruby/examples/webhooks/update.md | 23 + .../examples/databases/list-documents.md | 3 +- .../server-swift/examples/functions/create.md | 4 +- .../server-swift/examples/functions/update.md | 4 +- .../examples/sites/create-deployment.md | 4 +- .../server-swift/examples/sites/create.md | 5 +- .../server-swift/examples/sites/update.md | 5 +- .../examples/tablesdb/list-rows.md | 3 +- .../server-swift/examples/webhooks/create.md | 22 + .../server-swift/examples/webhooks/delete.md | 15 + .../server-swift/examples/webhooks/get.md | 15 + .../server-swift/examples/webhooks/list.md | 16 + .../examples/webhooks/update-signature.md | 15 + .../server-swift/examples/webhooks/update.md | 22 + specs/1.8.x/open-api3-1.8.x-client.json | 196 +- specs/1.8.x/open-api3-1.8.x-console.json | 5432 +++++++++++------ specs/1.8.x/open-api3-1.8.x-server.json | 2719 ++++++--- specs/1.8.x/swagger2-1.8.x-client.json | 196 +- specs/1.8.x/swagger2-1.8.x-console.json | 5098 ++++++++++------ specs/1.8.x/swagger2-1.8.x-server.json | 2752 ++++++--- 567 files changed, 14082 insertions(+), 6088 deletions(-) create mode 100644 examples/1.8.x/console-cli/examples/webhooks/create.md create mode 100644 examples/1.8.x/console-cli/examples/webhooks/delete.md create mode 100644 examples/1.8.x/console-cli/examples/webhooks/get.md create mode 100644 examples/1.8.x/console-cli/examples/webhooks/list.md create mode 100644 examples/1.8.x/console-cli/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/console-cli/examples/webhooks/update.md create mode 100644 examples/1.8.x/console-web/examples/domains/create-transfer-in.md create mode 100644 examples/1.8.x/console-web/examples/domains/create-transfer-out.md create mode 100644 examples/1.8.x/console-web/examples/domains/get-transfer-status.md create mode 100644 examples/1.8.x/console-web/examples/domains/update-purchase.md create mode 100644 examples/1.8.x/console-web/examples/domains/update-transfer-in.md create mode 100644 examples/1.8.x/console-web/examples/webhooks/create.md create mode 100644 examples/1.8.x/console-web/examples/webhooks/delete.md create mode 100644 examples/1.8.x/console-web/examples/webhooks/get.md create mode 100644 examples/1.8.x/console-web/examples/webhooks/list.md create mode 100644 examples/1.8.x/console-web/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/console-web/examples/webhooks/update.md create mode 100644 examples/1.8.x/server-dart/examples/webhooks/create.md create mode 100644 examples/1.8.x/server-dart/examples/webhooks/delete.md create mode 100644 examples/1.8.x/server-dart/examples/webhooks/get.md create mode 100644 examples/1.8.x/server-dart/examples/webhooks/list.md create mode 100644 examples/1.8.x/server-dart/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-dart/examples/webhooks/update.md create mode 100644 examples/1.8.x/server-dotnet/examples/webhooks/create.md create mode 100644 examples/1.8.x/server-dotnet/examples/webhooks/delete.md create mode 100644 examples/1.8.x/server-dotnet/examples/webhooks/get.md create mode 100644 examples/1.8.x/server-dotnet/examples/webhooks/list.md create mode 100644 examples/1.8.x/server-dotnet/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-dotnet/examples/webhooks/update.md create mode 100644 examples/1.8.x/server-go/examples/webhooks/create.md create mode 100644 examples/1.8.x/server-go/examples/webhooks/delete.md create mode 100644 examples/1.8.x/server-go/examples/webhooks/get.md create mode 100644 examples/1.8.x/server-go/examples/webhooks/list.md create mode 100644 examples/1.8.x/server-go/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-go/examples/webhooks/update.md create mode 100644 examples/1.8.x/server-graphql/examples/webhooks/create.md create mode 100644 examples/1.8.x/server-graphql/examples/webhooks/delete.md create mode 100644 examples/1.8.x/server-graphql/examples/webhooks/get.md create mode 100644 examples/1.8.x/server-graphql/examples/webhooks/list.md create mode 100644 examples/1.8.x/server-graphql/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-graphql/examples/webhooks/update.md create mode 100644 examples/1.8.x/server-kotlin/java/webhooks/create.md create mode 100644 examples/1.8.x/server-kotlin/java/webhooks/delete.md create mode 100644 examples/1.8.x/server-kotlin/java/webhooks/get.md create mode 100644 examples/1.8.x/server-kotlin/java/webhooks/list.md create mode 100644 examples/1.8.x/server-kotlin/java/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-kotlin/java/webhooks/update.md create mode 100644 examples/1.8.x/server-kotlin/kotlin/webhooks/create.md create mode 100644 examples/1.8.x/server-kotlin/kotlin/webhooks/delete.md create mode 100644 examples/1.8.x/server-kotlin/kotlin/webhooks/get.md create mode 100644 examples/1.8.x/server-kotlin/kotlin/webhooks/list.md create mode 100644 examples/1.8.x/server-kotlin/kotlin/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-kotlin/kotlin/webhooks/update.md create mode 100644 examples/1.8.x/server-nodejs/examples/webhooks/create.md create mode 100644 examples/1.8.x/server-nodejs/examples/webhooks/delete.md create mode 100644 examples/1.8.x/server-nodejs/examples/webhooks/get.md create mode 100644 examples/1.8.x/server-nodejs/examples/webhooks/list.md create mode 100644 examples/1.8.x/server-nodejs/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-nodejs/examples/webhooks/update.md create mode 100644 examples/1.8.x/server-php/examples/webhooks/create.md create mode 100644 examples/1.8.x/server-php/examples/webhooks/delete.md create mode 100644 examples/1.8.x/server-php/examples/webhooks/get.md create mode 100644 examples/1.8.x/server-php/examples/webhooks/list.md create mode 100644 examples/1.8.x/server-php/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-php/examples/webhooks/update.md create mode 100644 examples/1.8.x/server-python/examples/webhooks/create.md create mode 100644 examples/1.8.x/server-python/examples/webhooks/delete.md create mode 100644 examples/1.8.x/server-python/examples/webhooks/get.md create mode 100644 examples/1.8.x/server-python/examples/webhooks/list.md create mode 100644 examples/1.8.x/server-python/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-python/examples/webhooks/update.md create mode 100644 examples/1.8.x/server-rest/examples/webhooks/create.md create mode 100644 examples/1.8.x/server-rest/examples/webhooks/delete.md create mode 100644 examples/1.8.x/server-rest/examples/webhooks/get.md create mode 100644 examples/1.8.x/server-rest/examples/webhooks/list.md create mode 100644 examples/1.8.x/server-rest/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-rest/examples/webhooks/update.md create mode 100644 examples/1.8.x/server-ruby/examples/webhooks/create.md create mode 100644 examples/1.8.x/server-ruby/examples/webhooks/delete.md create mode 100644 examples/1.8.x/server-ruby/examples/webhooks/get.md create mode 100644 examples/1.8.x/server-ruby/examples/webhooks/list.md create mode 100644 examples/1.8.x/server-ruby/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-ruby/examples/webhooks/update.md create mode 100644 examples/1.8.x/server-swift/examples/webhooks/create.md create mode 100644 examples/1.8.x/server-swift/examples/webhooks/delete.md create mode 100644 examples/1.8.x/server-swift/examples/webhooks/get.md create mode 100644 examples/1.8.x/server-swift/examples/webhooks/list.md create mode 100644 examples/1.8.x/server-swift/examples/webhooks/update-signature.md create mode 100644 examples/1.8.x/server-swift/examples/webhooks/update.md diff --git a/examples/1.8.x/client-android/java/databases/list-documents.md b/examples/1.8.x/client-android/java/databases/list-documents.md index 26e7a52da..7edbec36d 100644 --- a/examples/1.8.x/client-android/java/databases/list-documents.md +++ b/examples/1.8.x/client-android/java/databases/list-documents.md @@ -15,6 +15,7 @@ databases.listDocuments( List.of(), // queries (optional) "", // transactionId (optional) false, // total (optional) + 0, // ttl (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.8.x/client-android/java/tablesdb/list-rows.md b/examples/1.8.x/client-android/java/tablesdb/list-rows.md index 48caad98a..6ab5489d4 100644 --- a/examples/1.8.x/client-android/java/tablesdb/list-rows.md +++ b/examples/1.8.x/client-android/java/tablesdb/list-rows.md @@ -15,6 +15,7 @@ tablesDB.listRows( List.of(), // queries (optional) "", // transactionId (optional) false, // total (optional) + 0, // ttl (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.8.x/client-android/kotlin/databases/list-documents.md b/examples/1.8.x/client-android/kotlin/databases/list-documents.md index 485ce792b..b42b7dd8a 100644 --- a/examples/1.8.x/client-android/kotlin/databases/list-documents.md +++ b/examples/1.8.x/client-android/kotlin/databases/list-documents.md @@ -15,5 +15,6 @@ val result = databases.listDocuments( queries = listOf(), // (optional) transactionId = "", // (optional) total = false, // (optional) + ttl = 0, // (optional) ) ``` diff --git a/examples/1.8.x/client-android/kotlin/tablesdb/list-rows.md b/examples/1.8.x/client-android/kotlin/tablesdb/list-rows.md index 9957a86f0..a428290a9 100644 --- a/examples/1.8.x/client-android/kotlin/tablesdb/list-rows.md +++ b/examples/1.8.x/client-android/kotlin/tablesdb/list-rows.md @@ -15,5 +15,6 @@ val result = tablesDB.listRows( queries = listOf(), // (optional) transactionId = "", // (optional) total = false, // (optional) + ttl = 0, // (optional) ) ``` diff --git a/examples/1.8.x/client-apple/examples/databases/list-documents.md b/examples/1.8.x/client-apple/examples/databases/list-documents.md index 4925ce3e6..801424eaf 100644 --- a/examples/1.8.x/client-apple/examples/databases/list-documents.md +++ b/examples/1.8.x/client-apple/examples/databases/list-documents.md @@ -12,7 +12,8 @@ let documentList = try await databases.listDocuments( collectionId: "", queries: [], // optional transactionId: "", // optional - total: false // optional + total: false, // optional + ttl: 0 // optional ) ``` diff --git a/examples/1.8.x/client-apple/examples/tablesdb/list-rows.md b/examples/1.8.x/client-apple/examples/tablesdb/list-rows.md index e23d3d093..b6df80e0c 100644 --- a/examples/1.8.x/client-apple/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/client-apple/examples/tablesdb/list-rows.md @@ -12,7 +12,8 @@ let rowList = try await tablesDB.listRows( tableId: "", queries: [], // optional transactionId: "", // optional - total: false // optional + total: false, // optional + ttl: 0 // optional ) ``` diff --git a/examples/1.8.x/client-flutter/examples/databases/list-documents.md b/examples/1.8.x/client-flutter/examples/databases/list-documents.md index ca690a559..531be6ade 100644 --- a/examples/1.8.x/client-flutter/examples/databases/list-documents.md +++ b/examples/1.8.x/client-flutter/examples/databases/list-documents.md @@ -13,5 +13,6 @@ DocumentList result = await databases.listDocuments( queries: [], // optional transactionId: '', // optional total: false, // optional + ttl: 0, // optional ); ``` diff --git a/examples/1.8.x/client-flutter/examples/tablesdb/list-rows.md b/examples/1.8.x/client-flutter/examples/tablesdb/list-rows.md index 1d535f8ab..a2637a93e 100644 --- a/examples/1.8.x/client-flutter/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/client-flutter/examples/tablesdb/list-rows.md @@ -13,5 +13,6 @@ RowList result = await tablesDB.listRows( queries: [], // optional transactionId: '', // optional total: false, // optional + ttl: 0, // optional ); ``` diff --git a/examples/1.8.x/client-react-native/examples/databases/list-documents.md b/examples/1.8.x/client-react-native/examples/databases/list-documents.md index 0641381bf..7907cd3fb 100644 --- a/examples/1.8.x/client-react-native/examples/databases/list-documents.md +++ b/examples/1.8.x/client-react-native/examples/databases/list-documents.md @@ -12,7 +12,8 @@ const result = await databases.listDocuments({ collectionId: '', queries: [], // optional transactionId: '', // optional - total: false // optional + total: false, // optional + ttl: 0 // optional }); console.log(result); diff --git a/examples/1.8.x/client-react-native/examples/tablesdb/list-rows.md b/examples/1.8.x/client-react-native/examples/tablesdb/list-rows.md index 5d270d6bf..80bbc454a 100644 --- a/examples/1.8.x/client-react-native/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/client-react-native/examples/tablesdb/list-rows.md @@ -12,7 +12,8 @@ const result = await tablesDB.listRows({ tableId: '', queries: [], // optional transactionId: '', // optional - total: false // optional + total: false, // optional + ttl: 0 // optional }); console.log(result); diff --git a/examples/1.8.x/client-web/examples/databases/list-documents.md b/examples/1.8.x/client-web/examples/databases/list-documents.md index 42dd36f66..5444dffb9 100644 --- a/examples/1.8.x/client-web/examples/databases/list-documents.md +++ b/examples/1.8.x/client-web/examples/databases/list-documents.md @@ -12,7 +12,8 @@ const result = await databases.listDocuments({ collectionId: '', queries: [], // optional transactionId: '', // optional - total: false // optional + total: false, // optional + ttl: 0 // optional }); console.log(result); diff --git a/examples/1.8.x/client-web/examples/tablesdb/list-rows.md b/examples/1.8.x/client-web/examples/tablesdb/list-rows.md index c6472a0b8..455ec6fe8 100644 --- a/examples/1.8.x/client-web/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/client-web/examples/tablesdb/list-rows.md @@ -12,7 +12,8 @@ const result = await tablesDB.listRows({ tableId: '', queries: [], // optional transactionId: '', // optional - total: false // optional + total: false, // optional + ttl: 0 // optional }); console.log(result); diff --git a/examples/1.8.x/console-cli/examples/sites/create-deployment.md b/examples/1.8.x/console-cli/examples/sites/create-deployment.md index d8cf3e99e..6168d6bea 100644 --- a/examples/1.8.x/console-cli/examples/sites/create-deployment.md +++ b/examples/1.8.x/console-cli/examples/sites/create-deployment.md @@ -1,6 +1,5 @@ ```bash appwrite sites create-deployment \ --site-id \ - --code 'path/to/file.png' \ - --activate false + --code 'path/to/file.png' ``` diff --git a/examples/1.8.x/console-cli/examples/webhooks/create.md b/examples/1.8.x/console-cli/examples/webhooks/create.md new file mode 100644 index 000000000..c0bf03564 --- /dev/null +++ b/examples/1.8.x/console-cli/examples/webhooks/create.md @@ -0,0 +1,7 @@ +```bash +appwrite webhooks create \ + --webhook-id \ + --url '' \ + --name \ + --events one two three +``` diff --git a/examples/1.8.x/console-cli/examples/webhooks/delete.md b/examples/1.8.x/console-cli/examples/webhooks/delete.md new file mode 100644 index 000000000..a9fc7a187 --- /dev/null +++ b/examples/1.8.x/console-cli/examples/webhooks/delete.md @@ -0,0 +1,4 @@ +```bash +appwrite webhooks delete \ + --webhook-id +``` diff --git a/examples/1.8.x/console-cli/examples/webhooks/get.md b/examples/1.8.x/console-cli/examples/webhooks/get.md new file mode 100644 index 000000000..3307149ae --- /dev/null +++ b/examples/1.8.x/console-cli/examples/webhooks/get.md @@ -0,0 +1,4 @@ +```bash +appwrite webhooks get \ + --webhook-id +``` diff --git a/examples/1.8.x/console-cli/examples/webhooks/list.md b/examples/1.8.x/console-cli/examples/webhooks/list.md new file mode 100644 index 000000000..50e57740b --- /dev/null +++ b/examples/1.8.x/console-cli/examples/webhooks/list.md @@ -0,0 +1,3 @@ +```bash +appwrite webhooks list +``` diff --git a/examples/1.8.x/console-cli/examples/webhooks/update-signature.md b/examples/1.8.x/console-cli/examples/webhooks/update-signature.md new file mode 100644 index 000000000..0636d5572 --- /dev/null +++ b/examples/1.8.x/console-cli/examples/webhooks/update-signature.md @@ -0,0 +1,4 @@ +```bash +appwrite webhooks update-signature \ + --webhook-id +``` diff --git a/examples/1.8.x/console-cli/examples/webhooks/update.md b/examples/1.8.x/console-cli/examples/webhooks/update.md new file mode 100644 index 000000000..27a2ee4e7 --- /dev/null +++ b/examples/1.8.x/console-cli/examples/webhooks/update.md @@ -0,0 +1,7 @@ +```bash +appwrite webhooks update \ + --webhook-id \ + --name \ + --url '' \ + --events one two three +``` diff --git a/examples/1.8.x/console-web/examples/databases/list-documents.md b/examples/1.8.x/console-web/examples/databases/list-documents.md index d9125be87..9c412c5b2 100644 --- a/examples/1.8.x/console-web/examples/databases/list-documents.md +++ b/examples/1.8.x/console-web/examples/databases/list-documents.md @@ -12,7 +12,8 @@ const result = await databases.listDocuments({ collectionId: '', queries: [], // optional transactionId: '', // optional - total: false // optional + total: false, // optional + ttl: 0 // optional }); console.log(result); diff --git a/examples/1.8.x/console-web/examples/domains/create-purchase.md b/examples/1.8.x/console-web/examples/domains/create-purchase.md index d6142c30f..ab33c5e81 100644 --- a/examples/1.8.x/console-web/examples/domains/create-purchase.md +++ b/examples/1.8.x/console-web/examples/domains/create-purchase.md @@ -9,7 +9,7 @@ const domains = new Domains(client); const result = await domains.createPurchase({ domain: '', - teamId: '', + organizationId: '', firstName: '', lastName: '', email: 'email@example.com', diff --git a/examples/1.8.x/console-web/examples/domains/create-transfer-in.md b/examples/1.8.x/console-web/examples/domains/create-transfer-in.md new file mode 100644 index 000000000..f26fa0c39 --- /dev/null +++ b/examples/1.8.x/console-web/examples/domains/create-transfer-in.md @@ -0,0 +1,18 @@ +```javascript +import { Client, Domains } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const domains = new Domains(client); + +const result = await domains.createTransferIn({ + domain: '', + organizationId: '', + authCode: '', + paymentMethodId: '' +}); + +console.log(result); +``` diff --git a/examples/1.8.x/console-web/examples/domains/create-transfer-out.md b/examples/1.8.x/console-web/examples/domains/create-transfer-out.md new file mode 100644 index 000000000..e8107b9f0 --- /dev/null +++ b/examples/1.8.x/console-web/examples/domains/create-transfer-out.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Domains } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const domains = new Domains(client); + +const result = await domains.createTransferOut({ + domainId: '', + organizationId: '' +}); + +console.log(result); +``` diff --git a/examples/1.8.x/console-web/examples/domains/get-transfer-status.md b/examples/1.8.x/console-web/examples/domains/get-transfer-status.md new file mode 100644 index 000000000..3305e05c5 --- /dev/null +++ b/examples/1.8.x/console-web/examples/domains/get-transfer-status.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Domains } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const domains = new Domains(client); + +const result = await domains.getTransferStatus({ + domainId: '' +}); + +console.log(result); +``` diff --git a/examples/1.8.x/console-web/examples/domains/update-purchase.md b/examples/1.8.x/console-web/examples/domains/update-purchase.md new file mode 100644 index 000000000..2f3b6bedf --- /dev/null +++ b/examples/1.8.x/console-web/examples/domains/update-purchase.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Domains } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const domains = new Domains(client); + +const result = await domains.updatePurchase({ + domainId: '', + organizationId: '' +}); + +console.log(result); +``` diff --git a/examples/1.8.x/console-web/examples/domains/update-transfer-in.md b/examples/1.8.x/console-web/examples/domains/update-transfer-in.md new file mode 100644 index 000000000..9dc3e260c --- /dev/null +++ b/examples/1.8.x/console-web/examples/domains/update-transfer-in.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Domains } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const domains = new Domains(client); + +const result = await domains.updateTransferIn({ + domainId: '', + organizationId: '' +}); + +console.log(result); +``` diff --git a/examples/1.8.x/console-web/examples/functions/create.md b/examples/1.8.x/console-web/examples/functions/create.md index c59d4e0e5..b45b0a1b1 100644 --- a/examples/1.8.x/console-web/examples/functions/create.md +++ b/examples/1.8.x/console-web/examples/functions/create.md @@ -25,7 +25,9 @@ const result = await functions.create({ providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional }); console.log(result); diff --git a/examples/1.8.x/console-web/examples/functions/update.md b/examples/1.8.x/console-web/examples/functions/update.md index 986ff0f69..f6f90ed7d 100644 --- a/examples/1.8.x/console-web/examples/functions/update.md +++ b/examples/1.8.x/console-web/examples/functions/update.md @@ -25,7 +25,9 @@ const result = await functions.update({ providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional }); console.log(result); diff --git a/examples/1.8.x/console-web/examples/migrations/create-appwrite-migration.md b/examples/1.8.x/console-web/examples/migrations/create-appwrite-migration.md index 2f7c07f80..d0f61541a 100644 --- a/examples/1.8.x/console-web/examples/migrations/create-appwrite-migration.md +++ b/examples/1.8.x/console-web/examples/migrations/create-appwrite-migration.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Migrations, Resources } from "@appwrite.io/console"; +import { Client, Migrations, AppwriteMigrationResource } 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 migrations = new Migrations(client); const result = await migrations.createAppwriteMigration({ - resources: [Resources.User], + resources: [AppwriteMigrationResource.User], endpoint: 'https://example.com', projectId: '', apiKey: '' diff --git a/examples/1.8.x/console-web/examples/migrations/create-firebase-migration.md b/examples/1.8.x/console-web/examples/migrations/create-firebase-migration.md index 21c972170..775df5569 100644 --- a/examples/1.8.x/console-web/examples/migrations/create-firebase-migration.md +++ b/examples/1.8.x/console-web/examples/migrations/create-firebase-migration.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Migrations, Resources } from "@appwrite.io/console"; +import { Client, Migrations, FirebaseMigrationResource } 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 migrations = new Migrations(client); const result = await migrations.createFirebaseMigration({ - resources: [Resources.User], + resources: [FirebaseMigrationResource.User], serviceAccount: '' }); diff --git a/examples/1.8.x/console-web/examples/migrations/create-n-host-migration.md b/examples/1.8.x/console-web/examples/migrations/create-n-host-migration.md index a24f9f35f..cd17162ab 100644 --- a/examples/1.8.x/console-web/examples/migrations/create-n-host-migration.md +++ b/examples/1.8.x/console-web/examples/migrations/create-n-host-migration.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Migrations, Resources } from "@appwrite.io/console"; +import { Client, Migrations, NHostMigrationResource } 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 migrations = new Migrations(client); const result = await migrations.createNHostMigration({ - resources: [Resources.User], + resources: [NHostMigrationResource.User], subdomain: '', region: '', adminSecret: '', diff --git a/examples/1.8.x/console-web/examples/migrations/create-supabase-migration.md b/examples/1.8.x/console-web/examples/migrations/create-supabase-migration.md index 3344ac0e3..6463d3582 100644 --- a/examples/1.8.x/console-web/examples/migrations/create-supabase-migration.md +++ b/examples/1.8.x/console-web/examples/migrations/create-supabase-migration.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Migrations, Resources } from "@appwrite.io/console"; +import { Client, Migrations, SupabaseMigrationResource } 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 migrations = new Migrations(client); const result = await migrations.createSupabaseMigration({ - resources: [Resources.User], + resources: [SupabaseMigrationResource.User], endpoint: 'https://example.com', apiKey: '', databaseHost: '', diff --git a/examples/1.8.x/console-web/examples/migrations/get-appwrite-report.md b/examples/1.8.x/console-web/examples/migrations/get-appwrite-report.md index b8396f260..d5417c9f6 100644 --- a/examples/1.8.x/console-web/examples/migrations/get-appwrite-report.md +++ b/examples/1.8.x/console-web/examples/migrations/get-appwrite-report.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Migrations, Resources } from "@appwrite.io/console"; +import { Client, Migrations, AppwriteMigrationResource } 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 migrations = new Migrations(client); const result = await migrations.getAppwriteReport({ - resources: [Resources.User], + resources: [AppwriteMigrationResource.User], endpoint: 'https://example.com', projectID: '', key: '' diff --git a/examples/1.8.x/console-web/examples/migrations/get-firebase-report.md b/examples/1.8.x/console-web/examples/migrations/get-firebase-report.md index 2c652ce83..46b9d8597 100644 --- a/examples/1.8.x/console-web/examples/migrations/get-firebase-report.md +++ b/examples/1.8.x/console-web/examples/migrations/get-firebase-report.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Migrations, Resources } from "@appwrite.io/console"; +import { Client, Migrations, FirebaseMigrationResource } 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 migrations = new Migrations(client); const result = await migrations.getFirebaseReport({ - resources: [Resources.User], + resources: [FirebaseMigrationResource.User], serviceAccount: '' }); diff --git a/examples/1.8.x/console-web/examples/migrations/get-n-host-report.md b/examples/1.8.x/console-web/examples/migrations/get-n-host-report.md index 16c2626d6..4ed95ea92 100644 --- a/examples/1.8.x/console-web/examples/migrations/get-n-host-report.md +++ b/examples/1.8.x/console-web/examples/migrations/get-n-host-report.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Migrations, Resources } from "@appwrite.io/console"; +import { Client, Migrations, NHostMigrationResource } 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 migrations = new Migrations(client); const result = await migrations.getNHostReport({ - resources: [Resources.User], + resources: [NHostMigrationResource.User], subdomain: '', region: '', adminSecret: '', diff --git a/examples/1.8.x/console-web/examples/migrations/get-supabase-report.md b/examples/1.8.x/console-web/examples/migrations/get-supabase-report.md index 40f04a218..834dd6bbc 100644 --- a/examples/1.8.x/console-web/examples/migrations/get-supabase-report.md +++ b/examples/1.8.x/console-web/examples/migrations/get-supabase-report.md @@ -1,5 +1,5 @@ ```javascript -import { Client, Migrations, Resources } from "@appwrite.io/console"; +import { Client, Migrations, SupabaseMigrationResource } 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 migrations = new Migrations(client); const result = await migrations.getSupabaseReport({ - resources: [Resources.User], + resources: [SupabaseMigrationResource.User], endpoint: 'https://example.com', apiKey: '', databaseHost: '', diff --git a/examples/1.8.x/console-web/examples/sites/create-deployment.md b/examples/1.8.x/console-web/examples/sites/create-deployment.md index 0b9ea0cd3..ce2f439ed 100644 --- a/examples/1.8.x/console-web/examples/sites/create-deployment.md +++ b/examples/1.8.x/console-web/examples/sites/create-deployment.md @@ -10,10 +10,10 @@ const sites = new Sites(client); const result = await sites.createDeployment({ siteId: '', code: document.getElementById('uploader').files[0], - activate: false, installCommand: '', // optional buildCommand: '', // optional - outputDirectory: '' // optional + outputDirectory: '', // optional + activate: false // optional }); console.log(result); diff --git a/examples/1.8.x/console-web/examples/sites/create.md b/examples/1.8.x/console-web/examples/sites/create.md index 5a7e0d3bb..a86709e8b 100644 --- a/examples/1.8.x/console-web/examples/sites/create.md +++ b/examples/1.8.x/console-web/examples/sites/create.md @@ -17,6 +17,7 @@ const result = await sites.create({ timeout: 1, // optional installCommand: '', // optional buildCommand: '', // optional + startCommand: '', // optional outputDirectory: '', // optional adapter: Adapter.Static, // optional installationId: '', // optional @@ -25,7 +26,9 @@ const result = await sites.create({ providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional }); console.log(result); diff --git a/examples/1.8.x/console-web/examples/sites/update.md b/examples/1.8.x/console-web/examples/sites/update.md index d88613cf8..731ae4b9c 100644 --- a/examples/1.8.x/console-web/examples/sites/update.md +++ b/examples/1.8.x/console-web/examples/sites/update.md @@ -16,6 +16,7 @@ const result = await sites.update({ timeout: 1, // optional installCommand: '', // optional buildCommand: '', // optional + startCommand: '', // optional outputDirectory: '', // optional buildRuntime: BuildRuntime.Node145, // optional adapter: Adapter.Static, // optional @@ -25,7 +26,9 @@ const result = await sites.update({ providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional }); console.log(result); diff --git a/examples/1.8.x/console-web/examples/tablesdb/list-rows.md b/examples/1.8.x/console-web/examples/tablesdb/list-rows.md index 0ada5b3e8..95df1e02f 100644 --- a/examples/1.8.x/console-web/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/console-web/examples/tablesdb/list-rows.md @@ -12,7 +12,8 @@ const result = await tablesDB.listRows({ tableId: '', queries: [], // optional transactionId: '', // optional - total: false // optional + total: false, // optional + ttl: 0 // optional }); console.log(result); diff --git a/examples/1.8.x/console-web/examples/webhooks/create.md b/examples/1.8.x/console-web/examples/webhooks/create.md new file mode 100644 index 000000000..c4ad5f3a0 --- /dev/null +++ b/examples/1.8.x/console-web/examples/webhooks/create.md @@ -0,0 +1,22 @@ +```javascript +import { Client, Webhooks } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const webhooks = new Webhooks(client); + +const result = await webhooks.create({ + webhookId: '', + url: '', + name: '', + events: [], + enabled: false, // optional + security: false, // optional + httpUser: '', // optional + httpPass: '' // optional +}); + +console.log(result); +``` diff --git a/examples/1.8.x/console-web/examples/webhooks/delete.md b/examples/1.8.x/console-web/examples/webhooks/delete.md new file mode 100644 index 000000000..1ba3b99dc --- /dev/null +++ b/examples/1.8.x/console-web/examples/webhooks/delete.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Webhooks } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const webhooks = new Webhooks(client); + +const result = await webhooks.delete({ + webhookId: '' +}); + +console.log(result); +``` diff --git a/examples/1.8.x/console-web/examples/webhooks/get.md b/examples/1.8.x/console-web/examples/webhooks/get.md new file mode 100644 index 000000000..f8afc2f90 --- /dev/null +++ b/examples/1.8.x/console-web/examples/webhooks/get.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Webhooks } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const webhooks = new Webhooks(client); + +const result = await webhooks.get({ + webhookId: '' +}); + +console.log(result); +``` diff --git a/examples/1.8.x/console-web/examples/webhooks/list.md b/examples/1.8.x/console-web/examples/webhooks/list.md new file mode 100644 index 000000000..ebdd766ae --- /dev/null +++ b/examples/1.8.x/console-web/examples/webhooks/list.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Webhooks } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const webhooks = new Webhooks(client); + +const result = await webhooks.list({ + queries: [], // optional + total: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.8.x/console-web/examples/webhooks/update-signature.md b/examples/1.8.x/console-web/examples/webhooks/update-signature.md new file mode 100644 index 000000000..a472c3b8d --- /dev/null +++ b/examples/1.8.x/console-web/examples/webhooks/update-signature.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Webhooks } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const webhooks = new Webhooks(client); + +const result = await webhooks.updateSignature({ + webhookId: '' +}); + +console.log(result); +``` diff --git a/examples/1.8.x/console-web/examples/webhooks/update.md b/examples/1.8.x/console-web/examples/webhooks/update.md new file mode 100644 index 000000000..52cb3553b --- /dev/null +++ b/examples/1.8.x/console-web/examples/webhooks/update.md @@ -0,0 +1,22 @@ +```javascript +import { Client, Webhooks } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const webhooks = new Webhooks(client); + +const result = await webhooks.update({ + webhookId: '', + name: '', + url: '', + events: [], + enabled: false, // optional + security: false, // optional + httpUser: '', // optional + httpPass: '' // optional +}); + +console.log(result); +``` diff --git a/examples/1.8.x/server-dart/examples/databases/list-documents.md b/examples/1.8.x/server-dart/examples/databases/list-documents.md index ab4f90b63..5cb4a1231 100644 --- a/examples/1.8.x/server-dart/examples/databases/list-documents.md +++ b/examples/1.8.x/server-dart/examples/databases/list-documents.md @@ -14,5 +14,6 @@ DocumentList result = await databases.listDocuments( queries: [], // (optional) transactionId: '', // (optional) total: false, // (optional) + ttl: 0, // (optional) ); ``` diff --git a/examples/1.8.x/server-dart/examples/functions/create.md b/examples/1.8.x/server-dart/examples/functions/create.md index 7efe07f01..c960e9bdf 100644 --- a/examples/1.8.x/server-dart/examples/functions/create.md +++ b/examples/1.8.x/server-dart/examples/functions/create.md @@ -27,6 +27,8 @@ Func result = await functions.create( providerBranch: '', // (optional) providerSilentMode: false, // (optional) providerRootDirectory: '', // (optional) - specification: '', // (optional) + buildSpecification: '', // (optional) + runtimeSpecification: '', // (optional) + deploymentRetention: 0, // (optional) ); ``` diff --git a/examples/1.8.x/server-dart/examples/functions/update.md b/examples/1.8.x/server-dart/examples/functions/update.md index 3a23cd68f..bd99c93fc 100644 --- a/examples/1.8.x/server-dart/examples/functions/update.md +++ b/examples/1.8.x/server-dart/examples/functions/update.md @@ -27,6 +27,8 @@ Func result = await functions.update( providerBranch: '', // (optional) providerSilentMode: false, // (optional) providerRootDirectory: '', // (optional) - specification: '', // (optional) + buildSpecification: '', // (optional) + runtimeSpecification: '', // (optional) + deploymentRetention: 0, // (optional) ); ``` diff --git a/examples/1.8.x/server-dart/examples/sites/create-deployment.md b/examples/1.8.x/server-dart/examples/sites/create-deployment.md index ad506f99d..261c04fe9 100644 --- a/examples/1.8.x/server-dart/examples/sites/create-deployment.md +++ b/examples/1.8.x/server-dart/examples/sites/create-deployment.md @@ -12,9 +12,9 @@ Sites sites = Sites(client); Deployment result = await sites.createDeployment( siteId: '', code: InputFile(path: './path-to-files/image.jpg', filename: 'image.jpg'), - activate: false, installCommand: '', // (optional) buildCommand: '', // (optional) outputDirectory: '', // (optional) + activate: false, // (optional) ); ``` diff --git a/examples/1.8.x/server-dart/examples/sites/create.md b/examples/1.8.x/server-dart/examples/sites/create.md index 692255b0a..39cd36018 100644 --- a/examples/1.8.x/server-dart/examples/sites/create.md +++ b/examples/1.8.x/server-dart/examples/sites/create.md @@ -19,6 +19,7 @@ Site result = await sites.create( timeout: 1, // (optional) installCommand: '', // (optional) buildCommand: '', // (optional) + startCommand: '', // (optional) outputDirectory: '', // (optional) adapter: enums.Adapter.static, // (optional) installationId: '', // (optional) @@ -27,6 +28,8 @@ Site result = await sites.create( providerBranch: '', // (optional) providerSilentMode: false, // (optional) providerRootDirectory: '', // (optional) - specification: '', // (optional) + buildSpecification: '', // (optional) + runtimeSpecification: '', // (optional) + deploymentRetention: 0, // (optional) ); ``` diff --git a/examples/1.8.x/server-dart/examples/sites/update.md b/examples/1.8.x/server-dart/examples/sites/update.md index 8846b51bc..ba6036c5a 100644 --- a/examples/1.8.x/server-dart/examples/sites/update.md +++ b/examples/1.8.x/server-dart/examples/sites/update.md @@ -18,6 +18,7 @@ Site result = await sites.update( timeout: 1, // (optional) installCommand: '', // (optional) buildCommand: '', // (optional) + startCommand: '', // (optional) outputDirectory: '', // (optional) buildRuntime: enums.BuildRuntime.node145, // (optional) adapter: enums.Adapter.static, // (optional) @@ -27,6 +28,8 @@ Site result = await sites.update( providerBranch: '', // (optional) providerSilentMode: false, // (optional) providerRootDirectory: '', // (optional) - specification: '', // (optional) + buildSpecification: '', // (optional) + runtimeSpecification: '', // (optional) + deploymentRetention: 0, // (optional) ); ``` diff --git a/examples/1.8.x/server-dart/examples/tablesdb/list-rows.md b/examples/1.8.x/server-dart/examples/tablesdb/list-rows.md index c3a426c57..863e461ee 100644 --- a/examples/1.8.x/server-dart/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/server-dart/examples/tablesdb/list-rows.md @@ -14,5 +14,6 @@ RowList result = await tablesDB.listRows( queries: [], // (optional) transactionId: '', // (optional) total: false, // (optional) + ttl: 0, // (optional) ); ``` diff --git a/examples/1.8.x/server-dart/examples/webhooks/create.md b/examples/1.8.x/server-dart/examples/webhooks/create.md new file mode 100644 index 000000000..6e0ba71fb --- /dev/null +++ b/examples/1.8.x/server-dart/examples/webhooks/create.md @@ -0,0 +1,21 @@ +```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 + +Webhooks webhooks = Webhooks(client); + +Webhook result = await webhooks.create( + webhookId: '', + url: '', + name: '', + events: [], + enabled: false, // (optional) + security: false, // (optional) + httpUser: '', // (optional) + httpPass: '', // (optional) +); +``` diff --git a/examples/1.8.x/server-dart/examples/webhooks/delete.md b/examples/1.8.x/server-dart/examples/webhooks/delete.md new file mode 100644 index 000000000..5df49aa2c --- /dev/null +++ b/examples/1.8.x/server-dart/examples/webhooks/delete.md @@ -0,0 +1,14 @@ +```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 + +Webhooks webhooks = Webhooks(client); + +await webhooks.delete( + webhookId: '', +); +``` diff --git a/examples/1.8.x/server-dart/examples/webhooks/get.md b/examples/1.8.x/server-dart/examples/webhooks/get.md new file mode 100644 index 000000000..60defa832 --- /dev/null +++ b/examples/1.8.x/server-dart/examples/webhooks/get.md @@ -0,0 +1,14 @@ +```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 + +Webhooks webhooks = Webhooks(client); + +Webhook result = await webhooks.get( + webhookId: '', +); +``` diff --git a/examples/1.8.x/server-dart/examples/webhooks/list.md b/examples/1.8.x/server-dart/examples/webhooks/list.md new file mode 100644 index 000000000..ea2d91e9c --- /dev/null +++ b/examples/1.8.x/server-dart/examples/webhooks/list.md @@ -0,0 +1,15 @@ +```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 + +Webhooks webhooks = Webhooks(client); + +WebhookList result = await webhooks.list( + queries: [], // (optional) + total: false, // (optional) +); +``` diff --git a/examples/1.8.x/server-dart/examples/webhooks/update-signature.md b/examples/1.8.x/server-dart/examples/webhooks/update-signature.md new file mode 100644 index 000000000..a73a16450 --- /dev/null +++ b/examples/1.8.x/server-dart/examples/webhooks/update-signature.md @@ -0,0 +1,14 @@ +```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 + +Webhooks webhooks = Webhooks(client); + +Webhook result = await webhooks.updateSignature( + webhookId: '', +); +``` diff --git a/examples/1.8.x/server-dart/examples/webhooks/update.md b/examples/1.8.x/server-dart/examples/webhooks/update.md new file mode 100644 index 000000000..2bd231060 --- /dev/null +++ b/examples/1.8.x/server-dart/examples/webhooks/update.md @@ -0,0 +1,21 @@ +```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 + +Webhooks webhooks = Webhooks(client); + +Webhook result = await webhooks.update( + webhookId: '', + name: '', + url: '', + events: [], + enabled: false, // (optional) + security: false, // (optional) + httpUser: '', // (optional) + httpPass: '', // (optional) +); +``` diff --git a/examples/1.8.x/server-dotnet/examples/databases/list-documents.md b/examples/1.8.x/server-dotnet/examples/databases/list-documents.md index c5f69e3e1..cb2d2dbe7 100644 --- a/examples/1.8.x/server-dotnet/examples/databases/list-documents.md +++ b/examples/1.8.x/server-dotnet/examples/databases/list-documents.md @@ -15,5 +15,6 @@ DocumentList result = await databases.ListDocuments( collectionId: "", queries: new List(), // optional transactionId: "", // optional - total: false // optional + total: false, // optional + ttl: 0 // optional );``` diff --git a/examples/1.8.x/server-dotnet/examples/functions/create.md b/examples/1.8.x/server-dotnet/examples/functions/create.md index 5032fc38f..3a68fda79 100644 --- a/examples/1.8.x/server-dotnet/examples/functions/create.md +++ b/examples/1.8.x/server-dotnet/examples/functions/create.md @@ -29,5 +29,7 @@ Function result = await functions.Create( providerBranch: "", // optional providerSilentMode: false, // optional providerRootDirectory: "", // optional - specification: "" // optional + buildSpecification: "", // optional + runtimeSpecification: "", // optional + deploymentRetention: 0 // optional );``` diff --git a/examples/1.8.x/server-dotnet/examples/functions/update.md b/examples/1.8.x/server-dotnet/examples/functions/update.md index 4f9df255a..953417f80 100644 --- a/examples/1.8.x/server-dotnet/examples/functions/update.md +++ b/examples/1.8.x/server-dotnet/examples/functions/update.md @@ -29,5 +29,7 @@ Function result = await functions.Update( providerBranch: "", // optional providerSilentMode: false, // optional providerRootDirectory: "", // optional - specification: "" // optional + buildSpecification: "", // optional + runtimeSpecification: "", // optional + deploymentRetention: 0 // optional );``` diff --git a/examples/1.8.x/server-dotnet/examples/sites/create-deployment.md b/examples/1.8.x/server-dotnet/examples/sites/create-deployment.md index d9be1a1e2..692d7743e 100644 --- a/examples/1.8.x/server-dotnet/examples/sites/create-deployment.md +++ b/examples/1.8.x/server-dotnet/examples/sites/create-deployment.md @@ -13,8 +13,8 @@ Sites sites = new Sites(client); Deployment result = await sites.CreateDeployment( siteId: "", code: InputFile.FromPath("./path-to-files/image.jpg"), - activate: false, installCommand: "", // optional buildCommand: "", // optional - outputDirectory: "" // optional + outputDirectory: "", // optional + activate: false // optional );``` diff --git a/examples/1.8.x/server-dotnet/examples/sites/create.md b/examples/1.8.x/server-dotnet/examples/sites/create.md index ac31e244f..391a56c30 100644 --- a/examples/1.8.x/server-dotnet/examples/sites/create.md +++ b/examples/1.8.x/server-dotnet/examples/sites/create.md @@ -21,6 +21,7 @@ Site result = await sites.Create( timeout: 1, // optional installCommand: "", // optional buildCommand: "", // optional + startCommand: "", // optional outputDirectory: "", // optional adapter: Adapter.Static, // optional installationId: "", // optional @@ -29,5 +30,7 @@ Site result = await sites.Create( providerBranch: "", // optional providerSilentMode: false, // optional providerRootDirectory: "", // optional - specification: "" // optional + buildSpecification: "", // optional + runtimeSpecification: "", // optional + deploymentRetention: 0 // optional );``` diff --git a/examples/1.8.x/server-dotnet/examples/sites/update.md b/examples/1.8.x/server-dotnet/examples/sites/update.md index bd65e36db..69662fe05 100644 --- a/examples/1.8.x/server-dotnet/examples/sites/update.md +++ b/examples/1.8.x/server-dotnet/examples/sites/update.md @@ -20,6 +20,7 @@ Site result = await sites.Update( timeout: 1, // optional installCommand: "", // optional buildCommand: "", // optional + startCommand: "", // optional outputDirectory: "", // optional buildRuntime: BuildRuntime.Node145, // optional adapter: Adapter.Static, // optional @@ -29,5 +30,7 @@ Site result = await sites.Update( providerBranch: "", // optional providerSilentMode: false, // optional providerRootDirectory: "", // optional - specification: "" // optional + buildSpecification: "", // optional + runtimeSpecification: "", // optional + deploymentRetention: 0 // optional );``` diff --git a/examples/1.8.x/server-dotnet/examples/tablesdb/list-rows.md b/examples/1.8.x/server-dotnet/examples/tablesdb/list-rows.md index a0f582fc7..e9186378b 100644 --- a/examples/1.8.x/server-dotnet/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/server-dotnet/examples/tablesdb/list-rows.md @@ -15,5 +15,6 @@ RowList result = await tablesDB.ListRows( tableId: "", queries: new List(), // optional transactionId: "", // optional - total: false // optional + total: false, // optional + ttl: 0 // optional );``` diff --git a/examples/1.8.x/server-dotnet/examples/webhooks/create.md b/examples/1.8.x/server-dotnet/examples/webhooks/create.md new file mode 100644 index 000000000..53ccc0a33 --- /dev/null +++ b/examples/1.8.x/server-dotnet/examples/webhooks/create.md @@ -0,0 +1,22 @@ +```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 + +Webhooks webhooks = new Webhooks(client); + +Webhook result = await webhooks.Create( + webhookId: "", + url: "", + name: "", + events: new List(), + enabled: false, // optional + security: false, // optional + httpUser: "", // optional + httpPass: "" // optional +);``` diff --git a/examples/1.8.x/server-dotnet/examples/webhooks/delete.md b/examples/1.8.x/server-dotnet/examples/webhooks/delete.md new file mode 100644 index 000000000..a9aac880d --- /dev/null +++ b/examples/1.8.x/server-dotnet/examples/webhooks/delete.md @@ -0,0 +1,15 @@ +```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 + +Webhooks webhooks = new Webhooks(client); + +await webhooks.Delete( + webhookId: "" +);``` diff --git a/examples/1.8.x/server-dotnet/examples/webhooks/get.md b/examples/1.8.x/server-dotnet/examples/webhooks/get.md new file mode 100644 index 000000000..f9c6835a3 --- /dev/null +++ b/examples/1.8.x/server-dotnet/examples/webhooks/get.md @@ -0,0 +1,15 @@ +```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 + +Webhooks webhooks = new Webhooks(client); + +Webhook result = await webhooks.Get( + webhookId: "" +);``` diff --git a/examples/1.8.x/server-dotnet/examples/webhooks/list.md b/examples/1.8.x/server-dotnet/examples/webhooks/list.md new file mode 100644 index 000000000..94db7d625 --- /dev/null +++ b/examples/1.8.x/server-dotnet/examples/webhooks/list.md @@ -0,0 +1,16 @@ +```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 + +Webhooks webhooks = new Webhooks(client); + +WebhookList result = await webhooks.List( + queries: new List(), // optional + total: false // optional +);``` diff --git a/examples/1.8.x/server-dotnet/examples/webhooks/update-signature.md b/examples/1.8.x/server-dotnet/examples/webhooks/update-signature.md new file mode 100644 index 000000000..3e5d1531e --- /dev/null +++ b/examples/1.8.x/server-dotnet/examples/webhooks/update-signature.md @@ -0,0 +1,15 @@ +```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 + +Webhooks webhooks = new Webhooks(client); + +Webhook result = await webhooks.UpdateSignature( + webhookId: "" +);``` diff --git a/examples/1.8.x/server-dotnet/examples/webhooks/update.md b/examples/1.8.x/server-dotnet/examples/webhooks/update.md new file mode 100644 index 000000000..cce5da7c4 --- /dev/null +++ b/examples/1.8.x/server-dotnet/examples/webhooks/update.md @@ -0,0 +1,22 @@ +```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 + +Webhooks webhooks = new Webhooks(client); + +Webhook result = await webhooks.Update( + webhookId: "", + name: "", + url: "", + events: new List(), + enabled: false, // optional + security: false, // optional + httpUser: "", // optional + httpPass: "" // optional +);``` diff --git a/examples/1.8.x/server-go/examples/databases/list-documents.md b/examples/1.8.x/server-go/examples/databases/list-documents.md index ab86f086c..1c702d717 100644 --- a/examples/1.8.x/server-go/examples/databases/list-documents.md +++ b/examples/1.8.x/server-go/examples/databases/list-documents.md @@ -21,5 +21,6 @@ response, error := service.ListDocuments( databases.WithListDocumentsQueries([]interface{}{}), databases.WithListDocumentsTransactionId(""), databases.WithListDocumentsTotal(false), + databases.WithListDocumentsTtl(0), ) ``` diff --git a/examples/1.8.x/server-go/examples/functions/create.md b/examples/1.8.x/server-go/examples/functions/create.md index b75cbe834..673c84d47 100644 --- a/examples/1.8.x/server-go/examples/functions/create.md +++ b/examples/1.8.x/server-go/examples/functions/create.md @@ -33,6 +33,8 @@ response, error := service.Create( functions.WithCreateProviderBranch(""), functions.WithCreateProviderSilentMode(false), functions.WithCreateProviderRootDirectory(""), - functions.WithCreateSpecification(""), + functions.WithCreateBuildSpecification(""), + functions.WithCreateRuntimeSpecification(""), + functions.WithCreateDeploymentRetention(0), ) ``` diff --git a/examples/1.8.x/server-go/examples/functions/update.md b/examples/1.8.x/server-go/examples/functions/update.md index 2038abcc2..6f89a995e 100644 --- a/examples/1.8.x/server-go/examples/functions/update.md +++ b/examples/1.8.x/server-go/examples/functions/update.md @@ -33,6 +33,8 @@ response, error := service.Update( functions.WithUpdateProviderBranch(""), functions.WithUpdateProviderSilentMode(false), functions.WithUpdateProviderRootDirectory(""), - functions.WithUpdateSpecification(""), + functions.WithUpdateBuildSpecification(""), + functions.WithUpdateRuntimeSpecification(""), + functions.WithUpdateDeploymentRetention(0), ) ``` diff --git a/examples/1.8.x/server-go/examples/sites/create-deployment.md b/examples/1.8.x/server-go/examples/sites/create-deployment.md index ed2dfb70f..086b5f1fb 100644 --- a/examples/1.8.x/server-go/examples/sites/create-deployment.md +++ b/examples/1.8.x/server-go/examples/sites/create-deployment.md @@ -18,9 +18,9 @@ service := sites.New(client) response, error := service.CreateDeployment( "", file.NewInputFile("/path/to/file.png", "file.png"), - false, sites.WithCreateDeploymentInstallCommand(""), sites.WithCreateDeploymentBuildCommand(""), sites.WithCreateDeploymentOutputDirectory(""), + sites.WithCreateDeploymentActivate(false), ) ``` diff --git a/examples/1.8.x/server-go/examples/sites/create.md b/examples/1.8.x/server-go/examples/sites/create.md index a44a8d184..ba1610039 100644 --- a/examples/1.8.x/server-go/examples/sites/create.md +++ b/examples/1.8.x/server-go/examples/sites/create.md @@ -25,6 +25,7 @@ response, error := service.Create( sites.WithCreateTimeout(1), sites.WithCreateInstallCommand(""), sites.WithCreateBuildCommand(""), + sites.WithCreateStartCommand(""), sites.WithCreateOutputDirectory(""), sites.WithCreateAdapter("static"), sites.WithCreateInstallationId(""), @@ -33,6 +34,8 @@ response, error := service.Create( sites.WithCreateProviderBranch(""), sites.WithCreateProviderSilentMode(false), sites.WithCreateProviderRootDirectory(""), - sites.WithCreateSpecification(""), + sites.WithCreateBuildSpecification(""), + sites.WithCreateRuntimeSpecification(""), + sites.WithCreateDeploymentRetention(0), ) ``` diff --git a/examples/1.8.x/server-go/examples/sites/update.md b/examples/1.8.x/server-go/examples/sites/update.md index 0f322edb4..f20edc4e8 100644 --- a/examples/1.8.x/server-go/examples/sites/update.md +++ b/examples/1.8.x/server-go/examples/sites/update.md @@ -24,6 +24,7 @@ response, error := service.Update( sites.WithUpdateTimeout(1), sites.WithUpdateInstallCommand(""), sites.WithUpdateBuildCommand(""), + sites.WithUpdateStartCommand(""), sites.WithUpdateOutputDirectory(""), sites.WithUpdateBuildRuntime("node-14.5"), sites.WithUpdateAdapter("static"), @@ -33,6 +34,8 @@ response, error := service.Update( sites.WithUpdateProviderBranch(""), sites.WithUpdateProviderSilentMode(false), sites.WithUpdateProviderRootDirectory(""), - sites.WithUpdateSpecification(""), + sites.WithUpdateBuildSpecification(""), + sites.WithUpdateRuntimeSpecification(""), + sites.WithUpdateDeploymentRetention(0), ) ``` diff --git a/examples/1.8.x/server-go/examples/tablesdb/list-rows.md b/examples/1.8.x/server-go/examples/tablesdb/list-rows.md index b1977609c..49c382f99 100644 --- a/examples/1.8.x/server-go/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/server-go/examples/tablesdb/list-rows.md @@ -21,5 +21,6 @@ response, error := service.ListRows( tablesdb.WithListRowsQueries([]interface{}{}), tablesdb.WithListRowsTransactionId(""), tablesdb.WithListRowsTotal(false), + tablesdb.WithListRowsTtl(0), ) ``` diff --git a/examples/1.8.x/server-go/examples/webhooks/create.md b/examples/1.8.x/server-go/examples/webhooks/create.md new file mode 100644 index 000000000..14484c568 --- /dev/null +++ b/examples/1.8.x/server-go/examples/webhooks/create.md @@ -0,0 +1,28 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/client" + "github.com/appwrite/sdk-for-go/webhooks" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := webhooks.New(client) + +response, error := service.Create( + "", + "", + "", + []interface{}{}, + webhooks.WithCreateEnabled(false), + webhooks.WithCreateSecurity(false), + webhooks.WithCreateHttpUser(""), + webhooks.WithCreateHttpPass(""), +) +``` diff --git a/examples/1.8.x/server-go/examples/webhooks/delete.md b/examples/1.8.x/server-go/examples/webhooks/delete.md new file mode 100644 index 000000000..c193e7b17 --- /dev/null +++ b/examples/1.8.x/server-go/examples/webhooks/delete.md @@ -0,0 +1,21 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/client" + "github.com/appwrite/sdk-for-go/webhooks" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := webhooks.New(client) + +response, error := service.Delete( + "", +) +``` diff --git a/examples/1.8.x/server-go/examples/webhooks/get.md b/examples/1.8.x/server-go/examples/webhooks/get.md new file mode 100644 index 000000000..ce01f93ba --- /dev/null +++ b/examples/1.8.x/server-go/examples/webhooks/get.md @@ -0,0 +1,21 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/client" + "github.com/appwrite/sdk-for-go/webhooks" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := webhooks.New(client) + +response, error := service.Get( + "", +) +``` diff --git a/examples/1.8.x/server-go/examples/webhooks/list.md b/examples/1.8.x/server-go/examples/webhooks/list.md new file mode 100644 index 000000000..e2d4a8513 --- /dev/null +++ b/examples/1.8.x/server-go/examples/webhooks/list.md @@ -0,0 +1,22 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/client" + "github.com/appwrite/sdk-for-go/webhooks" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := webhooks.New(client) + +response, error := service.List( + webhooks.WithListQueries([]interface{}{}), + webhooks.WithListTotal(false), +) +``` diff --git a/examples/1.8.x/server-go/examples/webhooks/update-signature.md b/examples/1.8.x/server-go/examples/webhooks/update-signature.md new file mode 100644 index 000000000..0c73804fd --- /dev/null +++ b/examples/1.8.x/server-go/examples/webhooks/update-signature.md @@ -0,0 +1,21 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/client" + "github.com/appwrite/sdk-for-go/webhooks" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := webhooks.New(client) + +response, error := service.UpdateSignature( + "", +) +``` diff --git a/examples/1.8.x/server-go/examples/webhooks/update.md b/examples/1.8.x/server-go/examples/webhooks/update.md new file mode 100644 index 000000000..91f3f2e95 --- /dev/null +++ b/examples/1.8.x/server-go/examples/webhooks/update.md @@ -0,0 +1,28 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/client" + "github.com/appwrite/sdk-for-go/webhooks" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := webhooks.New(client) + +response, error := service.Update( + "", + "", + "", + []interface{}{}, + webhooks.WithUpdateEnabled(false), + webhooks.WithUpdateSecurity(false), + webhooks.WithUpdateHttpUser(""), + webhooks.WithUpdateHttpPass(""), +) +``` diff --git a/examples/1.8.x/server-graphql/examples/functions/create.md b/examples/1.8.x/server-graphql/examples/functions/create.md index 116810259..fa44b0753 100644 --- a/examples/1.8.x/server-graphql/examples/functions/create.md +++ b/examples/1.8.x/server-graphql/examples/functions/create.md @@ -18,7 +18,9 @@ mutation { providerBranch: "", providerSilentMode: false, providerRootDirectory: "", - specification: "" + buildSpecification: "", + runtimeSpecification: "", + deploymentRetention: 0 ) { _id _createdAt @@ -29,6 +31,7 @@ mutation { live logging runtime + deploymentRetention deploymentId deploymentCreatedAt latestDeploymentId @@ -56,7 +59,8 @@ mutation { providerBranch providerRootDirectory providerSilentMode - specification + buildSpecification + runtimeSpecification } } ``` diff --git a/examples/1.8.x/server-graphql/examples/functions/update-function-deployment.md b/examples/1.8.x/server-graphql/examples/functions/update-function-deployment.md index b401f73dd..5e85f1f97 100644 --- a/examples/1.8.x/server-graphql/examples/functions/update-function-deployment.md +++ b/examples/1.8.x/server-graphql/examples/functions/update-function-deployment.md @@ -13,6 +13,7 @@ mutation { live logging runtime + deploymentRetention deploymentId deploymentCreatedAt latestDeploymentId @@ -40,7 +41,8 @@ mutation { providerBranch providerRootDirectory providerSilentMode - specification + buildSpecification + runtimeSpecification } } ``` diff --git a/examples/1.8.x/server-graphql/examples/functions/update.md b/examples/1.8.x/server-graphql/examples/functions/update.md index 7ca5c1b09..8d20d37b5 100644 --- a/examples/1.8.x/server-graphql/examples/functions/update.md +++ b/examples/1.8.x/server-graphql/examples/functions/update.md @@ -18,7 +18,9 @@ mutation { providerBranch: "", providerSilentMode: false, providerRootDirectory: "", - specification: "" + buildSpecification: "", + runtimeSpecification: "", + deploymentRetention: 0 ) { _id _createdAt @@ -29,6 +31,7 @@ mutation { live logging runtime + deploymentRetention deploymentId deploymentCreatedAt latestDeploymentId @@ -56,7 +59,8 @@ mutation { providerBranch providerRootDirectory providerSilentMode - specification + buildSpecification + runtimeSpecification } } ``` diff --git a/examples/1.8.x/server-graphql/examples/sites/create-deployment.md b/examples/1.8.x/server-graphql/examples/sites/create-deployment.md index 70745d66f..a420da32c 100644 --- a/examples/1.8.x/server-graphql/examples/sites/create-deployment.md +++ b/examples/1.8.x/server-graphql/examples/sites/create-deployment.md @@ -10,7 +10,7 @@ Content-Length: *Length of your entity body in bytes* --cec8e8123c05ba25 Content-Disposition: form-data; name="operations" -{ "query": "mutation { sitesCreateDeployment(siteId: $siteId, code: $code, activate: $activate, installCommand: $installCommand, buildCommand: $buildCommand, outputDirectory: $outputDirectory) { id }" }, "variables": { "siteId": "", "code": null, "activate": false, "installCommand": "", "buildCommand": "", "outputDirectory": "" } } +{ "query": "mutation { sitesCreateDeployment(siteId: $siteId, code: $code, installCommand: $installCommand, buildCommand: $buildCommand, outputDirectory: $outputDirectory, activate: $activate) { id }" }, "variables": { "siteId": "", "code": null, "installCommand": "", "buildCommand": "", "outputDirectory": "", "activate": false } } --cec8e8123c05ba25 Content-Disposition: form-data; name="map" diff --git a/examples/1.8.x/server-graphql/examples/sites/create.md b/examples/1.8.x/server-graphql/examples/sites/create.md index ed9e17265..538aee812 100644 --- a/examples/1.8.x/server-graphql/examples/sites/create.md +++ b/examples/1.8.x/server-graphql/examples/sites/create.md @@ -10,6 +10,7 @@ mutation { timeout: 1, installCommand: "", buildCommand: "", + startCommand: "", outputDirectory: "", adapter: "static", installationId: "", @@ -18,7 +19,9 @@ mutation { providerBranch: "", providerSilentMode: false, providerRootDirectory: "", - specification: "" + buildSpecification: "", + runtimeSpecification: "", + deploymentRetention: 0 ) { _id _createdAt @@ -28,6 +31,7 @@ mutation { live logging framework + deploymentRetention deploymentId deploymentCreatedAt deploymentScreenshotLight @@ -48,13 +52,15 @@ mutation { timeout installCommand buildCommand + startCommand outputDirectory installationId providerRepositoryId providerBranch providerRootDirectory providerSilentMode - specification + buildSpecification + runtimeSpecification buildRuntime adapter fallbackFile diff --git a/examples/1.8.x/server-graphql/examples/sites/update-site-deployment.md b/examples/1.8.x/server-graphql/examples/sites/update-site-deployment.md index fb42f305b..e515a25e0 100644 --- a/examples/1.8.x/server-graphql/examples/sites/update-site-deployment.md +++ b/examples/1.8.x/server-graphql/examples/sites/update-site-deployment.md @@ -12,6 +12,7 @@ mutation { live logging framework + deploymentRetention deploymentId deploymentCreatedAt deploymentScreenshotLight @@ -32,13 +33,15 @@ mutation { timeout installCommand buildCommand + startCommand outputDirectory installationId providerRepositoryId providerBranch providerRootDirectory providerSilentMode - specification + buildSpecification + runtimeSpecification buildRuntime adapter fallbackFile diff --git a/examples/1.8.x/server-graphql/examples/sites/update.md b/examples/1.8.x/server-graphql/examples/sites/update.md index 18a99c8fa..e24bde40e 100644 --- a/examples/1.8.x/server-graphql/examples/sites/update.md +++ b/examples/1.8.x/server-graphql/examples/sites/update.md @@ -9,6 +9,7 @@ mutation { timeout: 1, installCommand: "", buildCommand: "", + startCommand: "", outputDirectory: "", buildRuntime: "node-14.5", adapter: "static", @@ -18,7 +19,9 @@ mutation { providerBranch: "", providerSilentMode: false, providerRootDirectory: "", - specification: "" + buildSpecification: "", + runtimeSpecification: "", + deploymentRetention: 0 ) { _id _createdAt @@ -28,6 +31,7 @@ mutation { live logging framework + deploymentRetention deploymentId deploymentCreatedAt deploymentScreenshotLight @@ -48,13 +52,15 @@ mutation { timeout installCommand buildCommand + startCommand outputDirectory installationId providerRepositoryId providerBranch providerRootDirectory providerSilentMode - specification + buildSpecification + runtimeSpecification buildRuntime adapter fallbackFile diff --git a/examples/1.8.x/server-graphql/examples/webhooks/create.md b/examples/1.8.x/server-graphql/examples/webhooks/create.md new file mode 100644 index 000000000..bbf9c14b6 --- /dev/null +++ b/examples/1.8.x/server-graphql/examples/webhooks/create.md @@ -0,0 +1,28 @@ +```graphql +mutation { + webhooksCreate( + webhookId: "", + url: "", + name: "", + events: [], + enabled: false, + security: false, + httpUser: "", + httpPass: "" + ) { + _id + _createdAt + _updatedAt + name + url + events + security + httpUser + httpPass + signatureKey + enabled + logs + attempts + } +} +``` diff --git a/examples/1.8.x/server-graphql/examples/webhooks/delete.md b/examples/1.8.x/server-graphql/examples/webhooks/delete.md new file mode 100644 index 000000000..2a6724843 --- /dev/null +++ b/examples/1.8.x/server-graphql/examples/webhooks/delete.md @@ -0,0 +1,9 @@ +```graphql +mutation { + webhooksDelete( + webhookId: "" + ) { + status + } +} +``` diff --git a/examples/1.8.x/server-graphql/examples/webhooks/get.md b/examples/1.8.x/server-graphql/examples/webhooks/get.md new file mode 100644 index 000000000..d7962b96e --- /dev/null +++ b/examples/1.8.x/server-graphql/examples/webhooks/get.md @@ -0,0 +1,2 @@ +```graphql +``` diff --git a/examples/1.8.x/server-graphql/examples/webhooks/list.md b/examples/1.8.x/server-graphql/examples/webhooks/list.md new file mode 100644 index 000000000..d7962b96e --- /dev/null +++ b/examples/1.8.x/server-graphql/examples/webhooks/list.md @@ -0,0 +1,2 @@ +```graphql +``` diff --git a/examples/1.8.x/server-graphql/examples/webhooks/update-signature.md b/examples/1.8.x/server-graphql/examples/webhooks/update-signature.md new file mode 100644 index 000000000..9d34b2b94 --- /dev/null +++ b/examples/1.8.x/server-graphql/examples/webhooks/update-signature.md @@ -0,0 +1,21 @@ +```graphql +mutation { + webhooksUpdateSignature( + webhookId: "" + ) { + _id + _createdAt + _updatedAt + name + url + events + security + httpUser + httpPass + signatureKey + enabled + logs + attempts + } +} +``` diff --git a/examples/1.8.x/server-graphql/examples/webhooks/update.md b/examples/1.8.x/server-graphql/examples/webhooks/update.md new file mode 100644 index 000000000..1977e0ecc --- /dev/null +++ b/examples/1.8.x/server-graphql/examples/webhooks/update.md @@ -0,0 +1,28 @@ +```graphql +mutation { + webhooksUpdate( + webhookId: "", + name: "", + url: "", + events: [], + enabled: false, + security: false, + httpUser: "", + httpPass: "" + ) { + _id + _createdAt + _updatedAt + name + url + events + security + httpUser + httpPass + signatureKey + enabled + logs + attempts + } +} +``` diff --git a/examples/1.8.x/server-kotlin/java/databases/list-documents.md b/examples/1.8.x/server-kotlin/java/databases/list-documents.md index 415d880ec..f961c7a18 100644 --- a/examples/1.8.x/server-kotlin/java/databases/list-documents.md +++ b/examples/1.8.x/server-kotlin/java/databases/list-documents.md @@ -16,6 +16,7 @@ databases.listDocuments( List.of(), // queries (optional) "", // transactionId (optional) false, // total (optional) + 0, // ttl (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.8.x/server-kotlin/java/functions/create.md b/examples/1.8.x/server-kotlin/java/functions/create.md index 47015f369..d423c66ba 100644 --- a/examples/1.8.x/server-kotlin/java/functions/create.md +++ b/examples/1.8.x/server-kotlin/java/functions/create.md @@ -30,7 +30,9 @@ functions.create( "", // providerBranch (optional) false, // providerSilentMode (optional) "", // providerRootDirectory (optional) - "", // specification (optional) + "", // buildSpecification (optional) + "", // runtimeSpecification (optional) + 0, // deploymentRetention (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.8.x/server-kotlin/java/functions/update.md b/examples/1.8.x/server-kotlin/java/functions/update.md index 7ab240200..5e7b5c890 100644 --- a/examples/1.8.x/server-kotlin/java/functions/update.md +++ b/examples/1.8.x/server-kotlin/java/functions/update.md @@ -30,7 +30,9 @@ functions.update( "", // providerBranch (optional) false, // providerSilentMode (optional) "", // providerRootDirectory (optional) - "", // specification (optional) + "", // buildSpecification (optional) + "", // runtimeSpecification (optional) + 0, // deploymentRetention (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.8.x/server-kotlin/java/sites/create-deployment.md b/examples/1.8.x/server-kotlin/java/sites/create-deployment.md index b0ab42691..1301c3415 100644 --- a/examples/1.8.x/server-kotlin/java/sites/create-deployment.md +++ b/examples/1.8.x/server-kotlin/java/sites/create-deployment.md @@ -14,10 +14,10 @@ Sites sites = new Sites(client); sites.createDeployment( "", // siteId InputFile.fromPath("file.png"), // code - false, // activate "", // installCommand (optional) "", // buildCommand (optional) "", // outputDirectory (optional) + false, // activate (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.8.x/server-kotlin/java/sites/create.md b/examples/1.8.x/server-kotlin/java/sites/create.md index 328b39521..1f1f8e3bd 100644 --- a/examples/1.8.x/server-kotlin/java/sites/create.md +++ b/examples/1.8.x/server-kotlin/java/sites/create.md @@ -23,6 +23,7 @@ sites.create( 1, // timeout (optional) "", // installCommand (optional) "", // buildCommand (optional) + "", // startCommand (optional) "", // outputDirectory (optional) Adapter.STATIC, // adapter (optional) "", // installationId (optional) @@ -31,7 +32,9 @@ sites.create( "", // providerBranch (optional) false, // providerSilentMode (optional) "", // providerRootDirectory (optional) - "", // specification (optional) + "", // buildSpecification (optional) + "", // runtimeSpecification (optional) + 0, // deploymentRetention (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.8.x/server-kotlin/java/sites/update.md b/examples/1.8.x/server-kotlin/java/sites/update.md index 6f34a38d0..5086605b3 100644 --- a/examples/1.8.x/server-kotlin/java/sites/update.md +++ b/examples/1.8.x/server-kotlin/java/sites/update.md @@ -22,6 +22,7 @@ sites.update( 1, // timeout (optional) "", // installCommand (optional) "", // buildCommand (optional) + "", // startCommand (optional) "", // outputDirectory (optional) BuildRuntime.NODE_14_5, // buildRuntime (optional) Adapter.STATIC, // adapter (optional) @@ -31,7 +32,9 @@ sites.update( "", // providerBranch (optional) false, // providerSilentMode (optional) "", // providerRootDirectory (optional) - "", // specification (optional) + "", // buildSpecification (optional) + "", // runtimeSpecification (optional) + 0, // deploymentRetention (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.8.x/server-kotlin/java/tablesdb/list-rows.md b/examples/1.8.x/server-kotlin/java/tablesdb/list-rows.md index dfaad7197..174b4255b 100644 --- a/examples/1.8.x/server-kotlin/java/tablesdb/list-rows.md +++ b/examples/1.8.x/server-kotlin/java/tablesdb/list-rows.md @@ -16,6 +16,7 @@ tablesDB.listRows( List.of(), // queries (optional) "", // transactionId (optional) false, // total (optional) + 0, // ttl (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.8.x/server-kotlin/java/webhooks/create.md b/examples/1.8.x/server-kotlin/java/webhooks/create.md new file mode 100644 index 000000000..22a856ef6 --- /dev/null +++ b/examples/1.8.x/server-kotlin/java/webhooks/create.md @@ -0,0 +1,32 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Webhooks; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Webhooks webhooks = new Webhooks(client); + +webhooks.create( + "", // webhookId + "", // url + "", // name + List.of(), // events + false, // enabled (optional) + false, // security (optional) + "", // httpUser (optional) + "", // httpPass (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.8.x/server-kotlin/java/webhooks/delete.md b/examples/1.8.x/server-kotlin/java/webhooks/delete.md new file mode 100644 index 000000000..21c530473 --- /dev/null +++ b/examples/1.8.x/server-kotlin/java/webhooks/delete.md @@ -0,0 +1,25 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Webhooks; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Webhooks webhooks = new Webhooks(client); + +webhooks.delete( + "", // webhookId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.8.x/server-kotlin/java/webhooks/get.md b/examples/1.8.x/server-kotlin/java/webhooks/get.md new file mode 100644 index 000000000..07ed7714e --- /dev/null +++ b/examples/1.8.x/server-kotlin/java/webhooks/get.md @@ -0,0 +1,25 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Webhooks; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Webhooks webhooks = new Webhooks(client); + +webhooks.get( + "", // webhookId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.8.x/server-kotlin/java/webhooks/list.md b/examples/1.8.x/server-kotlin/java/webhooks/list.md new file mode 100644 index 000000000..22e3d32d0 --- /dev/null +++ b/examples/1.8.x/server-kotlin/java/webhooks/list.md @@ -0,0 +1,26 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Webhooks; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Webhooks webhooks = new Webhooks(client); + +webhooks.list( + List.of(), // queries (optional) + false, // total (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.8.x/server-kotlin/java/webhooks/update-signature.md b/examples/1.8.x/server-kotlin/java/webhooks/update-signature.md new file mode 100644 index 000000000..2526dd5c3 --- /dev/null +++ b/examples/1.8.x/server-kotlin/java/webhooks/update-signature.md @@ -0,0 +1,25 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Webhooks; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Webhooks webhooks = new Webhooks(client); + +webhooks.updateSignature( + "", // webhookId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.8.x/server-kotlin/java/webhooks/update.md b/examples/1.8.x/server-kotlin/java/webhooks/update.md new file mode 100644 index 000000000..cb7cf9bfa --- /dev/null +++ b/examples/1.8.x/server-kotlin/java/webhooks/update.md @@ -0,0 +1,32 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Webhooks; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Webhooks webhooks = new Webhooks(client); + +webhooks.update( + "", // webhookId + "", // name + "", // url + List.of(), // events + false, // enabled (optional) + false, // security (optional) + "", // httpUser (optional) + "", // httpPass (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.8.x/server-kotlin/kotlin/databases/list-documents.md b/examples/1.8.x/server-kotlin/kotlin/databases/list-documents.md index ab55a24cf..26e60e6ff 100644 --- a/examples/1.8.x/server-kotlin/kotlin/databases/list-documents.md +++ b/examples/1.8.x/server-kotlin/kotlin/databases/list-documents.md @@ -15,6 +15,7 @@ val response = databases.listDocuments( collectionId = "", queries = listOf(), // optional transactionId = "", // optional - total = false // optional + total = false, // optional + ttl = 0 // optional ) ``` diff --git a/examples/1.8.x/server-kotlin/kotlin/functions/create.md b/examples/1.8.x/server-kotlin/kotlin/functions/create.md index 0ad7f9737..ce62e4037 100644 --- a/examples/1.8.x/server-kotlin/kotlin/functions/create.md +++ b/examples/1.8.x/server-kotlin/kotlin/functions/create.md @@ -30,6 +30,8 @@ val response = functions.create( providerBranch = "", // optional providerSilentMode = false, // optional providerRootDirectory = "", // optional - specification = "" // optional + buildSpecification = "", // optional + runtimeSpecification = "", // optional + deploymentRetention = 0 // optional ) ``` diff --git a/examples/1.8.x/server-kotlin/kotlin/functions/update.md b/examples/1.8.x/server-kotlin/kotlin/functions/update.md index c04a3c96b..a686091f8 100644 --- a/examples/1.8.x/server-kotlin/kotlin/functions/update.md +++ b/examples/1.8.x/server-kotlin/kotlin/functions/update.md @@ -30,6 +30,8 @@ val response = functions.update( providerBranch = "", // optional providerSilentMode = false, // optional providerRootDirectory = "", // optional - specification = "" // optional + buildSpecification = "", // optional + runtimeSpecification = "", // optional + deploymentRetention = 0 // optional ) ``` diff --git a/examples/1.8.x/server-kotlin/kotlin/sites/create-deployment.md b/examples/1.8.x/server-kotlin/kotlin/sites/create-deployment.md index 0c1027f69..f9691190f 100644 --- a/examples/1.8.x/server-kotlin/kotlin/sites/create-deployment.md +++ b/examples/1.8.x/server-kotlin/kotlin/sites/create-deployment.md @@ -14,9 +14,9 @@ val sites = Sites(client) val response = sites.createDeployment( siteId = "", code = InputFile.fromPath("file.png"), - activate = false, installCommand = "", // optional buildCommand = "", // optional - outputDirectory = "" // optional + outputDirectory = "", // optional + activate = false // optional ) ``` diff --git a/examples/1.8.x/server-kotlin/kotlin/sites/create.md b/examples/1.8.x/server-kotlin/kotlin/sites/create.md index a0a020568..9bc8982f5 100644 --- a/examples/1.8.x/server-kotlin/kotlin/sites/create.md +++ b/examples/1.8.x/server-kotlin/kotlin/sites/create.md @@ -23,6 +23,7 @@ val response = sites.create( timeout = 1, // optional installCommand = "", // optional buildCommand = "", // optional + startCommand = "", // optional outputDirectory = "", // optional adapter = Adapter.STATIC, // optional installationId = "", // optional @@ -31,6 +32,8 @@ val response = sites.create( providerBranch = "", // optional providerSilentMode = false, // optional providerRootDirectory = "", // optional - specification = "" // optional + buildSpecification = "", // optional + runtimeSpecification = "", // optional + deploymentRetention = 0 // optional ) ``` diff --git a/examples/1.8.x/server-kotlin/kotlin/sites/update.md b/examples/1.8.x/server-kotlin/kotlin/sites/update.md index e3b1ecb61..63ff5b0ff 100644 --- a/examples/1.8.x/server-kotlin/kotlin/sites/update.md +++ b/examples/1.8.x/server-kotlin/kotlin/sites/update.md @@ -22,6 +22,7 @@ val response = sites.update( timeout = 1, // optional installCommand = "", // optional buildCommand = "", // optional + startCommand = "", // optional outputDirectory = "", // optional buildRuntime = BuildRuntime.NODE_14_5, // optional adapter = Adapter.STATIC, // optional @@ -31,6 +32,8 @@ val response = sites.update( providerBranch = "", // optional providerSilentMode = false, // optional providerRootDirectory = "", // optional - specification = "" // optional + buildSpecification = "", // optional + runtimeSpecification = "", // optional + deploymentRetention = 0 // optional ) ``` diff --git a/examples/1.8.x/server-kotlin/kotlin/tablesdb/list-rows.md b/examples/1.8.x/server-kotlin/kotlin/tablesdb/list-rows.md index 1f50588b5..c8b518d5d 100644 --- a/examples/1.8.x/server-kotlin/kotlin/tablesdb/list-rows.md +++ b/examples/1.8.x/server-kotlin/kotlin/tablesdb/list-rows.md @@ -15,6 +15,7 @@ val response = tablesDB.listRows( tableId = "", queries = listOf(), // optional transactionId = "", // optional - total = false // optional + total = false, // optional + ttl = 0 // optional ) ``` diff --git a/examples/1.8.x/server-kotlin/kotlin/webhooks/create.md b/examples/1.8.x/server-kotlin/kotlin/webhooks/create.md new file mode 100644 index 000000000..d5eaedd75 --- /dev/null +++ b/examples/1.8.x/server-kotlin/kotlin/webhooks/create.md @@ -0,0 +1,23 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Webhooks + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val webhooks = Webhooks(client) + +val response = webhooks.create( + webhookId = "", + url = "", + name = "", + events = listOf(), + enabled = false, // optional + security = false, // optional + httpUser = "", // optional + httpPass = "" // optional +) +``` diff --git a/examples/1.8.x/server-kotlin/kotlin/webhooks/delete.md b/examples/1.8.x/server-kotlin/kotlin/webhooks/delete.md new file mode 100644 index 000000000..6f381c2b6 --- /dev/null +++ b/examples/1.8.x/server-kotlin/kotlin/webhooks/delete.md @@ -0,0 +1,16 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Webhooks + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val webhooks = Webhooks(client) + +val response = webhooks.delete( + webhookId = "" +) +``` diff --git a/examples/1.8.x/server-kotlin/kotlin/webhooks/get.md b/examples/1.8.x/server-kotlin/kotlin/webhooks/get.md new file mode 100644 index 000000000..1f82c0b2d --- /dev/null +++ b/examples/1.8.x/server-kotlin/kotlin/webhooks/get.md @@ -0,0 +1,16 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Webhooks + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val webhooks = Webhooks(client) + +val response = webhooks.get( + webhookId = "" +) +``` diff --git a/examples/1.8.x/server-kotlin/kotlin/webhooks/list.md b/examples/1.8.x/server-kotlin/kotlin/webhooks/list.md new file mode 100644 index 000000000..f3f9f23d7 --- /dev/null +++ b/examples/1.8.x/server-kotlin/kotlin/webhooks/list.md @@ -0,0 +1,17 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Webhooks + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val webhooks = Webhooks(client) + +val response = webhooks.list( + queries = listOf(), // optional + total = false // optional +) +``` diff --git a/examples/1.8.x/server-kotlin/kotlin/webhooks/update-signature.md b/examples/1.8.x/server-kotlin/kotlin/webhooks/update-signature.md new file mode 100644 index 000000000..d58f9effc --- /dev/null +++ b/examples/1.8.x/server-kotlin/kotlin/webhooks/update-signature.md @@ -0,0 +1,16 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Webhooks + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val webhooks = Webhooks(client) + +val response = webhooks.updateSignature( + webhookId = "" +) +``` diff --git a/examples/1.8.x/server-kotlin/kotlin/webhooks/update.md b/examples/1.8.x/server-kotlin/kotlin/webhooks/update.md new file mode 100644 index 000000000..06e7d31d7 --- /dev/null +++ b/examples/1.8.x/server-kotlin/kotlin/webhooks/update.md @@ -0,0 +1,23 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Webhooks + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val webhooks = Webhooks(client) + +val response = webhooks.update( + webhookId = "", + name = "", + url = "", + events = listOf(), + enabled = false, // optional + security = false, // optional + httpUser = "", // optional + httpPass = "" // optional +) +``` diff --git a/examples/1.8.x/server-nodejs/examples/databases/list-documents.md b/examples/1.8.x/server-nodejs/examples/databases/list-documents.md index be2b37036..11fcec2d7 100644 --- a/examples/1.8.x/server-nodejs/examples/databases/list-documents.md +++ b/examples/1.8.x/server-nodejs/examples/databases/list-documents.md @@ -13,6 +13,7 @@ const result = await databases.listDocuments({ collectionId: '', queries: [], // optional transactionId: '', // optional - total: false // optional + total: false, // optional + ttl: 0 // optional }); ``` diff --git a/examples/1.8.x/server-nodejs/examples/functions/create.md b/examples/1.8.x/server-nodejs/examples/functions/create.md index 292a0e40e..b0004d85f 100644 --- a/examples/1.8.x/server-nodejs/examples/functions/create.md +++ b/examples/1.8.x/server-nodejs/examples/functions/create.md @@ -26,6 +26,8 @@ const result = await functions.create({ providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional }); ``` diff --git a/examples/1.8.x/server-nodejs/examples/functions/update.md b/examples/1.8.x/server-nodejs/examples/functions/update.md index 459b5f373..915037fff 100644 --- a/examples/1.8.x/server-nodejs/examples/functions/update.md +++ b/examples/1.8.x/server-nodejs/examples/functions/update.md @@ -26,6 +26,8 @@ const result = await functions.update({ providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional }); ``` diff --git a/examples/1.8.x/server-nodejs/examples/sites/create-deployment.md b/examples/1.8.x/server-nodejs/examples/sites/create-deployment.md index 1fea6050a..2603dda9d 100644 --- a/examples/1.8.x/server-nodejs/examples/sites/create-deployment.md +++ b/examples/1.8.x/server-nodejs/examples/sites/create-deployment.md @@ -12,9 +12,9 @@ const sites = new sdk.Sites(client); const result = await sites.createDeployment({ siteId: '', code: InputFile.fromPath('/path/to/file', 'filename'), - activate: false, installCommand: '', // optional buildCommand: '', // optional - outputDirectory: '' // optional + outputDirectory: '', // optional + activate: false // optional }); ``` diff --git a/examples/1.8.x/server-nodejs/examples/sites/create.md b/examples/1.8.x/server-nodejs/examples/sites/create.md index fe5c26495..65e5c64cc 100644 --- a/examples/1.8.x/server-nodejs/examples/sites/create.md +++ b/examples/1.8.x/server-nodejs/examples/sites/create.md @@ -18,6 +18,7 @@ const result = await sites.create({ timeout: 1, // optional installCommand: '', // optional buildCommand: '', // optional + startCommand: '', // optional outputDirectory: '', // optional adapter: sdk.Adapter.Static, // optional installationId: '', // optional @@ -26,6 +27,8 @@ const result = await sites.create({ providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional }); ``` diff --git a/examples/1.8.x/server-nodejs/examples/sites/update.md b/examples/1.8.x/server-nodejs/examples/sites/update.md index 28f2e80f1..0411752f2 100644 --- a/examples/1.8.x/server-nodejs/examples/sites/update.md +++ b/examples/1.8.x/server-nodejs/examples/sites/update.md @@ -17,6 +17,7 @@ const result = await sites.update({ timeout: 1, // optional installCommand: '', // optional buildCommand: '', // optional + startCommand: '', // optional outputDirectory: '', // optional buildRuntime: sdk.BuildRuntime.Node145, // optional adapter: sdk.Adapter.Static, // optional @@ -26,6 +27,8 @@ const result = await sites.update({ providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional }); ``` diff --git a/examples/1.8.x/server-nodejs/examples/tablesdb/list-rows.md b/examples/1.8.x/server-nodejs/examples/tablesdb/list-rows.md index 1f6894b3e..2777730b0 100644 --- a/examples/1.8.x/server-nodejs/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/server-nodejs/examples/tablesdb/list-rows.md @@ -13,6 +13,7 @@ const result = await tablesDB.listRows({ tableId: '', queries: [], // optional transactionId: '', // optional - total: false // optional + total: false, // optional + ttl: 0 // optional }); ``` diff --git a/examples/1.8.x/server-nodejs/examples/webhooks/create.md b/examples/1.8.x/server-nodejs/examples/webhooks/create.md new file mode 100644 index 000000000..5641306fb --- /dev/null +++ b/examples/1.8.x/server-nodejs/examples/webhooks/create.md @@ -0,0 +1,21 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const webhooks = new sdk.Webhooks(client); + +const result = await webhooks.create({ + webhookId: '', + url: '', + name: '', + events: [], + enabled: false, // optional + security: false, // optional + httpUser: '', // optional + httpPass: '' // optional +}); +``` diff --git a/examples/1.8.x/server-nodejs/examples/webhooks/delete.md b/examples/1.8.x/server-nodejs/examples/webhooks/delete.md new file mode 100644 index 000000000..51639e226 --- /dev/null +++ b/examples/1.8.x/server-nodejs/examples/webhooks/delete.md @@ -0,0 +1,14 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const webhooks = new sdk.Webhooks(client); + +const result = await webhooks.delete({ + webhookId: '' +}); +``` diff --git a/examples/1.8.x/server-nodejs/examples/webhooks/get.md b/examples/1.8.x/server-nodejs/examples/webhooks/get.md new file mode 100644 index 000000000..07d1ecda4 --- /dev/null +++ b/examples/1.8.x/server-nodejs/examples/webhooks/get.md @@ -0,0 +1,14 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const webhooks = new sdk.Webhooks(client); + +const result = await webhooks.get({ + webhookId: '' +}); +``` diff --git a/examples/1.8.x/server-nodejs/examples/webhooks/list.md b/examples/1.8.x/server-nodejs/examples/webhooks/list.md new file mode 100644 index 000000000..f509df714 --- /dev/null +++ b/examples/1.8.x/server-nodejs/examples/webhooks/list.md @@ -0,0 +1,15 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const webhooks = new sdk.Webhooks(client); + +const result = await webhooks.list({ + queries: [], // optional + total: false // optional +}); +``` diff --git a/examples/1.8.x/server-nodejs/examples/webhooks/update-signature.md b/examples/1.8.x/server-nodejs/examples/webhooks/update-signature.md new file mode 100644 index 000000000..6257ba587 --- /dev/null +++ b/examples/1.8.x/server-nodejs/examples/webhooks/update-signature.md @@ -0,0 +1,14 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const webhooks = new sdk.Webhooks(client); + +const result = await webhooks.updateSignature({ + webhookId: '' +}); +``` diff --git a/examples/1.8.x/server-nodejs/examples/webhooks/update.md b/examples/1.8.x/server-nodejs/examples/webhooks/update.md new file mode 100644 index 000000000..acd6c9a37 --- /dev/null +++ b/examples/1.8.x/server-nodejs/examples/webhooks/update.md @@ -0,0 +1,21 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const webhooks = new sdk.Webhooks(client); + +const result = await webhooks.update({ + webhookId: '', + name: '', + url: '', + events: [], + enabled: false, // optional + security: false, // optional + httpUser: '', // optional + httpPass: '' // optional +}); +``` diff --git a/examples/1.8.x/server-php/examples/databases/list-documents.md b/examples/1.8.x/server-php/examples/databases/list-documents.md index 1ff269251..8e3185806 100644 --- a/examples/1.8.x/server-php/examples/databases/list-documents.md +++ b/examples/1.8.x/server-php/examples/databases/list-documents.md @@ -16,5 +16,6 @@ $result = $databases->listDocuments( collectionId: '', queries: [], // optional transactionId: '', // optional - total: false // optional + total: false, // optional + ttl: 0 // optional );``` diff --git a/examples/1.8.x/server-php/examples/functions/create.md b/examples/1.8.x/server-php/examples/functions/create.md index e921e9991..958a4aa10 100644 --- a/examples/1.8.x/server-php/examples/functions/create.md +++ b/examples/1.8.x/server-php/examples/functions/create.md @@ -31,5 +31,7 @@ $result = $functions->create( providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional );``` diff --git a/examples/1.8.x/server-php/examples/functions/update.md b/examples/1.8.x/server-php/examples/functions/update.md index f9bdac11c..56e66b57f 100644 --- a/examples/1.8.x/server-php/examples/functions/update.md +++ b/examples/1.8.x/server-php/examples/functions/update.md @@ -31,5 +31,7 @@ $result = $functions->update( providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional );``` diff --git a/examples/1.8.x/server-php/examples/sites/create-deployment.md b/examples/1.8.x/server-php/examples/sites/create-deployment.md index c890f118d..536300d56 100644 --- a/examples/1.8.x/server-php/examples/sites/create-deployment.md +++ b/examples/1.8.x/server-php/examples/sites/create-deployment.md @@ -15,8 +15,8 @@ $sites = new Sites($client); $result = $sites->createDeployment( siteId: '', code: InputFile::withPath('file.png'), - activate: false, installCommand: '', // optional buildCommand: '', // optional - outputDirectory: '' // optional + outputDirectory: '', // optional + activate: false // optional );``` diff --git a/examples/1.8.x/server-php/examples/sites/create.md b/examples/1.8.x/server-php/examples/sites/create.md index 9191261f9..866a89cb1 100644 --- a/examples/1.8.x/server-php/examples/sites/create.md +++ b/examples/1.8.x/server-php/examples/sites/create.md @@ -24,6 +24,7 @@ $result = $sites->create( timeout: 1, // optional installCommand: '', // optional buildCommand: '', // optional + startCommand: '', // optional outputDirectory: '', // optional adapter: Adapter::STATIC(), // optional installationId: '', // optional @@ -32,5 +33,7 @@ $result = $sites->create( providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional );``` diff --git a/examples/1.8.x/server-php/examples/sites/update.md b/examples/1.8.x/server-php/examples/sites/update.md index 42d24fb19..b2de5a274 100644 --- a/examples/1.8.x/server-php/examples/sites/update.md +++ b/examples/1.8.x/server-php/examples/sites/update.md @@ -23,6 +23,7 @@ $result = $sites->update( timeout: 1, // optional installCommand: '', // optional buildCommand: '', // optional + startCommand: '', // optional outputDirectory: '', // optional buildRuntime: BuildRuntime::NODE145(), // optional adapter: Adapter::STATIC(), // optional @@ -32,5 +33,7 @@ $result = $sites->update( providerBranch: '', // optional providerSilentMode: false, // optional providerRootDirectory: '', // optional - specification: '' // optional + buildSpecification: '', // optional + runtimeSpecification: '', // optional + deploymentRetention: 0 // optional );``` diff --git a/examples/1.8.x/server-php/examples/tablesdb/list-rows.md b/examples/1.8.x/server-php/examples/tablesdb/list-rows.md index 710c7919b..b70a75984 100644 --- a/examples/1.8.x/server-php/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/server-php/examples/tablesdb/list-rows.md @@ -16,5 +16,6 @@ $result = $tablesDB->listRows( tableId: '', queries: [], // optional transactionId: '', // optional - total: false // optional + total: false, // optional + ttl: 0 // optional );``` diff --git a/examples/1.8.x/server-php/examples/webhooks/create.md b/examples/1.8.x/server-php/examples/webhooks/create.md new file mode 100644 index 000000000..008a81674 --- /dev/null +++ b/examples/1.8.x/server-php/examples/webhooks/create.md @@ -0,0 +1,23 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$webhooks = new Webhooks($client); + +$result = $webhooks->create( + webhookId: '', + url: '', + name: '', + events: [], + enabled: false, // optional + security: false, // optional + httpUser: '', // optional + httpPass: '' // optional +);``` diff --git a/examples/1.8.x/server-php/examples/webhooks/delete.md b/examples/1.8.x/server-php/examples/webhooks/delete.md new file mode 100644 index 000000000..cab10635b --- /dev/null +++ b/examples/1.8.x/server-php/examples/webhooks/delete.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$webhooks = new Webhooks($client); + +$result = $webhooks->delete( + webhookId: '' +);``` diff --git a/examples/1.8.x/server-php/examples/webhooks/get.md b/examples/1.8.x/server-php/examples/webhooks/get.md new file mode 100644 index 000000000..c8acae751 --- /dev/null +++ b/examples/1.8.x/server-php/examples/webhooks/get.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$webhooks = new Webhooks($client); + +$result = $webhooks->get( + webhookId: '' +);``` diff --git a/examples/1.8.x/server-php/examples/webhooks/list.md b/examples/1.8.x/server-php/examples/webhooks/list.md new file mode 100644 index 000000000..7727c468e --- /dev/null +++ b/examples/1.8.x/server-php/examples/webhooks/list.md @@ -0,0 +1,17 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$webhooks = new Webhooks($client); + +$result = $webhooks->list( + queries: [], // optional + total: false // optional +);``` diff --git a/examples/1.8.x/server-php/examples/webhooks/update-signature.md b/examples/1.8.x/server-php/examples/webhooks/update-signature.md new file mode 100644 index 000000000..5101085f8 --- /dev/null +++ b/examples/1.8.x/server-php/examples/webhooks/update-signature.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$webhooks = new Webhooks($client); + +$result = $webhooks->updateSignature( + webhookId: '' +);``` diff --git a/examples/1.8.x/server-php/examples/webhooks/update.md b/examples/1.8.x/server-php/examples/webhooks/update.md new file mode 100644 index 000000000..b253b1fcc --- /dev/null +++ b/examples/1.8.x/server-php/examples/webhooks/update.md @@ -0,0 +1,23 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$webhooks = new Webhooks($client); + +$result = $webhooks->update( + webhookId: '', + name: '', + url: '', + events: [], + enabled: false, // optional + security: false, // optional + httpUser: '', // optional + httpPass: '' // optional +);``` diff --git a/examples/1.8.x/server-python/examples/account/create-anonymous-session.md b/examples/1.8.x/server-python/examples/account/create-anonymous-session.md index bf0aeab50..70a7dd343 100644 --- a/examples/1.8.x/server-python/examples/account/create-anonymous-session.md +++ b/examples/1.8.x/server-python/examples/account/create-anonymous-session.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Session client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_anonymous_session() +result: Session = account.create_anonymous_session() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-email-password-session.md b/examples/1.8.x/server-python/examples/account/create-email-password-session.md index 5849f0291..292074dba 100644 --- a/examples/1.8.x/server-python/examples/account/create-email-password-session.md +++ b/examples/1.8.x/server-python/examples/account/create-email-password-session.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Session client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_email_password_session( +result: Session = account.create_email_password_session( email = 'email@example.com', password = 'password' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-email-token.md b/examples/1.8.x/server-python/examples/account/create-email-token.md index 4c783225e..78c5ecaab 100644 --- a/examples/1.8.x/server-python/examples/account/create-email-token.md +++ b/examples/1.8.x/server-python/examples/account/create-email-token.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Token client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_email_token( +result: Token = account.create_email_token( user_id = '', email = 'email@example.com', phrase = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-email-verification.md b/examples/1.8.x/server-python/examples/account/create-email-verification.md index 87b1e5b76..d4d8fd866 100644 --- a/examples/1.8.x/server-python/examples/account/create-email-verification.md +++ b/examples/1.8.x/server-python/examples/account/create-email-verification.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Token client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_email_verification( +result: Token = account.create_email_verification( url = 'https://example.com' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-jwt.md b/examples/1.8.x/server-python/examples/account/create-jwt.md index d4c6d3550..a28c65fd9 100644 --- a/examples/1.8.x/server-python/examples/account/create-jwt.md +++ b/examples/1.8.x/server-python/examples/account/create-jwt.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Jwt client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_jwt( +result: Jwt = account.create_jwt( duration = 0 # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-magic-url-token.md b/examples/1.8.x/server-python/examples/account/create-magic-url-token.md index f3a1670f2..5ded01281 100644 --- a/examples/1.8.x/server-python/examples/account/create-magic-url-token.md +++ b/examples/1.8.x/server-python/examples/account/create-magic-url-token.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Token client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_magic_url_token( +result: Token = account.create_magic_url_token( user_id = '', email = 'email@example.com', url = 'https://example.com', # optional phrase = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-mfa-authenticator.md b/examples/1.8.x/server-python/examples/account/create-mfa-authenticator.md index 784d2afcc..468011b2e 100644 --- a/examples/1.8.x/server-python/examples/account/create-mfa-authenticator.md +++ b/examples/1.8.x/server-python/examples/account/create-mfa-authenticator.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import MfaType from appwrite.enums import AuthenticatorType client = Client() @@ -10,7 +11,9 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_mfa_authenticator( +result: MfaType = account.create_mfa_authenticator( type = AuthenticatorType.TOTP ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-mfa-challenge.md b/examples/1.8.x/server-python/examples/account/create-mfa-challenge.md index 712b7e2ba..f31797a45 100644 --- a/examples/1.8.x/server-python/examples/account/create-mfa-challenge.md +++ b/examples/1.8.x/server-python/examples/account/create-mfa-challenge.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import MfaChallenge from appwrite.enums import AuthenticationFactor client = Client() @@ -10,7 +11,9 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_mfa_challenge( +result: MfaChallenge = account.create_mfa_challenge( factor = AuthenticationFactor.EMAIL ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-mfa-recovery-codes.md b/examples/1.8.x/server-python/examples/account/create-mfa-recovery-codes.md index 2511cfb4b..b7a2c4dd5 100644 --- a/examples/1.8.x/server-python/examples/account/create-mfa-recovery-codes.md +++ b/examples/1.8.x/server-python/examples/account/create-mfa-recovery-codes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import MfaRecoveryCodes client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_mfa_recovery_codes() +result: MfaRecoveryCodes = account.create_mfa_recovery_codes() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-o-auth-2-token.md b/examples/1.8.x/server-python/examples/account/create-o-auth-2-token.md index 4ffa9ffbd..87f7de0f4 100644 --- a/examples/1.8.x/server-python/examples/account/create-o-auth-2-token.md +++ b/examples/1.8.x/server-python/examples/account/create-o-auth-2-token.md @@ -10,7 +10,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_o_auth2_token( +result: str = account.create_o_auth2_token( provider = OAuthProvider.AMAZON, success = 'https://example.com', # optional failure = 'https://example.com', # optional diff --git a/examples/1.8.x/server-python/examples/account/create-phone-token.md b/examples/1.8.x/server-python/examples/account/create-phone-token.md index c30cbf940..fb09d64ec 100644 --- a/examples/1.8.x/server-python/examples/account/create-phone-token.md +++ b/examples/1.8.x/server-python/examples/account/create-phone-token.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Token client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_phone_token( +result: Token = account.create_phone_token( user_id = '', phone = '+12065550100' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-phone-verification.md b/examples/1.8.x/server-python/examples/account/create-phone-verification.md index 50db6a948..35d058e2b 100644 --- a/examples/1.8.x/server-python/examples/account/create-phone-verification.md +++ b/examples/1.8.x/server-python/examples/account/create-phone-verification.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Token client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_phone_verification() +result: Token = account.create_phone_verification() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-recovery.md b/examples/1.8.x/server-python/examples/account/create-recovery.md index ecf596cac..ea63672fe 100644 --- a/examples/1.8.x/server-python/examples/account/create-recovery.md +++ b/examples/1.8.x/server-python/examples/account/create-recovery.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Token client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_recovery( +result: Token = account.create_recovery( email = 'email@example.com', url = 'https://example.com' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-session.md b/examples/1.8.x/server-python/examples/account/create-session.md index 27f07330a..b09cf7224 100644 --- a/examples/1.8.x/server-python/examples/account/create-session.md +++ b/examples/1.8.x/server-python/examples/account/create-session.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Session client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_session( +result: Session = account.create_session( user_id = '', secret = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create-verification.md b/examples/1.8.x/server-python/examples/account/create-verification.md index 3330c2339..c44a76936 100644 --- a/examples/1.8.x/server-python/examples/account/create-verification.md +++ b/examples/1.8.x/server-python/examples/account/create-verification.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Token client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_verification( +result: Token = account.create_verification( url = 'https://example.com' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/create.md b/examples/1.8.x/server-python/examples/account/create.md index 1781c2383..87c8fabaf 100644 --- a/examples/1.8.x/server-python/examples/account/create.md +++ b/examples/1.8.x/server-python/examples/account/create.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import User client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create( +result: User = account.create( user_id = '', email = 'email@example.com', password = '', name = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/get-mfa-recovery-codes.md b/examples/1.8.x/server-python/examples/account/get-mfa-recovery-codes.md index bec99a187..f236eb6ba 100644 --- a/examples/1.8.x/server-python/examples/account/get-mfa-recovery-codes.md +++ b/examples/1.8.x/server-python/examples/account/get-mfa-recovery-codes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import MfaRecoveryCodes client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.get_mfa_recovery_codes() +result: MfaRecoveryCodes = account.get_mfa_recovery_codes() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/get-prefs.md b/examples/1.8.x/server-python/examples/account/get-prefs.md index 35603f21d..db5861525 100644 --- a/examples/1.8.x/server-python/examples/account/get-prefs.md +++ b/examples/1.8.x/server-python/examples/account/get-prefs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Preferences client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.get_prefs() +result: Preferences = account.get_prefs() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/get-session.md b/examples/1.8.x/server-python/examples/account/get-session.md index f978dfcb3..9a247b2ae 100644 --- a/examples/1.8.x/server-python/examples/account/get-session.md +++ b/examples/1.8.x/server-python/examples/account/get-session.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Session client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.get_session( +result: Session = account.get_session( session_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/get.md b/examples/1.8.x/server-python/examples/account/get.md index 2ec458f37..c06fd6ba0 100644 --- a/examples/1.8.x/server-python/examples/account/get.md +++ b/examples/1.8.x/server-python/examples/account/get.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import User client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.get() +result: User = account.get() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/list-identities.md b/examples/1.8.x/server-python/examples/account/list-identities.md index 8ba862565..5b8496de0 100644 --- a/examples/1.8.x/server-python/examples/account/list-identities.md +++ b/examples/1.8.x/server-python/examples/account/list-identities.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import IdentityList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.list_identities( +result: IdentityList = account.list_identities( queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/list-logs.md b/examples/1.8.x/server-python/examples/account/list-logs.md index 8f4063845..3f0a3b553 100644 --- a/examples/1.8.x/server-python/examples/account/list-logs.md +++ b/examples/1.8.x/server-python/examples/account/list-logs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import LogList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.list_logs( +result: LogList = account.list_logs( queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/list-mfa-factors.md b/examples/1.8.x/server-python/examples/account/list-mfa-factors.md index 9558fa15a..411a3e9a1 100644 --- a/examples/1.8.x/server-python/examples/account/list-mfa-factors.md +++ b/examples/1.8.x/server-python/examples/account/list-mfa-factors.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import MfaFactors client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.list_mfa_factors() +result: MfaFactors = account.list_mfa_factors() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/list-sessions.md b/examples/1.8.x/server-python/examples/account/list-sessions.md index 8603dc9b1..d9df7a714 100644 --- a/examples/1.8.x/server-python/examples/account/list-sessions.md +++ b/examples/1.8.x/server-python/examples/account/list-sessions.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import SessionList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.list_sessions() +result: SessionList = account.list_sessions() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-email-verification.md b/examples/1.8.x/server-python/examples/account/update-email-verification.md index 51f0f4824..5415f7d92 100644 --- a/examples/1.8.x/server-python/examples/account/update-email-verification.md +++ b/examples/1.8.x/server-python/examples/account/update-email-verification.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Token client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_email_verification( +result: Token = account.update_email_verification( user_id = '', secret = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-email.md b/examples/1.8.x/server-python/examples/account/update-email.md index 4b9f530db..d559e026c 100644 --- a/examples/1.8.x/server-python/examples/account/update-email.md +++ b/examples/1.8.x/server-python/examples/account/update-email.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import User client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_email( +result: User = account.update_email( email = 'email@example.com', password = 'password' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-magic-url-session.md b/examples/1.8.x/server-python/examples/account/update-magic-url-session.md index 777c5d8e8..754bbcdff 100644 --- a/examples/1.8.x/server-python/examples/account/update-magic-url-session.md +++ b/examples/1.8.x/server-python/examples/account/update-magic-url-session.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Session client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_magic_url_session( +result: Session = account.update_magic_url_session( user_id = '', secret = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-mfa-authenticator.md b/examples/1.8.x/server-python/examples/account/update-mfa-authenticator.md index 9fc0f8e5e..e7040b0a2 100644 --- a/examples/1.8.x/server-python/examples/account/update-mfa-authenticator.md +++ b/examples/1.8.x/server-python/examples/account/update-mfa-authenticator.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import User from appwrite.enums import AuthenticatorType client = Client() @@ -10,8 +11,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_mfa_authenticator( +result: User = account.update_mfa_authenticator( type = AuthenticatorType.TOTP, otp = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-mfa-challenge.md b/examples/1.8.x/server-python/examples/account/update-mfa-challenge.md index 2da910b03..40d6382f2 100644 --- a/examples/1.8.x/server-python/examples/account/update-mfa-challenge.md +++ b/examples/1.8.x/server-python/examples/account/update-mfa-challenge.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Session client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_mfa_challenge( +result: Session = account.update_mfa_challenge( challenge_id = '', otp = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-mfa-recovery-codes.md b/examples/1.8.x/server-python/examples/account/update-mfa-recovery-codes.md index 2b74e1d07..38ff568d9 100644 --- a/examples/1.8.x/server-python/examples/account/update-mfa-recovery-codes.md +++ b/examples/1.8.x/server-python/examples/account/update-mfa-recovery-codes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import MfaRecoveryCodes client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_mfa_recovery_codes() +result: MfaRecoveryCodes = account.update_mfa_recovery_codes() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-mfa.md b/examples/1.8.x/server-python/examples/account/update-mfa.md index 43e4077ac..607cea791 100644 --- a/examples/1.8.x/server-python/examples/account/update-mfa.md +++ b/examples/1.8.x/server-python/examples/account/update-mfa.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import User client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_mfa( +result: User = account.update_mfa( mfa = False ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-name.md b/examples/1.8.x/server-python/examples/account/update-name.md index d5b5df36d..d16c8dd01 100644 --- a/examples/1.8.x/server-python/examples/account/update-name.md +++ b/examples/1.8.x/server-python/examples/account/update-name.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import User client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_name( +result: User = account.update_name( name = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-password.md b/examples/1.8.x/server-python/examples/account/update-password.md index aa09dbe21..dc504e2c3 100644 --- a/examples/1.8.x/server-python/examples/account/update-password.md +++ b/examples/1.8.x/server-python/examples/account/update-password.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import User client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_password( +result: User = account.update_password( password = '', old_password = 'password' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-phone-session.md b/examples/1.8.x/server-python/examples/account/update-phone-session.md index 7fd599a1d..300cadd8f 100644 --- a/examples/1.8.x/server-python/examples/account/update-phone-session.md +++ b/examples/1.8.x/server-python/examples/account/update-phone-session.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Session client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_phone_session( +result: Session = account.update_phone_session( user_id = '', secret = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-phone-verification.md b/examples/1.8.x/server-python/examples/account/update-phone-verification.md index 1fa74a8b1..9091264d3 100644 --- a/examples/1.8.x/server-python/examples/account/update-phone-verification.md +++ b/examples/1.8.x/server-python/examples/account/update-phone-verification.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Token client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_phone_verification( +result: Token = account.update_phone_verification( user_id = '', secret = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-phone.md b/examples/1.8.x/server-python/examples/account/update-phone.md index 212bb2dcd..6dcd811e3 100644 --- a/examples/1.8.x/server-python/examples/account/update-phone.md +++ b/examples/1.8.x/server-python/examples/account/update-phone.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import User client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_phone( +result: User = account.update_phone( phone = '+12065550100', password = 'password' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-prefs.md b/examples/1.8.x/server-python/examples/account/update-prefs.md index 0aa3fa906..1c6a0a518 100644 --- a/examples/1.8.x/server-python/examples/account/update-prefs.md +++ b/examples/1.8.x/server-python/examples/account/update-prefs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import User client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_prefs( +result: User = account.update_prefs( prefs = { "language": "en", "timezone": "UTC", "darkTheme": True } ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-recovery.md b/examples/1.8.x/server-python/examples/account/update-recovery.md index 8c14a3ab9..90ed3096c 100644 --- a/examples/1.8.x/server-python/examples/account/update-recovery.md +++ b/examples/1.8.x/server-python/examples/account/update-recovery.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Token client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_recovery( +result: Token = account.update_recovery( user_id = '', secret = '', password = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-session.md b/examples/1.8.x/server-python/examples/account/update-session.md index 2b3082dbf..6232e0b38 100644 --- a/examples/1.8.x/server-python/examples/account/update-session.md +++ b/examples/1.8.x/server-python/examples/account/update-session.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Session client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_session( +result: Session = account.update_session( session_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-status.md b/examples/1.8.x/server-python/examples/account/update-status.md index baf496174..d48014532 100644 --- a/examples/1.8.x/server-python/examples/account/update-status.md +++ b/examples/1.8.x/server-python/examples/account/update-status.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import User client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_status() +result: User = account.update_status() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/account/update-verification.md b/examples/1.8.x/server-python/examples/account/update-verification.md index 9e49718e0..5dffe6ad4 100644 --- a/examples/1.8.x/server-python/examples/account/update-verification.md +++ b/examples/1.8.x/server-python/examples/account/update-verification.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.account import Account +from appwrite.models import Token client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_verification( +result: Token = account.update_verification( user_id = '', secret = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/activities/get-event.md b/examples/1.8.x/server-python/examples/activities/get-event.md index 353d9d58d..12819034c 100644 --- a/examples/1.8.x/server-python/examples/activities/get-event.md +++ b/examples/1.8.x/server-python/examples/activities/get-event.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.activities import Activities +from appwrite.models import ActivityEvent client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key activities = Activities(client) -result = activities.get_event( +result: ActivityEvent = activities.get_event( event_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/activities/list-events.md b/examples/1.8.x/server-python/examples/activities/list-events.md index 2c7c92d2b..bbeb644bb 100644 --- a/examples/1.8.x/server-python/examples/activities/list-events.md +++ b/examples/1.8.x/server-python/examples/activities/list-events.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.activities import Activities +from appwrite.models import ActivityEventList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key activities = Activities(client) -result = activities.list_events( +result: ActivityEventList = activities.list_events( queries = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/avatars/get-browser.md b/examples/1.8.x/server-python/examples/avatars/get-browser.md index 4e5b7a1b6..3c950dbb8 100644 --- a/examples/1.8.x/server-python/examples/avatars/get-browser.md +++ b/examples/1.8.x/server-python/examples/avatars/get-browser.md @@ -10,7 +10,7 @@ client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_browser( +result: bytes = avatars.get_browser( code = Browser.AVANT_BROWSER, width = 0, # optional height = 0, # optional diff --git a/examples/1.8.x/server-python/examples/avatars/get-credit-card.md b/examples/1.8.x/server-python/examples/avatars/get-credit-card.md index 587291572..8ef04f635 100644 --- a/examples/1.8.x/server-python/examples/avatars/get-credit-card.md +++ b/examples/1.8.x/server-python/examples/avatars/get-credit-card.md @@ -10,7 +10,7 @@ client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_credit_card( +result: bytes = avatars.get_credit_card( code = CreditCard.AMERICAN_EXPRESS, width = 0, # optional height = 0, # optional diff --git a/examples/1.8.x/server-python/examples/avatars/get-favicon.md b/examples/1.8.x/server-python/examples/avatars/get-favicon.md index b201146c5..dd234eafc 100644 --- a/examples/1.8.x/server-python/examples/avatars/get-favicon.md +++ b/examples/1.8.x/server-python/examples/avatars/get-favicon.md @@ -9,7 +9,7 @@ client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_favicon( +result: bytes = avatars.get_favicon( url = 'https://example.com' ) ``` diff --git a/examples/1.8.x/server-python/examples/avatars/get-flag.md b/examples/1.8.x/server-python/examples/avatars/get-flag.md index 2bd0776a1..f97b20dd8 100644 --- a/examples/1.8.x/server-python/examples/avatars/get-flag.md +++ b/examples/1.8.x/server-python/examples/avatars/get-flag.md @@ -10,7 +10,7 @@ client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_flag( +result: bytes = avatars.get_flag( code = Flag.AFGHANISTAN, width = 0, # optional height = 0, # optional diff --git a/examples/1.8.x/server-python/examples/avatars/get-image.md b/examples/1.8.x/server-python/examples/avatars/get-image.md index fa013f1a6..9beea030e 100644 --- a/examples/1.8.x/server-python/examples/avatars/get-image.md +++ b/examples/1.8.x/server-python/examples/avatars/get-image.md @@ -9,7 +9,7 @@ client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_image( +result: bytes = avatars.get_image( url = 'https://example.com', width = 0, # optional height = 0 # optional diff --git a/examples/1.8.x/server-python/examples/avatars/get-initials.md b/examples/1.8.x/server-python/examples/avatars/get-initials.md index 2dff22a79..30a39a8ec 100644 --- a/examples/1.8.x/server-python/examples/avatars/get-initials.md +++ b/examples/1.8.x/server-python/examples/avatars/get-initials.md @@ -9,7 +9,7 @@ client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_initials( +result: bytes = avatars.get_initials( name = '', # optional width = 0, # optional height = 0, # optional diff --git a/examples/1.8.x/server-python/examples/avatars/get-qr.md b/examples/1.8.x/server-python/examples/avatars/get-qr.md index f3dbede1e..a7968e75c 100644 --- a/examples/1.8.x/server-python/examples/avatars/get-qr.md +++ b/examples/1.8.x/server-python/examples/avatars/get-qr.md @@ -9,7 +9,7 @@ client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_qr( +result: bytes = avatars.get_qr( text = '', size = 1, # optional margin = 0, # optional diff --git a/examples/1.8.x/server-python/examples/avatars/get-screenshot.md b/examples/1.8.x/server-python/examples/avatars/get-screenshot.md index 31587c319..608032799 100644 --- a/examples/1.8.x/server-python/examples/avatars/get-screenshot.md +++ b/examples/1.8.x/server-python/examples/avatars/get-screenshot.md @@ -13,7 +13,7 @@ client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_screenshot( +result: bytes = avatars.get_screenshot( url = 'https://example.com', headers = { "Authorization": "Bearer token123", diff --git a/examples/1.8.x/server-python/examples/backups/create-archive.md b/examples/1.8.x/server-python/examples/backups/create-archive.md index 5393fa313..77264469d 100644 --- a/examples/1.8.x/server-python/examples/backups/create-archive.md +++ b/examples/1.8.x/server-python/examples/backups/create-archive.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.backups import Backups +from appwrite.models import BackupArchive from appwrite.enums import BackupServices client = Client() @@ -10,8 +11,10 @@ client.set_key('') # Your secret API key backups = Backups(client) -result = backups.create_archive( +result: BackupArchive = backups.create_archive( services = [BackupServices.DATABASES], resource_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/backups/create-policy.md b/examples/1.8.x/server-python/examples/backups/create-policy.md index 74458b12f..bf24e87ad 100644 --- a/examples/1.8.x/server-python/examples/backups/create-policy.md +++ b/examples/1.8.x/server-python/examples/backups/create-policy.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.backups import Backups +from appwrite.models import BackupPolicy from appwrite.enums import BackupServices client = Client() @@ -10,7 +11,7 @@ client.set_key('') # Your secret API key backups = Backups(client) -result = backups.create_policy( +result: BackupPolicy = backups.create_policy( policy_id = '', services = [BackupServices.DATABASES], retention = 1, @@ -19,4 +20,6 @@ result = backups.create_policy( resource_id = '', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/backups/create-restoration.md b/examples/1.8.x/server-python/examples/backups/create-restoration.md index 31fb49a52..e2966caa1 100644 --- a/examples/1.8.x/server-python/examples/backups/create-restoration.md +++ b/examples/1.8.x/server-python/examples/backups/create-restoration.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.backups import Backups +from appwrite.models import BackupRestoration from appwrite.enums import BackupServices client = Client() @@ -10,10 +11,12 @@ client.set_key('') # Your secret API key backups = Backups(client) -result = backups.create_restoration( +result: BackupRestoration = backups.create_restoration( archive_id = '', services = [BackupServices.DATABASES], new_resource_id = '', # optional new_resource_name = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/backups/get-archive.md b/examples/1.8.x/server-python/examples/backups/get-archive.md index 3aa3e4ef6..60b9c646c 100644 --- a/examples/1.8.x/server-python/examples/backups/get-archive.md +++ b/examples/1.8.x/server-python/examples/backups/get-archive.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.backups import Backups +from appwrite.models import BackupArchive client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key backups = Backups(client) -result = backups.get_archive( +result: BackupArchive = backups.get_archive( archive_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/backups/get-policy.md b/examples/1.8.x/server-python/examples/backups/get-policy.md index 8ebea3aec..3fa673a8e 100644 --- a/examples/1.8.x/server-python/examples/backups/get-policy.md +++ b/examples/1.8.x/server-python/examples/backups/get-policy.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.backups import Backups +from appwrite.models import BackupPolicy client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key backups = Backups(client) -result = backups.get_policy( +result: BackupPolicy = backups.get_policy( policy_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/backups/get-restoration.md b/examples/1.8.x/server-python/examples/backups/get-restoration.md index 5e8d004c4..775f047b7 100644 --- a/examples/1.8.x/server-python/examples/backups/get-restoration.md +++ b/examples/1.8.x/server-python/examples/backups/get-restoration.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.backups import Backups +from appwrite.models import BackupRestoration client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key backups = Backups(client) -result = backups.get_restoration( +result: BackupRestoration = backups.get_restoration( restoration_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/backups/list-archives.md b/examples/1.8.x/server-python/examples/backups/list-archives.md index 8ec0409bb..3d1799234 100644 --- a/examples/1.8.x/server-python/examples/backups/list-archives.md +++ b/examples/1.8.x/server-python/examples/backups/list-archives.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.backups import Backups +from appwrite.models import BackupArchiveList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key backups = Backups(client) -result = backups.list_archives( +result: BackupArchiveList = backups.list_archives( queries = [] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/backups/list-policies.md b/examples/1.8.x/server-python/examples/backups/list-policies.md index 33bbe8c44..bcfb67348 100644 --- a/examples/1.8.x/server-python/examples/backups/list-policies.md +++ b/examples/1.8.x/server-python/examples/backups/list-policies.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.backups import Backups +from appwrite.models import BackupPolicyList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key backups = Backups(client) -result = backups.list_policies( +result: BackupPolicyList = backups.list_policies( queries = [] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/backups/list-restorations.md b/examples/1.8.x/server-python/examples/backups/list-restorations.md index f26d82859..c353a50e0 100644 --- a/examples/1.8.x/server-python/examples/backups/list-restorations.md +++ b/examples/1.8.x/server-python/examples/backups/list-restorations.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.backups import Backups +from appwrite.models import BackupRestorationList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key backups = Backups(client) -result = backups.list_restorations( +result: BackupRestorationList = backups.list_restorations( queries = [] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/backups/update-policy.md b/examples/1.8.x/server-python/examples/backups/update-policy.md index 99308d468..74fbdeb3d 100644 --- a/examples/1.8.x/server-python/examples/backups/update-policy.md +++ b/examples/1.8.x/server-python/examples/backups/update-policy.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.backups import Backups +from appwrite.models import BackupPolicy client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_key('') # Your secret API key backups = Backups(client) -result = backups.update_policy( +result: BackupPolicy = backups.update_policy( policy_id = '', name = '', # optional retention = 1, # optional schedule = '', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-boolean-attribute.md b/examples/1.8.x/server-python/examples/databases/create-boolean-attribute.md index aff126869..b18196d72 100644 --- a/examples/1.8.x/server-python/examples/databases/create-boolean-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-boolean-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeBoolean client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_boolean_attribute( +result: AttributeBoolean = databases.create_boolean_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.create_boolean_attribute( default = False, # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-collection.md b/examples/1.8.x/server-python/examples/databases/create-collection.md index f6244a066..7e9afa0f1 100644 --- a/examples/1.8.x/server-python/examples/databases/create-collection.md +++ b/examples/1.8.x/server-python/examples/databases/create-collection.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Collection from appwrite.permission import Permission from appwrite.role import Role @@ -11,7 +12,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_collection( +result: Collection = databases.create_collection( database_id = '', collection_id = '', name = '', @@ -21,4 +22,6 @@ result = databases.create_collection( attributes = [], # optional indexes = [] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-datetime-attribute.md b/examples/1.8.x/server-python/examples/databases/create-datetime-attribute.md index d4329bc23..c8dc6c239 100644 --- a/examples/1.8.x/server-python/examples/databases/create-datetime-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-datetime-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeDatetime client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_datetime_attribute( +result: AttributeDatetime = databases.create_datetime_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.create_datetime_attribute( default = '', # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-document.md b/examples/1.8.x/server-python/examples/databases/create-document.md index a08f15f88..26b003443 100644 --- a/examples/1.8.x/server-python/examples/databases/create-document.md +++ b/examples/1.8.x/server-python/examples/databases/create-document.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Document from appwrite.permission import Permission from appwrite.role import Role @@ -11,7 +12,7 @@ client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.create_document( +result: Document = databases.create_document( database_id = '', collection_id = '', document_id = '', @@ -25,4 +26,6 @@ result = databases.create_document( permissions = [Permission.read(Role.any())], # optional transaction_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-documents.md b/examples/1.8.x/server-python/examples/databases/create-documents.md index 5e739d970..a1df96a90 100644 --- a/examples/1.8.x/server-python/examples/databases/create-documents.md +++ b/examples/1.8.x/server-python/examples/databases/create-documents.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import DocumentList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_documents( +result: DocumentList = databases.create_documents( database_id = '', collection_id = '', documents = [], transaction_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-email-attribute.md b/examples/1.8.x/server-python/examples/databases/create-email-attribute.md index 07cf8f4af..8c37eff09 100644 --- a/examples/1.8.x/server-python/examples/databases/create-email-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-email-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeEmail client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_email_attribute( +result: AttributeEmail = databases.create_email_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.create_email_attribute( default = 'email@example.com', # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-enum-attribute.md b/examples/1.8.x/server-python/examples/databases/create-enum-attribute.md index 570e2a1bc..bc8a4ab74 100644 --- a/examples/1.8.x/server-python/examples/databases/create-enum-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-enum-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeEnum client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_enum_attribute( +result: AttributeEnum = databases.create_enum_attribute( database_id = '', collection_id = '', key = '', @@ -18,4 +19,6 @@ result = databases.create_enum_attribute( default = '', # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-float-attribute.md b/examples/1.8.x/server-python/examples/databases/create-float-attribute.md index 0ff954b18..204dbfdb6 100644 --- a/examples/1.8.x/server-python/examples/databases/create-float-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-float-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeFloat client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_float_attribute( +result: AttributeFloat = databases.create_float_attribute( database_id = '', collection_id = '', key = '', @@ -19,4 +20,6 @@ result = databases.create_float_attribute( default = None, # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-index.md b/examples/1.8.x/server-python/examples/databases/create-index.md index 8f61edee7..21cd229a5 100644 --- a/examples/1.8.x/server-python/examples/databases/create-index.md +++ b/examples/1.8.x/server-python/examples/databases/create-index.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Index from appwrite.enums import IndexType from appwrite.enums import OrderBy @@ -11,7 +12,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_index( +result: Index = databases.create_index( database_id = '', collection_id = '', key = '', @@ -20,4 +21,6 @@ result = databases.create_index( orders = [OrderBy.ASC], # optional lengths = [] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-integer-attribute.md b/examples/1.8.x/server-python/examples/databases/create-integer-attribute.md index 9760b8ca5..fe609ba4b 100644 --- a/examples/1.8.x/server-python/examples/databases/create-integer-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-integer-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeInteger client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_integer_attribute( +result: AttributeInteger = databases.create_integer_attribute( database_id = '', collection_id = '', key = '', @@ -19,4 +20,6 @@ result = databases.create_integer_attribute( default = None, # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-ip-attribute.md b/examples/1.8.x/server-python/examples/databases/create-ip-attribute.md index 24acfe054..c684df57f 100644 --- a/examples/1.8.x/server-python/examples/databases/create-ip-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-ip-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeIp client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_ip_attribute( +result: AttributeIp = databases.create_ip_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.create_ip_attribute( default = '', # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-line-attribute.md b/examples/1.8.x/server-python/examples/databases/create-line-attribute.md index 84dd47a3a..5a7827670 100644 --- a/examples/1.8.x/server-python/examples/databases/create-line-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-line-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeLine client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_line_attribute( +result: AttributeLine = databases.create_line_attribute( database_id = '', collection_id = '', key = '', required = False, default = [[1, 2], [3, 4], [5, 6]] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-longtext-attribute.md b/examples/1.8.x/server-python/examples/databases/create-longtext-attribute.md index 64d747d90..7659fadb1 100644 --- a/examples/1.8.x/server-python/examples/databases/create-longtext-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-longtext-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeLongtext client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_longtext_attribute( +result: AttributeLongtext = databases.create_longtext_attribute( database_id = '', collection_id = '', key = '', @@ -18,4 +19,6 @@ result = databases.create_longtext_attribute( array = False, # optional encrypt = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-python/examples/databases/create-mediumtext-attribute.md index 84cb1f8a1..f7381b2a6 100644 --- a/examples/1.8.x/server-python/examples/databases/create-mediumtext-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-mediumtext-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeMediumtext client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_mediumtext_attribute( +result: AttributeMediumtext = databases.create_mediumtext_attribute( database_id = '', collection_id = '', key = '', @@ -18,4 +19,6 @@ result = databases.create_mediumtext_attribute( array = False, # optional encrypt = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-operations.md b/examples/1.8.x/server-python/examples/databases/create-operations.md index 9b3967dc1..ce412c3b6 100644 --- a/examples/1.8.x/server-python/examples/databases/create-operations.md +++ b/examples/1.8.x/server-python/examples/databases/create-operations.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Transaction client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_operations( +result: Transaction = databases.create_operations( transaction_id = '', operations = [ { @@ -23,4 +24,6 @@ result = databases.create_operations( } ] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-point-attribute.md b/examples/1.8.x/server-python/examples/databases/create-point-attribute.md index c6886a8f8..8b8c8d1af 100644 --- a/examples/1.8.x/server-python/examples/databases/create-point-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-point-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributePoint client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_point_attribute( +result: AttributePoint = databases.create_point_attribute( database_id = '', collection_id = '', key = '', required = False, default = [1, 2] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-polygon-attribute.md b/examples/1.8.x/server-python/examples/databases/create-polygon-attribute.md index 79dd0f054..defb0e943 100644 --- a/examples/1.8.x/server-python/examples/databases/create-polygon-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-polygon-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributePolygon client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_polygon_attribute( +result: AttributePolygon = databases.create_polygon_attribute( database_id = '', collection_id = '', key = '', required = False, default = [[[1, 2], [3, 4], [5, 6], [1, 2]]] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-relationship-attribute.md b/examples/1.8.x/server-python/examples/databases/create-relationship-attribute.md index 298386daa..b4300dd2d 100644 --- a/examples/1.8.x/server-python/examples/databases/create-relationship-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-relationship-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeRelationship from appwrite.enums import RelationshipType from appwrite.enums import RelationMutate @@ -11,7 +12,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_relationship_attribute( +result: AttributeRelationship = databases.create_relationship_attribute( database_id = '', collection_id = '', related_collection_id = '', @@ -21,4 +22,6 @@ result = databases.create_relationship_attribute( two_way_key = '', # optional on_delete = RelationMutate.CASCADE # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-string-attribute.md b/examples/1.8.x/server-python/examples/databases/create-string-attribute.md index f23aff8bf..9d1383d64 100644 --- a/examples/1.8.x/server-python/examples/databases/create-string-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-string-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeString client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_string_attribute( +result: AttributeString = databases.create_string_attribute( database_id = '', collection_id = '', key = '', @@ -19,4 +20,6 @@ result = databases.create_string_attribute( array = False, # optional encrypt = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-text-attribute.md b/examples/1.8.x/server-python/examples/databases/create-text-attribute.md index 7f60cf767..89f29e2ba 100644 --- a/examples/1.8.x/server-python/examples/databases/create-text-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-text-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeText client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_text_attribute( +result: AttributeText = databases.create_text_attribute( database_id = '', collection_id = '', key = '', @@ -18,4 +19,6 @@ result = databases.create_text_attribute( array = False, # optional encrypt = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-transaction.md b/examples/1.8.x/server-python/examples/databases/create-transaction.md index d391e27ee..733b2cf3b 100644 --- a/examples/1.8.x/server-python/examples/databases/create-transaction.md +++ b/examples/1.8.x/server-python/examples/databases/create-transaction.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Transaction client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_transaction( +result: Transaction = databases.create_transaction( ttl = 60 # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-url-attribute.md b/examples/1.8.x/server-python/examples/databases/create-url-attribute.md index 6d7d98591..b6e773ac4 100644 --- a/examples/1.8.x/server-python/examples/databases/create-url-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-url-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeUrl client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_url_attribute( +result: AttributeUrl = databases.create_url_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.create_url_attribute( default = 'https://example.com', # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create-varchar-attribute.md b/examples/1.8.x/server-python/examples/databases/create-varchar-attribute.md index 224dacd99..964e2fc34 100644 --- a/examples/1.8.x/server-python/examples/databases/create-varchar-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/create-varchar-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeVarchar client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create_varchar_attribute( +result: AttributeVarchar = databases.create_varchar_attribute( database_id = '', collection_id = '', key = '', @@ -19,4 +20,6 @@ result = databases.create_varchar_attribute( array = False, # optional encrypt = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/create.md b/examples/1.8.x/server-python/examples/databases/create.md index 98bff01d8..68a5b3743 100644 --- a/examples/1.8.x/server-python/examples/databases/create.md +++ b/examples/1.8.x/server-python/examples/databases/create.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Database client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.create( +result: Database = databases.create( database_id = '', name = '', enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/decrement-document-attribute.md b/examples/1.8.x/server-python/examples/databases/decrement-document-attribute.md index df296d01c..c7bbfdd1e 100644 --- a/examples/1.8.x/server-python/examples/databases/decrement-document-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/decrement-document-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Document client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.decrement_document_attribute( +result: Document = databases.decrement_document_attribute( database_id = '', collection_id = '', document_id = '', @@ -18,4 +19,6 @@ result = databases.decrement_document_attribute( min = None, # optional transaction_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/delete-documents.md b/examples/1.8.x/server-python/examples/databases/delete-documents.md index b8185856d..d410bdefe 100644 --- a/examples/1.8.x/server-python/examples/databases/delete-documents.md +++ b/examples/1.8.x/server-python/examples/databases/delete-documents.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import DocumentList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.delete_documents( +result: DocumentList = databases.delete_documents( database_id = '', collection_id = '', queries = [], # optional transaction_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/get-attribute.md b/examples/1.8.x/server-python/examples/databases/get-attribute.md index 0eb99c071..d841226f3 100644 --- a/examples/1.8.x/server-python/examples/databases/get-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/get-attribute.md @@ -1,6 +1,17 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeBoolean +from appwrite.models import AttributeInteger +from appwrite.models import AttributeFloat +from appwrite.models import AttributeEmail +from appwrite.models import AttributeEnum +from appwrite.models import AttributeUrl +from appwrite.models import AttributeIp +from appwrite.models import AttributeDatetime +from appwrite.models import AttributeRelationship +from appwrite.models import AttributeString +from typing import Union client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +20,11 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.get_attribute( +result: Union[AttributeBoolean, AttributeInteger, AttributeFloat, AttributeEmail, AttributeEnum, AttributeUrl, AttributeIp, AttributeDatetime, AttributeRelationship, AttributeString] = databases.get_attribute( database_id = '', collection_id = '', key = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/get-collection.md b/examples/1.8.x/server-python/examples/databases/get-collection.md index f0085481c..6650f4ae8 100644 --- a/examples/1.8.x/server-python/examples/databases/get-collection.md +++ b/examples/1.8.x/server-python/examples/databases/get-collection.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Collection client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.get_collection( +result: Collection = databases.get_collection( database_id = '', collection_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/get-document.md b/examples/1.8.x/server-python/examples/databases/get-document.md index fb0ed4aca..c6d968ac1 100644 --- a/examples/1.8.x/server-python/examples/databases/get-document.md +++ b/examples/1.8.x/server-python/examples/databases/get-document.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Document client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.get_document( +result: Document = databases.get_document( database_id = '', collection_id = '', document_id = '', queries = [], # optional transaction_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/get-index.md b/examples/1.8.x/server-python/examples/databases/get-index.md index 7b5f67f7d..d76008ac5 100644 --- a/examples/1.8.x/server-python/examples/databases/get-index.md +++ b/examples/1.8.x/server-python/examples/databases/get-index.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Index client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.get_index( +result: Index = databases.get_index( database_id = '', collection_id = '', key = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/get-transaction.md b/examples/1.8.x/server-python/examples/databases/get-transaction.md index 4f9b4940f..3348baa83 100644 --- a/examples/1.8.x/server-python/examples/databases/get-transaction.md +++ b/examples/1.8.x/server-python/examples/databases/get-transaction.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Transaction client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.get_transaction( +result: Transaction = databases.get_transaction( transaction_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/get.md b/examples/1.8.x/server-python/examples/databases/get.md index c928b6b91..b2906c561 100644 --- a/examples/1.8.x/server-python/examples/databases/get.md +++ b/examples/1.8.x/server-python/examples/databases/get.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Database client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.get( +result: Database = databases.get( database_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/increment-document-attribute.md b/examples/1.8.x/server-python/examples/databases/increment-document-attribute.md index 667e92798..37fb12440 100644 --- a/examples/1.8.x/server-python/examples/databases/increment-document-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/increment-document-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Document client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.increment_document_attribute( +result: Document = databases.increment_document_attribute( database_id = '', collection_id = '', document_id = '', @@ -18,4 +19,6 @@ result = databases.increment_document_attribute( max = None, # optional transaction_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/list-attributes.md b/examples/1.8.x/server-python/examples/databases/list-attributes.md index c9cb51b7c..4fc25f41b 100644 --- a/examples/1.8.x/server-python/examples/databases/list-attributes.md +++ b/examples/1.8.x/server-python/examples/databases/list-attributes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.list_attributes( +result: AttributeList = databases.list_attributes( database_id = '', collection_id = '', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/list-collections.md b/examples/1.8.x/server-python/examples/databases/list-collections.md index f14e7970c..19e71456e 100644 --- a/examples/1.8.x/server-python/examples/databases/list-collections.md +++ b/examples/1.8.x/server-python/examples/databases/list-collections.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import CollectionList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.list_collections( +result: CollectionList = databases.list_collections( database_id = '', queries = [], # optional search = '', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/list-documents.md b/examples/1.8.x/server-python/examples/databases/list-documents.md index 11ce444c4..f085c7d30 100644 --- a/examples/1.8.x/server-python/examples/databases/list-documents.md +++ b/examples/1.8.x/server-python/examples/databases/list-documents.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import DocumentList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,14 @@ client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.list_documents( +result: DocumentList = databases.list_documents( database_id = '', collection_id = '', queries = [], # optional transaction_id = '', # optional - total = False # optional + total = False, # optional + ttl = 0 # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/list-indexes.md b/examples/1.8.x/server-python/examples/databases/list-indexes.md index 95dd617b5..7129c5a55 100644 --- a/examples/1.8.x/server-python/examples/databases/list-indexes.md +++ b/examples/1.8.x/server-python/examples/databases/list-indexes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import IndexList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.list_indexes( +result: IndexList = databases.list_indexes( database_id = '', collection_id = '', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/list-transactions.md b/examples/1.8.x/server-python/examples/databases/list-transactions.md index f549f1acb..bd0993144 100644 --- a/examples/1.8.x/server-python/examples/databases/list-transactions.md +++ b/examples/1.8.x/server-python/examples/databases/list-transactions.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import TransactionList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.list_transactions( +result: TransactionList = databases.list_transactions( queries = [] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/list.md b/examples/1.8.x/server-python/examples/databases/list.md index b3f4de8f5..7fb1acd22 100644 --- a/examples/1.8.x/server-python/examples/databases/list.md +++ b/examples/1.8.x/server-python/examples/databases/list.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import DatabaseList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.list( +result: DatabaseList = databases.list( queries = [], # optional search = '', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-boolean-attribute.md b/examples/1.8.x/server-python/examples/databases/update-boolean-attribute.md index b5ba34261..34ae961c5 100644 --- a/examples/1.8.x/server-python/examples/databases/update-boolean-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-boolean-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeBoolean client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_boolean_attribute( +result: AttributeBoolean = databases.update_boolean_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.update_boolean_attribute( default = False, new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-collection.md b/examples/1.8.x/server-python/examples/databases/update-collection.md index 3f9462fb3..cfb804074 100644 --- a/examples/1.8.x/server-python/examples/databases/update-collection.md +++ b/examples/1.8.x/server-python/examples/databases/update-collection.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Collection from appwrite.permission import Permission from appwrite.role import Role @@ -11,7 +12,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_collection( +result: Collection = databases.update_collection( database_id = '', collection_id = '', name = '', # optional @@ -19,4 +20,6 @@ result = databases.update_collection( document_security = False, # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-datetime-attribute.md b/examples/1.8.x/server-python/examples/databases/update-datetime-attribute.md index da080f2af..ca054b488 100644 --- a/examples/1.8.x/server-python/examples/databases/update-datetime-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-datetime-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeDatetime client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_datetime_attribute( +result: AttributeDatetime = databases.update_datetime_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.update_datetime_attribute( default = '', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-document.md b/examples/1.8.x/server-python/examples/databases/update-document.md index b10cd5a51..667d9b6e3 100644 --- a/examples/1.8.x/server-python/examples/databases/update-document.md +++ b/examples/1.8.x/server-python/examples/databases/update-document.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Document from appwrite.permission import Permission from appwrite.role import Role @@ -11,7 +12,7 @@ client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.update_document( +result: Document = databases.update_document( database_id = '', collection_id = '', document_id = '', @@ -25,4 +26,6 @@ result = databases.update_document( permissions = [Permission.read(Role.any())], # optional transaction_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-documents.md b/examples/1.8.x/server-python/examples/databases/update-documents.md index 6e0cd4fe7..edae26a45 100644 --- a/examples/1.8.x/server-python/examples/databases/update-documents.md +++ b/examples/1.8.x/server-python/examples/databases/update-documents.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import DocumentList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_documents( +result: DocumentList = databases.update_documents( database_id = '', collection_id = '', data = { @@ -22,4 +23,6 @@ result = databases.update_documents( queries = [], # optional transaction_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-email-attribute.md b/examples/1.8.x/server-python/examples/databases/update-email-attribute.md index fbafd983a..ac6bb1933 100644 --- a/examples/1.8.x/server-python/examples/databases/update-email-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-email-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeEmail client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_email_attribute( +result: AttributeEmail = databases.update_email_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.update_email_attribute( default = 'email@example.com', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-enum-attribute.md b/examples/1.8.x/server-python/examples/databases/update-enum-attribute.md index 0b9ab13b8..d7cf1fe9d 100644 --- a/examples/1.8.x/server-python/examples/databases/update-enum-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-enum-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeEnum client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_enum_attribute( +result: AttributeEnum = databases.update_enum_attribute( database_id = '', collection_id = '', key = '', @@ -18,4 +19,6 @@ result = databases.update_enum_attribute( default = '', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-float-attribute.md b/examples/1.8.x/server-python/examples/databases/update-float-attribute.md index 13bc920bd..c11825561 100644 --- a/examples/1.8.x/server-python/examples/databases/update-float-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-float-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeFloat client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_float_attribute( +result: AttributeFloat = databases.update_float_attribute( database_id = '', collection_id = '', key = '', @@ -19,4 +20,6 @@ result = databases.update_float_attribute( max = None, # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-integer-attribute.md b/examples/1.8.x/server-python/examples/databases/update-integer-attribute.md index 92ea39204..ddeebf4f1 100644 --- a/examples/1.8.x/server-python/examples/databases/update-integer-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-integer-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeInteger client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_integer_attribute( +result: AttributeInteger = databases.update_integer_attribute( database_id = '', collection_id = '', key = '', @@ -19,4 +20,6 @@ result = databases.update_integer_attribute( max = None, # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-ip-attribute.md b/examples/1.8.x/server-python/examples/databases/update-ip-attribute.md index 05e7d5fd1..11978eb0f 100644 --- a/examples/1.8.x/server-python/examples/databases/update-ip-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-ip-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeIp client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_ip_attribute( +result: AttributeIp = databases.update_ip_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.update_ip_attribute( default = '', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-line-attribute.md b/examples/1.8.x/server-python/examples/databases/update-line-attribute.md index b29b55fa6..ba8237635 100644 --- a/examples/1.8.x/server-python/examples/databases/update-line-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-line-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeLine client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_line_attribute( +result: AttributeLine = databases.update_line_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.update_line_attribute( default = [[1, 2], [3, 4], [5, 6]], # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-longtext-attribute.md b/examples/1.8.x/server-python/examples/databases/update-longtext-attribute.md index 71649fef4..ec7050e7d 100644 --- a/examples/1.8.x/server-python/examples/databases/update-longtext-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-longtext-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeLongtext client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_longtext_attribute( +result: AttributeLongtext = databases.update_longtext_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.update_longtext_attribute( default = '', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-python/examples/databases/update-mediumtext-attribute.md index 756c95b7d..1036a808a 100644 --- a/examples/1.8.x/server-python/examples/databases/update-mediumtext-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-mediumtext-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeMediumtext client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_mediumtext_attribute( +result: AttributeMediumtext = databases.update_mediumtext_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.update_mediumtext_attribute( default = '', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-point-attribute.md b/examples/1.8.x/server-python/examples/databases/update-point-attribute.md index cd6ee1763..9095bdf66 100644 --- a/examples/1.8.x/server-python/examples/databases/update-point-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-point-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributePoint client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_point_attribute( +result: AttributePoint = databases.update_point_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.update_point_attribute( default = [1, 2], # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-polygon-attribute.md b/examples/1.8.x/server-python/examples/databases/update-polygon-attribute.md index fa5fc6807..dffcaa579 100644 --- a/examples/1.8.x/server-python/examples/databases/update-polygon-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-polygon-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributePolygon client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_polygon_attribute( +result: AttributePolygon = databases.update_polygon_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.update_polygon_attribute( default = [[[1, 2], [3, 4], [5, 6], [1, 2]]], # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-relationship-attribute.md b/examples/1.8.x/server-python/examples/databases/update-relationship-attribute.md index 62c8d4a6b..226e8b0a7 100644 --- a/examples/1.8.x/server-python/examples/databases/update-relationship-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-relationship-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeRelationship from appwrite.enums import RelationMutate client = Client() @@ -10,11 +11,13 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_relationship_attribute( +result: AttributeRelationship = databases.update_relationship_attribute( database_id = '', collection_id = '', key = '', on_delete = RelationMutate.CASCADE, # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-string-attribute.md b/examples/1.8.x/server-python/examples/databases/update-string-attribute.md index e97d132e5..897a3134c 100644 --- a/examples/1.8.x/server-python/examples/databases/update-string-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-string-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeString client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_string_attribute( +result: AttributeString = databases.update_string_attribute( database_id = '', collection_id = '', key = '', @@ -18,4 +19,6 @@ result = databases.update_string_attribute( size = 1, # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-text-attribute.md b/examples/1.8.x/server-python/examples/databases/update-text-attribute.md index b7c553d8d..02b5fd35e 100644 --- a/examples/1.8.x/server-python/examples/databases/update-text-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-text-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeText client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_text_attribute( +result: AttributeText = databases.update_text_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.update_text_attribute( default = '', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-transaction.md b/examples/1.8.x/server-python/examples/databases/update-transaction.md index 8ccb74639..937a227e6 100644 --- a/examples/1.8.x/server-python/examples/databases/update-transaction.md +++ b/examples/1.8.x/server-python/examples/databases/update-transaction.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Transaction client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_transaction( +result: Transaction = databases.update_transaction( transaction_id = '', commit = False, # optional rollback = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-url-attribute.md b/examples/1.8.x/server-python/examples/databases/update-url-attribute.md index 56e2c1c73..d57477082 100644 --- a/examples/1.8.x/server-python/examples/databases/update-url-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-url-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeUrl client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_url_attribute( +result: AttributeUrl = databases.update_url_attribute( database_id = '', collection_id = '', key = '', @@ -17,4 +18,6 @@ result = databases.update_url_attribute( default = 'https://example.com', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update-varchar-attribute.md b/examples/1.8.x/server-python/examples/databases/update-varchar-attribute.md index 3504e8db5..f3079e160 100644 --- a/examples/1.8.x/server-python/examples/databases/update-varchar-attribute.md +++ b/examples/1.8.x/server-python/examples/databases/update-varchar-attribute.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import AttributeVarchar client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update_varchar_attribute( +result: AttributeVarchar = databases.update_varchar_attribute( database_id = '', collection_id = '', key = '', @@ -18,4 +19,6 @@ result = databases.update_varchar_attribute( size = 1, # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/update.md b/examples/1.8.x/server-python/examples/databases/update.md index 864a8970c..73458d4f2 100644 --- a/examples/1.8.x/server-python/examples/databases/update.md +++ b/examples/1.8.x/server-python/examples/databases/update.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Database client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.update( +result: Database = databases.update( database_id = '', name = '', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/upsert-document.md b/examples/1.8.x/server-python/examples/databases/upsert-document.md index bc097e98f..b18eb794d 100644 --- a/examples/1.8.x/server-python/examples/databases/upsert-document.md +++ b/examples/1.8.x/server-python/examples/databases/upsert-document.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import Document from appwrite.permission import Permission from appwrite.role import Role @@ -11,7 +12,7 @@ client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.upsert_document( +result: Document = databases.upsert_document( database_id = '', collection_id = '', document_id = '', @@ -25,4 +26,6 @@ result = databases.upsert_document( permissions = [Permission.read(Role.any())], # optional transaction_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/databases/upsert-documents.md b/examples/1.8.x/server-python/examples/databases/upsert-documents.md index ca091c4ed..5039ccb0a 100644 --- a/examples/1.8.x/server-python/examples/databases/upsert-documents.md +++ b/examples/1.8.x/server-python/examples/databases/upsert-documents.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.databases import Databases +from appwrite.models import DocumentList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('') # Your secret API key databases = Databases(client) -result = databases.upsert_documents( +result: DocumentList = databases.upsert_documents( database_id = '', collection_id = '', documents = [], transaction_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/create-deployment.md b/examples/1.8.x/server-python/examples/functions/create-deployment.md index a76764807..ed197c329 100644 --- a/examples/1.8.x/server-python/examples/functions/create-deployment.md +++ b/examples/1.8.x/server-python/examples/functions/create-deployment.md @@ -2,6 +2,7 @@ from appwrite.client import Client from appwrite.services.functions import Functions from appwrite.input_file import InputFile +from appwrite.models import Deployment client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -10,11 +11,13 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.create_deployment( +result: Deployment = functions.create_deployment( function_id = '', code = InputFile.from_path('file.png'), activate = False, entrypoint = '', # optional commands = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/create-duplicate-deployment.md b/examples/1.8.x/server-python/examples/functions/create-duplicate-deployment.md index 5005b211f..68400cbeb 100644 --- a/examples/1.8.x/server-python/examples/functions/create-duplicate-deployment.md +++ b/examples/1.8.x/server-python/examples/functions/create-duplicate-deployment.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Deployment client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.create_duplicate_deployment( +result: Deployment = functions.create_duplicate_deployment( function_id = '', deployment_id = '', build_id = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/create-execution.md b/examples/1.8.x/server-python/examples/functions/create-execution.md index c1b4b9117..c88c00efd 100644 --- a/examples/1.8.x/server-python/examples/functions/create-execution.md +++ b/examples/1.8.x/server-python/examples/functions/create-execution.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Execution from appwrite.enums import ExecutionMethod client = Client() @@ -10,7 +11,7 @@ client.set_session('') # The user session to authenticate with functions = Functions(client) -result = functions.create_execution( +result: Execution = functions.create_execution( function_id = '', body = '', # optional async = False, # optional @@ -19,4 +20,6 @@ result = functions.create_execution( headers = {}, # optional scheduled_at = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/create-template-deployment.md b/examples/1.8.x/server-python/examples/functions/create-template-deployment.md index 6df7dd1b9..19227be6f 100644 --- a/examples/1.8.x/server-python/examples/functions/create-template-deployment.md +++ b/examples/1.8.x/server-python/examples/functions/create-template-deployment.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Deployment from appwrite.enums import TemplateReferenceType client = Client() @@ -10,7 +11,7 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.create_template_deployment( +result: Deployment = functions.create_template_deployment( function_id = '', repository = '', owner = '', @@ -19,4 +20,6 @@ result = functions.create_template_deployment( reference = '', activate = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/create-variable.md b/examples/1.8.x/server-python/examples/functions/create-variable.md index 046310fbe..e8f0b90b8 100644 --- a/examples/1.8.x/server-python/examples/functions/create-variable.md +++ b/examples/1.8.x/server-python/examples/functions/create-variable.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Variable client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.create_variable( +result: Variable = functions.create_variable( function_id = '', key = '', value = '', secret = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/create-vcs-deployment.md b/examples/1.8.x/server-python/examples/functions/create-vcs-deployment.md index 1ebf5267f..be644a7c4 100644 --- a/examples/1.8.x/server-python/examples/functions/create-vcs-deployment.md +++ b/examples/1.8.x/server-python/examples/functions/create-vcs-deployment.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Deployment from appwrite.enums import VCSReferenceType client = Client() @@ -10,10 +11,12 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.create_vcs_deployment( +result: Deployment = functions.create_vcs_deployment( function_id = '', type = VCSReferenceType.BRANCH, reference = '', activate = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/create.md b/examples/1.8.x/server-python/examples/functions/create.md index 219069258..235df7050 100644 --- a/examples/1.8.x/server-python/examples/functions/create.md +++ b/examples/1.8.x/server-python/examples/functions/create.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Function from appwrite.enums import Runtime from appwrite.enums import Scopes @@ -11,7 +12,7 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.create( +result: Function = functions.create( function_id = '', name = '', runtime = Runtime.NODE_14_5, @@ -29,6 +30,10 @@ result = functions.create( provider_branch = '', # optional provider_silent_mode = False, # optional provider_root_directory = '', # optional - specification = '' # optional + build_specification = '', # optional + runtime_specification = '', # optional + deployment_retention = 0 # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/get-deployment-download.md b/examples/1.8.x/server-python/examples/functions/get-deployment-download.md index b68345a30..7f6b2f6ba 100644 --- a/examples/1.8.x/server-python/examples/functions/get-deployment-download.md +++ b/examples/1.8.x/server-python/examples/functions/get-deployment-download.md @@ -10,7 +10,7 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.get_deployment_download( +result: bytes = functions.get_deployment_download( function_id = '', deployment_id = '', type = DeploymentDownloadType.SOURCE # optional diff --git a/examples/1.8.x/server-python/examples/functions/get-deployment.md b/examples/1.8.x/server-python/examples/functions/get-deployment.md index 03b04f64f..d9f8ba2bf 100644 --- a/examples/1.8.x/server-python/examples/functions/get-deployment.md +++ b/examples/1.8.x/server-python/examples/functions/get-deployment.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Deployment client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.get_deployment( +result: Deployment = functions.get_deployment( function_id = '', deployment_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/get-execution.md b/examples/1.8.x/server-python/examples/functions/get-execution.md index a2fe56684..47d4ce387 100644 --- a/examples/1.8.x/server-python/examples/functions/get-execution.md +++ b/examples/1.8.x/server-python/examples/functions/get-execution.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Execution client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with functions = Functions(client) -result = functions.get_execution( +result: Execution = functions.get_execution( function_id = '', execution_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/get-variable.md b/examples/1.8.x/server-python/examples/functions/get-variable.md index 0cc3807b9..7ba591ad6 100644 --- a/examples/1.8.x/server-python/examples/functions/get-variable.md +++ b/examples/1.8.x/server-python/examples/functions/get-variable.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Variable client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.get_variable( +result: Variable = functions.get_variable( function_id = '', variable_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/get.md b/examples/1.8.x/server-python/examples/functions/get.md index 7bf7ff259..a604e4d9c 100644 --- a/examples/1.8.x/server-python/examples/functions/get.md +++ b/examples/1.8.x/server-python/examples/functions/get.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Function client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.get( +result: Function = functions.get( function_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/list-deployments.md b/examples/1.8.x/server-python/examples/functions/list-deployments.md index 45d5412a9..097181653 100644 --- a/examples/1.8.x/server-python/examples/functions/list-deployments.md +++ b/examples/1.8.x/server-python/examples/functions/list-deployments.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import DeploymentList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.list_deployments( +result: DeploymentList = functions.list_deployments( function_id = '', queries = [], # optional search = '', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/list-executions.md b/examples/1.8.x/server-python/examples/functions/list-executions.md index da65054eb..907ec8597 100644 --- a/examples/1.8.x/server-python/examples/functions/list-executions.md +++ b/examples/1.8.x/server-python/examples/functions/list-executions.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import ExecutionList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_session('') # The user session to authenticate with functions = Functions(client) -result = functions.list_executions( +result: ExecutionList = functions.list_executions( function_id = '', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/list-runtimes.md b/examples/1.8.x/server-python/examples/functions/list-runtimes.md index 3e7000ab6..ee75c80e6 100644 --- a/examples/1.8.x/server-python/examples/functions/list-runtimes.md +++ b/examples/1.8.x/server-python/examples/functions/list-runtimes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import RuntimeList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.list_runtimes() +result: RuntimeList = functions.list_runtimes() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/list-specifications.md b/examples/1.8.x/server-python/examples/functions/list-specifications.md index f491a1276..5b76860db 100644 --- a/examples/1.8.x/server-python/examples/functions/list-specifications.md +++ b/examples/1.8.x/server-python/examples/functions/list-specifications.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import SpecificationList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.list_specifications() +result: SpecificationList = functions.list_specifications() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/list-variables.md b/examples/1.8.x/server-python/examples/functions/list-variables.md index 414550373..ac1b96094 100644 --- a/examples/1.8.x/server-python/examples/functions/list-variables.md +++ b/examples/1.8.x/server-python/examples/functions/list-variables.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import VariableList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.list_variables( +result: VariableList = functions.list_variables( function_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/list.md b/examples/1.8.x/server-python/examples/functions/list.md index 3c6adec95..6f1876966 100644 --- a/examples/1.8.x/server-python/examples/functions/list.md +++ b/examples/1.8.x/server-python/examples/functions/list.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import FunctionList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.list( +result: FunctionList = functions.list( queries = [], # optional search = '', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/update-deployment-status.md b/examples/1.8.x/server-python/examples/functions/update-deployment-status.md index 15c2e0dfa..97a554935 100644 --- a/examples/1.8.x/server-python/examples/functions/update-deployment-status.md +++ b/examples/1.8.x/server-python/examples/functions/update-deployment-status.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Deployment client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.update_deployment_status( +result: Deployment = functions.update_deployment_status( function_id = '', deployment_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/update-function-deployment.md b/examples/1.8.x/server-python/examples/functions/update-function-deployment.md index 90eff8bb6..be39738ac 100644 --- a/examples/1.8.x/server-python/examples/functions/update-function-deployment.md +++ b/examples/1.8.x/server-python/examples/functions/update-function-deployment.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Function client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.update_function_deployment( +result: Function = functions.update_function_deployment( function_id = '', deployment_id = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/update-variable.md b/examples/1.8.x/server-python/examples/functions/update-variable.md index 10176d0f4..ed20fc59b 100644 --- a/examples/1.8.x/server-python/examples/functions/update-variable.md +++ b/examples/1.8.x/server-python/examples/functions/update-variable.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Variable client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.update_variable( +result: Variable = functions.update_variable( function_id = '', variable_id = '', key = '', value = '', # optional secret = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/functions/update.md b/examples/1.8.x/server-python/examples/functions/update.md index fd9915159..181626c45 100644 --- a/examples/1.8.x/server-python/examples/functions/update.md +++ b/examples/1.8.x/server-python/examples/functions/update.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.functions import Functions +from appwrite.models import Function from appwrite.enums import Runtime from appwrite.enums import Scopes @@ -11,7 +12,7 @@ client.set_key('') # Your secret API key functions = Functions(client) -result = functions.update( +result: Function = functions.update( function_id = '', name = '', runtime = Runtime.NODE_14_5, # optional @@ -29,6 +30,10 @@ result = functions.update( provider_branch = '', # optional provider_silent_mode = False, # optional provider_root_directory = '', # optional - specification = '' # optional + build_specification = '', # optional + runtime_specification = '', # optional + deployment_retention = 0 # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-antivirus.md b/examples/1.8.x/server-python/examples/health/get-antivirus.md index a3bd10b9b..1ab51503c 100644 --- a/examples/1.8.x/server-python/examples/health/get-antivirus.md +++ b/examples/1.8.x/server-python/examples/health/get-antivirus.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthAntivirus client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_antivirus() +result: HealthAntivirus = health.get_antivirus() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-cache.md b/examples/1.8.x/server-python/examples/health/get-cache.md index 3e0bd15ce..390508785 100644 --- a/examples/1.8.x/server-python/examples/health/get-cache.md +++ b/examples/1.8.x/server-python/examples/health/get-cache.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthStatusList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_cache() +result: HealthStatusList = health.get_cache() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-certificate.md b/examples/1.8.x/server-python/examples/health/get-certificate.md index 6fa8c862c..53dde7fb1 100644 --- a/examples/1.8.x/server-python/examples/health/get-certificate.md +++ b/examples/1.8.x/server-python/examples/health/get-certificate.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthCertificate client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_certificate( +result: HealthCertificate = health.get_certificate( domain = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-console-pausing.md b/examples/1.8.x/server-python/examples/health/get-console-pausing.md index 884a44528..633c175a9 100644 --- a/examples/1.8.x/server-python/examples/health/get-console-pausing.md +++ b/examples/1.8.x/server-python/examples/health/get-console-pausing.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthStatus client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_console_pausing( +result: HealthStatus = health.get_console_pausing( threshold = None, # optional inactivity_days = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-db.md b/examples/1.8.x/server-python/examples/health/get-db.md index 69414aaea..47b6dd986 100644 --- a/examples/1.8.x/server-python/examples/health/get-db.md +++ b/examples/1.8.x/server-python/examples/health/get-db.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthStatusList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_db() +result: HealthStatusList = health.get_db() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-failed-jobs.md b/examples/1.8.x/server-python/examples/health/get-failed-jobs.md index 2ade2a7f0..9815c2468 100644 --- a/examples/1.8.x/server-python/examples/health/get-failed-jobs.md +++ b/examples/1.8.x/server-python/examples/health/get-failed-jobs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue from appwrite.enums import Name client = Client() @@ -10,8 +11,10 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_failed_jobs( +result: HealthQueue = health.get_failed_jobs( name = Name.V1_DATABASE, threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-pub-sub.md b/examples/1.8.x/server-python/examples/health/get-pub-sub.md index 86640912f..588a2bacd 100644 --- a/examples/1.8.x/server-python/examples/health/get-pub-sub.md +++ b/examples/1.8.x/server-python/examples/health/get-pub-sub.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthStatusList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_pub_sub() +result: HealthStatusList = health.get_pub_sub() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-audits.md b/examples/1.8.x/server-python/examples/health/get-queue-audits.md index 43ad82f5b..a892ca250 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-audits.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-audits.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_audits( +result: HealthQueue = health.get_queue_audits( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-builds.md b/examples/1.8.x/server-python/examples/health/get-queue-builds.md index 850a1515e..0ae87b2ca 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-builds.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-builds.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_builds( +result: HealthQueue = health.get_queue_builds( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-certificates.md b/examples/1.8.x/server-python/examples/health/get-queue-certificates.md index 4e18f7674..6666463fa 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-certificates.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-certificates.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_certificates( +result: HealthQueue = health.get_queue_certificates( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-databases.md b/examples/1.8.x/server-python/examples/health/get-queue-databases.md index 1df0ca1ef..44e165ed6 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-databases.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-databases.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_databases( +result: HealthQueue = health.get_queue_databases( name = '', # optional threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-deletes.md b/examples/1.8.x/server-python/examples/health/get-queue-deletes.md index 315f7bf21..fece63016 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-deletes.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-deletes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_deletes( +result: HealthQueue = health.get_queue_deletes( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-functions.md b/examples/1.8.x/server-python/examples/health/get-queue-functions.md index 3947d2dbc..03d9afe84 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-functions.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-functions.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_functions( +result: HealthQueue = health.get_queue_functions( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-logs.md b/examples/1.8.x/server-python/examples/health/get-queue-logs.md index 59bd7d132..5191fa5a4 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-logs.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-logs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_logs( +result: HealthQueue = health.get_queue_logs( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-mails.md b/examples/1.8.x/server-python/examples/health/get-queue-mails.md index 772a44f6c..aed05e1db 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-mails.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-mails.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_mails( +result: HealthQueue = health.get_queue_mails( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-messaging.md b/examples/1.8.x/server-python/examples/health/get-queue-messaging.md index 4f4671259..5da876a6e 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-messaging.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-messaging.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_messaging( +result: HealthQueue = health.get_queue_messaging( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-migrations.md b/examples/1.8.x/server-python/examples/health/get-queue-migrations.md index baa7de8d7..749675d76 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-migrations.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-migrations.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_migrations( +result: HealthQueue = health.get_queue_migrations( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-stats-resources.md b/examples/1.8.x/server-python/examples/health/get-queue-stats-resources.md index 05ea239e0..60c0dd579 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-stats-resources.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-stats-resources.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_stats_resources( +result: HealthQueue = health.get_queue_stats_resources( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-usage.md b/examples/1.8.x/server-python/examples/health/get-queue-usage.md index 9c86453a6..10fa4a0f9 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-usage.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-usage.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_usage( +result: HealthQueue = health.get_queue_usage( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-queue-webhooks.md b/examples/1.8.x/server-python/examples/health/get-queue-webhooks.md index a01d44db4..24423761b 100644 --- a/examples/1.8.x/server-python/examples/health/get-queue-webhooks.md +++ b/examples/1.8.x/server-python/examples/health/get-queue-webhooks.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthQueue client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_queue_webhooks( +result: HealthQueue = health.get_queue_webhooks( threshold = None # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-storage-local.md b/examples/1.8.x/server-python/examples/health/get-storage-local.md index 98087672c..57b8ec40f 100644 --- a/examples/1.8.x/server-python/examples/health/get-storage-local.md +++ b/examples/1.8.x/server-python/examples/health/get-storage-local.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthStatus client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_storage_local() +result: HealthStatus = health.get_storage_local() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-storage.md b/examples/1.8.x/server-python/examples/health/get-storage.md index b6bdca353..a17ee4e33 100644 --- a/examples/1.8.x/server-python/examples/health/get-storage.md +++ b/examples/1.8.x/server-python/examples/health/get-storage.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthStatus client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_storage() +result: HealthStatus = health.get_storage() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get-time.md b/examples/1.8.x/server-python/examples/health/get-time.md index 9d0dd57e1..5ffae25ee 100644 --- a/examples/1.8.x/server-python/examples/health/get-time.md +++ b/examples/1.8.x/server-python/examples/health/get-time.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthTime client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get_time() +result: HealthTime = health.get_time() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/health/get.md b/examples/1.8.x/server-python/examples/health/get.md index 40ce32f79..5a3b3d061 100644 --- a/examples/1.8.x/server-python/examples/health/get.md +++ b/examples/1.8.x/server-python/examples/health/get.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.health import Health +from appwrite.models import HealthStatus client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('') # Your secret API key health = Health(client) -result = health.get() +result: HealthStatus = health.get() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/locale/get.md b/examples/1.8.x/server-python/examples/locale/get.md index 25e16e68d..bef85fab8 100644 --- a/examples/1.8.x/server-python/examples/locale/get.md +++ b/examples/1.8.x/server-python/examples/locale/get.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.locale import Locale +from appwrite.models import Locale as LocaleModel client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with locale = Locale(client) -result = locale.get() +result: LocaleModel = locale.get() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/locale/list-codes.md b/examples/1.8.x/server-python/examples/locale/list-codes.md index 1cc542511..adc293961 100644 --- a/examples/1.8.x/server-python/examples/locale/list-codes.md +++ b/examples/1.8.x/server-python/examples/locale/list-codes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.locale import Locale +from appwrite.models import LocaleCodeList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with locale = Locale(client) -result = locale.list_codes() +result: LocaleCodeList = locale.list_codes() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/locale/list-continents.md b/examples/1.8.x/server-python/examples/locale/list-continents.md index 40d6c6f3b..fcf05e6ef 100644 --- a/examples/1.8.x/server-python/examples/locale/list-continents.md +++ b/examples/1.8.x/server-python/examples/locale/list-continents.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.locale import Locale +from appwrite.models import ContinentList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with locale = Locale(client) -result = locale.list_continents() +result: ContinentList = locale.list_continents() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/locale/list-countries-eu.md b/examples/1.8.x/server-python/examples/locale/list-countries-eu.md index 2409ae3c6..374cc9a37 100644 --- a/examples/1.8.x/server-python/examples/locale/list-countries-eu.md +++ b/examples/1.8.x/server-python/examples/locale/list-countries-eu.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.locale import Locale +from appwrite.models import CountryList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with locale = Locale(client) -result = locale.list_countries_eu() +result: CountryList = locale.list_countries_eu() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/locale/list-countries-phones.md b/examples/1.8.x/server-python/examples/locale/list-countries-phones.md index 90dc28074..8b36a1f91 100644 --- a/examples/1.8.x/server-python/examples/locale/list-countries-phones.md +++ b/examples/1.8.x/server-python/examples/locale/list-countries-phones.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.locale import Locale +from appwrite.models import PhoneList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with locale = Locale(client) -result = locale.list_countries_phones() +result: PhoneList = locale.list_countries_phones() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/locale/list-countries.md b/examples/1.8.x/server-python/examples/locale/list-countries.md index 1ca58a392..5c45a7668 100644 --- a/examples/1.8.x/server-python/examples/locale/list-countries.md +++ b/examples/1.8.x/server-python/examples/locale/list-countries.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.locale import Locale +from appwrite.models import CountryList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with locale = Locale(client) -result = locale.list_countries() +result: CountryList = locale.list_countries() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/locale/list-currencies.md b/examples/1.8.x/server-python/examples/locale/list-currencies.md index 76e0e2319..07f061c96 100644 --- a/examples/1.8.x/server-python/examples/locale/list-currencies.md +++ b/examples/1.8.x/server-python/examples/locale/list-currencies.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.locale import Locale +from appwrite.models import CurrencyList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with locale = Locale(client) -result = locale.list_currencies() +result: CurrencyList = locale.list_currencies() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/locale/list-languages.md b/examples/1.8.x/server-python/examples/locale/list-languages.md index e9b028e09..3fb0c82cf 100644 --- a/examples/1.8.x/server-python/examples/locale/list-languages.md +++ b/examples/1.8.x/server-python/examples/locale/list-languages.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.locale import Locale +from appwrite.models import LanguageList client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_session('') # The user session to authenticate with locale = Locale(client) -result = locale.list_languages() +result: LanguageList = locale.list_languages() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-apns-provider.md b/examples/1.8.x/server-python/examples/messaging/create-apns-provider.md index 84f6b25b7..52d144d62 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-apns-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/create-apns-provider.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Provider client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key messaging = Messaging(client) -result = messaging.create_apns_provider( +result: Provider = messaging.create_apns_provider( provider_id = '', name = '', auth_key = '', # optional @@ -19,4 +20,6 @@ result = messaging.create_apns_provider( sandbox = False, # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-email.md b/examples/1.8.x/server-python/examples/messaging/create-email.md index 58dc6cf5a..c1a8a32fa 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-email.md +++ b/examples/1.8.x/server-python/examples/messaging/create-email.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Message client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key messaging = Messaging(client) -result = messaging.create_email( +result: Message = messaging.create_email( message_id = '', subject = '', content = '', @@ -23,4 +24,6 @@ result = messaging.create_email( html = False, # optional scheduled_at = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-fcm-provider.md b/examples/1.8.x/server-python/examples/messaging/create-fcm-provider.md index 11e5e6357..b4dc9b2f2 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-fcm-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/create-fcm-provider.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Provider client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('') # Your secret API key messaging = Messaging(client) -result = messaging.create_fcm_provider( +result: Provider = messaging.create_fcm_provider( provider_id = '', name = '', service_account_json = {}, # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-mailgun-provider.md b/examples/1.8.x/server-python/examples/messaging/create-mailgun-provider.md index 8bd974b3b..d16f453aa 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-mailgun-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/create-mailgun-provider.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Provider client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key messaging = Messaging(client) -result = messaging.create_mailgun_provider( +result: Provider = messaging.create_mailgun_provider( provider_id = '', name = '', api_key = '', # optional @@ -21,4 +22,6 @@ result = messaging.create_mailgun_provider( reply_to_email = 'email@example.com', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-msg-91-provider.md b/examples/1.8.x/server-python/examples/messaging/create-msg-91-provider.md index 514e344c4..9bf577df7 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-msg-91-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/create-msg-91-provider.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Provider client = Client() client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('') # Your secret API key messaging = Messaging(client) -result = messaging.create_msg91_provider( +result: Provider = messaging.create_msg91_provider( provider_id = '', name = '', template_id = '', # optional @@ -17,4 +18,6 @@ result = messaging.create_msg91_provider( auth_key = '', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-push.md b/examples/1.8.x/server-python/examples/messaging/create-push.md index 2bc06bda8..1a7dcc106 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-push.md +++ b/examples/1.8.x/server-python/examples/messaging/create-push.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Message from appwrite.enums import MessagePriority client = Client() @@ -10,7 +11,7 @@ client.set_key('') # Your secret API key messaging = Messaging(client) -result = messaging.create_push( +result: Message = messaging.create_push( message_id = '', title = '', # optional body = '<BODY>', # optional @@ -31,4 +32,6 @@ result = messaging.create_push( critical = False, # optional priority = MessagePriority.NORMAL # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-resend-provider.md b/examples/1.8.x/server-python/examples/messaging/create-resend-provider.md index 43c6372bc..5a1205a41 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-resend-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/create-resend-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.create_resend_provider( +result: Provider = messaging.create_resend_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', api_key = '<API_KEY>', # optional @@ -19,4 +20,6 @@ result = messaging.create_resend_provider( reply_to_email = 'email@example.com', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-sendgrid-provider.md b/examples/1.8.x/server-python/examples/messaging/create-sendgrid-provider.md index 9a1c8a2ed..e9abd646a 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-sendgrid-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/create-sendgrid-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.create_sendgrid_provider( +result: Provider = messaging.create_sendgrid_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', api_key = '<API_KEY>', # optional @@ -19,4 +20,6 @@ result = messaging.create_sendgrid_provider( reply_to_email = 'email@example.com', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-sms.md b/examples/1.8.x/server-python/examples/messaging/create-sms.md index 66a76c2c2..7eb94e8fe 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-sms.md +++ b/examples/1.8.x/server-python/examples/messaging/create-sms.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Message client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.create_sms( +result: Message = messaging.create_sms( message_id = '<MESSAGE_ID>', content = '<CONTENT>', topics = [], # optional @@ -18,4 +19,6 @@ result = messaging.create_sms( draft = False, # optional scheduled_at = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-smtp-provider.md b/examples/1.8.x/server-python/examples/messaging/create-smtp-provider.md index cd3d703ee..55e5b6eaf 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-smtp-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/create-smtp-provider.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Provider from appwrite.enums import SmtpEncryption client = Client() @@ -10,7 +11,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.create_smtp_provider( +result: Provider = messaging.create_smtp_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', host = '<HOST>', @@ -26,4 +27,6 @@ result = messaging.create_smtp_provider( reply_to_email = 'email@example.com', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-subscriber.md b/examples/1.8.x/server-python/examples/messaging/create-subscriber.md index 402e35f59..2c230b1ac 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-subscriber.md +++ b/examples/1.8.x/server-python/examples/messaging/create-subscriber.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Subscriber client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_jwt('<YOUR_JWT>') # Your secret JSON Web Token messaging = Messaging(client) -result = messaging.create_subscriber( +result: Subscriber = messaging.create_subscriber( topic_id = '<TOPIC_ID>', subscriber_id = '<SUBSCRIBER_ID>', target_id = '<TARGET_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-telesign-provider.md b/examples/1.8.x/server-python/examples/messaging/create-telesign-provider.md index 7a2be40bd..e4e105893 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-telesign-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/create-telesign-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.create_telesign_provider( +result: Provider = messaging.create_telesign_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', from = '+12065550100', # optional @@ -17,4 +18,6 @@ result = messaging.create_telesign_provider( api_key = '<API_KEY>', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-textmagic-provider.md b/examples/1.8.x/server-python/examples/messaging/create-textmagic-provider.md index 47ba6f32e..3b42e692b 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-textmagic-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/create-textmagic-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.create_textmagic_provider( +result: Provider = messaging.create_textmagic_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', from = '+12065550100', # optional @@ -17,4 +18,6 @@ result = messaging.create_textmagic_provider( api_key = '<API_KEY>', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-topic.md b/examples/1.8.x/server-python/examples/messaging/create-topic.md index cb2096593..3a6547eb1 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-topic.md +++ b/examples/1.8.x/server-python/examples/messaging/create-topic.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Topic client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.create_topic( +result: Topic = messaging.create_topic( topic_id = '<TOPIC_ID>', name = '<NAME>', subscribe = ["any"] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-twilio-provider.md b/examples/1.8.x/server-python/examples/messaging/create-twilio-provider.md index 53f7d3729..6a20087d7 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-twilio-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/create-twilio-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.create_twilio_provider( +result: Provider = messaging.create_twilio_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', from = '+12065550100', # optional @@ -17,4 +18,6 @@ result = messaging.create_twilio_provider( auth_token = '<AUTH_TOKEN>', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/create-vonage-provider.md b/examples/1.8.x/server-python/examples/messaging/create-vonage-provider.md index 034e53994..4afc224d3 100644 --- a/examples/1.8.x/server-python/examples/messaging/create-vonage-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/create-vonage-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.create_vonage_provider( +result: Provider = messaging.create_vonage_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', from = '+12065550100', # optional @@ -17,4 +18,6 @@ result = messaging.create_vonage_provider( api_secret = '<API_SECRET>', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/get-message.md b/examples/1.8.x/server-python/examples/messaging/get-message.md index a1a2ea1f2..b93df097e 100644 --- a/examples/1.8.x/server-python/examples/messaging/get-message.md +++ b/examples/1.8.x/server-python/examples/messaging/get-message.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Message client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.get_message( +result: Message = messaging.get_message( message_id = '<MESSAGE_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/get-provider.md b/examples/1.8.x/server-python/examples/messaging/get-provider.md index 41f286078..77750af4b 100644 --- a/examples/1.8.x/server-python/examples/messaging/get-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/get-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.get_provider( +result: Provider = messaging.get_provider( provider_id = '<PROVIDER_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/get-subscriber.md b/examples/1.8.x/server-python/examples/messaging/get-subscriber.md index 26e76b7b0..58b6dda21 100644 --- a/examples/1.8.x/server-python/examples/messaging/get-subscriber.md +++ b/examples/1.8.x/server-python/examples/messaging/get-subscriber.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Subscriber client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.get_subscriber( +result: Subscriber = messaging.get_subscriber( topic_id = '<TOPIC_ID>', subscriber_id = '<SUBSCRIBER_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/get-topic.md b/examples/1.8.x/server-python/examples/messaging/get-topic.md index 4917f0a62..7c38c8012 100644 --- a/examples/1.8.x/server-python/examples/messaging/get-topic.md +++ b/examples/1.8.x/server-python/examples/messaging/get-topic.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Topic client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.get_topic( +result: Topic = messaging.get_topic( topic_id = '<TOPIC_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/list-message-logs.md b/examples/1.8.x/server-python/examples/messaging/list-message-logs.md index 9ae02f633..27d6b9b63 100644 --- a/examples/1.8.x/server-python/examples/messaging/list-message-logs.md +++ b/examples/1.8.x/server-python/examples/messaging/list-message-logs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import LogList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.list_message_logs( +result: LogList = messaging.list_message_logs( message_id = '<MESSAGE_ID>', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/list-messages.md b/examples/1.8.x/server-python/examples/messaging/list-messages.md index a8b1254cd..cb833b251 100644 --- a/examples/1.8.x/server-python/examples/messaging/list-messages.md +++ b/examples/1.8.x/server-python/examples/messaging/list-messages.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import MessageList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.list_messages( +result: MessageList = messaging.list_messages( queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/list-provider-logs.md b/examples/1.8.x/server-python/examples/messaging/list-provider-logs.md index 9bdd1e432..ad2714280 100644 --- a/examples/1.8.x/server-python/examples/messaging/list-provider-logs.md +++ b/examples/1.8.x/server-python/examples/messaging/list-provider-logs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import LogList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.list_provider_logs( +result: LogList = messaging.list_provider_logs( provider_id = '<PROVIDER_ID>', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/list-providers.md b/examples/1.8.x/server-python/examples/messaging/list-providers.md index cb272aa0c..eae8eee0c 100644 --- a/examples/1.8.x/server-python/examples/messaging/list-providers.md +++ b/examples/1.8.x/server-python/examples/messaging/list-providers.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import ProviderList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.list_providers( +result: ProviderList = messaging.list_providers( queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/list-subscriber-logs.md b/examples/1.8.x/server-python/examples/messaging/list-subscriber-logs.md index cb5e1a88d..b02c2b1ba 100644 --- a/examples/1.8.x/server-python/examples/messaging/list-subscriber-logs.md +++ b/examples/1.8.x/server-python/examples/messaging/list-subscriber-logs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import LogList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.list_subscriber_logs( +result: LogList = messaging.list_subscriber_logs( subscriber_id = '<SUBSCRIBER_ID>', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/list-subscribers.md b/examples/1.8.x/server-python/examples/messaging/list-subscribers.md index 33818ac3b..7502d00f1 100644 --- a/examples/1.8.x/server-python/examples/messaging/list-subscribers.md +++ b/examples/1.8.x/server-python/examples/messaging/list-subscribers.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import SubscriberList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.list_subscribers( +result: SubscriberList = messaging.list_subscribers( topic_id = '<TOPIC_ID>', queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/list-targets.md b/examples/1.8.x/server-python/examples/messaging/list-targets.md index 4b5b59c23..6c753b2fb 100644 --- a/examples/1.8.x/server-python/examples/messaging/list-targets.md +++ b/examples/1.8.x/server-python/examples/messaging/list-targets.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import TargetList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.list_targets( +result: TargetList = messaging.list_targets( message_id = '<MESSAGE_ID>', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/list-topic-logs.md b/examples/1.8.x/server-python/examples/messaging/list-topic-logs.md index 1e6e15f84..3ed2d7e3a 100644 --- a/examples/1.8.x/server-python/examples/messaging/list-topic-logs.md +++ b/examples/1.8.x/server-python/examples/messaging/list-topic-logs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import LogList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.list_topic_logs( +result: LogList = messaging.list_topic_logs( topic_id = '<TOPIC_ID>', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/list-topics.md b/examples/1.8.x/server-python/examples/messaging/list-topics.md index cf50c0f1c..106deab05 100644 --- a/examples/1.8.x/server-python/examples/messaging/list-topics.md +++ b/examples/1.8.x/server-python/examples/messaging/list-topics.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import TopicList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.list_topics( +result: TopicList = messaging.list_topics( queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-apns-provider.md b/examples/1.8.x/server-python/examples/messaging/update-apns-provider.md index 1108a3789..bdbfc06e4 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-apns-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/update-apns-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_apns_provider( +result: Provider = messaging.update_apns_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', # optional enabled = False, # optional @@ -19,4 +20,6 @@ result = messaging.update_apns_provider( bundle_id = '<BUNDLE_ID>', # optional sandbox = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-email.md b/examples/1.8.x/server-python/examples/messaging/update-email.md index e63fd35a3..9b78e6b05 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-email.md +++ b/examples/1.8.x/server-python/examples/messaging/update-email.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Message client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_email( +result: Message = messaging.update_email( message_id = '<MESSAGE_ID>', topics = [], # optional users = [], # optional @@ -23,4 +24,6 @@ result = messaging.update_email( scheduled_at = '', # optional attachments = [] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-fcm-provider.md b/examples/1.8.x/server-python/examples/messaging/update-fcm-provider.md index 94f730082..6270cb80d 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-fcm-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/update-fcm-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_fcm_provider( +result: Provider = messaging.update_fcm_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', # optional enabled = False, # optional service_account_json = {} # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-mailgun-provider.md b/examples/1.8.x/server-python/examples/messaging/update-mailgun-provider.md index a774d01fb..5c3285cd6 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-mailgun-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/update-mailgun-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_mailgun_provider( +result: Provider = messaging.update_mailgun_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', # optional api_key = '<API_KEY>', # optional @@ -21,4 +22,6 @@ result = messaging.update_mailgun_provider( reply_to_name = '<REPLY_TO_NAME>', # optional reply_to_email = '<REPLY_TO_EMAIL>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-msg-91-provider.md b/examples/1.8.x/server-python/examples/messaging/update-msg-91-provider.md index 984e3e4c4..d608d6315 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-msg-91-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/update-msg-91-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_msg91_provider( +result: Provider = messaging.update_msg91_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', # optional enabled = False, # optional @@ -17,4 +18,6 @@ result = messaging.update_msg91_provider( sender_id = '<SENDER_ID>', # optional auth_key = '<AUTH_KEY>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-push.md b/examples/1.8.x/server-python/examples/messaging/update-push.md index de4284495..ac86bcbe8 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-push.md +++ b/examples/1.8.x/server-python/examples/messaging/update-push.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Message from appwrite.enums import MessagePriority client = Client() @@ -10,7 +11,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_push( +result: Message = messaging.update_push( message_id = '<MESSAGE_ID>', topics = [], # optional users = [], # optional @@ -31,4 +32,6 @@ result = messaging.update_push( critical = False, # optional priority = MessagePriority.NORMAL # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-resend-provider.md b/examples/1.8.x/server-python/examples/messaging/update-resend-provider.md index ecd21ee47..1de7e46fd 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-resend-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/update-resend-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_resend_provider( +result: Provider = messaging.update_resend_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', # optional enabled = False, # optional @@ -19,4 +20,6 @@ result = messaging.update_resend_provider( reply_to_name = '<REPLY_TO_NAME>', # optional reply_to_email = '<REPLY_TO_EMAIL>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-sendgrid-provider.md b/examples/1.8.x/server-python/examples/messaging/update-sendgrid-provider.md index e7f9a3634..23bf7bad9 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-sendgrid-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/update-sendgrid-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_sendgrid_provider( +result: Provider = messaging.update_sendgrid_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', # optional enabled = False, # optional @@ -19,4 +20,6 @@ result = messaging.update_sendgrid_provider( reply_to_name = '<REPLY_TO_NAME>', # optional reply_to_email = '<REPLY_TO_EMAIL>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-sms.md b/examples/1.8.x/server-python/examples/messaging/update-sms.md index 0973a1004..570c959dd 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-sms.md +++ b/examples/1.8.x/server-python/examples/messaging/update-sms.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Message client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_sms( +result: Message = messaging.update_sms( message_id = '<MESSAGE_ID>', topics = [], # optional users = [], # optional @@ -18,4 +19,6 @@ result = messaging.update_sms( draft = False, # optional scheduled_at = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-smtp-provider.md b/examples/1.8.x/server-python/examples/messaging/update-smtp-provider.md index 7824c628f..b47125009 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-smtp-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/update-smtp-provider.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Provider from appwrite.enums import SmtpEncryption client = Client() @@ -10,7 +11,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_smtp_provider( +result: Provider = messaging.update_smtp_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', # optional host = '<HOST>', # optional @@ -26,4 +27,6 @@ result = messaging.update_smtp_provider( reply_to_email = '<REPLY_TO_EMAIL>', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-telesign-provider.md b/examples/1.8.x/server-python/examples/messaging/update-telesign-provider.md index dc1d3f187..d59fbaf67 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-telesign-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/update-telesign-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_telesign_provider( +result: Provider = messaging.update_telesign_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', # optional enabled = False, # optional @@ -17,4 +18,6 @@ result = messaging.update_telesign_provider( api_key = '<API_KEY>', # optional from = '<FROM>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-textmagic-provider.md b/examples/1.8.x/server-python/examples/messaging/update-textmagic-provider.md index 0165999d1..e1f9569b9 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-textmagic-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/update-textmagic-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_textmagic_provider( +result: Provider = messaging.update_textmagic_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', # optional enabled = False, # optional @@ -17,4 +18,6 @@ result = messaging.update_textmagic_provider( api_key = '<API_KEY>', # optional from = '<FROM>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-topic.md b/examples/1.8.x/server-python/examples/messaging/update-topic.md index 5b20cc679..d7936aa6a 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-topic.md +++ b/examples/1.8.x/server-python/examples/messaging/update-topic.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.messaging import Messaging +from appwrite.models import Topic client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_topic( +result: Topic = messaging.update_topic( topic_id = '<TOPIC_ID>', name = '<NAME>', # optional subscribe = ["any"] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-twilio-provider.md b/examples/1.8.x/server-python/examples/messaging/update-twilio-provider.md index 1db09b245..e4622e273 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-twilio-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/update-twilio-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_twilio_provider( +result: Provider = messaging.update_twilio_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', # optional enabled = False, # optional @@ -17,4 +18,6 @@ result = messaging.update_twilio_provider( auth_token = '<AUTH_TOKEN>', # optional from = '<FROM>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/messaging/update-vonage-provider.md b/examples/1.8.x/server-python/examples/messaging/update-vonage-provider.md index e8a2712d7..ba3798943 100644 --- a/examples/1.8.x/server-python/examples/messaging/update-vonage-provider.md +++ b/examples/1.8.x/server-python/examples/messaging/update-vonage-provider.md @@ -1,6 +1,7 @@ ```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 @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key messaging = Messaging(client) -result = messaging.update_vonage_provider( +result: Provider = messaging.update_vonage_provider( provider_id = '<PROVIDER_ID>', name = '<NAME>', # optional enabled = False, # optional @@ -17,4 +18,6 @@ result = messaging.update_vonage_provider( api_secret = '<API_SECRET>', # optional from = '<FROM>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/create-deployment.md b/examples/1.8.x/server-python/examples/sites/create-deployment.md index dc411f05e..8abb038e3 100644 --- a/examples/1.8.x/server-python/examples/sites/create-deployment.md +++ b/examples/1.8.x/server-python/examples/sites/create-deployment.md @@ -2,6 +2,7 @@ from appwrite.client import Client from appwrite.services.sites import Sites from appwrite.input_file import InputFile +from appwrite.models import Deployment client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -10,12 +11,14 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.create_deployment( +result: Deployment = sites.create_deployment( site_id = '<SITE_ID>', code = InputFile.from_path('file.png'), - activate = False, install_command = '<INSTALL_COMMAND>', # optional build_command = '<BUILD_COMMAND>', # optional - output_directory = '<OUTPUT_DIRECTORY>' # optional + output_directory = '<OUTPUT_DIRECTORY>', # optional + activate = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/create-duplicate-deployment.md b/examples/1.8.x/server-python/examples/sites/create-duplicate-deployment.md index 63cd2b996..35b52564b 100644 --- a/examples/1.8.x/server-python/examples/sites/create-duplicate-deployment.md +++ b/examples/1.8.x/server-python/examples/sites/create-duplicate-deployment.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Deployment client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.create_duplicate_deployment( +result: Deployment = sites.create_duplicate_deployment( site_id = '<SITE_ID>', deployment_id = '<DEPLOYMENT_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/create-template-deployment.md b/examples/1.8.x/server-python/examples/sites/create-template-deployment.md index 17aa6a11e..f65b153b5 100644 --- a/examples/1.8.x/server-python/examples/sites/create-template-deployment.md +++ b/examples/1.8.x/server-python/examples/sites/create-template-deployment.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Deployment from appwrite.enums import TemplateReferenceType client = Client() @@ -10,7 +11,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.create_template_deployment( +result: Deployment = sites.create_template_deployment( site_id = '<SITE_ID>', repository = '<REPOSITORY>', owner = '<OWNER>', @@ -19,4 +20,6 @@ result = sites.create_template_deployment( reference = '<REFERENCE>', activate = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/create-variable.md b/examples/1.8.x/server-python/examples/sites/create-variable.md index e8971fd96..d9f866b33 100644 --- a/examples/1.8.x/server-python/examples/sites/create-variable.md +++ b/examples/1.8.x/server-python/examples/sites/create-variable.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Variable client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.create_variable( +result: Variable = sites.create_variable( site_id = '<SITE_ID>', key = '<KEY>', value = '<VALUE>', secret = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/create-vcs-deployment.md b/examples/1.8.x/server-python/examples/sites/create-vcs-deployment.md index 116f4e953..1846cefc3 100644 --- a/examples/1.8.x/server-python/examples/sites/create-vcs-deployment.md +++ b/examples/1.8.x/server-python/examples/sites/create-vcs-deployment.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Deployment from appwrite.enums import VCSReferenceType client = Client() @@ -10,10 +11,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.create_vcs_deployment( +result: Deployment = sites.create_vcs_deployment( site_id = '<SITE_ID>', type = VCSReferenceType.BRANCH, reference = '<REFERENCE>', activate = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/create.md b/examples/1.8.x/server-python/examples/sites/create.md index 248a23465..9fa508a1c 100644 --- a/examples/1.8.x/server-python/examples/sites/create.md +++ b/examples/1.8.x/server-python/examples/sites/create.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Site from appwrite.enums import Framework from appwrite.enums import BuildRuntime from appwrite.enums import Adapter @@ -12,7 +13,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.create( +result: Site = sites.create( site_id = '<SITE_ID>', name = '<NAME>', framework = Framework.ANALOG, @@ -22,6 +23,7 @@ result = sites.create( timeout = 1, # optional install_command = '<INSTALL_COMMAND>', # optional build_command = '<BUILD_COMMAND>', # optional + start_command = '<START_COMMAND>', # optional output_directory = '<OUTPUT_DIRECTORY>', # optional adapter = Adapter.STATIC, # optional installation_id = '<INSTALLATION_ID>', # optional @@ -30,6 +32,10 @@ result = sites.create( provider_branch = '<PROVIDER_BRANCH>', # optional provider_silent_mode = False, # optional provider_root_directory = '<PROVIDER_ROOT_DIRECTORY>', # optional - specification = '' # optional + build_specification = '', # optional + runtime_specification = '', # optional + deployment_retention = 0 # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/get-deployment-download.md b/examples/1.8.x/server-python/examples/sites/get-deployment-download.md index fae837191..eae2543c4 100644 --- a/examples/1.8.x/server-python/examples/sites/get-deployment-download.md +++ b/examples/1.8.x/server-python/examples/sites/get-deployment-download.md @@ -10,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.get_deployment_download( +result: bytes = sites.get_deployment_download( site_id = '<SITE_ID>', deployment_id = '<DEPLOYMENT_ID>', type = DeploymentDownloadType.SOURCE # optional diff --git a/examples/1.8.x/server-python/examples/sites/get-deployment.md b/examples/1.8.x/server-python/examples/sites/get-deployment.md index c4ed80cf6..5291928c3 100644 --- a/examples/1.8.x/server-python/examples/sites/get-deployment.md +++ b/examples/1.8.x/server-python/examples/sites/get-deployment.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Deployment client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.get_deployment( +result: Deployment = sites.get_deployment( site_id = '<SITE_ID>', deployment_id = '<DEPLOYMENT_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/get-log.md b/examples/1.8.x/server-python/examples/sites/get-log.md index 6b70fe265..aa718daad 100644 --- a/examples/1.8.x/server-python/examples/sites/get-log.md +++ b/examples/1.8.x/server-python/examples/sites/get-log.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Execution client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.get_log( +result: Execution = sites.get_log( site_id = '<SITE_ID>', log_id = '<LOG_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/get-variable.md b/examples/1.8.x/server-python/examples/sites/get-variable.md index 5251fc4e1..9eb30dd91 100644 --- a/examples/1.8.x/server-python/examples/sites/get-variable.md +++ b/examples/1.8.x/server-python/examples/sites/get-variable.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Variable client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.get_variable( +result: Variable = sites.get_variable( site_id = '<SITE_ID>', variable_id = '<VARIABLE_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/get.md b/examples/1.8.x/server-python/examples/sites/get.md index 129248cc5..c792987a1 100644 --- a/examples/1.8.x/server-python/examples/sites/get.md +++ b/examples/1.8.x/server-python/examples/sites/get.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Site client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.get( +result: Site = sites.get( site_id = '<SITE_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/list-deployments.md b/examples/1.8.x/server-python/examples/sites/list-deployments.md index 3e9c73801..70b2a0b3c 100644 --- a/examples/1.8.x/server-python/examples/sites/list-deployments.md +++ b/examples/1.8.x/server-python/examples/sites/list-deployments.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import DeploymentList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.list_deployments( +result: DeploymentList = sites.list_deployments( site_id = '<SITE_ID>', queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/list-frameworks.md b/examples/1.8.x/server-python/examples/sites/list-frameworks.md index 6e2edae86..84996b3f7 100644 --- a/examples/1.8.x/server-python/examples/sites/list-frameworks.md +++ b/examples/1.8.x/server-python/examples/sites/list-frameworks.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import FrameworkList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.list_frameworks() +result: FrameworkList = sites.list_frameworks() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/list-logs.md b/examples/1.8.x/server-python/examples/sites/list-logs.md index 35dd7fe50..4543f2323 100644 --- a/examples/1.8.x/server-python/examples/sites/list-logs.md +++ b/examples/1.8.x/server-python/examples/sites/list-logs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import ExecutionList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.list_logs( +result: ExecutionList = sites.list_logs( site_id = '<SITE_ID>', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/list-specifications.md b/examples/1.8.x/server-python/examples/sites/list-specifications.md index a82616b4c..c1229a302 100644 --- a/examples/1.8.x/server-python/examples/sites/list-specifications.md +++ b/examples/1.8.x/server-python/examples/sites/list-specifications.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import SpecificationList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,5 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.list_specifications() +result: SpecificationList = sites.list_specifications() + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/list-variables.md b/examples/1.8.x/server-python/examples/sites/list-variables.md index 35b5265a7..5560279d4 100644 --- a/examples/1.8.x/server-python/examples/sites/list-variables.md +++ b/examples/1.8.x/server-python/examples/sites/list-variables.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import VariableList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.list_variables( +result: VariableList = sites.list_variables( site_id = '<SITE_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/list.md b/examples/1.8.x/server-python/examples/sites/list.md index 2d87535ee..0a5648271 100644 --- a/examples/1.8.x/server-python/examples/sites/list.md +++ b/examples/1.8.x/server-python/examples/sites/list.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import SiteList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.list( +result: SiteList = sites.list( queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/update-deployment-status.md b/examples/1.8.x/server-python/examples/sites/update-deployment-status.md index 68f24fa2e..8ab82d4ad 100644 --- a/examples/1.8.x/server-python/examples/sites/update-deployment-status.md +++ b/examples/1.8.x/server-python/examples/sites/update-deployment-status.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Deployment client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.update_deployment_status( +result: Deployment = sites.update_deployment_status( site_id = '<SITE_ID>', deployment_id = '<DEPLOYMENT_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/update-site-deployment.md b/examples/1.8.x/server-python/examples/sites/update-site-deployment.md index 53f0b8b9e..507923e9d 100644 --- a/examples/1.8.x/server-python/examples/sites/update-site-deployment.md +++ b/examples/1.8.x/server-python/examples/sites/update-site-deployment.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Site client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.update_site_deployment( +result: Site = sites.update_site_deployment( site_id = '<SITE_ID>', deployment_id = '<DEPLOYMENT_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/update-variable.md b/examples/1.8.x/server-python/examples/sites/update-variable.md index 57ace3eea..5e165781a 100644 --- a/examples/1.8.x/server-python/examples/sites/update-variable.md +++ b/examples/1.8.x/server-python/examples/sites/update-variable.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Variable client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.update_variable( +result: Variable = sites.update_variable( site_id = '<SITE_ID>', variable_id = '<VARIABLE_ID>', key = '<KEY>', value = '<VALUE>', # optional secret = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/sites/update.md b/examples/1.8.x/server-python/examples/sites/update.md index f4e6a6d2e..3ce497566 100644 --- a/examples/1.8.x/server-python/examples/sites/update.md +++ b/examples/1.8.x/server-python/examples/sites/update.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.sites import Sites +from appwrite.models import Site from appwrite.enums import Framework from appwrite.enums import BuildRuntime from appwrite.enums import Adapter @@ -12,7 +13,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key sites = Sites(client) -result = sites.update( +result: Site = sites.update( site_id = '<SITE_ID>', name = '<NAME>', framework = Framework.ANALOG, @@ -21,6 +22,7 @@ result = sites.update( timeout = 1, # optional install_command = '<INSTALL_COMMAND>', # optional build_command = '<BUILD_COMMAND>', # optional + start_command = '<START_COMMAND>', # optional output_directory = '<OUTPUT_DIRECTORY>', # optional build_runtime = BuildRuntime.NODE_14_5, # optional adapter = Adapter.STATIC, # optional @@ -30,6 +32,10 @@ result = sites.update( provider_branch = '<PROVIDER_BRANCH>', # optional provider_silent_mode = False, # optional provider_root_directory = '<PROVIDER_ROOT_DIRECTORY>', # optional - specification = '' # optional + build_specification = '', # optional + runtime_specification = '', # optional + deployment_retention = 0 # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/storage/create-bucket.md b/examples/1.8.x/server-python/examples/storage/create-bucket.md index 58caa706b..418f8ecb1 100644 --- a/examples/1.8.x/server-python/examples/storage/create-bucket.md +++ b/examples/1.8.x/server-python/examples/storage/create-bucket.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.storage import Storage +from appwrite.models import Bucket from appwrite.enums import Compression from appwrite.permission import Permission from appwrite.role import Role @@ -12,7 +13,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key storage = Storage(client) -result = storage.create_bucket( +result: Bucket = storage.create_bucket( bucket_id = '<BUCKET_ID>', name = '<NAME>', permissions = [Permission.read(Role.any())], # optional @@ -25,4 +26,6 @@ result = storage.create_bucket( antivirus = False, # optional transformations = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/storage/create-file.md b/examples/1.8.x/server-python/examples/storage/create-file.md index 4e347b2d5..2103a1d60 100644 --- a/examples/1.8.x/server-python/examples/storage/create-file.md +++ b/examples/1.8.x/server-python/examples/storage/create-file.md @@ -2,6 +2,7 @@ from appwrite.client import Client from appwrite.services.storage import Storage from appwrite.input_file import InputFile +from appwrite.models import File from appwrite.permission import Permission from appwrite.role import Role @@ -12,10 +13,12 @@ client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.create_file( +result: File = storage.create_file( bucket_id = '<BUCKET_ID>', file_id = '<FILE_ID>', file = InputFile.from_path('file.png'), permissions = [Permission.read(Role.any())] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/storage/get-bucket.md b/examples/1.8.x/server-python/examples/storage/get-bucket.md index a12e72046..eaa707ced 100644 --- a/examples/1.8.x/server-python/examples/storage/get-bucket.md +++ b/examples/1.8.x/server-python/examples/storage/get-bucket.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.storage import Storage +from appwrite.models import Bucket client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key storage = Storage(client) -result = storage.get_bucket( +result: Bucket = storage.get_bucket( bucket_id = '<BUCKET_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/storage/get-file-download.md b/examples/1.8.x/server-python/examples/storage/get-file-download.md index 790bd7267..ac6f9424d 100644 --- a/examples/1.8.x/server-python/examples/storage/get-file-download.md +++ b/examples/1.8.x/server-python/examples/storage/get-file-download.md @@ -9,7 +9,7 @@ client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.get_file_download( +result: bytes = storage.get_file_download( bucket_id = '<BUCKET_ID>', file_id = '<FILE_ID>', token = '<TOKEN>' # optional diff --git a/examples/1.8.x/server-python/examples/storage/get-file-preview.md b/examples/1.8.x/server-python/examples/storage/get-file-preview.md index b14a64640..4cbc4a586 100644 --- a/examples/1.8.x/server-python/examples/storage/get-file-preview.md +++ b/examples/1.8.x/server-python/examples/storage/get-file-preview.md @@ -11,7 +11,7 @@ client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.get_file_preview( +result: bytes = storage.get_file_preview( bucket_id = '<BUCKET_ID>', file_id = '<FILE_ID>', width = 0, # optional diff --git a/examples/1.8.x/server-python/examples/storage/get-file-view.md b/examples/1.8.x/server-python/examples/storage/get-file-view.md index f78822d2d..5cceef6ff 100644 --- a/examples/1.8.x/server-python/examples/storage/get-file-view.md +++ b/examples/1.8.x/server-python/examples/storage/get-file-view.md @@ -9,7 +9,7 @@ client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.get_file_view( +result: bytes = storage.get_file_view( bucket_id = '<BUCKET_ID>', file_id = '<FILE_ID>', token = '<TOKEN>' # optional diff --git a/examples/1.8.x/server-python/examples/storage/get-file.md b/examples/1.8.x/server-python/examples/storage/get-file.md index 8c79a68c8..fb1435115 100644 --- a/examples/1.8.x/server-python/examples/storage/get-file.md +++ b/examples/1.8.x/server-python/examples/storage/get-file.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.storage import Storage +from appwrite.models import File client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.get_file( +result: File = storage.get_file( bucket_id = '<BUCKET_ID>', file_id = '<FILE_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/storage/list-buckets.md b/examples/1.8.x/server-python/examples/storage/list-buckets.md index 5c280cd7d..aebd50b6b 100644 --- a/examples/1.8.x/server-python/examples/storage/list-buckets.md +++ b/examples/1.8.x/server-python/examples/storage/list-buckets.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.storage import Storage +from appwrite.models import BucketList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key storage = Storage(client) -result = storage.list_buckets( +result: BucketList = storage.list_buckets( queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/storage/list-files.md b/examples/1.8.x/server-python/examples/storage/list-files.md index 5a0e2f2b5..a676c3136 100644 --- a/examples/1.8.x/server-python/examples/storage/list-files.md +++ b/examples/1.8.x/server-python/examples/storage/list-files.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.storage import Storage +from appwrite.models import FileList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.list_files( +result: FileList = storage.list_files( bucket_id = '<BUCKET_ID>', queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/storage/update-bucket.md b/examples/1.8.x/server-python/examples/storage/update-bucket.md index 669d9abb5..ecb1ada62 100644 --- a/examples/1.8.x/server-python/examples/storage/update-bucket.md +++ b/examples/1.8.x/server-python/examples/storage/update-bucket.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.storage import Storage +from appwrite.models import Bucket from appwrite.enums import Compression from appwrite.permission import Permission from appwrite.role import Role @@ -12,7 +13,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key storage = Storage(client) -result = storage.update_bucket( +result: Bucket = storage.update_bucket( bucket_id = '<BUCKET_ID>', name = '<NAME>', permissions = [Permission.read(Role.any())], # optional @@ -25,4 +26,6 @@ result = storage.update_bucket( antivirus = False, # optional transformations = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/storage/update-file.md b/examples/1.8.x/server-python/examples/storage/update-file.md index 4e14348f9..b0fad8d47 100644 --- a/examples/1.8.x/server-python/examples/storage/update-file.md +++ b/examples/1.8.x/server-python/examples/storage/update-file.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.storage import Storage +from appwrite.models import File from appwrite.permission import Permission from appwrite.role import Role @@ -11,10 +12,12 @@ client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.update_file( +result: File = storage.update_file( bucket_id = '<BUCKET_ID>', file_id = '<FILE_ID>', name = '<NAME>', # optional permissions = [Permission.read(Role.any())] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-boolean-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-boolean-column.md index 29b6e4325..a50011686 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-boolean-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-boolean-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnBoolean client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_boolean_column( +result: ColumnBoolean = tables_db.create_boolean_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.create_boolean_column( default = False, # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-datetime-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-datetime-column.md index 3f31d6380..1255834cd 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-datetime-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-datetime-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnDatetime client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_datetime_column( +result: ColumnDatetime = tables_db.create_datetime_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.create_datetime_column( default = '', # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-email-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-email-column.md index 263af1c16..b75bd4258 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-email-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-email-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnEmail client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_email_column( +result: ColumnEmail = tables_db.create_email_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.create_email_column( default = 'email@example.com', # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-enum-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-enum-column.md index 6f77c50ff..a5248b41f 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-enum-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-enum-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnEnum client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_enum_column( +result: ColumnEnum = tables_db.create_enum_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -18,4 +19,6 @@ result = tables_db.create_enum_column( default = '<DEFAULT>', # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-float-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-float-column.md index 05b1d966f..97f414b15 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-float-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-float-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnFloat client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_float_column( +result: ColumnFloat = tables_db.create_float_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -19,4 +20,6 @@ result = tables_db.create_float_column( default = None, # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-index.md b/examples/1.8.x/server-python/examples/tablesdb/create-index.md index ddf400dd3..acf0792c0 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-index.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-index.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnIndex from appwrite.enums import IndexType from appwrite.enums import OrderBy @@ -11,7 +12,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_index( +result: ColumnIndex = tables_db.create_index( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -20,4 +21,6 @@ result = tables_db.create_index( orders = [OrderBy.ASC], # optional lengths = [] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-integer-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-integer-column.md index 89e0162c6..35ccf4174 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-integer-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-integer-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnInteger client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_integer_column( +result: ColumnInteger = tables_db.create_integer_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -19,4 +20,6 @@ result = tables_db.create_integer_column( default = None, # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-ip-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-ip-column.md index 0528b577d..712166880 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-ip-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-ip-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnIp client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_ip_column( +result: ColumnIp = tables_db.create_ip_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.create_ip_column( default = '', # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-line-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-line-column.md index 3d99152ad..0173466e8 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-line-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-line-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnLine client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_line_column( +result: ColumnLine = tables_db.create_line_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', required = False, default = [[1, 2], [3, 4], [5, 6]] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-longtext-column.md index 65981d64b..29f20903e 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-longtext-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-longtext-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnLongtext client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_longtext_column( +result: ColumnLongtext = tables_db.create_longtext_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -18,4 +19,6 @@ result = tables_db.create_longtext_column( array = False, # optional encrypt = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-mediumtext-column.md index c731988e3..4cdc93baf 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-mediumtext-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-mediumtext-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnMediumtext client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_mediumtext_column( +result: ColumnMediumtext = tables_db.create_mediumtext_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -18,4 +19,6 @@ result = tables_db.create_mediumtext_column( array = False, # optional encrypt = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-operations.md b/examples/1.8.x/server-python/examples/tablesdb/create-operations.md index 780f08896..cb2a8c920 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-operations.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-operations.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Transaction client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_operations( +result: Transaction = tables_db.create_operations( transaction_id = '<TRANSACTION_ID>', operations = [ { @@ -23,4 +24,6 @@ result = tables_db.create_operations( } ] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-point-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-point-column.md index 311bea4cb..d5dbfce42 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-point-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-point-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnPoint client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_point_column( +result: ColumnPoint = tables_db.create_point_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', required = False, default = [1, 2] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-polygon-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-polygon-column.md index 9e72cdf66..a21f00a5c 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-polygon-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-polygon-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnPolygon client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_polygon_column( +result: ColumnPolygon = tables_db.create_polygon_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', required = False, default = [[[1, 2], [3, 4], [5, 6], [1, 2]]] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-relationship-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-relationship-column.md index 3248f0dde..0ec16dbe8 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-relationship-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-relationship-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnRelationship from appwrite.enums import RelationshipType from appwrite.enums import RelationMutate @@ -11,7 +12,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_relationship_column( +result: ColumnRelationship = tables_db.create_relationship_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', related_table_id = '<RELATED_TABLE_ID>', @@ -21,4 +22,6 @@ result = tables_db.create_relationship_column( two_way_key = '', # optional on_delete = RelationMutate.CASCADE # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-row.md b/examples/1.8.x/server-python/examples/tablesdb/create-row.md index bba8b95db..aa8a9fe67 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-row.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-row.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Row from appwrite.permission import Permission from appwrite.role import Role @@ -11,7 +12,7 @@ client.set_session('') # The user session to authenticate with tables_db = TablesDB(client) -result = tables_db.create_row( +result: Row = tables_db.create_row( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', row_id = '<ROW_ID>', @@ -25,4 +26,6 @@ result = tables_db.create_row( permissions = [Permission.read(Role.any())], # optional transaction_id = '<TRANSACTION_ID>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-rows.md b/examples/1.8.x/server-python/examples/tablesdb/create-rows.md index 40276d0c2..9e741fe4c 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-rows.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-rows.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import RowList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_rows( +result: RowList = tables_db.create_rows( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', rows = [], transaction_id = '<TRANSACTION_ID>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-string-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-string-column.md index 584944d2d..6dae7f9c4 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-string-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-string-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnString client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_string_column( +result: ColumnString = tables_db.create_string_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -19,4 +20,6 @@ result = tables_db.create_string_column( array = False, # optional encrypt = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-table.md b/examples/1.8.x/server-python/examples/tablesdb/create-table.md index d6b9c5f3d..029fb281e 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-table.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-table.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Table from appwrite.permission import Permission from appwrite.role import Role @@ -11,7 +12,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_table( +result: Table = tables_db.create_table( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', name = '<NAME>', @@ -21,4 +22,6 @@ result = tables_db.create_table( columns = [], # optional indexes = [] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-text-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-text-column.md index 013c6756e..5f8a94db5 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-text-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-text-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnText client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_text_column( +result: ColumnText = tables_db.create_text_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -18,4 +19,6 @@ result = tables_db.create_text_column( array = False, # optional encrypt = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-transaction.md b/examples/1.8.x/server-python/examples/tablesdb/create-transaction.md index 9fb96a088..b48e262fd 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-transaction.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-transaction.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Transaction client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_transaction( +result: Transaction = tables_db.create_transaction( ttl = 60 # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-url-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-url-column.md index 7daa52b5b..b37879ac2 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-url-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-url-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnUrl client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_url_column( +result: ColumnUrl = tables_db.create_url_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.create_url_column( default = 'https://example.com', # optional array = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-varchar-column.md index 981cf697f..02e041012 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create-varchar-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create-varchar-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnVarchar client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create_varchar_column( +result: ColumnVarchar = tables_db.create_varchar_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -19,4 +20,6 @@ result = tables_db.create_varchar_column( array = False, # optional encrypt = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create.md b/examples/1.8.x/server-python/examples/tablesdb/create.md index 7505f52a1..fb6bf0fb4 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/create.md +++ b/examples/1.8.x/server-python/examples/tablesdb/create.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Database client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.create( +result: Database = tables_db.create( database_id = '<DATABASE_ID>', name = '<NAME>', enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/decrement-row-column.md b/examples/1.8.x/server-python/examples/tablesdb/decrement-row-column.md index 56cbb2d80..f44790221 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/decrement-row-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/decrement-row-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Row client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_session('') # The user session to authenticate with tables_db = TablesDB(client) -result = tables_db.decrement_row_column( +result: Row = tables_db.decrement_row_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', row_id = '<ROW_ID>', @@ -18,4 +19,6 @@ result = tables_db.decrement_row_column( min = None, # optional transaction_id = '<TRANSACTION_ID>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/delete-rows.md b/examples/1.8.x/server-python/examples/tablesdb/delete-rows.md index 5164fc14c..2a3a89ca0 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/delete-rows.md +++ b/examples/1.8.x/server-python/examples/tablesdb/delete-rows.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import RowList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.delete_rows( +result: RowList = tables_db.delete_rows( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', queries = [], # optional transaction_id = '<TRANSACTION_ID>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/get-column.md b/examples/1.8.x/server-python/examples/tablesdb/get-column.md index 1d52922d0..77492464a 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/get-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/get-column.md @@ -1,6 +1,17 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnBoolean +from appwrite.models import ColumnInteger +from appwrite.models import ColumnFloat +from appwrite.models import ColumnEmail +from appwrite.models import ColumnEnum +from appwrite.models import ColumnUrl +from appwrite.models import ColumnIp +from appwrite.models import ColumnDatetime +from appwrite.models import ColumnRelationship +from appwrite.models import ColumnString +from typing import Union client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +20,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.get_column( +result: Union[ColumnBoolean, ColumnInteger, ColumnFloat, ColumnEmail, ColumnEnum, ColumnUrl, ColumnIp, ColumnDatetime, ColumnRelationship, ColumnString] = tables_db.get_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/get-index.md b/examples/1.8.x/server-python/examples/tablesdb/get-index.md index 006da0108..72c8e465d 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/get-index.md +++ b/examples/1.8.x/server-python/examples/tablesdb/get-index.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnIndex client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.get_index( +result: ColumnIndex = tables_db.get_index( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/get-row.md b/examples/1.8.x/server-python/examples/tablesdb/get-row.md index 6b10f3e2c..55609e257 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/get-row.md +++ b/examples/1.8.x/server-python/examples/tablesdb/get-row.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Row client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_session('') # The user session to authenticate with tables_db = TablesDB(client) -result = tables_db.get_row( +result: Row = tables_db.get_row( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', row_id = '<ROW_ID>', queries = [], # optional transaction_id = '<TRANSACTION_ID>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/get-table.md b/examples/1.8.x/server-python/examples/tablesdb/get-table.md index 6cd8f0617..da6a4bcb4 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/get-table.md +++ b/examples/1.8.x/server-python/examples/tablesdb/get-table.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Table client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.get_table( +result: Table = tables_db.get_table( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/get-transaction.md b/examples/1.8.x/server-python/examples/tablesdb/get-transaction.md index d2f4b7df0..b51fcc268 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/get-transaction.md +++ b/examples/1.8.x/server-python/examples/tablesdb/get-transaction.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Transaction client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.get_transaction( +result: Transaction = tables_db.get_transaction( transaction_id = '<TRANSACTION_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/get.md b/examples/1.8.x/server-python/examples/tablesdb/get.md index a3c0c216c..036deeec9 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/get.md +++ b/examples/1.8.x/server-python/examples/tablesdb/get.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Database client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.get( +result: Database = tables_db.get( database_id = '<DATABASE_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/increment-row-column.md b/examples/1.8.x/server-python/examples/tablesdb/increment-row-column.md index 75a9003b1..ac844f197 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/increment-row-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/increment-row-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Row client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_session('') # The user session to authenticate with tables_db = TablesDB(client) -result = tables_db.increment_row_column( +result: Row = tables_db.increment_row_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', row_id = '<ROW_ID>', @@ -18,4 +19,6 @@ result = tables_db.increment_row_column( max = None, # optional transaction_id = '<TRANSACTION_ID>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/list-columns.md b/examples/1.8.x/server-python/examples/tablesdb/list-columns.md index 36434877b..3a450487e 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/list-columns.md +++ b/examples/1.8.x/server-python/examples/tablesdb/list-columns.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.list_columns( +result: ColumnList = tables_db.list_columns( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/list-indexes.md b/examples/1.8.x/server-python/examples/tablesdb/list-indexes.md index 2263fc90f..b1ccf1a42 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/list-indexes.md +++ b/examples/1.8.x/server-python/examples/tablesdb/list-indexes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnIndexList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.list_indexes( +result: ColumnIndexList = tables_db.list_indexes( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/list-rows.md b/examples/1.8.x/server-python/examples/tablesdb/list-rows.md index 150ff6d59..0ef941040 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/server-python/examples/tablesdb/list-rows.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import RowList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,14 @@ client.set_session('') # The user session to authenticate with tables_db = TablesDB(client) -result = tables_db.list_rows( +result: RowList = tables_db.list_rows( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', queries = [], # optional transaction_id = '<TRANSACTION_ID>', # optional - total = False # optional + total = False, # optional + ttl = 0 # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/list-tables.md b/examples/1.8.x/server-python/examples/tablesdb/list-tables.md index 48937e8c5..589aaa989 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/list-tables.md +++ b/examples/1.8.x/server-python/examples/tablesdb/list-tables.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import TableList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.list_tables( +result: TableList = tables_db.list_tables( database_id = '<DATABASE_ID>', queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/list-transactions.md b/examples/1.8.x/server-python/examples/tablesdb/list-transactions.md index 6f8619925..b4384e67c 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/list-transactions.md +++ b/examples/1.8.x/server-python/examples/tablesdb/list-transactions.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import TransactionList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.list_transactions( +result: TransactionList = tables_db.list_transactions( queries = [] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/list.md b/examples/1.8.x/server-python/examples/tablesdb/list.md index d687a42ff..cfc352d1b 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/list.md +++ b/examples/1.8.x/server-python/examples/tablesdb/list.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import DatabaseList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.list( +result: DatabaseList = tables_db.list( queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-boolean-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-boolean-column.md index d140cc116..ce0a02d95 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-boolean-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-boolean-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnBoolean client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_boolean_column( +result: ColumnBoolean = tables_db.update_boolean_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.update_boolean_column( default = False, new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-datetime-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-datetime-column.md index 3e0955c9e..c525ace08 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-datetime-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-datetime-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnDatetime client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_datetime_column( +result: ColumnDatetime = tables_db.update_datetime_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.update_datetime_column( default = '', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-email-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-email-column.md index cd5a84be6..565b941e1 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-email-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-email-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnEmail client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_email_column( +result: ColumnEmail = tables_db.update_email_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.update_email_column( default = 'email@example.com', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-enum-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-enum-column.md index 612bdc825..4357a93d4 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-enum-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-enum-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnEnum client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_enum_column( +result: ColumnEnum = tables_db.update_enum_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -18,4 +19,6 @@ result = tables_db.update_enum_column( default = '<DEFAULT>', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-float-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-float-column.md index a622f8b49..339e9c8a2 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-float-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-float-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnFloat client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_float_column( +result: ColumnFloat = tables_db.update_float_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -19,4 +20,6 @@ result = tables_db.update_float_column( max = None, # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-integer-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-integer-column.md index 060d38d62..21a2b1c20 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-integer-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-integer-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnInteger client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_integer_column( +result: ColumnInteger = tables_db.update_integer_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -19,4 +20,6 @@ result = tables_db.update_integer_column( max = None, # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-ip-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-ip-column.md index 636ec3caf..cb7e18897 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-ip-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-ip-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnIp client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_ip_column( +result: ColumnIp = tables_db.update_ip_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.update_ip_column( default = '', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-line-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-line-column.md index d7b773953..c5bbb5d91 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-line-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-line-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnLine client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_line_column( +result: ColumnLine = tables_db.update_line_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.update_line_column( default = [[1, 2], [3, 4], [5, 6]], # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-longtext-column.md index 16deaeb90..8b31f1782 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-longtext-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-longtext-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnLongtext client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_longtext_column( +result: ColumnLongtext = tables_db.update_longtext_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.update_longtext_column( default = '<DEFAULT>', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-mediumtext-column.md index 18ac7ced2..ad4cdd40e 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-mediumtext-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-mediumtext-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnMediumtext client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_mediumtext_column( +result: ColumnMediumtext = tables_db.update_mediumtext_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.update_mediumtext_column( default = '<DEFAULT>', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-point-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-point-column.md index a75546ca1..5ab558463 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-point-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-point-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnPoint client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_point_column( +result: ColumnPoint = tables_db.update_point_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.update_point_column( default = [1, 2], # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-polygon-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-polygon-column.md index 33d3b2ac2..692a16c0f 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-polygon-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-polygon-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnPolygon client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_polygon_column( +result: ColumnPolygon = tables_db.update_polygon_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.update_polygon_column( default = [[[1, 2], [3, 4], [5, 6], [1, 2]]], # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-relationship-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-relationship-column.md index a10395d75..20307f6dd 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-relationship-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-relationship-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnRelationship from appwrite.enums import RelationMutate client = Client() @@ -10,11 +11,13 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_relationship_column( +result: ColumnRelationship = tables_db.update_relationship_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', on_delete = RelationMutate.CASCADE, # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-row.md b/examples/1.8.x/server-python/examples/tablesdb/update-row.md index 1cabdbeef..30522e7bc 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-row.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-row.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Row from appwrite.permission import Permission from appwrite.role import Role @@ -11,7 +12,7 @@ client.set_session('') # The user session to authenticate with tables_db = TablesDB(client) -result = tables_db.update_row( +result: Row = tables_db.update_row( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', row_id = '<ROW_ID>', @@ -25,4 +26,6 @@ result = tables_db.update_row( permissions = [Permission.read(Role.any())], # optional transaction_id = '<TRANSACTION_ID>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-rows.md b/examples/1.8.x/server-python/examples/tablesdb/update-rows.md index 0a7029193..dc3641b3e 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-rows.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-rows.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import RowList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_rows( +result: RowList = tables_db.update_rows( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', data = { @@ -22,4 +23,6 @@ result = tables_db.update_rows( queries = [], # optional transaction_id = '<TRANSACTION_ID>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-string-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-string-column.md index cbc8655bc..0fdc53c7d 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-string-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-string-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnString client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_string_column( +result: ColumnString = tables_db.update_string_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -18,4 +19,6 @@ result = tables_db.update_string_column( size = 1, # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-table.md b/examples/1.8.x/server-python/examples/tablesdb/update-table.md index d45df51a1..c8101558d 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-table.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-table.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Table from appwrite.permission import Permission from appwrite.role import Role @@ -11,7 +12,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_table( +result: Table = tables_db.update_table( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', name = '<NAME>', # optional @@ -19,4 +20,6 @@ result = tables_db.update_table( row_security = False, # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-text-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-text-column.md index 47cce30b0..3be554c1a 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-text-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-text-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnText client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_text_column( +result: ColumnText = tables_db.update_text_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.update_text_column( default = '<DEFAULT>', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-transaction.md b/examples/1.8.x/server-python/examples/tablesdb/update-transaction.md index c55340d75..999f53b18 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-transaction.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-transaction.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Transaction client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_transaction( +result: Transaction = tables_db.update_transaction( transaction_id = '<TRANSACTION_ID>', commit = False, # optional rollback = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-url-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-url-column.md index 1af172ce1..2d8626a2d 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-url-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-url-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnUrl client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_url_column( +result: ColumnUrl = tables_db.update_url_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -17,4 +18,6 @@ result = tables_db.update_url_column( default = 'https://example.com', new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-varchar-column.md index b1dc732d8..1a415b80a 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update-varchar-column.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update-varchar-column.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import ColumnVarchar client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update_varchar_column( +result: ColumnVarchar = tables_db.update_varchar_column( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', key = '', @@ -18,4 +19,6 @@ result = tables_db.update_varchar_column( size = 1, # optional new_key = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update.md b/examples/1.8.x/server-python/examples/tablesdb/update.md index 85b5c9633..aea548588 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/update.md +++ b/examples/1.8.x/server-python/examples/tablesdb/update.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Database client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.update( +result: Database = tables_db.update( database_id = '<DATABASE_ID>', name = '<NAME>', # optional enabled = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/upsert-row.md b/examples/1.8.x/server-python/examples/tablesdb/upsert-row.md index f985e84f5..c511545c3 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/upsert-row.md +++ b/examples/1.8.x/server-python/examples/tablesdb/upsert-row.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import Row from appwrite.permission import Permission from appwrite.role import Role @@ -11,7 +12,7 @@ client.set_session('') # The user session to authenticate with tables_db = TablesDB(client) -result = tables_db.upsert_row( +result: Row = tables_db.upsert_row( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', row_id = '<ROW_ID>', @@ -25,4 +26,6 @@ result = tables_db.upsert_row( permissions = [Permission.read(Role.any())], # optional transaction_id = '<TRANSACTION_ID>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/upsert-rows.md b/examples/1.8.x/server-python/examples/tablesdb/upsert-rows.md index d33971344..0b6a754e3 100644 --- a/examples/1.8.x/server-python/examples/tablesdb/upsert-rows.md +++ b/examples/1.8.x/server-python/examples/tablesdb/upsert-rows.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tables_db import TablesDB +from appwrite.models import RowList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tables_db = TablesDB(client) -result = tables_db.upsert_rows( +result: RowList = tables_db.upsert_rows( database_id = '<DATABASE_ID>', table_id = '<TABLE_ID>', rows = [], transaction_id = '<TRANSACTION_ID>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/teams/create-membership.md b/examples/1.8.x/server-python/examples/teams/create-membership.md index 71442d4f0..313bf5f6a 100644 --- a/examples/1.8.x/server-python/examples/teams/create-membership.md +++ b/examples/1.8.x/server-python/examples/teams/create-membership.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.teams import Teams +from appwrite.models import Membership client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.create_membership( +result: Membership = teams.create_membership( team_id = '<TEAM_ID>', roles = [], email = 'email@example.com', # optional @@ -18,4 +19,6 @@ result = teams.create_membership( url = 'https://example.com', # optional name = '<NAME>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/teams/create.md b/examples/1.8.x/server-python/examples/teams/create.md index d366d0569..965d854a2 100644 --- a/examples/1.8.x/server-python/examples/teams/create.md +++ b/examples/1.8.x/server-python/examples/teams/create.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.teams import Teams +from appwrite.models import Team client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.create( +result: Team = teams.create( team_id = '<TEAM_ID>', name = '<NAME>', roles = [] # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/teams/get-membership.md b/examples/1.8.x/server-python/examples/teams/get-membership.md index 91c5b2a63..54ad0cd34 100644 --- a/examples/1.8.x/server-python/examples/teams/get-membership.md +++ b/examples/1.8.x/server-python/examples/teams/get-membership.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.teams import Teams +from appwrite.models import Membership client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.get_membership( +result: Membership = teams.get_membership( team_id = '<TEAM_ID>', membership_id = '<MEMBERSHIP_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/teams/get-prefs.md b/examples/1.8.x/server-python/examples/teams/get-prefs.md index 8f41f631d..20ae59624 100644 --- a/examples/1.8.x/server-python/examples/teams/get-prefs.md +++ b/examples/1.8.x/server-python/examples/teams/get-prefs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.teams import Teams +from appwrite.models import Preferences client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.get_prefs( +result: Preferences = teams.get_prefs( team_id = '<TEAM_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/teams/get.md b/examples/1.8.x/server-python/examples/teams/get.md index 0f6d88093..3b5116c9e 100644 --- a/examples/1.8.x/server-python/examples/teams/get.md +++ b/examples/1.8.x/server-python/examples/teams/get.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.teams import Teams +from appwrite.models import Team client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.get( +result: Team = teams.get( team_id = '<TEAM_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/teams/list-memberships.md b/examples/1.8.x/server-python/examples/teams/list-memberships.md index 3e105ad27..8acc9d14b 100644 --- a/examples/1.8.x/server-python/examples/teams/list-memberships.md +++ b/examples/1.8.x/server-python/examples/teams/list-memberships.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.teams import Teams +from appwrite.models import MembershipList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.list_memberships( +result: MembershipList = teams.list_memberships( team_id = '<TEAM_ID>', queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/teams/list.md b/examples/1.8.x/server-python/examples/teams/list.md index 9c43f9edd..9fcd1ddb3 100644 --- a/examples/1.8.x/server-python/examples/teams/list.md +++ b/examples/1.8.x/server-python/examples/teams/list.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.teams import Teams +from appwrite.models import TeamList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.list( +result: TeamList = teams.list( queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/teams/update-membership-status.md b/examples/1.8.x/server-python/examples/teams/update-membership-status.md index 2d9d1f38a..b836d8204 100644 --- a/examples/1.8.x/server-python/examples/teams/update-membership-status.md +++ b/examples/1.8.x/server-python/examples/teams/update-membership-status.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.teams import Teams +from appwrite.models import Membership client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.update_membership_status( +result: Membership = teams.update_membership_status( team_id = '<TEAM_ID>', membership_id = '<MEMBERSHIP_ID>', user_id = '<USER_ID>', secret = '<SECRET>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/teams/update-membership.md b/examples/1.8.x/server-python/examples/teams/update-membership.md index bb10886f2..4425ae58d 100644 --- a/examples/1.8.x/server-python/examples/teams/update-membership.md +++ b/examples/1.8.x/server-python/examples/teams/update-membership.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.teams import Teams +from appwrite.models import Membership client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.update_membership( +result: Membership = teams.update_membership( team_id = '<TEAM_ID>', membership_id = '<MEMBERSHIP_ID>', roles = [] ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/teams/update-name.md b/examples/1.8.x/server-python/examples/teams/update-name.md index 893e3ed25..376d6c3fe 100644 --- a/examples/1.8.x/server-python/examples/teams/update-name.md +++ b/examples/1.8.x/server-python/examples/teams/update-name.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.teams import Teams +from appwrite.models import Team client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.update_name( +result: Team = teams.update_name( team_id = '<TEAM_ID>', name = '<NAME>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/teams/update-prefs.md b/examples/1.8.x/server-python/examples/teams/update-prefs.md index e4fb82287..23f487891 100644 --- a/examples/1.8.x/server-python/examples/teams/update-prefs.md +++ b/examples/1.8.x/server-python/examples/teams/update-prefs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.teams import Teams +from appwrite.models import Preferences client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.update_prefs( +result: Preferences = teams.update_prefs( team_id = '<TEAM_ID>', prefs = {} ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tokens/create-file-token.md b/examples/1.8.x/server-python/examples/tokens/create-file-token.md index fe05a6520..32dce32e8 100644 --- a/examples/1.8.x/server-python/examples/tokens/create-file-token.md +++ b/examples/1.8.x/server-python/examples/tokens/create-file-token.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tokens import Tokens +from appwrite.models import ResourceToken client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tokens = Tokens(client) -result = tokens.create_file_token( +result: ResourceToken = tokens.create_file_token( bucket_id = '<BUCKET_ID>', file_id = '<FILE_ID>', expire = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tokens/get.md b/examples/1.8.x/server-python/examples/tokens/get.md index aee3a97d3..83a9649a2 100644 --- a/examples/1.8.x/server-python/examples/tokens/get.md +++ b/examples/1.8.x/server-python/examples/tokens/get.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tokens import Tokens +from appwrite.models import ResourceToken client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tokens = Tokens(client) -result = tokens.get( +result: ResourceToken = tokens.get( token_id = '<TOKEN_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tokens/list.md b/examples/1.8.x/server-python/examples/tokens/list.md index 9464504c2..d5700165a 100644 --- a/examples/1.8.x/server-python/examples/tokens/list.md +++ b/examples/1.8.x/server-python/examples/tokens/list.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tokens import Tokens +from appwrite.models import ResourceTokenList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tokens = Tokens(client) -result = tokens.list( +result: ResourceTokenList = tokens.list( bucket_id = '<BUCKET_ID>', file_id = '<FILE_ID>', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/tokens/update.md b/examples/1.8.x/server-python/examples/tokens/update.md index abf544b32..4b57a606b 100644 --- a/examples/1.8.x/server-python/examples/tokens/update.md +++ b/examples/1.8.x/server-python/examples/tokens/update.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.tokens import Tokens +from appwrite.models import ResourceToken client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key tokens = Tokens(client) -result = tokens.update( +result: ResourceToken = tokens.update( token_id = '<TOKEN_ID>', expire = '' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-argon-2-user.md b/examples/1.8.x/server-python/examples/users/create-argon-2-user.md index a54b2c02a..cd3e2bc9e 100644 --- a/examples/1.8.x/server-python/examples/users/create-argon-2-user.md +++ b/examples/1.8.x/server-python/examples/users/create-argon-2-user.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_argon2_user( +result: User = users.create_argon2_user( user_id = '<USER_ID>', email = 'email@example.com', password = 'password', name = '<NAME>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-bcrypt-user.md b/examples/1.8.x/server-python/examples/users/create-bcrypt-user.md index 804181bdd..d3ab13e69 100644 --- a/examples/1.8.x/server-python/examples/users/create-bcrypt-user.md +++ b/examples/1.8.x/server-python/examples/users/create-bcrypt-user.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_bcrypt_user( +result: User = users.create_bcrypt_user( user_id = '<USER_ID>', email = 'email@example.com', password = 'password', name = '<NAME>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-jwt.md b/examples/1.8.x/server-python/examples/users/create-jwt.md index 1ccf47377..bf4df2e08 100644 --- a/examples/1.8.x/server-python/examples/users/create-jwt.md +++ b/examples/1.8.x/server-python/examples/users/create-jwt.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import Jwt client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_jwt( +result: Jwt = users.create_jwt( user_id = '<USER_ID>', session_id = '<SESSION_ID>', # optional duration = 0 # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-md-5-user.md b/examples/1.8.x/server-python/examples/users/create-md-5-user.md index f86991791..53b45bfed 100644 --- a/examples/1.8.x/server-python/examples/users/create-md-5-user.md +++ b/examples/1.8.x/server-python/examples/users/create-md-5-user.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_md5_user( +result: User = users.create_md5_user( user_id = '<USER_ID>', email = 'email@example.com', password = 'password', name = '<NAME>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-mfa-recovery-codes.md b/examples/1.8.x/server-python/examples/users/create-mfa-recovery-codes.md index d6da65bab..0c83df496 100644 --- a/examples/1.8.x/server-python/examples/users/create-mfa-recovery-codes.md +++ b/examples/1.8.x/server-python/examples/users/create-mfa-recovery-codes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import MfaRecoveryCodes client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_mfa_recovery_codes( +result: MfaRecoveryCodes = users.create_mfa_recovery_codes( user_id = '<USER_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-ph-pass-user.md b/examples/1.8.x/server-python/examples/users/create-ph-pass-user.md index c762b9820..456a04b00 100644 --- a/examples/1.8.x/server-python/examples/users/create-ph-pass-user.md +++ b/examples/1.8.x/server-python/examples/users/create-ph-pass-user.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_ph_pass_user( +result: User = users.create_ph_pass_user( user_id = '<USER_ID>', email = 'email@example.com', password = 'password', name = '<NAME>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-scrypt-modified-user.md b/examples/1.8.x/server-python/examples/users/create-scrypt-modified-user.md index 9a87d1438..e802270b7 100644 --- a/examples/1.8.x/server-python/examples/users/create-scrypt-modified-user.md +++ b/examples/1.8.x/server-python/examples/users/create-scrypt-modified-user.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_scrypt_modified_user( +result: User = users.create_scrypt_modified_user( user_id = '<USER_ID>', email = 'email@example.com', password = 'password', @@ -18,4 +19,6 @@ result = users.create_scrypt_modified_user( password_signer_key = '<PASSWORD_SIGNER_KEY>', name = '<NAME>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-scrypt-user.md b/examples/1.8.x/server-python/examples/users/create-scrypt-user.md index d83d951c4..db5618be9 100644 --- a/examples/1.8.x/server-python/examples/users/create-scrypt-user.md +++ b/examples/1.8.x/server-python/examples/users/create-scrypt-user.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_scrypt_user( +result: User = users.create_scrypt_user( user_id = '<USER_ID>', email = 'email@example.com', password = 'password', @@ -20,4 +21,6 @@ result = users.create_scrypt_user( password_length = None, name = '<NAME>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-session.md b/examples/1.8.x/server-python/examples/users/create-session.md index 0ab75f0a9..38a6dbccb 100644 --- a/examples/1.8.x/server-python/examples/users/create-session.md +++ b/examples/1.8.x/server-python/examples/users/create-session.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import Session client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_session( +result: Session = users.create_session( user_id = '<USER_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-sha-user.md b/examples/1.8.x/server-python/examples/users/create-sha-user.md index 674a4c2bf..9d42300a7 100644 --- a/examples/1.8.x/server-python/examples/users/create-sha-user.md +++ b/examples/1.8.x/server-python/examples/users/create-sha-user.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User from appwrite.enums import PasswordHash client = Client() @@ -10,11 +11,13 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_sha_user( +result: User = users.create_sha_user( user_id = '<USER_ID>', email = 'email@example.com', password = 'password', password_version = PasswordHash.SHA1, # optional name = '<NAME>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-target.md b/examples/1.8.x/server-python/examples/users/create-target.md index 030899422..fcfd394a3 100644 --- a/examples/1.8.x/server-python/examples/users/create-target.md +++ b/examples/1.8.x/server-python/examples/users/create-target.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import Target from appwrite.enums import MessagingProviderType client = Client() @@ -10,7 +11,7 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_target( +result: Target = users.create_target( user_id = '<USER_ID>', target_id = '<TARGET_ID>', provider_type = MessagingProviderType.EMAIL, @@ -18,4 +19,6 @@ result = users.create_target( provider_id = '<PROVIDER_ID>', # optional name = '<NAME>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create-token.md b/examples/1.8.x/server-python/examples/users/create-token.md index e4ac48a4c..d7520f5ef 100644 --- a/examples/1.8.x/server-python/examples/users/create-token.md +++ b/examples/1.8.x/server-python/examples/users/create-token.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import Token client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create_token( +result: Token = users.create_token( user_id = '<USER_ID>', length = 4, # optional expire = 60 # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/create.md b/examples/1.8.x/server-python/examples/users/create.md index 4ce1c2193..38361cbf5 100644 --- a/examples/1.8.x/server-python/examples/users/create.md +++ b/examples/1.8.x/server-python/examples/users/create.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.create( +result: User = users.create( user_id = '<USER_ID>', email = 'email@example.com', # optional phone = '+12065550100', # optional password = '', # optional name = '<NAME>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/get-mfa-recovery-codes.md b/examples/1.8.x/server-python/examples/users/get-mfa-recovery-codes.md index cf0d67cd6..058aedde1 100644 --- a/examples/1.8.x/server-python/examples/users/get-mfa-recovery-codes.md +++ b/examples/1.8.x/server-python/examples/users/get-mfa-recovery-codes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import MfaRecoveryCodes client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.get_mfa_recovery_codes( +result: MfaRecoveryCodes = users.get_mfa_recovery_codes( user_id = '<USER_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/get-prefs.md b/examples/1.8.x/server-python/examples/users/get-prefs.md index f95cc59df..093b92013 100644 --- a/examples/1.8.x/server-python/examples/users/get-prefs.md +++ b/examples/1.8.x/server-python/examples/users/get-prefs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import Preferences client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.get_prefs( +result: Preferences = users.get_prefs( user_id = '<USER_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/get-target.md b/examples/1.8.x/server-python/examples/users/get-target.md index 8fe84df7e..38a7d63d7 100644 --- a/examples/1.8.x/server-python/examples/users/get-target.md +++ b/examples/1.8.x/server-python/examples/users/get-target.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import Target client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.get_target( +result: Target = users.get_target( user_id = '<USER_ID>', target_id = '<TARGET_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/get.md b/examples/1.8.x/server-python/examples/users/get.md index 0cc21b64f..941d428ae 100644 --- a/examples/1.8.x/server-python/examples/users/get.md +++ b/examples/1.8.x/server-python/examples/users/get.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.get( +result: User = users.get( user_id = '<USER_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/list-identities.md b/examples/1.8.x/server-python/examples/users/list-identities.md index 2b19132c4..c6e7d8dcb 100644 --- a/examples/1.8.x/server-python/examples/users/list-identities.md +++ b/examples/1.8.x/server-python/examples/users/list-identities.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import IdentityList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.list_identities( +result: IdentityList = users.list_identities( queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/list-logs.md b/examples/1.8.x/server-python/examples/users/list-logs.md index 5604d4c18..34d41e757 100644 --- a/examples/1.8.x/server-python/examples/users/list-logs.md +++ b/examples/1.8.x/server-python/examples/users/list-logs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import LogList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.list_logs( +result: LogList = users.list_logs( user_id = '<USER_ID>', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/list-memberships.md b/examples/1.8.x/server-python/examples/users/list-memberships.md index 7f01abff8..c64d7ba55 100644 --- a/examples/1.8.x/server-python/examples/users/list-memberships.md +++ b/examples/1.8.x/server-python/examples/users/list-memberships.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import MembershipList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,10 +10,12 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.list_memberships( +result: MembershipList = users.list_memberships( user_id = '<USER_ID>', queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/list-mfa-factors.md b/examples/1.8.x/server-python/examples/users/list-mfa-factors.md index c5d285fae..69f5a56ff 100644 --- a/examples/1.8.x/server-python/examples/users/list-mfa-factors.md +++ b/examples/1.8.x/server-python/examples/users/list-mfa-factors.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import MfaFactors client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.list_mfa_factors( +result: MfaFactors = users.list_mfa_factors( user_id = '<USER_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/list-sessions.md b/examples/1.8.x/server-python/examples/users/list-sessions.md index 2b2970dbf..e8abced45 100644 --- a/examples/1.8.x/server-python/examples/users/list-sessions.md +++ b/examples/1.8.x/server-python/examples/users/list-sessions.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import SessionList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.list_sessions( +result: SessionList = users.list_sessions( user_id = '<USER_ID>', total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/list-targets.md b/examples/1.8.x/server-python/examples/users/list-targets.md index 394258313..e043866f3 100644 --- a/examples/1.8.x/server-python/examples/users/list-targets.md +++ b/examples/1.8.x/server-python/examples/users/list-targets.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import TargetList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.list_targets( +result: TargetList = users.list_targets( user_id = '<USER_ID>', queries = [], # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/list.md b/examples/1.8.x/server-python/examples/users/list.md index f16566dcd..0d623a776 100644 --- a/examples/1.8.x/server-python/examples/users/list.md +++ b/examples/1.8.x/server-python/examples/users/list.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import UserList client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,9 +10,11 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.list( +result: UserList = users.list( queries = [], # optional search = '<SEARCH>', # optional total = False # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-email-verification.md b/examples/1.8.x/server-python/examples/users/update-email-verification.md index e494f6431..8fd05134e 100644 --- a/examples/1.8.x/server-python/examples/users/update-email-verification.md +++ b/examples/1.8.x/server-python/examples/users/update-email-verification.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_email_verification( +result: User = users.update_email_verification( user_id = '<USER_ID>', email_verification = False ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-email.md b/examples/1.8.x/server-python/examples/users/update-email.md index 4434b6e4b..7dcf066f3 100644 --- a/examples/1.8.x/server-python/examples/users/update-email.md +++ b/examples/1.8.x/server-python/examples/users/update-email.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_email( +result: User = users.update_email( user_id = '<USER_ID>', email = 'email@example.com' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-labels.md b/examples/1.8.x/server-python/examples/users/update-labels.md index 23d9f6f25..bffba0c1e 100644 --- a/examples/1.8.x/server-python/examples/users/update-labels.md +++ b/examples/1.8.x/server-python/examples/users/update-labels.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_labels( +result: User = users.update_labels( user_id = '<USER_ID>', labels = [] ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-mfa-recovery-codes.md b/examples/1.8.x/server-python/examples/users/update-mfa-recovery-codes.md index 39e844206..c9090ee85 100644 --- a/examples/1.8.x/server-python/examples/users/update-mfa-recovery-codes.md +++ b/examples/1.8.x/server-python/examples/users/update-mfa-recovery-codes.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import MfaRecoveryCodes client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,7 +10,9 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_mfa_recovery_codes( +result: MfaRecoveryCodes = users.update_mfa_recovery_codes( user_id = '<USER_ID>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-mfa.md b/examples/1.8.x/server-python/examples/users/update-mfa.md index 0f92c2e92..4dda390c2 100644 --- a/examples/1.8.x/server-python/examples/users/update-mfa.md +++ b/examples/1.8.x/server-python/examples/users/update-mfa.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_mfa( +result: User = users.update_mfa( user_id = '<USER_ID>', mfa = False ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-name.md b/examples/1.8.x/server-python/examples/users/update-name.md index 5e9fc0021..248411be2 100644 --- a/examples/1.8.x/server-python/examples/users/update-name.md +++ b/examples/1.8.x/server-python/examples/users/update-name.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_name( +result: User = users.update_name( user_id = '<USER_ID>', name = '<NAME>' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-password.md b/examples/1.8.x/server-python/examples/users/update-password.md index 5d6bdc82a..2a0c93236 100644 --- a/examples/1.8.x/server-python/examples/users/update-password.md +++ b/examples/1.8.x/server-python/examples/users/update-password.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_password( +result: User = users.update_password( user_id = '<USER_ID>', password = '' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-phone-verification.md b/examples/1.8.x/server-python/examples/users/update-phone-verification.md index 4ee7d00f3..6b3120221 100644 --- a/examples/1.8.x/server-python/examples/users/update-phone-verification.md +++ b/examples/1.8.x/server-python/examples/users/update-phone-verification.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_phone_verification( +result: User = users.update_phone_verification( user_id = '<USER_ID>', phone_verification = False ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-phone.md b/examples/1.8.x/server-python/examples/users/update-phone.md index 1f963894a..82f8e15fe 100644 --- a/examples/1.8.x/server-python/examples/users/update-phone.md +++ b/examples/1.8.x/server-python/examples/users/update-phone.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_phone( +result: User = users.update_phone( user_id = '<USER_ID>', number = '+12065550100' ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-prefs.md b/examples/1.8.x/server-python/examples/users/update-prefs.md index ec2f0a403..6d1f043b1 100644 --- a/examples/1.8.x/server-python/examples/users/update-prefs.md +++ b/examples/1.8.x/server-python/examples/users/update-prefs.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import Preferences client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_prefs( +result: Preferences = users.update_prefs( user_id = '<USER_ID>', prefs = {} ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-status.md b/examples/1.8.x/server-python/examples/users/update-status.md index 28918bab5..fcf8d0e5e 100644 --- a/examples/1.8.x/server-python/examples/users/update-status.md +++ b/examples/1.8.x/server-python/examples/users/update-status.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import User client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,8 +10,10 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_status( +result: User = users.update_status( user_id = '<USER_ID>', status = False ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/users/update-target.md b/examples/1.8.x/server-python/examples/users/update-target.md index c1c30ed71..1a7c5f107 100644 --- a/examples/1.8.x/server-python/examples/users/update-target.md +++ b/examples/1.8.x/server-python/examples/users/update-target.md @@ -1,6 +1,7 @@ ```python from appwrite.client import Client from appwrite.services.users import Users +from appwrite.models import Target client = Client() client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint @@ -9,11 +10,13 @@ client.set_key('<YOUR_API_KEY>') # Your secret API key users = Users(client) -result = users.update_target( +result: Target = users.update_target( user_id = '<USER_ID>', target_id = '<TARGET_ID>', identifier = '<IDENTIFIER>', # optional provider_id = '<PROVIDER_ID>', # optional name = '<NAME>' # optional ) + +print(result.model_dump()) ``` diff --git a/examples/1.8.x/server-python/examples/webhooks/create.md b/examples/1.8.x/server-python/examples/webhooks/create.md new file mode 100644 index 000000000..11b15986d --- /dev/null +++ b/examples/1.8.x/server-python/examples/webhooks/create.md @@ -0,0 +1,25 @@ +```python +from appwrite.client import Client +from appwrite.services.webhooks import Webhooks +from appwrite.models import Webhook + +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 + +webhooks = Webhooks(client) + +result: Webhook = webhooks.create( + webhook_id = '<WEBHOOK_ID>', + url = '', + name = '<NAME>', + events = [], + enabled = False, # optional + security = False, # optional + http_user = '<HTTP_USER>', # optional + http_pass = '<HTTP_PASS>' # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.8.x/server-python/examples/webhooks/delete.md b/examples/1.8.x/server-python/examples/webhooks/delete.md new file mode 100644 index 000000000..1b6cbdb38 --- /dev/null +++ b/examples/1.8.x/server-python/examples/webhooks/delete.md @@ -0,0 +1,15 @@ +```python +from appwrite.client import Client +from appwrite.services.webhooks import Webhooks + +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 + +webhooks = Webhooks(client) + +result = webhooks.delete( + webhook_id = '<WEBHOOK_ID>' +) +``` diff --git a/examples/1.8.x/server-python/examples/webhooks/get.md b/examples/1.8.x/server-python/examples/webhooks/get.md new file mode 100644 index 000000000..e24808ce3 --- /dev/null +++ b/examples/1.8.x/server-python/examples/webhooks/get.md @@ -0,0 +1,18 @@ +```python +from appwrite.client import Client +from appwrite.services.webhooks import Webhooks +from appwrite.models import Webhook + +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 + +webhooks = Webhooks(client) + +result: Webhook = webhooks.get( + webhook_id = '<WEBHOOK_ID>' +) + +print(result.model_dump()) +``` diff --git a/examples/1.8.x/server-python/examples/webhooks/list.md b/examples/1.8.x/server-python/examples/webhooks/list.md new file mode 100644 index 000000000..0bb232043 --- /dev/null +++ b/examples/1.8.x/server-python/examples/webhooks/list.md @@ -0,0 +1,19 @@ +```python +from appwrite.client import Client +from appwrite.services.webhooks import Webhooks +from appwrite.models import WebhookList + +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 + +webhooks = Webhooks(client) + +result: WebhookList = webhooks.list( + queries = [], # optional + total = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.8.x/server-python/examples/webhooks/update-signature.md b/examples/1.8.x/server-python/examples/webhooks/update-signature.md new file mode 100644 index 000000000..94f739e82 --- /dev/null +++ b/examples/1.8.x/server-python/examples/webhooks/update-signature.md @@ -0,0 +1,18 @@ +```python +from appwrite.client import Client +from appwrite.services.webhooks import Webhooks +from appwrite.models import Webhook + +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 + +webhooks = Webhooks(client) + +result: Webhook = webhooks.update_signature( + webhook_id = '<WEBHOOK_ID>' +) + +print(result.model_dump()) +``` diff --git a/examples/1.8.x/server-python/examples/webhooks/update.md b/examples/1.8.x/server-python/examples/webhooks/update.md new file mode 100644 index 000000000..e13b05583 --- /dev/null +++ b/examples/1.8.x/server-python/examples/webhooks/update.md @@ -0,0 +1,25 @@ +```python +from appwrite.client import Client +from appwrite.services.webhooks import Webhooks +from appwrite.models import Webhook + +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 + +webhooks = Webhooks(client) + +result: Webhook = webhooks.update( + webhook_id = '<WEBHOOK_ID>', + name = '<NAME>', + url = '', + events = [], + enabled = False, # optional + security = False, # optional + http_user = '<HTTP_USER>', # optional + http_pass = '<HTTP_PASS>' # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.8.x/server-rest/examples/databases/update-relationship-attribute.md b/examples/1.8.x/server-rest/examples/databases/update-relationship-attribute.md index 8a04860ce..d7379c749 100644 --- a/examples/1.8.x/server-rest/examples/databases/update-relationship-attribute.md +++ b/examples/1.8.x/server-rest/examples/databases/update-relationship-attribute.md @@ -1,5 +1,5 @@ ```http -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship HTTP/1.1 +PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/relationship/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json X-Appwrite-Response-Format: 1.8.0 diff --git a/examples/1.8.x/server-rest/examples/functions/create.md b/examples/1.8.x/server-rest/examples/functions/create.md index f3a062bb0..8bb287036 100644 --- a/examples/1.8.x/server-rest/examples/functions/create.md +++ b/examples/1.8.x/server-rest/examples/functions/create.md @@ -24,6 +24,8 @@ X-Appwrite-Key: <YOUR_API_KEY> "providerBranch": "<PROVIDER_BRANCH>", "providerSilentMode": false, "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>", - "specification": "" + "buildSpecification": "", + "runtimeSpecification": "", + "deploymentRetention": 0 } ``` diff --git a/examples/1.8.x/server-rest/examples/functions/update.md b/examples/1.8.x/server-rest/examples/functions/update.md index fa16b581e..a2c548abe 100644 --- a/examples/1.8.x/server-rest/examples/functions/update.md +++ b/examples/1.8.x/server-rest/examples/functions/update.md @@ -23,6 +23,8 @@ X-Appwrite-Key: <YOUR_API_KEY> "providerBranch": "<PROVIDER_BRANCH>", "providerSilentMode": false, "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>", - "specification": "" + "buildSpecification": "", + "runtimeSpecification": "", + "deploymentRetention": 0 } ``` diff --git a/examples/1.8.x/server-rest/examples/sites/create.md b/examples/1.8.x/server-rest/examples/sites/create.md index 7de649311..fc586c410 100644 --- a/examples/1.8.x/server-rest/examples/sites/create.md +++ b/examples/1.8.x/server-rest/examples/sites/create.md @@ -15,6 +15,7 @@ X-Appwrite-Key: <YOUR_API_KEY> "timeout": 1, "installCommand": "<INSTALL_COMMAND>", "buildCommand": "<BUILD_COMMAND>", + "startCommand": "<START_COMMAND>", "outputDirectory": "<OUTPUT_DIRECTORY>", "buildRuntime": "node-14.5", "adapter": "static", @@ -24,6 +25,8 @@ X-Appwrite-Key: <YOUR_API_KEY> "providerBranch": "<PROVIDER_BRANCH>", "providerSilentMode": false, "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>", - "specification": "" + "buildSpecification": "", + "runtimeSpecification": "", + "deploymentRetention": 0 } ``` diff --git a/examples/1.8.x/server-rest/examples/sites/update.md b/examples/1.8.x/server-rest/examples/sites/update.md index 7d79e83dc..e799ce827 100644 --- a/examples/1.8.x/server-rest/examples/sites/update.md +++ b/examples/1.8.x/server-rest/examples/sites/update.md @@ -14,6 +14,7 @@ X-Appwrite-Key: <YOUR_API_KEY> "timeout": 1, "installCommand": "<INSTALL_COMMAND>", "buildCommand": "<BUILD_COMMAND>", + "startCommand": "<START_COMMAND>", "outputDirectory": "<OUTPUT_DIRECTORY>", "buildRuntime": "node-14.5", "adapter": "static", @@ -23,6 +24,8 @@ X-Appwrite-Key: <YOUR_API_KEY> "providerBranch": "<PROVIDER_BRANCH>", "providerSilentMode": false, "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>", - "specification": "" + "buildSpecification": "", + "runtimeSpecification": "", + "deploymentRetention": 0 } ``` diff --git a/examples/1.8.x/server-rest/examples/webhooks/create.md b/examples/1.8.x/server-rest/examples/webhooks/create.md new file mode 100644 index 000000000..2442842d1 --- /dev/null +++ b/examples/1.8.x/server-rest/examples/webhooks/create.md @@ -0,0 +1,19 @@ +```http +POST /v1/webhooks HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.8.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "webhookId": "<WEBHOOK_ID>", + "url": "", + "name": "<NAME>", + "events": [], + "enabled": false, + "security": false, + "httpUser": "<HTTP_USER>", + "httpPass": "<HTTP_PASS>" +} +``` diff --git a/examples/1.8.x/server-rest/examples/webhooks/delete.md b/examples/1.8.x/server-rest/examples/webhooks/delete.md new file mode 100644 index 000000000..22b60dba7 --- /dev/null +++ b/examples/1.8.x/server-rest/examples/webhooks/delete.md @@ -0,0 +1,9 @@ +```http +DELETE /v1/webhooks/{webhookId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.8.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +``` diff --git a/examples/1.8.x/server-rest/examples/webhooks/get.md b/examples/1.8.x/server-rest/examples/webhooks/get.md new file mode 100644 index 000000000..86034bcdd --- /dev/null +++ b/examples/1.8.x/server-rest/examples/webhooks/get.md @@ -0,0 +1,7 @@ +```http +GET /v1/webhooks/{webhookId} HTTP/1.1 +Host: cloud.appwrite.io +X-Appwrite-Response-Format: 1.8.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> +``` diff --git a/examples/1.8.x/server-rest/examples/webhooks/list.md b/examples/1.8.x/server-rest/examples/webhooks/list.md new file mode 100644 index 000000000..df0a7159d --- /dev/null +++ b/examples/1.8.x/server-rest/examples/webhooks/list.md @@ -0,0 +1,7 @@ +```http +GET /v1/webhooks HTTP/1.1 +Host: cloud.appwrite.io +X-Appwrite-Response-Format: 1.8.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> +``` diff --git a/examples/1.8.x/server-rest/examples/webhooks/update-signature.md b/examples/1.8.x/server-rest/examples/webhooks/update-signature.md new file mode 100644 index 000000000..5099005da --- /dev/null +++ b/examples/1.8.x/server-rest/examples/webhooks/update-signature.md @@ -0,0 +1,9 @@ +```http +PATCH /v1/webhooks/{webhookId}/signature HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.8.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +``` diff --git a/examples/1.8.x/server-rest/examples/webhooks/update.md b/examples/1.8.x/server-rest/examples/webhooks/update.md new file mode 100644 index 000000000..b13c97b67 --- /dev/null +++ b/examples/1.8.x/server-rest/examples/webhooks/update.md @@ -0,0 +1,18 @@ +```http +PUT /v1/webhooks/{webhookId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.8.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "url": "", + "events": [], + "enabled": false, + "security": false, + "httpUser": "<HTTP_USER>", + "httpPass": "<HTTP_PASS>" +} +``` diff --git a/examples/1.8.x/server-ruby/examples/databases/list-documents.md b/examples/1.8.x/server-ruby/examples/databases/list-documents.md index 78a34ce74..0e471e298 100644 --- a/examples/1.8.x/server-ruby/examples/databases/list-documents.md +++ b/examples/1.8.x/server-ruby/examples/databases/list-documents.md @@ -15,6 +15,7 @@ result = databases.list_documents( collection_id: '<COLLECTION_ID>', queries: [], # optional transaction_id: '<TRANSACTION_ID>', # optional - total: false # optional + total: false, # optional + ttl: 0 # optional ) ``` diff --git a/examples/1.8.x/server-ruby/examples/functions/create.md b/examples/1.8.x/server-ruby/examples/functions/create.md index c9358a758..ee2b47929 100644 --- a/examples/1.8.x/server-ruby/examples/functions/create.md +++ b/examples/1.8.x/server-ruby/examples/functions/create.md @@ -29,6 +29,8 @@ result = functions.create( provider_branch: '<PROVIDER_BRANCH>', # optional provider_silent_mode: false, # optional provider_root_directory: '<PROVIDER_ROOT_DIRECTORY>', # optional - specification: '' # optional + build_specification: '', # optional + runtime_specification: '', # optional + deployment_retention: 0 # optional ) ``` diff --git a/examples/1.8.x/server-ruby/examples/functions/update.md b/examples/1.8.x/server-ruby/examples/functions/update.md index e06c276d2..8e883a543 100644 --- a/examples/1.8.x/server-ruby/examples/functions/update.md +++ b/examples/1.8.x/server-ruby/examples/functions/update.md @@ -29,6 +29,8 @@ result = functions.update( provider_branch: '<PROVIDER_BRANCH>', # optional provider_silent_mode: false, # optional provider_root_directory: '<PROVIDER_ROOT_DIRECTORY>', # optional - specification: '' # optional + build_specification: '', # optional + runtime_specification: '', # optional + deployment_retention: 0 # optional ) ``` diff --git a/examples/1.8.x/server-ruby/examples/sites/create-deployment.md b/examples/1.8.x/server-ruby/examples/sites/create-deployment.md index ab971341c..14bb26adb 100644 --- a/examples/1.8.x/server-ruby/examples/sites/create-deployment.md +++ b/examples/1.8.x/server-ruby/examples/sites/create-deployment.md @@ -13,9 +13,9 @@ sites = Sites.new(client) result = sites.create_deployment( site_id: '<SITE_ID>', code: InputFile.from_path('dir/file.png'), - activate: false, install_command: '<INSTALL_COMMAND>', # optional build_command: '<BUILD_COMMAND>', # optional - output_directory: '<OUTPUT_DIRECTORY>' # optional + output_directory: '<OUTPUT_DIRECTORY>', # optional + activate: false # optional ) ``` diff --git a/examples/1.8.x/server-ruby/examples/sites/create.md b/examples/1.8.x/server-ruby/examples/sites/create.md index 8177d7d7f..eb28cbfee 100644 --- a/examples/1.8.x/server-ruby/examples/sites/create.md +++ b/examples/1.8.x/server-ruby/examples/sites/create.md @@ -21,6 +21,7 @@ result = sites.create( timeout: 1, # optional install_command: '<INSTALL_COMMAND>', # optional build_command: '<BUILD_COMMAND>', # optional + start_command: '<START_COMMAND>', # optional output_directory: '<OUTPUT_DIRECTORY>', # optional adapter: Adapter::STATIC, # optional installation_id: '<INSTALLATION_ID>', # optional @@ -29,6 +30,8 @@ result = sites.create( provider_branch: '<PROVIDER_BRANCH>', # optional provider_silent_mode: false, # optional provider_root_directory: '<PROVIDER_ROOT_DIRECTORY>', # optional - specification: '' # optional + build_specification: '', # optional + runtime_specification: '', # optional + deployment_retention: 0 # optional ) ``` diff --git a/examples/1.8.x/server-ruby/examples/sites/update.md b/examples/1.8.x/server-ruby/examples/sites/update.md index de544d449..2476c3caa 100644 --- a/examples/1.8.x/server-ruby/examples/sites/update.md +++ b/examples/1.8.x/server-ruby/examples/sites/update.md @@ -20,6 +20,7 @@ result = sites.update( timeout: 1, # optional install_command: '<INSTALL_COMMAND>', # optional build_command: '<BUILD_COMMAND>', # optional + start_command: '<START_COMMAND>', # optional output_directory: '<OUTPUT_DIRECTORY>', # optional build_runtime: BuildRuntime::NODE_14_5, # optional adapter: Adapter::STATIC, # optional @@ -29,6 +30,8 @@ result = sites.update( provider_branch: '<PROVIDER_BRANCH>', # optional provider_silent_mode: false, # optional provider_root_directory: '<PROVIDER_ROOT_DIRECTORY>', # optional - specification: '' # optional + build_specification: '', # optional + runtime_specification: '', # optional + deployment_retention: 0 # optional ) ``` diff --git a/examples/1.8.x/server-ruby/examples/tablesdb/list-rows.md b/examples/1.8.x/server-ruby/examples/tablesdb/list-rows.md index 3c0c6c671..6d5669317 100644 --- a/examples/1.8.x/server-ruby/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/server-ruby/examples/tablesdb/list-rows.md @@ -15,6 +15,7 @@ result = tables_db.list_rows( table_id: '<TABLE_ID>', queries: [], # optional transaction_id: '<TRANSACTION_ID>', # optional - total: false # optional + total: false, # optional + ttl: 0 # optional ) ``` diff --git a/examples/1.8.x/server-ruby/examples/webhooks/create.md b/examples/1.8.x/server-ruby/examples/webhooks/create.md new file mode 100644 index 000000000..7989c8b05 --- /dev/null +++ b/examples/1.8.x/server-ruby/examples/webhooks/create.md @@ -0,0 +1,23 @@ +```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 + +webhooks = Webhooks.new(client) + +result = webhooks.create( + webhook_id: '<WEBHOOK_ID>', + url: '', + name: '<NAME>', + events: [], + enabled: false, # optional + security: false, # optional + http_user: '<HTTP_USER>', # optional + http_pass: '<HTTP_PASS>' # optional +) +``` diff --git a/examples/1.8.x/server-ruby/examples/webhooks/delete.md b/examples/1.8.x/server-ruby/examples/webhooks/delete.md new file mode 100644 index 000000000..5951b7cab --- /dev/null +++ b/examples/1.8.x/server-ruby/examples/webhooks/delete.md @@ -0,0 +1,16 @@ +```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 + +webhooks = Webhooks.new(client) + +result = webhooks.delete( + webhook_id: '<WEBHOOK_ID>' +) +``` diff --git a/examples/1.8.x/server-ruby/examples/webhooks/get.md b/examples/1.8.x/server-ruby/examples/webhooks/get.md new file mode 100644 index 000000000..d81c12995 --- /dev/null +++ b/examples/1.8.x/server-ruby/examples/webhooks/get.md @@ -0,0 +1,16 @@ +```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 + +webhooks = Webhooks.new(client) + +result = webhooks.get( + webhook_id: '<WEBHOOK_ID>' +) +``` diff --git a/examples/1.8.x/server-ruby/examples/webhooks/list.md b/examples/1.8.x/server-ruby/examples/webhooks/list.md new file mode 100644 index 000000000..541604073 --- /dev/null +++ b/examples/1.8.x/server-ruby/examples/webhooks/list.md @@ -0,0 +1,17 @@ +```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 + +webhooks = Webhooks.new(client) + +result = webhooks.list( + queries: [], # optional + total: false # optional +) +``` diff --git a/examples/1.8.x/server-ruby/examples/webhooks/update-signature.md b/examples/1.8.x/server-ruby/examples/webhooks/update-signature.md new file mode 100644 index 000000000..11acf672e --- /dev/null +++ b/examples/1.8.x/server-ruby/examples/webhooks/update-signature.md @@ -0,0 +1,16 @@ +```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 + +webhooks = Webhooks.new(client) + +result = webhooks.update_signature( + webhook_id: '<WEBHOOK_ID>' +) +``` diff --git a/examples/1.8.x/server-ruby/examples/webhooks/update.md b/examples/1.8.x/server-ruby/examples/webhooks/update.md new file mode 100644 index 000000000..51567d553 --- /dev/null +++ b/examples/1.8.x/server-ruby/examples/webhooks/update.md @@ -0,0 +1,23 @@ +```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 + +webhooks = Webhooks.new(client) + +result = webhooks.update( + webhook_id: '<WEBHOOK_ID>', + name: '<NAME>', + url: '', + events: [], + enabled: false, # optional + security: false, # optional + http_user: '<HTTP_USER>', # optional + http_pass: '<HTTP_PASS>' # optional +) +``` diff --git a/examples/1.8.x/server-swift/examples/databases/list-documents.md b/examples/1.8.x/server-swift/examples/databases/list-documents.md index 2d61a8437..75ef8c7b8 100644 --- a/examples/1.8.x/server-swift/examples/databases/list-documents.md +++ b/examples/1.8.x/server-swift/examples/databases/list-documents.md @@ -13,7 +13,8 @@ let documentList = try await databases.listDocuments( collectionId: "<COLLECTION_ID>", queries: [], // optional transactionId: "<TRANSACTION_ID>", // optional - total: false // optional + total: false, // optional + ttl: 0 // optional ) ``` diff --git a/examples/1.8.x/server-swift/examples/functions/create.md b/examples/1.8.x/server-swift/examples/functions/create.md index 553f8f878..f64aad770 100644 --- a/examples/1.8.x/server-swift/examples/functions/create.md +++ b/examples/1.8.x/server-swift/examples/functions/create.md @@ -27,7 +27,9 @@ let function = try await functions.create( providerBranch: "<PROVIDER_BRANCH>", // optional providerSilentMode: false, // optional providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", // optional - specification: "" // optional + buildSpecification: "", // optional + runtimeSpecification: "", // optional + deploymentRetention: 0 // optional ) ``` diff --git a/examples/1.8.x/server-swift/examples/functions/update.md b/examples/1.8.x/server-swift/examples/functions/update.md index 27c1765e9..69d2f2bff 100644 --- a/examples/1.8.x/server-swift/examples/functions/update.md +++ b/examples/1.8.x/server-swift/examples/functions/update.md @@ -27,7 +27,9 @@ let function = try await functions.update( providerBranch: "<PROVIDER_BRANCH>", // optional providerSilentMode: false, // optional providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", // optional - specification: "" // optional + buildSpecification: "", // optional + runtimeSpecification: "", // optional + deploymentRetention: 0 // optional ) ``` diff --git a/examples/1.8.x/server-swift/examples/sites/create-deployment.md b/examples/1.8.x/server-swift/examples/sites/create-deployment.md index 5d44fe2de..9dd28d874 100644 --- a/examples/1.8.x/server-swift/examples/sites/create-deployment.md +++ b/examples/1.8.x/server-swift/examples/sites/create-deployment.md @@ -11,10 +11,10 @@ let sites = Sites(client) let deployment = try await sites.createDeployment( siteId: "<SITE_ID>", code: InputFile.fromPath("file.png"), - activate: false, installCommand: "<INSTALL_COMMAND>", // optional buildCommand: "<BUILD_COMMAND>", // optional - outputDirectory: "<OUTPUT_DIRECTORY>" // optional + outputDirectory: "<OUTPUT_DIRECTORY>", // optional + activate: false // optional ) ``` diff --git a/examples/1.8.x/server-swift/examples/sites/create.md b/examples/1.8.x/server-swift/examples/sites/create.md index 0f3342740..86334cf3e 100644 --- a/examples/1.8.x/server-swift/examples/sites/create.md +++ b/examples/1.8.x/server-swift/examples/sites/create.md @@ -19,6 +19,7 @@ let site = try await sites.create( timeout: 1, // optional installCommand: "<INSTALL_COMMAND>", // optional buildCommand: "<BUILD_COMMAND>", // optional + startCommand: "<START_COMMAND>", // optional outputDirectory: "<OUTPUT_DIRECTORY>", // optional adapter: .static, // optional installationId: "<INSTALLATION_ID>", // optional @@ -27,7 +28,9 @@ let site = try await sites.create( providerBranch: "<PROVIDER_BRANCH>", // optional providerSilentMode: false, // optional providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", // optional - specification: "" // optional + buildSpecification: "", // optional + runtimeSpecification: "", // optional + deploymentRetention: 0 // optional ) ``` diff --git a/examples/1.8.x/server-swift/examples/sites/update.md b/examples/1.8.x/server-swift/examples/sites/update.md index 6958fb3d7..074e24fb3 100644 --- a/examples/1.8.x/server-swift/examples/sites/update.md +++ b/examples/1.8.x/server-swift/examples/sites/update.md @@ -18,6 +18,7 @@ let site = try await sites.update( timeout: 1, // optional installCommand: "<INSTALL_COMMAND>", // optional buildCommand: "<BUILD_COMMAND>", // optional + startCommand: "<START_COMMAND>", // optional outputDirectory: "<OUTPUT_DIRECTORY>", // optional buildRuntime: .node145, // optional adapter: .static, // optional @@ -27,7 +28,9 @@ let site = try await sites.update( providerBranch: "<PROVIDER_BRANCH>", // optional providerSilentMode: false, // optional providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", // optional - specification: "" // optional + buildSpecification: "", // optional + runtimeSpecification: "", // optional + deploymentRetention: 0 // optional ) ``` diff --git a/examples/1.8.x/server-swift/examples/tablesdb/list-rows.md b/examples/1.8.x/server-swift/examples/tablesdb/list-rows.md index 110c159e0..6be251796 100644 --- a/examples/1.8.x/server-swift/examples/tablesdb/list-rows.md +++ b/examples/1.8.x/server-swift/examples/tablesdb/list-rows.md @@ -13,7 +13,8 @@ let rowList = try await tablesDB.listRows( tableId: "<TABLE_ID>", queries: [], // optional transactionId: "<TRANSACTION_ID>", // optional - total: false // optional + total: false, // optional + ttl: 0 // optional ) ``` diff --git a/examples/1.8.x/server-swift/examples/webhooks/create.md b/examples/1.8.x/server-swift/examples/webhooks/create.md new file mode 100644 index 000000000..4956ac74f --- /dev/null +++ b/examples/1.8.x/server-swift/examples/webhooks/create.md @@ -0,0 +1,22 @@ +```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 webhooks = Webhooks(client) + +let webhook = try await webhooks.create( + webhookId: "<WEBHOOK_ID>", + url: "", + name: "<NAME>", + events: [], + enabled: false, // optional + security: false, // optional + httpUser: "<HTTP_USER>", // optional + httpPass: "<HTTP_PASS>" // optional +) + +``` diff --git a/examples/1.8.x/server-swift/examples/webhooks/delete.md b/examples/1.8.x/server-swift/examples/webhooks/delete.md new file mode 100644 index 000000000..337c001cd --- /dev/null +++ b/examples/1.8.x/server-swift/examples/webhooks/delete.md @@ -0,0 +1,15 @@ +```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 webhooks = Webhooks(client) + +let result = try await webhooks.delete( + webhookId: "<WEBHOOK_ID>" +) + +``` diff --git a/examples/1.8.x/server-swift/examples/webhooks/get.md b/examples/1.8.x/server-swift/examples/webhooks/get.md new file mode 100644 index 000000000..7710218d7 --- /dev/null +++ b/examples/1.8.x/server-swift/examples/webhooks/get.md @@ -0,0 +1,15 @@ +```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 webhooks = Webhooks(client) + +let webhook = try await webhooks.get( + webhookId: "<WEBHOOK_ID>" +) + +``` diff --git a/examples/1.8.x/server-swift/examples/webhooks/list.md b/examples/1.8.x/server-swift/examples/webhooks/list.md new file mode 100644 index 000000000..d6dbf7713 --- /dev/null +++ b/examples/1.8.x/server-swift/examples/webhooks/list.md @@ -0,0 +1,16 @@ +```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 webhooks = Webhooks(client) + +let webhookList = try await webhooks.list( + queries: [], // optional + total: false // optional +) + +``` diff --git a/examples/1.8.x/server-swift/examples/webhooks/update-signature.md b/examples/1.8.x/server-swift/examples/webhooks/update-signature.md new file mode 100644 index 000000000..7dba9f7e6 --- /dev/null +++ b/examples/1.8.x/server-swift/examples/webhooks/update-signature.md @@ -0,0 +1,15 @@ +```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 webhooks = Webhooks(client) + +let webhook = try await webhooks.updateSignature( + webhookId: "<WEBHOOK_ID>" +) + +``` diff --git a/examples/1.8.x/server-swift/examples/webhooks/update.md b/examples/1.8.x/server-swift/examples/webhooks/update.md new file mode 100644 index 000000000..55566e3c0 --- /dev/null +++ b/examples/1.8.x/server-swift/examples/webhooks/update.md @@ -0,0 +1,22 @@ +```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 webhooks = Webhooks(client) + +let webhook = try await webhooks.update( + webhookId: "<WEBHOOK_ID>", + name: "<NAME>", + url: "", + events: [], + enabled: false, // optional + security: false, // optional + httpUser: "<HTTP_USER>", // optional + httpPass: "<HTTP_PASS>" // optional +) + +``` diff --git a/specs/1.8.x/open-api3-1.8.x-client.json b/specs/1.8.x/open-api3-1.8.x-client.json index 0b5a59cb2..655ae7b16 100644 --- a/specs/1.8.x/open-api3-1.8.x-client.json +++ b/specs/1.8.x/open-api3-1.8.x-client.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "version": "1.8.1", + "version": "1.8.2", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -555,7 +555,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 239, + "weight": 217, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -627,7 +627,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 241, + "weight": 219, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -751,7 +751,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 242, + "weight": 220, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -891,7 +891,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 243, + "weight": 221, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1015,7 +1015,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 247, + "weight": 225, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1149,7 +1149,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 248, + "weight": 226, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1287,7 +1287,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 240, + "weight": 218, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1388,7 +1388,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 246, + "weight": 224, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1487,7 +1487,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 244, + "weight": 222, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1586,7 +1586,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 245, + "weight": 223, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -4051,7 +4051,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 250, + "weight": 228, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4179,7 +4179,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 249, + "weight": 227, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4313,7 +4313,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 253, + "weight": 231, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4373,7 +4373,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 251, + "weight": 229, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4863,7 +4863,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 252, + "weight": 230, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4947,7 +4947,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 255, + "weight": 233, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5041,7 +5041,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 254, + "weight": 232, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5135,7 +5135,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 256, + "weight": 234, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5888,7 +5888,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 332, + "weight": 310, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -5955,7 +5955,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 328, + "weight": 306, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6026,7 +6026,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 329, + "weight": 307, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6090,7 +6090,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 330, + "weight": 308, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6168,7 +6168,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 331, + "weight": 309, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6234,7 +6234,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 333, + "weight": 311, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6319,7 +6319,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 283, + "weight": 261, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -6405,6 +6405,18 @@ "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" } ] }, @@ -6431,7 +6443,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 275, + "weight": 253, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -6592,7 +6604,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 276, + "weight": 254, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -6703,7 +6715,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 279, + "weight": 257, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -6858,7 +6870,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 277, + "weight": 255, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -6970,7 +6982,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 281, + "weight": 259, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -7077,7 +7089,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 286, + "weight": 264, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -7206,7 +7218,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 285, + "weight": 263, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -7335,7 +7347,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 577, + "weight": 417, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -7422,7 +7434,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 575, + "weight": 415, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -7540,7 +7552,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 576, + "weight": 416, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -7615,7 +7627,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 176, + "weight": 154, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -7669,7 +7681,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 175, + "weight": 153, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -8155,7 +8167,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 223, + "weight": 201, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -8239,7 +8251,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 227, + "weight": 205, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -8315,7 +8327,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 535, + "weight": 527, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -8414,7 +8426,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 781, + "weight": 734, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -8516,7 +8528,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 534, + "weight": 526, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -8590,7 +8602,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 536, + "weight": 528, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -8682,7 +8694,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 537, + "weight": 529, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -8751,7 +8763,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 539, + "weight": 531, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -8831,7 +8843,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 538, + "weight": 530, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -9061,7 +9073,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 540, + "weight": 532, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -9148,7 +9160,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 405, + "weight": 383, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -9218,7 +9230,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 401, + "weight": 379, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -9292,7 +9304,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 402, + "weight": 380, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -9359,7 +9371,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 403, + "weight": 381, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -9440,7 +9452,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 404, + "weight": 382, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -9509,7 +9521,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 406, + "weight": 384, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -9597,7 +9609,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 397, + "weight": 375, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -9682,6 +9694,18 @@ "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" } ] }, @@ -9708,7 +9732,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 389, + "weight": 367, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -9864,7 +9888,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 390, + "weight": 368, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -9974,7 +9998,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 393, + "weight": 371, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -10124,7 +10148,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 391, + "weight": 369, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -10235,7 +10259,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 395, + "weight": 373, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -10341,7 +10365,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 400, + "weight": 378, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -10469,7 +10493,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 399, + "weight": 377, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -10597,7 +10621,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 107, + "weight": 503, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -10686,7 +10710,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 106, + "weight": 501, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -10773,7 +10797,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 108, + "weight": 502, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -10837,7 +10861,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 110, + "weight": 505, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -10913,7 +10937,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 112, + "weight": 504, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -10979,7 +11003,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 114, + "weight": 510, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -11078,7 +11102,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 113, + "weight": 508, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -11143,7 +11167,7 @@ }, "roles": { "type": "array", - "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "x-example": null, "items": { "type": "string" @@ -11194,7 +11218,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 115, + "weight": 509, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -11246,7 +11270,7 @@ ] }, "patch": { - "summary": "Update membership", + "summary": "Update team membership", "operationId": "teamsUpdateMembership", "tags": [ "teams" @@ -11268,7 +11292,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 116, + "weight": 511, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -11326,7 +11350,7 @@ "properties": { "roles": { "type": "array", - "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "x-example": null, "items": { "type": "string" @@ -11356,8 +11380,8 @@ "deprecated": false, "x-appwrite": { "method": "deleteMembership", - "group": null, - "weight": 555, + "group": "memberships", + "weight": 735, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -11433,7 +11457,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 117, + "weight": 513, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -11533,7 +11557,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 109, + "weight": 506, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -11574,7 +11598,7 @@ ] }, "put": { - "summary": "Update preferences", + "summary": "Update team preferences", "operationId": "teamsUpdatePrefs", "tags": [ "teams" @@ -11596,7 +11620,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 111, + "weight": 507, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -12236,8 +12260,8 @@ }, "$sequence": { "type": "integer", - "description": "Row automatically incrementing ID.", - "x-example": 1, + "description": "Row sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -12286,7 +12310,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$tableId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -12307,8 +12331,8 @@ }, "$sequence": { "type": "integer", - "description": "Document automatically incrementing ID.", - "x-example": 1, + "description": "Document sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -12357,7 +12381,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$collectionId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", diff --git a/specs/1.8.x/open-api3-1.8.x-console.json b/specs/1.8.x/open-api3-1.8.x-console.json index cc574de86..5f4ff9d99 100644 --- a/specs/1.8.x/open-api3-1.8.x-console.json +++ b/specs/1.8.x/open-api3-1.8.x-console.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "version": "1.8.1", + "version": "1.8.2", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -227,7 +227,7 @@ "x-appwrite": { "method": "listBillingAddresses", "group": null, - "weight": 769, + "weight": 720, "cookies": false, "type": "", "demo": "account\/list-billing-addresses.md", @@ -289,7 +289,7 @@ "x-appwrite": { "method": "createBillingAddress", "group": null, - "weight": 767, + "weight": 718, "cookies": false, "type": "", "demo": "account\/create-billing-address.md", @@ -384,7 +384,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 768, + "weight": 719, "cookies": false, "type": "", "demo": "account\/get-billing-address.md", @@ -443,7 +443,7 @@ "x-appwrite": { "method": "updateBillingAddress", "group": null, - "weight": 770, + "weight": 721, "cookies": false, "type": "", "demo": "account\/update-billing-address.md", @@ -541,7 +541,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 771, + "weight": 722, "cookies": false, "type": "", "demo": "account\/delete-billing-address.md", @@ -602,7 +602,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 773, + "weight": 724, "cookies": false, "type": "", "demo": "account\/get-coupon.md", @@ -877,7 +877,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 772, + "weight": 723, "cookies": false, "type": "", "demo": "account\/list-invoices.md", @@ -903,7 +903,7 @@ "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\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, type, amount, currency, from, to, dueAt, attempts, status, grossAmount", "required": false, "schema": { "type": "array", @@ -993,7 +993,7 @@ "tags": [ "account" ], - "description": "Get a list of all API keys from the current account. ", + "description": "Get a list of all API keys from the current account.", "responses": { "200": { "description": "API Keys List", @@ -1010,7 +1010,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 755, + "weight": 706, "cookies": false, "type": "", "demo": "account\/list-keys.md", @@ -1023,29 +1023,6 @@ ], "packaging": false, "public": true, - "methods": [ - { - "name": "listKeys", - "namespace": "account", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "total" - ], - "required": [], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/keyList" - } - ], - "description": "", - "demo": "account\/list-keys.md", - "public": true - } - ], "auth": { "Project": [] } @@ -1092,7 +1069,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 756, + "weight": 707, "cookies": false, "type": "", "demo": "account\/create-key.md", @@ -1105,34 +1082,6 @@ ], "packaging": false, "public": true, - "methods": [ - { - "name": "createKey", - "namespace": "account", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "name", - "scopes", - "expire" - ], - "required": [ - "name", - "scopes" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/key" - } - ], - "description": "", - "demo": "account\/create-key.md", - "public": true - } - ], "auth": { "Project": [] } @@ -1209,7 +1158,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 759, + "weight": 710, "cookies": false, "type": "", "demo": "account\/get-key.md", @@ -1222,31 +1171,6 @@ ], "packaging": false, "public": true, - "methods": [ - { - "name": "getKey", - "namespace": "account", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "keyId" - ], - "required": [ - "keyId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/key" - } - ], - "description": "", - "demo": "account\/get-key.md", - "public": true - } - ], "auth": { "Project": [] } @@ -1292,7 +1216,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 758, + "weight": 709, "cookies": false, "type": "", "demo": "account\/update-key.md", @@ -1305,36 +1229,6 @@ ], "packaging": false, "public": true, - "methods": [ - { - "name": "updateKey", - "namespace": "account", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "keyId", - "name", - "scopes", - "expire" - ], - "required": [ - "keyId", - "name", - "scopes" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/key" - } - ], - "description": "", - "demo": "account\/update-key.md", - "public": true - } - ], "auth": { "Project": [] } @@ -1414,7 +1308,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 757, + "weight": 708, "cookies": false, "type": "", "demo": "account\/delete-key.md", @@ -1427,30 +1321,6 @@ ], "packaging": false, "public": true, - "methods": [ - { - "name": "deleteKey", - "namespace": "account", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "keyId" - ], - "required": [ - "keyId" - ], - "responses": [ - { - "code": 204 - } - ], - "description": "", - "demo": "account\/delete-key.md", - "public": true - } - ], "auth": { "Project": [] } @@ -1576,7 +1446,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 239, + "weight": 217, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -1647,7 +1517,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 241, + "weight": 219, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -1770,7 +1640,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 242, + "weight": 220, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -1909,7 +1779,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 243, + "weight": 221, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -2032,7 +1902,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 247, + "weight": 225, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -2165,7 +2035,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 248, + "weight": 226, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -2302,7 +2172,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 240, + "weight": 218, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -2402,7 +2272,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 246, + "weight": 224, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -2500,7 +2370,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 244, + "weight": 222, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -2598,7 +2468,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 245, + "weight": 223, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2846,7 +2716,7 @@ "x-appwrite": { "method": "listPaymentMethods", "group": null, - "weight": 762, + "weight": 713, "cookies": false, "type": "", "demo": "account\/list-payment-methods.md", @@ -2908,7 +2778,7 @@ "x-appwrite": { "method": "createPaymentMethod", "group": null, - "weight": 760, + "weight": 711, "cookies": false, "type": "", "demo": "account\/create-payment-method.md", @@ -2957,7 +2827,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 761, + "weight": 712, "cookies": false, "type": "", "demo": "account\/get-payment-method.md", @@ -3016,7 +2886,7 @@ "x-appwrite": { "method": "updatePaymentMethod", "group": null, - "weight": 763, + "weight": 714, "cookies": false, "type": "", "demo": "account\/update-payment-method.md", @@ -3100,7 +2970,7 @@ "x-appwrite": { "method": "deletePaymentMethod", "group": null, - "weight": 766, + "weight": 717, "cookies": false, "type": "", "demo": "account\/delete-payment-method.md", @@ -3161,7 +3031,7 @@ "x-appwrite": { "method": "updatePaymentMethodProvider", "group": null, - "weight": 764, + "weight": 715, "cookies": false, "type": "", "demo": "account\/update-payment-method-provider.md", @@ -3253,7 +3123,7 @@ "x-appwrite": { "method": "updatePaymentMethodMandateOptions", "group": null, - "weight": 765, + "weight": 716, "cookies": false, "type": "", "demo": "account\/update-payment-method-mandate-options.md", @@ -5507,7 +5377,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 779, + "weight": 732, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -5570,7 +5440,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 780, + "weight": 733, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -5626,7 +5496,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 250, + "weight": 228, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -5754,7 +5624,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 249, + "weight": 227, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -5888,7 +5758,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 253, + "weight": 231, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -5948,7 +5818,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 251, + "weight": 229, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -6438,7 +6308,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 252, + "weight": 230, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -6522,7 +6392,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 255, + "weight": 233, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -6616,7 +6486,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 254, + "weight": 232, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -6710,7 +6580,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 256, + "weight": 234, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -7463,7 +7333,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 749, + "weight": 700, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -7527,7 +7397,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 750, + "weight": 701, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -7613,7 +7483,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 748, + "weight": 699, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -7667,7 +7537,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 751, + "weight": 702, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -7730,7 +7600,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 744, + "weight": 695, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -7794,7 +7664,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 745, + "weight": 696, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -7909,7 +7779,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 743, + "weight": 694, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -7970,7 +7840,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 746, + "weight": 697, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -8059,7 +7929,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 747, + "weight": 698, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -8122,7 +7992,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 754, + "weight": 705, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -8218,7 +8088,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 753, + "weight": 704, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -8284,7 +8154,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 752, + "weight": 703, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -8340,7 +8210,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 505, + "weight": 483, "cookies": false, "type": "", "demo": "assistant\/chat.md", @@ -8408,7 +8278,7 @@ "x-appwrite": { "method": "getCampaign", "group": null, - "weight": 623, + "weight": 568, "cookies": false, "type": "", "demo": "console\/get-campaign.md", @@ -8469,7 +8339,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 620, + "weight": 565, "cookies": false, "type": "", "demo": "console\/get-coupon.md", @@ -8530,7 +8400,7 @@ "x-appwrite": { "method": "getPlans", "group": null, - "weight": 618, + "weight": 563, "cookies": false, "type": "", "demo": "console\/get-plans.md", @@ -8598,7 +8468,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 619, + "weight": 564, "cookies": false, "type": "", "demo": "console\/get-plan.md", @@ -8659,7 +8529,7 @@ "x-appwrite": { "method": "getProgram", "group": null, - "weight": 621, + "weight": 566, "cookies": false, "type": "", "demo": "console\/get-program.md", @@ -8720,7 +8590,7 @@ "x-appwrite": { "method": "createProgramMembership", "group": null, - "weight": 622, + "weight": 567, "cookies": false, "type": "", "demo": "console\/create-program-membership.md", @@ -8781,7 +8651,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 617, + "weight": 562, "cookies": false, "type": "", "demo": "console\/list-regions.md", @@ -8823,7 +8693,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 506, + "weight": 484, "cookies": false, "type": "", "demo": "console\/get-resource.md", @@ -8898,7 +8768,7 @@ "x-appwrite": { "method": "createSource", "group": null, - "weight": 624, + "weight": 569, "cookies": false, "type": "", "demo": "console\/create-source.md", @@ -8989,7 +8859,7 @@ "x-appwrite": { "method": "suggestColumns", "group": null, - "weight": 625, + "weight": 570, "cookies": false, "type": "", "demo": "console\/suggest-columns.md", @@ -9094,7 +8964,7 @@ "x-appwrite": { "method": "suggestIndexes", "group": null, - "weight": 626, + "weight": 571, "cookies": false, "type": "", "demo": "console\/suggest-indexes.md", @@ -9189,7 +9059,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 504, + "weight": 482, "cookies": false, "type": "", "demo": "console\/variables.md", @@ -9238,7 +9108,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 264, + "weight": 242, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -9357,7 +9227,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 260, + "weight": 238, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -9474,7 +9344,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 332, + "weight": 310, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -9541,7 +9411,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 328, + "weight": 306, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -9612,7 +9482,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 329, + "weight": 307, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -9676,7 +9546,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 330, + "weight": 308, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -9754,7 +9624,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 331, + "weight": 309, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -9820,7 +9690,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 333, + "weight": 311, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -9905,7 +9775,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 267, + "weight": 245, "cookies": false, "type": "", "demo": "databases\/list-usage.md", @@ -10009,7 +9879,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 261, + "weight": 239, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -10103,7 +9973,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 262, + "weight": 240, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -10213,7 +10083,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 263, + "weight": 241, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -10308,7 +10178,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 272, + "weight": 250, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -10408,7 +10278,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 268, + "weight": 246, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -10535,7 +10405,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 269, + "weight": 247, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -10610,7 +10480,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 270, + "weight": 248, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -10713,7 +10583,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 271, + "weight": 249, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -10790,7 +10660,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 289, + "weight": 267, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -10891,7 +10761,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 290, + "weight": 268, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -10933,7 +10803,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "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", @@ -11004,7 +10874,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 291, + "weight": 269, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -11122,7 +10992,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 292, + "weight": 270, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -11235,7 +11105,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 293, + "weight": 271, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -11353,7 +11223,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 294, + "weight": 272, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -11467,7 +11337,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 295, + "weight": 273, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -11586,7 +11456,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 296, + "weight": 274, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -11708,7 +11578,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 297, + "weight": 275, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -11835,7 +11705,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 298, + "weight": 276, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -11963,7 +11833,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 299, + "weight": 277, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -12096,7 +11966,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 300, + "weight": 278, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -12224,7 +12094,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 301, + "weight": 279, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -12357,7 +12227,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 302, + "weight": 280, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -12470,7 +12340,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 303, + "weight": 281, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -12588,7 +12458,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 304, + "weight": 282, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -12703,7 +12573,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 305, + "weight": 283, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -12827,7 +12697,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 322, + "weight": 300, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -12941,7 +12811,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 323, + "weight": 301, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -13055,7 +12925,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 320, + "weight": 298, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -13169,7 +13039,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 321, + "weight": 299, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -13283,7 +13153,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 306, + "weight": 284, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -13398,7 +13268,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 307, + "weight": 285, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -13522,7 +13392,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 308, + "weight": 286, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -13637,7 +13507,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 309, + "weight": 287, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -13761,7 +13631,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 310, + "weight": 288, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -13876,146 +13746,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { - "post": { - "summary": "Create string attribute", - "operationId": "databasesCreateStringAttribute", - "tags": [ - "databases" - ], - "description": "Create a string attribute.\n", - "responses": { - "202": { - "description": "AttributeString", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/attributeString" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "createStringAttribute", - "group": "attributes", - "weight": 312, - "cookies": false, - "type": "", - "demo": "databases\/create-string-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createStringColumn" - }, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "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 table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "schema": { - "type": "string", - "x-example": "<COLLECTION_ID>" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": null - }, - "size": { - "type": "integer", - "description": "Attribute size for text attributes, in number of characters.", - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { "patch": { - "summary": "Update string attribute", - "operationId": "databasesUpdateStringAttribute", + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", "tags": [ "databases" ], - "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "200": { - "description": "AttributeString", + "description": "AttributeRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeString" + "$ref": "#\/components\/schemas\/attributeRelationship" } } } @@ -14023,12 +13768,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateStringAttribute", + "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 313, + "weight": 289, "cookies": false, "type": "", - "demo": "databases\/update-string-attribute.md", + "demo": "databases\/update-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -14039,10 +13784,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateStringColumn" + "replaceWith": "tablesDB.updateRelationshipColumn" }, "auth": { "Project": [] @@ -14067,7 +13812,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -14091,23 +13836,17 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false - }, - "default": { + "onDelete": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string attribute.", - "x-example": 1, - "format": "int32", - "x-nullable": true + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] }, "newKey": { "type": "string", @@ -14115,45 +13854,41 @@ "x-example": null, "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } } } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { - "summary": "Create text attribute", - "operationId": "databasesCreateTextAttribute", + "summary": "Create string attribute", + "operationId": "databasesCreateStringAttribute", "tags": [ "databases" ], - "description": "Create a text attribute.\n", + "description": "Create a string attribute.\n", "responses": { "202": { - "description": "AttributeText", + "description": "AttributeString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeText" + "$ref": "#\/components\/schemas\/attributeString" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createTextAttribute", + "method": "createStringAttribute", "group": "attributes", - "weight": 318, + "weight": 290, "cookies": false, "type": "", - "demo": "databases\/create-text-attribute.md", + "demo": "databases\/create-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -14164,7 +13899,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createStringColumn" + }, "auth": { "Project": [] } @@ -14188,7 +13927,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. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -14208,6 +13947,12 @@ "description": "Attribute Key.", "x-example": null }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "x-example": 1, + "format": "int32" + }, "required": { "type": "boolean", "description": "Is attribute required?", @@ -14232,6 +13977,7 @@ }, "required": [ "key", + "size", "required" ] } @@ -14240,34 +13986,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { "patch": { - "summary": "Update text attribute", - "operationId": "databasesUpdateTextAttribute", + "summary": "Update string attribute", + "operationId": "databasesUpdateStringAttribute", "tags": [ "databases" ], - "description": "Update a text attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeText", + "description": "AttributeString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeText" + "$ref": "#\/components\/schemas\/attributeString" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateTextAttribute", + "method": "updateStringAttribute", "group": "attributes", - "weight": 319, + "weight": 291, "cookies": false, "type": "", - "demo": "databases\/update-text-attribute.md", + "demo": "databases\/update-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -14278,7 +14024,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateStringColumn" + }, "auth": { "Project": [] } @@ -14302,7 +14052,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. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -14337,6 +14087,13 @@ "x-example": "<DEFAULT>", "x-nullable": true }, + "size": { + "type": "integer", + "description": "Maximum size of the string attribute.", + "x-example": 1, + "format": "int32", + "x-nullable": true + }, "newKey": { "type": "string", "description": "New Attribute Key.", @@ -14354,34 +14111,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text": { "post": { - "summary": "Create URL attribute", - "operationId": "databasesCreateUrlAttribute", + "summary": "Create text attribute", + "operationId": "databasesCreateTextAttribute", "tags": [ "databases" ], - "description": "Create a URL attribute.\n", + "description": "Create a text attribute.\n", "responses": { "202": { - "description": "AttributeURL", + "description": "AttributeText", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeUrl" + "$ref": "#\/components\/schemas\/attributeText" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createUrlAttribute", + "method": "createTextAttribute", "group": "attributes", - "weight": 314, + "weight": 296, "cookies": false, "type": "", - "demo": "databases\/create-url-attribute.md", + "demo": "databases\/create-text-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -14392,11 +14149,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createUrlColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-text-attribute.md", "auth": { "Project": [] } @@ -14420,7 +14173,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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", @@ -14448,14 +14201,18 @@ "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "<DEFAULT>", "x-nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", + "x-example": false } }, "required": [ @@ -14468,34 +14225,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text\/{key}": { "patch": { - "summary": "Update URL attribute", - "operationId": "databasesUpdateUrlAttribute", + "summary": "Update text attribute", + "operationId": "databasesUpdateTextAttribute", "tags": [ "databases" ], - "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a text attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeURL", + "description": "AttributeText", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeUrl" + "$ref": "#\/components\/schemas\/attributeText" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateUrlAttribute", + "method": "updateTextAttribute", "group": "attributes", - "weight": 315, + "weight": 297, "cookies": false, "type": "", - "demo": "databases\/update-url-attribute.md", + "demo": "databases\/update-text-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -14506,11 +14263,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateUrlColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-text-attribute.md", "auth": { "Project": [] } @@ -14534,7 +14287,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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", @@ -14566,8 +14319,7 @@ "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "<DEFAULT>", "x-nullable": true }, "newKey": { @@ -14587,34 +14339,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { "post": { - "summary": "Create varchar attribute", - "operationId": "databasesCreateVarcharAttribute", + "summary": "Create URL attribute", + "operationId": "databasesCreateUrlAttribute", "tags": [ "databases" ], - "description": "Create a varchar attribute.\n", + "description": "Create a URL attribute.\n", "responses": { "202": { - "description": "AttributeVarchar", + "description": "AttributeURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeVarchar" + "$ref": "#\/components\/schemas\/attributeUrl" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createVarcharAttribute", + "method": "createUrlAttribute", "group": "attributes", - "weight": 316, + "weight": 292, "cookies": false, "type": "", - "demo": "databases\/create-varchar-attribute.md", + "demo": "databases\/create-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -14625,7 +14377,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createUrlColumn" + }, "auth": { "Project": [] } @@ -14649,7 +14405,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", @@ -14669,12 +14425,6 @@ "description": "Attribute Key.", "x-example": null }, - "size": { - "type": "integer", - "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", - "x-example": 1, - "format": "int32" - }, "required": { "type": "boolean", "description": "Is attribute required?", @@ -14683,23 +14433,18 @@ "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false } }, "required": [ "key", - "size", "required" ] } @@ -14708,34 +14453,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { "patch": { - "summary": "Update varchar attribute", - "operationId": "databasesUpdateVarcharAttribute", + "summary": "Update URL attribute", + "operationId": "databasesUpdateUrlAttribute", "tags": [ "databases" ], - "description": "Update a varchar attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeVarchar", + "description": "AttributeURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeVarchar" + "$ref": "#\/components\/schemas\/attributeUrl" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateVarcharAttribute", + "method": "updateUrlAttribute", "group": "attributes", - "weight": 317, + "weight": 293, "cookies": false, "type": "", - "demo": "databases\/update-varchar-attribute.md", + "demo": "databases\/update-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -14746,7 +14491,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateUrlColumn" + }, "auth": { "Project": [] } @@ -14770,7 +14519,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", @@ -14802,14 +14551,8 @@ "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar attribute.", - "x-example": 1, - "format": "int32", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "newKey": { @@ -14829,80 +14572,45 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { - "get": { - "summary": "Get attribute", - "operationId": "databasesGetAttribute", + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar": { + "post": { + "summary": "Create varchar attribute", + "operationId": "databasesCreateVarcharAttribute", "tags": [ "databases" ], - "description": "Get attribute by ID.", + "description": "Create a varchar attribute.\n", "responses": { - "200": { - "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", + "202": { + "description": "AttributeVarchar", "content": { "application\/json": { "schema": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/attributeBoolean" - }, - { - "$ref": "#\/components\/schemas\/attributeInteger" - }, - { - "$ref": "#\/components\/schemas\/attributeFloat" - }, - { - "$ref": "#\/components\/schemas\/attributeEmail" - }, - { - "$ref": "#\/components\/schemas\/attributeEnum" - }, - { - "$ref": "#\/components\/schemas\/attributeUrl" - }, - { - "$ref": "#\/components\/schemas\/attributeIp" - }, - { - "$ref": "#\/components\/schemas\/attributeDatetime" - }, - { - "$ref": "#\/components\/schemas\/attributeRelationship" - }, - { - "$ref": "#\/components\/schemas\/attributeString" - } - ] + "$ref": "#\/components\/schemas\/attributeVarchar" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getAttribute", + "method": "createVarcharAttribute", "group": "attributes", - "weight": 287, + "weight": 294, "cookies": false, "type": "", - "demo": "databases\/get-attribute.md", + "demo": "databases\/create-varchar-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "collections.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.getColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-varchar-attribute.md", "auth": { "Project": [] } @@ -14926,45 +14634,93 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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": "key", - "description": "Attribute Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } - ] - }, - "delete": { - "summary": "Delete attribute", - "operationId": "databasesDeleteAttribute", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": null + }, + "size": { + "type": "integer", + "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", + "x-example": 1, + "format": "int32" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "<DEFAULT>", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar\/{key}": { + "patch": { + "summary": "Update varchar attribute", + "operationId": "databasesUpdateVarcharAttribute", "tags": [ "databases" ], - "description": "Deletes an attribute.", + "description": "Update a varchar attribute. Changing the `default` value will not update already existing documents.\n", "responses": { - "204": { - "description": "No content" + "200": { + "description": "AttributeVarchar", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeVarchar" + } + } + } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "deleteAttribute", + "method": "updateVarcharAttribute", "group": "attributes", - "weight": 288, + "weight": 295, "cookies": false, "type": "", - "demo": "databases\/delete-attribute.md", + "demo": "databases\/update-varchar-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -14975,11 +14731,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.deleteColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-varchar-attribute.md", "auth": { "Project": [] } @@ -15003,7 +14755,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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", @@ -15020,24 +14772,94 @@ }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "<DEFAULT>", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the varchar attribute.", + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship": { - "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { + "get": { + "summary": "Get attribute", + "operationId": "databasesGetAttribute", "tags": [ "databases" ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "description": "Get attribute by ID.", "responses": { "200": { - "description": "AttributeRelationship", + "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeRelationship" + "oneOf": [ + { + "$ref": "#\/components\/schemas\/attributeBoolean" + }, + { + "$ref": "#\/components\/schemas\/attributeInteger" + }, + { + "$ref": "#\/components\/schemas\/attributeFloat" + }, + { + "$ref": "#\/components\/schemas\/attributeEmail" + }, + { + "$ref": "#\/components\/schemas\/attributeEnum" + }, + { + "$ref": "#\/components\/schemas\/attributeUrl" + }, + { + "$ref": "#\/components\/schemas\/attributeIp" + }, + { + "$ref": "#\/components\/schemas\/attributeDatetime" + }, + { + "$ref": "#\/components\/schemas\/attributeRelationship" + }, + { + "$ref": "#\/components\/schemas\/attributeString" + } + ] } } } @@ -15045,26 +14867,26 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateRelationshipAttribute", + "method": "getAttribute", "group": "attributes", - "weight": 311, + "weight": 265, "cookies": false, "type": "", - "demo": "databases\/update-relationship-attribute.md", + "demo": "databases\/get-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "collections.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" + "replaceWith": "tablesDB.getColumn" }, "auth": { "Project": [] @@ -15106,37 +14928,84 @@ }, "in": "path" } + ] + }, + "delete": { + "summary": "Delete attribute", + "operationId": "databasesDeleteAttribute", + "tags": [ + "databases" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true - } - } - } - } + "description": "Deletes an attribute.", + "responses": { + "204": { + "description": "No content" } - } + }, + "deprecated": true, + "x-appwrite": { + "method": "deleteAttribute", + "group": "attributes", + "weight": 266, + "cookies": false, + "type": "", + "demo": "databases\/delete-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.deleteColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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": "key", + "description": "Attribute Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] } }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { @@ -15163,7 +15032,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 283, + "weight": 261, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -15249,6 +15118,18 @@ "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" } ] }, @@ -15275,7 +15156,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 275, + "weight": 253, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -15466,7 +15347,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 280, + "weight": 258, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -15603,7 +15484,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 278, + "weight": 256, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -15708,7 +15589,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 282, + "weight": 260, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -15810,7 +15691,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 276, + "weight": 254, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -15921,7 +15802,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 279, + "weight": 257, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -16076,7 +15957,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 277, + "weight": 255, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -16188,7 +16069,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 281, + "weight": 259, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -16295,7 +16176,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 284, + "weight": 262, "cookies": false, "type": "", "demo": "databases\/list-document-logs.md", @@ -16393,7 +16274,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 286, + "weight": 264, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -16522,7 +16403,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 285, + "weight": 263, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -16651,7 +16532,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 327, + "weight": 305, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -16750,7 +16631,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 324, + "weight": 302, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -16891,7 +16772,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 325, + "weight": 303, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -16968,7 +16849,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 326, + "weight": 304, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -17054,7 +16935,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 273, + "weight": 251, "cookies": false, "type": "", "demo": "databases\/list-collection-logs.md", @@ -17142,7 +17023,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 274, + "weight": 252, "cookies": false, "type": "", "demo": "databases\/get-collection-usage.md", @@ -17239,7 +17120,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 265, + "weight": 243, "cookies": false, "type": "", "demo": "databases\/list-logs.md", @@ -17347,7 +17228,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 266, + "weight": 244, "cookies": false, "type": "", "demo": "databases\/get-usage.md", @@ -17464,7 +17345,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 632, + "weight": 577, "cookies": false, "type": "", "demo": "domains\/list.md", @@ -17536,7 +17417,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 627, + "weight": 572, "cookies": false, "type": "", "demo": "domains\/create.md", @@ -17609,11 +17490,11 @@ "x-appwrite": { "method": "getPrice", "group": null, - "weight": 630, + "weight": 575, "cookies": false, "type": "", "demo": "domains\/get-price.md", - "rate-limit": 50, + "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": "domains.read", @@ -17684,11 +17565,11 @@ "description": " Create a domain purchase with registrant information.", "responses": { "201": { - "description": "Domain", + "description": "DomainPurchase", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/domain" + "$ref": "#\/components\/schemas\/domainPurchase" } } } @@ -17698,14 +17579,14 @@ "x-appwrite": { "method": "createPurchase", "group": null, - "weight": 672, + "weight": 621, "cookies": false, "type": "", "demo": "domains\/create-purchase.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "billing.write", "platforms": [ "console" ], @@ -17731,10 +17612,10 @@ "description": "Fully qualified domain name to purchase (for example, example.com).", "x-example": null }, - "teamId": { + "organizationId": { "type": "string", "description": "Team ID that will own the domain.", - "x-example": "<TEAM_ID>" + "x-example": "<ORGANIZATION_ID>" }, "firstName": { "type": "string", @@ -17787,7 +17668,7 @@ }, "required": [ "domain", - "teamId", + "organizationId", "firstName", "lastName", "email", @@ -17801,6 +17682,85 @@ } } }, + "\/domains\/purchases\/{domainId}": { + "patch": { + "summary": "Confirm a domain purchase", + "operationId": "domainsUpdatePurchase", + "tags": [ + "domains" + ], + "description": " Confirm and complete a domain purchase after payment authentication.", + "responses": { + "200": { + "description": "DomainPurchase", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/domainPurchase" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePurchase", + "group": null, + "weight": 622, + "cookies": false, + "type": "", + "demo": "domains\/update-purchase.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "domainId", + "description": "Domain ID to confirm purchase for.", + "required": true, + "schema": { + "type": "string", + "x-example": "<DOMAIN_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Team ID that owns the domain.", + "x-example": "<ORGANIZATION_ID>" + } + }, + "required": [ + "organizationId" + ] + } + } + } + } + } + }, "\/domains\/suggestions": { "get": { "summary": "List domain suggestions", @@ -17825,7 +17785,7 @@ "x-appwrite": { "method": "listSuggestions", "group": null, - "weight": 671, + "weight": 620, "cookies": false, "type": "", "demo": "domains\/list-suggestions.md", @@ -17920,6 +17880,243 @@ ] } }, + "\/domains\/transfers\/in": { + "post": { + "summary": "Create a domain transfer in.", + "operationId": "domainsCreateTransferIn", + "tags": [ + "domains" + ], + "description": " Create a domain transfer in with authorization code and registrant information.", + "responses": { + "201": { + "description": "DomainPurchase", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/domainPurchase" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTransferIn", + "group": null, + "weight": 581, + "cookies": false, + "type": "", + "demo": "domains\/create-transfer-in.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name to transfer in.", + "x-example": null + }, + "organizationId": { + "type": "string", + "description": "Organization ID that this domain will belong to.", + "x-example": "<ORGANIZATION_ID>" + }, + "authCode": { + "type": "string", + "description": "Authorization code for the domain transfer.", + "x-example": "<AUTH_CODE>" + }, + "paymentMethodId": { + "type": "string", + "description": "Payment method ID to authorize and capture the transfer.", + "x-example": "<PAYMENT_METHOD_ID>" + } + }, + "required": [ + "domain", + "organizationId", + "authCode", + "paymentMethodId" + ] + } + } + } + } + } + }, + "\/domains\/transfers\/in\/{domainId}": { + "patch": { + "summary": "Confirm a domain transfer in", + "operationId": "domainsUpdateTransferIn", + "tags": [ + "domains" + ], + "description": " Confirm and complete a domain transfer in after payment authentication.", + "responses": { + "200": { + "description": "DomainPurchase", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/domainPurchase" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTransferIn", + "group": null, + "weight": 582, + "cookies": false, + "type": "", + "demo": "domains\/update-transfer-in.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "domainId", + "description": "Domain ID to confirm transfer for.", + "required": true, + "schema": { + "type": "string", + "x-example": "<DOMAIN_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Team ID that owns the domain.", + "x-example": "<ORGANIZATION_ID>" + } + }, + "required": [ + "organizationId" + ] + } + } + } + } + } + }, + "\/domains\/transfers\/out": { + "post": { + "summary": "Create a domain transfer out.", + "operationId": "domainsCreateTransferOut", + "tags": [ + "domains" + ], + "description": " Create a domain transfer out and return the authorization code.", + "responses": { + "202": { + "description": "domainTransferOut", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/domainTransferOut" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTransferOut", + "group": null, + "weight": 583, + "cookies": false, + "type": "", + "demo": "domains\/create-transfer-out.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "domainId": { + "type": "string", + "description": "Domain unique ID.", + "x-example": "<DOMAIN_ID>" + }, + "organizationId": { + "type": "string", + "description": "Organization ID that this domain belongs to.", + "x-example": "<ORGANIZATION_ID>" + } + }, + "required": [ + "domainId", + "organizationId" + ] + } + } + } + } + } + }, "\/domains\/{domainId}": { "get": { "summary": "Get a single domain by its unique ID.", @@ -17944,7 +18141,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 629, + "weight": 574, "cookies": false, "type": "", "demo": "domains\/get.md", @@ -17995,7 +18192,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 628, + "weight": 573, "cookies": false, "type": "", "demo": "domains\/delete.md", @@ -18055,7 +18252,7 @@ "x-appwrite": { "method": "updateNameservers", "group": null, - "weight": 633, + "weight": 578, "cookies": false, "type": "", "demo": "domains\/update-nameservers.md", @@ -18115,7 +18312,7 @@ "x-appwrite": { "method": "getPresetGoogleWorkspace", "group": null, - "weight": 660, + "weight": 609, "cookies": false, "type": "", "demo": "domains\/get-preset-google-workspace.md", @@ -18173,7 +18370,7 @@ "x-appwrite": { "method": "createPresetGoogleWorkspace", "group": null, - "weight": 659, + "weight": 608, "cookies": false, "type": "", "demo": "domains\/create-preset-google-workspace.md", @@ -18233,7 +18430,7 @@ "x-appwrite": { "method": "getPresetICloud", "group": null, - "weight": 670, + "weight": 619, "cookies": false, "type": "", "demo": "domains\/get-preset-i-cloud.md", @@ -18291,7 +18488,7 @@ "x-appwrite": { "method": "createPresetICloud", "group": null, - "weight": 669, + "weight": 618, "cookies": false, "type": "", "demo": "domains\/create-preset-i-cloud.md", @@ -18351,7 +18548,7 @@ "x-appwrite": { "method": "getPresetMailgun", "group": null, - "weight": 662, + "weight": 611, "cookies": false, "type": "", "demo": "domains\/get-preset-mailgun.md", @@ -18409,7 +18606,7 @@ "x-appwrite": { "method": "createPresetMailgun", "group": null, - "weight": 661, + "weight": 610, "cookies": false, "type": "", "demo": "domains\/create-preset-mailgun.md", @@ -18469,7 +18666,7 @@ "x-appwrite": { "method": "getPresetOutlook", "group": null, - "weight": 668, + "weight": 617, "cookies": false, "type": "", "demo": "domains\/get-preset-outlook.md", @@ -18527,7 +18724,7 @@ "x-appwrite": { "method": "createPresetOutlook", "group": null, - "weight": 667, + "weight": 616, "cookies": false, "type": "", "demo": "domains\/create-preset-outlook.md", @@ -18587,7 +18784,7 @@ "x-appwrite": { "method": "getPresetProtonMail", "group": null, - "weight": 666, + "weight": 615, "cookies": false, "type": "", "demo": "domains\/get-preset-proton-mail.md", @@ -18645,7 +18842,7 @@ "x-appwrite": { "method": "createPresetProtonMail", "group": null, - "weight": 665, + "weight": 614, "cookies": false, "type": "", "demo": "domains\/create-preset-proton-mail.md", @@ -18705,7 +18902,7 @@ "x-appwrite": { "method": "getPresetZoho", "group": null, - "weight": 664, + "weight": 613, "cookies": false, "type": "", "demo": "domains\/get-preset-zoho.md", @@ -18763,7 +18960,7 @@ "x-appwrite": { "method": "createPresetZoho", "group": null, - "weight": 663, + "weight": 612, "cookies": false, "type": "", "demo": "domains\/create-preset-zoho.md", @@ -18823,7 +19020,7 @@ "x-appwrite": { "method": "listRecords", "group": null, - "weight": 658, + "weight": 607, "cookies": false, "type": "", "demo": "domains\/list-records.md", @@ -18896,7 +19093,7 @@ "x-appwrite": { "method": "createRecordA", "group": null, - "weight": 636, + "weight": 585, "cookies": false, "type": "", "demo": "domains\/create-record-a.md", @@ -18993,7 +19190,7 @@ "x-appwrite": { "method": "updateRecordA", "group": null, - "weight": 637, + "weight": 586, "cookies": false, "type": "", "demo": "domains\/update-record-a.md", @@ -19100,7 +19297,7 @@ "x-appwrite": { "method": "createRecordAAAA", "group": null, - "weight": 638, + "weight": 587, "cookies": false, "type": "", "demo": "domains\/create-record-aaaa.md", @@ -19197,7 +19394,7 @@ "x-appwrite": { "method": "updateRecordAAAA", "group": null, - "weight": 639, + "weight": 588, "cookies": false, "type": "", "demo": "domains\/update-record-aaaa.md", @@ -19304,7 +19501,7 @@ "x-appwrite": { "method": "createRecordAlias", "group": null, - "weight": 640, + "weight": 589, "cookies": false, "type": "", "demo": "domains\/create-record-alias.md", @@ -19401,7 +19598,7 @@ "x-appwrite": { "method": "updateRecordAlias", "group": null, - "weight": 641, + "weight": 590, "cookies": false, "type": "", "demo": "domains\/update-record-alias.md", @@ -19508,7 +19705,7 @@ "x-appwrite": { "method": "createRecordCAA", "group": null, - "weight": 642, + "weight": 591, "cookies": false, "type": "", "demo": "domains\/create-record-caa.md", @@ -19605,7 +19802,7 @@ "x-appwrite": { "method": "updateRecordCAA", "group": null, - "weight": 643, + "weight": 592, "cookies": false, "type": "", "demo": "domains\/update-record-caa.md", @@ -19712,7 +19909,7 @@ "x-appwrite": { "method": "createRecordCNAME", "group": null, - "weight": 644, + "weight": 593, "cookies": false, "type": "", "demo": "domains\/create-record-cname.md", @@ -19809,7 +20006,7 @@ "x-appwrite": { "method": "updateRecordCNAME", "group": null, - "weight": 645, + "weight": 594, "cookies": false, "type": "", "demo": "domains\/update-record-cname.md", @@ -19916,7 +20113,7 @@ "x-appwrite": { "method": "createRecordHTTPS", "group": null, - "weight": 646, + "weight": 595, "cookies": false, "type": "", "demo": "domains\/create-record-https.md", @@ -20013,7 +20210,7 @@ "x-appwrite": { "method": "updateRecordHTTPS", "group": null, - "weight": 647, + "weight": 596, "cookies": false, "type": "", "demo": "domains\/update-record-https.md", @@ -20120,7 +20317,7 @@ "x-appwrite": { "method": "createRecordMX", "group": null, - "weight": 648, + "weight": 597, "cookies": false, "type": "", "demo": "domains\/create-record-mx.md", @@ -20224,7 +20421,7 @@ "x-appwrite": { "method": "updateRecordMX", "group": null, - "weight": 649, + "weight": 598, "cookies": false, "type": "", "demo": "domains\/update-record-mx.md", @@ -20338,7 +20535,7 @@ "x-appwrite": { "method": "createRecordNS", "group": null, - "weight": 650, + "weight": 599, "cookies": false, "type": "", "demo": "domains\/create-record-ns.md", @@ -20435,7 +20632,7 @@ "x-appwrite": { "method": "updateRecordNS", "group": null, - "weight": 651, + "weight": 600, "cookies": false, "type": "", "demo": "domains\/update-record-ns.md", @@ -20542,7 +20739,7 @@ "x-appwrite": { "method": "createRecordSRV", "group": null, - "weight": 652, + "weight": 601, "cookies": false, "type": "", "demo": "domains\/create-record-srv.md", @@ -20660,7 +20857,7 @@ "x-appwrite": { "method": "updateRecordSRV", "group": null, - "weight": 653, + "weight": 602, "cookies": false, "type": "", "demo": "domains\/update-record-srv.md", @@ -20788,7 +20985,7 @@ "x-appwrite": { "method": "createRecordTXT", "group": null, - "weight": 654, + "weight": 603, "cookies": false, "type": "", "demo": "domains\/create-record-txt.md", @@ -20884,7 +21081,7 @@ "x-appwrite": { "method": "updateRecordTXT", "group": null, - "weight": 655, + "weight": 604, "cookies": false, "type": "", "demo": "domains\/update-record-txt.md", @@ -20991,7 +21188,7 @@ "x-appwrite": { "method": "getRecord", "group": null, - "weight": 657, + "weight": 606, "cookies": false, "type": "", "demo": "domains\/get-record.md", @@ -21052,7 +21249,7 @@ "x-appwrite": { "method": "deleteRecord", "group": null, - "weight": 656, + "weight": 605, "cookies": false, "type": "", "demo": "domains\/delete-record.md", @@ -21122,7 +21319,7 @@ "x-appwrite": { "method": "updateTeam", "group": null, - "weight": 635, + "weight": 580, "cookies": false, "type": "", "demo": "domains\/update-team.md", @@ -21177,6 +21374,66 @@ } } }, + "\/domains\/{domainId}\/transfers\/status": { + "get": { + "summary": "Get domain transfer status.", + "operationId": "domainsGetTransferStatus", + "tags": [ + "domains" + ], + "description": " Get the transfer status for a domain.", + "responses": { + "200": { + "description": "domainTransferStatus", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/domainTransferStatus" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTransferStatus", + "group": null, + "weight": 584, + "cookies": false, + "type": "", + "demo": "domains\/get-transfer-status.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "domains.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<DOMAIN_ID>" + }, + "in": "path" + } + ] + } + }, "\/domains\/{domainId}\/zone": { "get": { "summary": "Retrieve the DNS zone file for the given domain.", @@ -21194,7 +21451,7 @@ "x-appwrite": { "method": "getZone", "group": null, - "weight": 631, + "weight": 576, "cookies": false, "type": "", "demo": "domains\/get-zone.md", @@ -21252,7 +21509,7 @@ "x-appwrite": { "method": "updateZone", "group": null, - "weight": 634, + "weight": 579, "cookies": false, "type": "", "demo": "domains\/update-zone.md", @@ -21331,7 +21588,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 561, + "weight": 401, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -21416,7 +21673,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 558, + "weight": 556, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -21492,9 +21749,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -21549,7 +21803,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -21665,6 +22005,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -21704,10 +22046,21 @@ "description": "Path to function code in the linked repo.", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Build specification for the function deployments.", + "x-example": null + }, + "runtimeSpecification": { "type": "string", - "description": "Runtime specification for the function and builds.", + "description": "Runtime specification for the function executions.", "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" } }, "required": [ @@ -21745,7 +22098,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 563, + "weight": 403, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -21795,7 +22148,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 564, + "weight": 404, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -21845,7 +22198,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 587, + "weight": 427, "cookies": false, "type": "", "demo": "functions\/list-templates.md", @@ -21908,9 +22261,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -21965,7 +22315,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -22060,7 +22496,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 586, + "weight": 426, "cookies": false, "type": "", "demo": "functions\/get-template.md", @@ -22120,7 +22556,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 580, + "weight": 420, "cookies": false, "type": "", "demo": "functions\/list-usage.md", @@ -22192,7 +22628,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 559, + "weight": 399, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -22252,7 +22688,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 560, + "weight": 557, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -22335,9 +22771,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -22392,7 +22825,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -22508,6 +23027,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -22548,10 +23069,21 @@ "description": "Path to function code in the linked repo.", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { "type": "string", - "description": "Runtime specification for the function and builds.", + "description": "Build specification for the function deployments.", "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the function executions.", + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" } }, "required": [ @@ -22578,7 +23110,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 562, + "weight": 402, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -22640,7 +23172,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 567, + "weight": 407, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -22721,7 +23253,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 568, + "weight": 408, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -22816,7 +23348,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 565, + "weight": 405, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -22916,7 +23448,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 573, + "weight": 413, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -23002,7 +23534,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 570, + "weight": 410, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -23119,7 +23651,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 571, + "weight": 411, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -23217,7 +23749,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 566, + "weight": 406, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -23280,7 +23812,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 569, + "weight": 409, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -23345,7 +23877,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 572, + "weight": 412, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -23436,7 +23968,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 574, + "weight": 414, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -23508,7 +24040,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 577, + "weight": 417, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -23595,7 +24127,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 575, + "weight": 415, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -23713,7 +24245,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 576, + "weight": 416, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -23779,7 +24311,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 578, + "weight": 418, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -23851,7 +24383,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 579, + "weight": 419, "cookies": false, "type": "", "demo": "functions\/get-usage.md", @@ -23933,7 +24465,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 583, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -23993,7 +24525,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 581, + "weight": 558, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -24085,7 +24617,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 582, + "weight": 422, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -24155,7 +24687,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 584, + "weight": 424, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -24249,7 +24781,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 585, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -24321,7 +24853,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 176, + "weight": 154, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -24375,7 +24907,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 175, + "weight": 153, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -24429,7 +24961,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 450, + "weight": 428, "cookies": false, "type": "", "demo": "health\/get.md", @@ -24480,7 +25012,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 459, + "weight": 437, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -24531,7 +25063,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 453, + "weight": 431, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -24582,7 +25114,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 456, + "weight": 434, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -24620,6 +25152,81 @@ ] } }, + "\/health\/console-pausing": { + "get": { + "summary": "Get console pausing health", + "operationId": "healthGetConsolePausing", + "tags": [ + "health" + ], + "description": "Get console pausing health status. Monitors projects approaching the pause threshold to detect potential issues with console access tracking.\n", + "responses": { + "200": { + "description": "Health Status", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/healthStatus" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getConsolePausing", + "group": null, + "weight": 688, + "cookies": false, + "type": "", + "demo": "health\/get-console-pausing.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-console-pausing.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "threshold", + "description": "Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 10 + }, + "in": "query" + }, + { + "name": "inactivityDays", + "description": "Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 7 + }, + "in": "query" + } + ] + } + }, "\/health\/db": { "get": { "summary": "Get DB", @@ -24644,7 +25251,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 452, + "weight": 430, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -24695,7 +25302,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 454, + "weight": 432, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -24746,7 +25353,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 460, + "weight": 438, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -24810,7 +25417,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 734, + "weight": 684, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -24874,7 +25481,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 733, + "weight": 683, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -24938,7 +25545,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 464, + "weight": 442, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -25002,7 +25609,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 735, + "weight": 685, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -25066,7 +25673,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 463, + "weight": 441, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -25130,7 +25737,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 465, + "weight": 443, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -25205,7 +25812,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 466, + "weight": 444, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -25269,7 +25876,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 473, + "weight": 451, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -25360,7 +25967,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 470, + "weight": 448, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -25424,7 +26031,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 462, + "weight": 440, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -25488,7 +26095,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 467, + "weight": 445, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -25552,7 +26159,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 468, + "weight": 446, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -25616,7 +26223,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 469, + "weight": 447, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -25680,7 +26287,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 736, + "weight": 686, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -25744,7 +26351,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 471, + "weight": 449, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -25808,7 +26415,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 472, + "weight": 450, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -25872,7 +26479,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 737, + "weight": 687, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -25936,7 +26543,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 461, + "weight": 439, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -26000,7 +26607,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 458, + "weight": 436, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -26051,7 +26658,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 457, + "weight": 435, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -26102,7 +26709,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 455, + "weight": 433, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -26585,7 +27192,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 231, + "weight": 209, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -26673,7 +27280,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 228, + "weight": 206, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -26819,7 +27426,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 235, + "weight": 213, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -26977,7 +27584,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 230, + "weight": 208, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -27155,7 +27762,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 237, + "weight": 215, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -27353,7 +27960,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 229, + "weight": 207, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -27534,7 +28141,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 236, + "weight": 214, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -27721,7 +28328,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 234, + "weight": 212, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -27775,7 +28382,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 238, + "weight": 216, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -27838,7 +28445,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 232, + "weight": 210, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -27925,7 +28532,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 233, + "weight": 211, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -28012,7 +28619,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 202, + "weight": 180, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -28100,7 +28707,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 201, + "weight": 179, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -28279,7 +28886,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 215, + "weight": 193, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -28460,7 +29067,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 200, + "weight": 178, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -28612,7 +29219,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 214, + "weight": 192, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -28765,7 +29372,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 191, + "weight": 169, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -28885,7 +29492,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 205, + "weight": 183, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -29007,7 +29614,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 195, + "weight": 173, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -29104,7 +29711,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 209, + "weight": 187, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -29204,7 +29811,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 193, + "weight": 171, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -29313,7 +29920,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 207, + "weight": 185, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -29424,7 +30031,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 192, + "weight": 170, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -29533,7 +30140,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 206, + "weight": 184, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -29644,7 +30251,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 194, + "weight": 172, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -29878,7 +30485,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 208, + "weight": 186, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -30111,7 +30718,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 196, + "weight": 174, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -30209,7 +30816,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 210, + "weight": 188, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -30309,7 +30916,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 197, + "weight": 175, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -30407,7 +31014,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 211, + "weight": 189, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -30507,7 +31114,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 198, + "weight": 176, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -30605,7 +31212,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 212, + "weight": 190, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -30705,7 +31312,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 199, + "weight": 177, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -30803,7 +31410,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 213, + "weight": 191, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -30903,7 +31510,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 204, + "weight": 182, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -30957,7 +31564,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 216, + "weight": 194, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -31020,7 +31627,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 203, + "weight": 181, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -31107,7 +31714,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 225, + "weight": 203, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -31194,7 +31801,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 218, + "weight": 196, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -31280,7 +31887,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 217, + "weight": 195, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -31364,7 +31971,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 220, + "weight": 198, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -31425,7 +32032,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 221, + "weight": 199, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -31505,7 +32112,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 222, + "weight": 200, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -31568,7 +32175,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 219, + "weight": 197, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -31655,7 +32262,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 224, + "weight": 202, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -31693,7 +32300,7 @@ }, { "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: name, provider, type, enabled", + "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: targetId, topicId, userId, providerType", "required": false, "schema": { "type": "array", @@ -31751,7 +32358,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 223, + "weight": 201, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -31842,7 +32449,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 226, + "weight": 204, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -31906,7 +32513,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 227, + "weight": 205, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -31982,7 +32589,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 183, + "weight": 161, "cookies": false, "type": "", "demo": "migrations\/list.md", @@ -32068,7 +32675,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 177, + "weight": 155, "cookies": false, "type": "", "demo": "migrations\/create-appwrite-migration.md", @@ -32120,11 +32727,15 @@ "function", "deployment", "environment-variable", + "provider", + "topic", + "subscriber", + "message", "site", "site-deployment", "site-variable" ], - "x-enum-name": null, + "x-enum-name": "AppwriteMigrationResource", "x-enum-keys": [] } }, @@ -32181,7 +32792,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 185, + "weight": 163, "cookies": false, "type": "", "demo": "migrations\/get-appwrite-report.md", @@ -32230,11 +32841,15 @@ "function", "deployment", "environment-variable", + "provider", + "topic", + "subscriber", + "message", "site", "site-deployment", "site-variable" ], - "x-enum-name": null, + "x-enum-name": "AppwriteMigrationResource", "x-enum-keys": [] } }, @@ -32298,7 +32913,7 @@ "x-appwrite": { "method": "createCSVExport", "group": null, - "weight": 182, + "weight": 160, "cookies": false, "type": "", "demo": "migrations\/create-csv-export.md", @@ -32413,7 +33028,7 @@ "x-appwrite": { "method": "createCSVImport", "group": null, - "weight": 181, + "weight": 159, "cookies": false, "type": "", "demo": "migrations\/create-csv-import.md", @@ -32498,7 +33113,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 178, + "weight": 156, "cookies": false, "type": "", "demo": "migrations\/create-firebase-migration.md", @@ -32545,7 +33160,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "FirebaseMigrationResource", "x-enum-keys": [] } }, @@ -32589,7 +33204,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 186, + "weight": 164, "cookies": false, "type": "", "demo": "migrations\/get-firebase-report.md", @@ -32633,7 +33248,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "FirebaseMigrationResource", "x-enum-keys": [] } }, @@ -32676,7 +33291,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 180, + "weight": 158, "cookies": false, "type": "", "demo": "migrations\/create-n-host-migration.md", @@ -32724,7 +33339,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "NHostMigrationResource", "x-enum-keys": [] } }, @@ -32804,7 +33419,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 188, + "weight": 166, "cookies": false, "type": "", "demo": "migrations\/get-n-host-report.md", @@ -32849,7 +33464,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "NHostMigrationResource", "x-enum-keys": [] } }, @@ -32953,7 +33568,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 179, + "weight": 157, "cookies": false, "type": "", "demo": "migrations\/create-supabase-migration.md", @@ -33001,7 +33616,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "SupabaseMigrationResource", "x-enum-keys": [] } }, @@ -33076,7 +33691,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 187, + "weight": 165, "cookies": false, "type": "", "demo": "migrations\/get-supabase-report.md", @@ -33121,7 +33736,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "SupabaseMigrationResource", "x-enum-keys": [] } }, @@ -33216,7 +33831,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 184, + "weight": 162, "cookies": false, "type": "", "demo": "migrations\/get.md", @@ -33275,7 +33890,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 189, + "weight": 167, "cookies": false, "type": "", "demo": "migrations\/retry.md", @@ -33327,7 +33942,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 190, + "weight": 168, "cookies": false, "type": "", "demo": "migrations\/delete.md", @@ -33388,7 +34003,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 692, + "weight": 642, "cookies": false, "type": "", "demo": "organizations\/list.md", @@ -33468,7 +34083,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 691, + "weight": 641, "cookies": false, "type": "", "demo": "organizations\/create.md", @@ -33598,7 +34213,7 @@ "x-appwrite": { "method": "estimationCreateOrganization", "group": null, - "weight": 725, + "weight": 675, "cookies": false, "type": "", "demo": "organizations\/estimation-create-organization.md", @@ -33690,7 +34305,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 693, + "weight": 643, "cookies": false, "type": "", "demo": "organizations\/delete.md", @@ -33751,7 +34366,7 @@ "x-appwrite": { "method": "listAggregations", "group": null, - "weight": 708, + "weight": 658, "cookies": false, "type": "", "demo": "organizations\/list-aggregations.md", @@ -33825,7 +34440,7 @@ "x-appwrite": { "method": "getAggregation", "group": null, - "weight": 709, + "weight": 659, "cookies": false, "type": "", "demo": "organizations\/get-aggregation.md", @@ -33919,7 +34534,7 @@ "x-appwrite": { "method": "setBillingAddress", "group": null, - "weight": 701, + "weight": 651, "cookies": false, "type": "", "demo": "organizations\/set-billing-address.md", @@ -33990,7 +34605,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 702, + "weight": 652, "cookies": false, "type": "", "demo": "organizations\/delete-billing-address.md", @@ -34051,7 +34666,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 700, + "weight": 650, "cookies": false, "type": "", "demo": "organizations\/get-billing-address.md", @@ -34122,7 +34737,7 @@ "x-appwrite": { "method": "setBillingEmail", "group": null, - "weight": 720, + "weight": 670, "cookies": false, "type": "", "demo": "organizations\/set-billing-email.md", @@ -34203,7 +34818,7 @@ "x-appwrite": { "method": "updateBudget", "group": null, - "weight": 697, + "weight": 647, "cookies": false, "type": "", "demo": "organizations\/update-budget.md", @@ -34293,7 +34908,7 @@ "x-appwrite": { "method": "listCredits", "group": null, - "weight": 712, + "weight": 662, "cookies": false, "type": "", "demo": "organizations\/list-credits.md", @@ -34365,7 +34980,7 @@ "x-appwrite": { "method": "addCredit", "group": null, - "weight": 713, + "weight": 663, "cookies": false, "type": "", "demo": "organizations\/add-credit.md", @@ -34445,7 +35060,7 @@ "x-appwrite": { "method": "getAvailableCredits", "group": null, - "weight": 711, + "weight": 661, "cookies": false, "type": "", "demo": "organizations\/get-available-credits.md", @@ -34506,7 +35121,7 @@ "x-appwrite": { "method": "getCredit", "group": null, - "weight": 710, + "weight": 660, "cookies": false, "type": "", "demo": "organizations\/get-credit.md", @@ -34577,7 +35192,7 @@ "x-appwrite": { "method": "estimationDeleteOrganization", "group": null, - "weight": 726, + "weight": 676, "cookies": false, "type": "", "demo": "organizations\/estimation-delete-organization.md", @@ -34638,7 +35253,7 @@ "x-appwrite": { "method": "estimationUpdatePlan", "group": null, - "weight": 724, + "weight": 674, "cookies": false, "type": "", "demo": "organizations\/estimation-update-plan.md", @@ -34732,7 +35347,7 @@ "x-appwrite": { "method": "createDowngradeFeedback", "group": null, - "weight": 727, + "weight": 677, "cookies": false, "type": "", "demo": "organizations\/create-downgrade-feedback.md", @@ -34830,7 +35445,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 715, + "weight": 665, "cookies": false, "type": "", "demo": "organizations\/list-invoices.md", @@ -34866,7 +35481,7 @@ }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, type, amount, currency, from, to, dueAt, attempts, status, grossAmount", "required": false, "schema": { "type": "array", @@ -34904,7 +35519,7 @@ "x-appwrite": { "method": "getInvoice", "group": null, - "weight": 714, + "weight": 664, "cookies": false, "type": "", "demo": "organizations\/get-invoice.md", @@ -34975,7 +35590,7 @@ "x-appwrite": { "method": "getInvoiceDownload", "group": null, - "weight": 718, + "weight": 668, "cookies": false, "type": "", "demo": "organizations\/get-invoice-download.md", @@ -35046,7 +35661,7 @@ "x-appwrite": { "method": "createInvoicePayment", "group": null, - "weight": 719, + "weight": 669, "cookies": false, "type": "", "demo": "organizations\/create-invoice-payment.md", @@ -35136,7 +35751,7 @@ "x-appwrite": { "method": "validateInvoice", "group": null, - "weight": 716, + "weight": 666, "cookies": false, "type": "", "demo": "organizations\/validate-invoice.md", @@ -35207,7 +35822,7 @@ "x-appwrite": { "method": "getInvoiceView", "group": null, - "weight": 717, + "weight": 667, "cookies": false, "type": "", "demo": "organizations\/get-invoice-view.md", @@ -35278,7 +35893,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 730, + "weight": 680, "cookies": false, "type": "", "demo": "organizations\/list-keys.md", @@ -35347,7 +35962,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 728, + "weight": 678, "cookies": false, "type": "", "demo": "organizations\/create-key.md", @@ -35457,7 +36072,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 732, + "weight": 682, "cookies": false, "type": "", "demo": "organizations\/get-key.md", @@ -35525,7 +36140,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 729, + "weight": 679, "cookies": false, "type": "", "demo": "organizations\/update-key.md", @@ -35636,7 +36251,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 731, + "weight": 681, "cookies": false, "type": "", "demo": "organizations\/delete-key.md", @@ -35706,7 +36321,7 @@ "x-appwrite": { "method": "setDefaultPaymentMethod", "group": null, - "weight": 704, + "weight": 654, "cookies": false, "type": "", "demo": "organizations\/set-default-payment-method.md", @@ -35784,7 +36399,7 @@ "x-appwrite": { "method": "deleteDefaultPaymentMethod", "group": null, - "weight": 706, + "weight": 656, "cookies": false, "type": "", "demo": "organizations\/delete-default-payment-method.md", @@ -35845,7 +36460,7 @@ "x-appwrite": { "method": "setBackupPaymentMethod", "group": null, - "weight": 705, + "weight": 655, "cookies": false, "type": "", "demo": "organizations\/set-backup-payment-method.md", @@ -35923,7 +36538,7 @@ "x-appwrite": { "method": "deleteBackupPaymentMethod", "group": null, - "weight": 707, + "weight": 657, "cookies": false, "type": "", "demo": "organizations\/delete-backup-payment-method.md", @@ -35984,7 +36599,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 703, + "weight": 653, "cookies": false, "type": "", "demo": "organizations\/get-payment-method.md", @@ -36055,7 +36670,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 694, + "weight": 644, "cookies": false, "type": "", "demo": "organizations\/get-plan.md", @@ -36114,7 +36729,7 @@ "x-appwrite": { "method": "updatePlan", "group": null, - "weight": 695, + "weight": 645, "cookies": false, "type": "", "demo": "organizations\/update-plan.md", @@ -36232,7 +36847,7 @@ "x-appwrite": { "method": "cancelDowngrade", "group": null, - "weight": 696, + "weight": 646, "cookies": false, "type": "", "demo": "organizations\/cancel-downgrade.md", @@ -36293,7 +36908,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 723, + "weight": 673, "cookies": false, "type": "", "demo": "organizations\/list-regions.md", @@ -36354,7 +36969,7 @@ "x-appwrite": { "method": "getScopes", "group": null, - "weight": 722, + "weight": 672, "cookies": false, "type": "", "demo": "organizations\/get-scopes.md", @@ -36426,7 +37041,7 @@ "x-appwrite": { "method": "setBillingTaxId", "group": null, - "weight": 698, + "weight": 648, "cookies": false, "type": "", "demo": "organizations\/set-billing-tax-id.md", @@ -36506,7 +37121,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 699, + "weight": 649, "cookies": false, "type": "", "demo": "organizations\/get-usage.md", @@ -36585,7 +37200,7 @@ "x-appwrite": { "method": "validatePayment", "group": null, - "weight": 721, + "weight": 671, "cookies": false, "type": "", "demo": "organizations\/validate-payment.md", @@ -36665,7 +37280,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 556, + "weight": 555, "cookies": false, "type": "", "demo": "project\/get-usage.md", @@ -36754,7 +37369,7 @@ "x-appwrite": { "method": "listVariables", "group": null, - "weight": 102, + "weight": 96, "cookies": false, "type": "", "demo": "project\/list-variables.md", @@ -36801,7 +37416,7 @@ "x-appwrite": { "method": "createVariable", "group": null, - "weight": 101, + "weight": 95, "cookies": false, "type": "", "demo": "project\/create-variable.md", @@ -36880,7 +37495,7 @@ "x-appwrite": { "method": "getVariable", "group": null, - "weight": 103, + "weight": 97, "cookies": false, "type": "", "demo": "project\/get-variable.md", @@ -36939,7 +37554,7 @@ "x-appwrite": { "method": "updateVariable", "group": null, - "weight": 104, + "weight": 98, "cookies": false, "type": "", "demo": "project\/update-variable.md", @@ -37022,7 +37637,7 @@ "x-appwrite": { "method": "deleteVariable", "group": null, - "weight": 105, + "weight": 99, "cookies": false, "type": "", "demo": "project\/delete-variable.md", @@ -37083,7 +37698,7 @@ "x-appwrite": { "method": "list", "group": "projects", - "weight": 777, + "weight": 730, "cookies": false, "type": "", "demo": "projects\/list.md", @@ -37166,7 +37781,7 @@ "x-appwrite": { "method": "create", "group": "projects", - "weight": 775, + "weight": 728, "cookies": false, "type": "", "demo": "projects\/create.md", @@ -37366,7 +37981,7 @@ "x-appwrite": { "method": "update", "group": "projects", - "weight": 776, + "weight": 729, "cookies": false, "type": "", "demo": "projects\/update.md", @@ -38580,7 +39195,7 @@ "x-appwrite": { "method": "updateSessionInvalidation", "group": "auth", - "weight": 99, + "weight": 93, "cookies": false, "type": "", "demo": "projects\/update-session-invalidation.md", @@ -38737,6 +39352,60 @@ } } }, + "\/projects\/{projectId}\/console-access": { + "patch": { + "summary": "Record console access to a project", + "operationId": "projectsUpdateConsoleAccess", + "tags": [ + "projects" + ], + "description": "Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.\n", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateConsoleAccess", + "group": null, + "weight": 725, + "cookies": false, + "type": "", + "demo": "projects\/update-console-access.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-console-access.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project ID", + "required": true, + "schema": { + "type": "string", + "x-example": "<PROJECT_ID>" + }, + "in": "path" + } + ] + } + }, "\/projects\/{projectId}\/dev-keys": { "get": { "summary": "List dev keys", @@ -38761,7 +39430,7 @@ "x-appwrite": { "method": "listDevKeys", "group": "devKeys", - "weight": 410, + "weight": 388, "cookies": false, "type": "", "demo": "projects\/list-dev-keys.md", @@ -38832,7 +39501,7 @@ "x-appwrite": { "method": "createDevKey", "group": "devKeys", - "weight": 407, + "weight": 385, "cookies": false, "type": "", "demo": "projects\/create-dev-key.md", @@ -38917,7 +39586,7 @@ "x-appwrite": { "method": "getDevKey", "group": "devKeys", - "weight": 409, + "weight": 387, "cookies": false, "type": "", "demo": "projects\/get-dev-key.md", @@ -38985,7 +39654,7 @@ "x-appwrite": { "method": "updateDevKey", "group": "devKeys", - "weight": 408, + "weight": 386, "cookies": false, "type": "", "demo": "projects\/update-dev-key.md", @@ -39071,7 +39740,7 @@ "x-appwrite": { "method": "deleteDevKey", "group": "devKeys", - "weight": 411, + "weight": 389, "cookies": false, "type": "", "demo": "projects\/delete-dev-key.md", @@ -39141,7 +39810,7 @@ "x-appwrite": { "method": "createJWT", "group": "auth", - "weight": 85, + "weight": 79, "cookies": false, "type": "", "demo": "projects\/create-jwt.md", @@ -39246,6 +39915,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -39300,7 +39971,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 81, + "weight": 75, "cookies": false, "type": "", "demo": "projects\/list-keys.md", @@ -39383,7 +40054,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 80, + "weight": 74, "cookies": false, "type": "", "demo": "projects\/create-key.md", @@ -39498,6 +40169,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -39554,7 +40227,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 82, + "weight": 76, "cookies": false, "type": "", "demo": "projects\/get-key.md", @@ -39623,7 +40296,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 83, + "weight": 77, "cookies": false, "type": "", "demo": "projects\/update-key.md", @@ -39743,6 +40416,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -39790,7 +40465,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 84, + "weight": 78, "cookies": false, "type": "", "demo": "projects\/delete-key.md", @@ -39861,7 +40536,7 @@ "x-appwrite": { "method": "updateLabels", "group": "projects", - "weight": 415, + "weight": 393, "cookies": false, "type": "", "demo": "projects\/update-labels.md", @@ -40084,7 +40759,7 @@ "x-appwrite": { "method": "listPlatforms", "group": "platforms", - "weight": 87, + "weight": 81, "cookies": false, "type": "", "demo": "projects\/list-platforms.md", @@ -40154,7 +40829,7 @@ "x-appwrite": { "method": "createPlatform", "group": "platforms", - "weight": 86, + "weight": 80, "cookies": false, "type": "", "demo": "projects\/create-platform.md", @@ -40274,7 +40949,7 @@ "x-appwrite": { "method": "getPlatform", "group": "platforms", - "weight": 88, + "weight": 82, "cookies": false, "type": "", "demo": "projects\/get-platform.md", @@ -40343,7 +41018,7 @@ "x-appwrite": { "method": "updatePlatform", "group": "platforms", - "weight": 89, + "weight": 83, "cookies": false, "type": "", "demo": "projects\/update-platform.md", @@ -40439,7 +41114,7 @@ "x-appwrite": { "method": "deletePlatform", "group": "platforms", - "weight": 90, + "weight": 84, "cookies": false, "type": "", "demo": "projects\/delete-platform.md", @@ -40510,7 +41185,7 @@ "x-appwrite": { "method": "listSchedules", "group": "schedules", - "weight": 419, + "weight": 397, "cookies": false, "type": "", "demo": "projects\/list-schedules.md", @@ -40593,7 +41268,7 @@ "x-appwrite": { "method": "createSchedule", "group": "schedules", - "weight": 778, + "weight": 731, "cookies": false, "type": "", "demo": "projects\/create-schedule.md", @@ -40703,7 +41378,7 @@ "x-appwrite": { "method": "getSchedule", "group": "schedules", - "weight": 418, + "weight": 396, "cookies": false, "type": "", "demo": "projects\/get-schedule.md", @@ -40957,7 +41632,7 @@ "x-appwrite": { "method": "updateSmtp", "group": "templates", - "weight": 91, + "weight": 85, "cookies": false, "type": "", "demo": "projects\/update-smtp.md", @@ -41155,7 +41830,7 @@ "x-appwrite": { "method": "createSmtpTest", "group": "templates", - "weight": 92, + "weight": 86, "cookies": false, "type": "", "demo": "projects\/create-smtp-test.md", @@ -41346,44 +42021,37 @@ } } }, - "\/projects\/{projectId}\/team": { + "\/projects\/{projectId}\/status": { "patch": { - "summary": "Update project team", - "operationId": "projectsUpdateTeam", + "summary": "Update the status of a project", + "operationId": "projectsUpdateStatus", "tags": [ "projects" ], - "description": "Update the team ID of a project allowing for it to be transferred to another team.", + "description": "Update the status of a project. Can be used to archive\/restore projects, and to restore paused projects. When restoring a paused project, the console fingerprint header must be provided and the project must not be blocked for any reason other than inactivity.\n", "responses": { - "200": { - "description": "Project", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/project" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateTeam", - "group": "projects", - "weight": 774, + "method": "updateStatus", + "group": null, + "weight": 726, "cookies": false, "type": "", - "demo": "projects\/update-team.md", - "rate-limit": 0, + "demo": "projects\/update-status.md", + "rate-limit": 10, "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", + "rate-key": "ip:{ip},userId:{userId}", "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-status.md", "auth": { "Project": [] } @@ -41396,7 +42064,7 @@ "parameters": [ { "name": "projectId", - "description": "Project unique ID.", + "description": "Project ID", "required": true, "schema": { "type": "string", @@ -41411,14 +42079,19 @@ "schema": { "type": "object", "properties": { - "teamId": { + "status": { "type": "string", - "description": "Team ID of the team to transfer project to.", - "x-example": "<TEAM_ID>" + "description": "New status for the project", + "x-example": "active", + "enum": [ + "active" + ], + "x-enum-name": null, + "x-enum-keys": [] } }, "required": [ - "teamId" + "status" ] } } @@ -41426,21 +42099,21 @@ } } }, - "\/projects\/{projectId}\/templates\/email\/{type}\/{locale}": { - "get": { - "summary": "Get custom email template", - "operationId": "projectsGetEmailTemplate", + "\/projects\/{projectId}\/team": { + "patch": { + "summary": "Update project team", + "operationId": "projectsUpdateTeam", "tags": [ "projects" ], - "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details. ", + "description": "Update the team ID of a project allowing for it to be transferred to another team.", "responses": { "200": { - "description": "EmailTemplate", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/emailTemplate" + "$ref": "#\/components\/schemas\/project" } } } @@ -41448,12 +42121,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "getEmailTemplate", - "group": "templates", - "weight": 94, + "method": "updateTeam", + "group": "projects", + "weight": 727, "cookies": false, "type": "", - "demo": "projects\/get-email-template.md", + "demo": "projects\/update-team.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -41463,7 +42136,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-email-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-team.md", "auth": { "Project": [] } @@ -41483,182 +42156,37 @@ "x-example": "<PROJECT_ID>" }, "in": "path" - }, - { - "name": "type", - "description": "Template type", - "required": true, - "schema": { - "type": "string", - "x-example": "verification", - "enum": [ - "verification", - "magicSession", - "recovery", - "invitation", - "mfaChallenge", - "sessionAlert", - "otpSession" - ], - "x-enum-name": "EmailTemplateType", - "x-enum-keys": [] - }, - "in": "path" - }, - { - "name": "locale", - "description": "Template locale", - "required": true, - "schema": { - "type": "string", - "x-example": "af", - "enum": [ - "af", - "ar-ae", - "ar-bh", - "ar-dz", - "ar-eg", - "ar-iq", - "ar-jo", - "ar-kw", - "ar-lb", - "ar-ly", - "ar-ma", - "ar-om", - "ar-qa", - "ar-sa", - "ar-sy", - "ar-tn", - "ar-ye", - "as", - "az", - "be", - "bg", - "bh", - "bn", - "bs", - "ca", - "cs", - "cy", - "da", - "de", - "de-at", - "de-ch", - "de-li", - "de-lu", - "el", - "en", - "en-au", - "en-bz", - "en-ca", - "en-gb", - "en-ie", - "en-jm", - "en-nz", - "en-tt", - "en-us", - "en-za", - "eo", - "es", - "es-ar", - "es-bo", - "es-cl", - "es-co", - "es-cr", - "es-do", - "es-ec", - "es-gt", - "es-hn", - "es-mx", - "es-ni", - "es-pa", - "es-pe", - "es-pr", - "es-py", - "es-sv", - "es-uy", - "es-ve", - "et", - "eu", - "fa", - "fi", - "fo", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "fr-lu", - "ga", - "gd", - "he", - "hi", - "hr", - "hu", - "id", - "is", - "it", - "it-ch", - "ja", - "ji", - "ko", - "ku", - "lt", - "lv", - "mk", - "ml", - "ms", - "mt", - "nb", - "ne", - "nl", - "nl-be", - "nn", - "no", - "pa", - "pl", - "pt", - "pt-br", - "rm", - "ro", - "ro-md", - "ru", - "ru-md", - "sb", - "sk", - "sl", - "sq", - "sr", - "sv", - "sv-fi", - "th", - "tn", - "tr", - "ts", - "ua", - "ur", - "ve", - "vi", - "xh", - "zh-cn", - "zh-hk", - "zh-sg", - "zh-tw", - "zu" - ], - "x-enum-name": "EmailTemplateLocale", - "x-enum-keys": [] - }, - "in": "path" } - ] - }, - "patch": { - "summary": "Update custom email templates", - "operationId": "projectsUpdateEmailTemplate", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team ID of the team to transfer project to.", + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "teamId" + ] + } + } + } + } + } + }, + "\/projects\/{projectId}\/templates\/email\/{type}\/{locale}": { + "get": { + "summary": "Get custom email template", + "operationId": "projectsGetEmailTemplate", "tags": [ "projects" ], - "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", + "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details. ", "responses": { "200": { "description": "EmailTemplate", @@ -41673,12 +42201,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEmailTemplate", + "method": "getEmailTemplate", "group": "templates", - "weight": 96, + "weight": 88, "cookies": false, "type": "", - "demo": "projects\/update-email-template.md", + "demo": "projects\/get-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -41688,7 +42216,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-email-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-email-template.md", "auth": { "Project": [] } @@ -41875,57 +42403,15 @@ }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "subject": { - "type": "string", - "description": "Email Subject", - "x-example": "<SUBJECT>" - }, - "message": { - "type": "string", - "description": "Template message", - "x-example": "<MESSAGE>" - }, - "senderName": { - "type": "string", - "description": "Name of the email sender", - "x-example": "<SENDER_NAME>" - }, - "senderEmail": { - "type": "string", - "description": "Email of the sender", - "x-example": "email@example.com", - "format": "email" - }, - "replyTo": { - "type": "string", - "description": "Reply to email", - "x-example": "email@example.com", - "format": "email" - } - }, - "required": [ - "subject", - "message" - ] - } - } - } - } + ] }, - "delete": { - "summary": "Delete custom email template", - "operationId": "projectsDeleteEmailTemplate", + "patch": { + "summary": "Update custom email templates", + "operationId": "projectsUpdateEmailTemplate", "tags": [ "projects" ], - "description": "Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state. ", + "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", "responses": { "200": { "description": "EmailTemplate", @@ -41940,12 +42426,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteEmailTemplate", + "method": "updateEmailTemplate", "group": "templates", - "weight": 98, + "weight": 90, "cookies": false, "type": "", - "demo": "projects\/delete-email-template.md", + "demo": "projects\/update-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -41955,7 +42441,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-email-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-email-template.md", "auth": { "Project": [] } @@ -42142,37 +42628,77 @@ }, "in": "path" } - ] - } - }, - "\/projects\/{projectId}\/templates\/sms\/{type}\/{locale}": { - "get": { - "summary": "Get custom SMS template", - "operationId": "projectsGetSmsTemplate", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "subject": { + "type": "string", + "description": "Email Subject", + "x-example": "<SUBJECT>" + }, + "message": { + "type": "string", + "description": "Template message", + "x-example": "<MESSAGE>" + }, + "senderName": { + "type": "string", + "description": "Name of the email sender", + "x-example": "<SENDER_NAME>" + }, + "senderEmail": { + "type": "string", + "description": "Email of the sender", + "x-example": "email@example.com", + "format": "email" + }, + "replyTo": { + "type": "string", + "description": "Reply to email", + "x-example": "email@example.com", + "format": "email" + } + }, + "required": [ + "subject", + "message" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete custom email template", + "operationId": "projectsDeleteEmailTemplate", "tags": [ "projects" ], - "description": "Get a custom SMS template for the specified locale and type returning it's contents.", + "description": "Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state. ", "responses": { "200": { - "description": "SmsTemplate", + "description": "EmailTemplate", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/smsTemplate" + "$ref": "#\/components\/schemas\/emailTemplate" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getSmsTemplate", + "method": "deleteEmailTemplate", "group": "templates", - "weight": 93, + "weight": 92, "cookies": false, "type": "", - "demo": "projects\/get-sms-template.md", + "demo": "projects\/delete-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42181,72 +42707,8 @@ "console" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-sms-template.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.getSMSTemplate" - }, - "methods": [ - { - "name": "getSmsTemplate", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "projectId", - "type", - "locale" - ], - "required": [ - "projectId", - "type", - "locale" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/smsTemplate" - } - ], - "description": "Get a custom SMS template for the specified locale and type returning it's contents.", - "demo": "projects\/get-sms-template.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.getSMSTemplate" - } - }, - { - "name": "getSMSTemplate", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "projectId", - "type", - "locale" - ], - "required": [ - "projectId", - "type", - "locale" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/smsTemplate" - } - ], - "description": "Get a custom SMS template for the specified locale and type returning it's contents.", - "demo": "projects\/get-sms-template.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-email-template.md", "auth": { "Project": [] } @@ -42276,11 +42738,14 @@ "x-example": "verification", "enum": [ "verification", - "login", + "magicSession", + "recovery", "invitation", - "mfaChallenge" + "mfaChallenge", + "sessionAlert", + "otpSession" ], - "x-enum-name": "SmsTemplateType", + "x-enum-name": "EmailTemplateType", "x-enum-keys": [] }, "in": "path" @@ -42425,20 +42890,22 @@ "zh-tw", "zu" ], - "x-enum-name": "SmsTemplateLocale", + "x-enum-name": "EmailTemplateLocale", "x-enum-keys": [] }, "in": "path" } ] - }, - "patch": { - "summary": "Update custom SMS template", - "operationId": "projectsUpdateSmsTemplate", + } + }, + "\/projects\/{projectId}\/templates\/sms\/{type}\/{locale}": { + "get": { + "summary": "Get custom SMS template", + "operationId": "projectsGetSmsTemplate", "tags": [ "projects" ], - "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", + "description": "Get a custom SMS template for the specified locale and type returning it's contents.", "responses": { "200": { "description": "SmsTemplate", @@ -42453,12 +42920,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateSmsTemplate", + "method": "getSmsTemplate", "group": "templates", - "weight": 95, + "weight": 87, "cookies": false, "type": "", - "demo": "projects\/update-sms-template.md", + "demo": "projects\/get-sms-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42468,14 +42935,14 @@ ], "packaging": false, "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-sms-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-sms-template.md", "deprecated": { "since": "1.8.0", - "replaceWith": "projects.updateSMSTemplate" + "replaceWith": "projects.getSMSTemplate" }, "methods": [ { - "name": "updateSmsTemplate", + "name": "getSmsTemplate", "namespace": "projects", "desc": "", "auth": { @@ -42484,14 +42951,12 @@ "parameters": [ "projectId", "type", - "locale", - "message" + "locale" ], "required": [ "projectId", "type", - "locale", - "message" + "locale" ], "responses": [ { @@ -42499,16 +42964,16 @@ "model": "#\/components\/schemas\/smsTemplate" } ], - "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", - "demo": "projects\/update-sms-template.md", + "description": "Get a custom SMS template for the specified locale and type returning it's contents.", + "demo": "projects\/get-sms-template.md", "public": false, "deprecated": { "since": "1.8.0", - "replaceWith": "projects.updateSMSTemplate" + "replaceWith": "projects.getSMSTemplate" } }, { - "name": "updateSMSTemplate", + "name": "getSMSTemplate", "namespace": "projects", "desc": "", "auth": { @@ -42517,14 +42982,12 @@ "parameters": [ "projectId", "type", - "locale", - "message" + "locale" ], "required": [ "projectId", "type", - "locale", - "message" + "locale" ], "responses": [ { @@ -42532,8 +42995,8 @@ "model": "#\/components\/schemas\/smsTemplate" } ], - "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", - "demo": "projects\/update-sms-template.md", + "description": "Get a custom SMS template for the specified locale and type returning it's contents.", + "demo": "projects\/get-sms-template.md", "public": true } ], @@ -42720,34 +43183,15 @@ }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Template message", - "x-example": "<MESSAGE>" - } - }, - "required": [ - "message" - ] - } - } - } - } + ] }, - "delete": { - "summary": "Reset custom SMS template", - "operationId": "projectsDeleteSmsTemplate", + "patch": { + "summary": "Update custom SMS template", + "operationId": "projectsUpdateSmsTemplate", "tags": [ "projects" ], - "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", + "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", "responses": { "200": { "description": "SmsTemplate", @@ -42762,12 +43206,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "deleteSmsTemplate", + "method": "updateSmsTemplate", "group": "templates", - "weight": 97, + "weight": 89, "cookies": false, "type": "", - "demo": "projects\/delete-sms-template.md", + "demo": "projects\/update-sms-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42777,14 +43221,14 @@ ], "packaging": false, "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-sms-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-sms-template.md", "deprecated": { "since": "1.8.0", - "replaceWith": "projects.deleteSMSTemplate" + "replaceWith": "projects.updateSMSTemplate" }, "methods": [ { - "name": "deleteSmsTemplate", + "name": "updateSmsTemplate", "namespace": "projects", "desc": "", "auth": { @@ -42793,12 +43237,14 @@ "parameters": [ "projectId", "type", - "locale" + "locale", + "message" ], "required": [ "projectId", "type", - "locale" + "locale", + "message" ], "responses": [ { @@ -42806,16 +43252,16 @@ "model": "#\/components\/schemas\/smsTemplate" } ], - "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", - "demo": "projects\/delete-sms-template.md", + "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", + "demo": "projects\/update-sms-template.md", "public": false, "deprecated": { "since": "1.8.0", - "replaceWith": "projects.deleteSMSTemplate" + "replaceWith": "projects.updateSMSTemplate" } }, { - "name": "deleteSMSTemplate", + "name": "updateSMSTemplate", "namespace": "projects", "desc": "", "auth": { @@ -42824,12 +43270,14 @@ "parameters": [ "projectId", "type", - "locale" + "locale", + "message" ], "required": [ "projectId", "type", - "locale" + "locale", + "message" ], "responses": [ { @@ -42837,8 +43285,8 @@ "model": "#\/components\/schemas\/smsTemplate" } ], - "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", - "demo": "projects\/delete-sms-template.md", + "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", + "demo": "projects\/update-sms-template.md", "public": true } ], @@ -43025,137 +43473,6 @@ }, "in": "path" } - ] - } - }, - "\/projects\/{projectId}\/webhooks": { - "get": { - "summary": "List webhooks", - "operationId": "projectsListWebhooks", - "tags": [ - "projects" - ], - "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results. ", - "responses": { - "200": { - "description": "Webhooks List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/webhookList" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listWebhooks", - "group": "webhooks", - "weight": 75, - "cookies": false, - "type": "", - "demo": "projects\/list-webhooks.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-webhooks.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<PROJECT_ID>" - }, - "in": "path" - }, - { - "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 webhook", - "operationId": "projectsCreateWebhook", - "tags": [ - "projects" - ], - "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur. ", - "responses": { - "201": { - "description": "Webhook", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/webhook" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createWebhook", - "group": "webhooks", - "weight": 74, - "cookies": false, - "type": "", - "demo": "projects\/create-webhook.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-webhook.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<PROJECT_ID>" - }, - "in": "path" - } ], "requestBody": { "content": { @@ -43163,154 +43480,47 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Webhook name. Max length: 128 chars.", - "x-example": "<NAME>" - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "x-example": false - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "x-example": null, - "items": { - "type": "string" - } - }, - "url": { - "type": "string", - "description": "Webhook URL.", - "x-example": null - }, - "security": { - "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", - "x-example": false - }, - "httpUser": { - "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "x-example": "<HTTP_USER>" - }, - "httpPass": { + "message": { "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "x-example": "<HTTP_PASS>" + "description": "Template message", + "x-example": "<MESSAGE>" } }, "required": [ - "name", - "events", - "url", - "security" + "message" ] } } } } - } - }, - "\/projects\/{projectId}\/webhooks\/{webhookId}": { - "get": { - "summary": "Get webhook", - "operationId": "projectsGetWebhook", - "tags": [ - "projects" - ], - "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", - "responses": { - "200": { - "description": "Webhook", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/webhook" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getWebhook", - "group": "webhooks", - "weight": 76, - "cookies": false, - "type": "", - "demo": "projects\/get-webhook.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-webhook.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<PROJECT_ID>" - }, - "in": "path" - }, - { - "name": "webhookId", - "description": "Webhook unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<WEBHOOK_ID>" - }, - "in": "path" - } - ] }, - "put": { - "summary": "Update webhook", - "operationId": "projectsUpdateWebhook", + "delete": { + "summary": "Reset custom SMS template", + "operationId": "projectsDeleteSmsTemplate", "tags": [ "projects" ], - "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook. ", + "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", "responses": { "200": { - "description": "Webhook", + "description": "SmsTemplate", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/webhook" + "$ref": "#\/components\/schemas\/smsTemplate" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateWebhook", - "group": "webhooks", - "weight": 77, + "method": "deleteSmsTemplate", + "group": "templates", + "weight": 91, "cookies": false, "type": "", - "demo": "projects\/update-webhook.md", + "demo": "projects\/delete-sms-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -43319,125 +43529,72 @@ "console" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-webhook.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<PROJECT_ID>" - }, - "in": "path" + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-sms-template.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.deleteSMSTemplate" }, - { - "name": "webhookId", - "description": "Webhook unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<WEBHOOK_ID>" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Webhook name. Max length: 128 chars.", - "x-example": "<NAME>" - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "x-example": false - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "x-example": null, - "items": { - "type": "string" - } - }, - "url": { - "type": "string", - "description": "Webhook URL.", - "x-example": null - }, - "security": { - "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", - "x-example": false - }, - "httpUser": { - "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "x-example": "<HTTP_USER>" - }, - "httpPass": { - "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "x-example": "<HTTP_PASS>" - } - }, - "required": [ - "name", - "events", - "url", - "security" - ] + "methods": [ + { + "name": "deleteSmsTemplate", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "projectId", + "type", + "locale" + ], + "required": [ + "projectId", + "type", + "locale" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/smsTemplate" + } + ], + "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", + "demo": "projects\/delete-sms-template.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.deleteSMSTemplate" } + }, + { + "name": "deleteSMSTemplate", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "projectId", + "type", + "locale" + ], + "required": [ + "projectId", + "type", + "locale" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/smsTemplate" + } + ], + "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", + "demo": "projects\/delete-sms-template.md", + "public": true } - } - } - }, - "delete": { - "summary": "Delete webhook", - "operationId": "projectsDeleteWebhook", - "tags": [ - "projects" - ], - "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteWebhook", - "group": "webhooks", - "weight": 79, - "cookies": false, - "type": "", - "demo": "projects\/delete-webhook.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", - "platforms": [ - "console" ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-webhook.md", "auth": { "Project": [] } @@ -43459,83 +43616,165 @@ "in": "path" }, { - "name": "webhookId", - "description": "Webhook unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "<WEBHOOK_ID>" - }, - "in": "path" - } - ] - } - }, - "\/projects\/{projectId}\/webhooks\/{webhookId}\/signature": { - "patch": { - "summary": "Update webhook signature key", - "operationId": "projectsUpdateWebhookSignature", - "tags": [ - "projects" - ], - "description": "Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook. ", - "responses": { - "200": { - "description": "Webhook", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/webhook" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateWebhookSignature", - "group": "webhooks", - "weight": 78, - "cookies": false, - "type": "", - "demo": "projects\/update-webhook-signature.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-webhook-signature.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", + "name": "type", + "description": "Template type", "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "x-example": "verification", + "enum": [ + "verification", + "login", + "invitation", + "mfaChallenge" + ], + "x-enum-name": "SmsTemplateType", + "x-enum-keys": [] }, "in": "path" }, { - "name": "webhookId", - "description": "Webhook unique ID.", + "name": "locale", + "description": "Template locale", "required": true, "schema": { "type": "string", - "x-example": "<WEBHOOK_ID>" + "x-example": "af", + "enum": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ], + "x-enum-name": "SmsTemplateLocale", + "x-enum-keys": [] }, "in": "path" } @@ -43566,7 +43805,7 @@ "x-appwrite": { "method": "listRules", "group": null, - "weight": 787, + "weight": 741, "cookies": false, "type": "", "demo": "proxy\/list-rules.md", @@ -43651,7 +43890,7 @@ "x-appwrite": { "method": "createAPIRule", "group": null, - "weight": 782, + "weight": 736, "cookies": false, "type": "", "demo": "proxy\/create-api-rule.md", @@ -43718,7 +43957,7 @@ "x-appwrite": { "method": "createFunctionRule", "group": null, - "weight": 784, + "weight": 738, "cookies": false, "type": "", "demo": "proxy\/create-function-rule.md", @@ -43796,7 +44035,7 @@ "x-appwrite": { "method": "createRedirectRule", "group": null, - "weight": 785, + "weight": 739, "cookies": false, "type": "", "demo": "proxy\/create-redirect-rule.md", @@ -43910,7 +44149,7 @@ "x-appwrite": { "method": "createSiteRule", "group": null, - "weight": 783, + "weight": 737, "cookies": false, "type": "", "demo": "proxy\/create-site-rule.md", @@ -43988,7 +44227,7 @@ "x-appwrite": { "method": "getRule", "group": null, - "weight": 786, + "weight": 740, "cookies": false, "type": "", "demo": "proxy\/get-rule.md", @@ -44039,7 +44278,7 @@ "x-appwrite": { "method": "deleteRule", "group": null, - "weight": 788, + "weight": 742, "cookies": false, "type": "", "demo": "proxy\/delete-rule.md", @@ -44099,7 +44338,7 @@ "x-appwrite": { "method": "updateRuleVerification", "group": null, - "weight": 789, + "weight": 743, "cookies": false, "type": "", "demo": "proxy\/update-rule-verification.md", @@ -44159,7 +44398,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 590, + "weight": 455, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -44244,7 +44483,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 588, + "weight": 559, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -44334,6 +44573,11 @@ "description": "Build Command.", "x-example": "<BUILD_COMMAND>" }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "x-example": "<START_COMMAND>" + }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", @@ -44375,9 +44619,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -44432,7 +44673,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -44478,10 +44805,21 @@ "description": "Path to site code in the linked repo.", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "x-example": null + }, + "runtimeSpecification": { "type": "string", - "description": "Framework specification for the site and builds.", + "description": "Runtime specification for the SSR executions.", "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" } }, "required": [ @@ -44520,7 +44858,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 593, + "weight": 458, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -44570,7 +44908,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 616, + "weight": 481, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -44620,7 +44958,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 612, + "weight": 477, "cookies": false, "type": "", "demo": "sites\/list-templates.md", @@ -44752,7 +45090,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 613, + "weight": 478, "cookies": false, "type": "", "demo": "sites\/get-template.md", @@ -44812,7 +45150,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 614, + "weight": 479, "cookies": false, "type": "", "demo": "sites\/list-usage.md", @@ -44884,7 +45222,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 589, + "weight": 454, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -44944,7 +45282,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 591, + "weight": 560, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -45041,6 +45379,11 @@ "description": "Build Command.", "x-example": "<BUILD_COMMAND>" }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "x-example": "<START_COMMAND>" + }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", @@ -45082,9 +45425,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -45139,7 +45479,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -45185,10 +45611,21 @@ "description": "Path to site code in the linked repo.", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { "type": "string", - "description": "Framework specification for the site and builds.", + "description": "Build specification for the site deployments.", "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" } }, "required": [ @@ -45216,7 +45653,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 592, + "weight": 457, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -45278,7 +45715,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 599, + "weight": 464, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -45359,7 +45796,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 598, + "weight": 463, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -45454,7 +45891,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 594, + "weight": 459, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -45527,8 +45964,7 @@ } }, "required": [ - "code", - "activate" + "code" ] } } @@ -45560,7 +45996,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 602, + "weight": 467, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -45641,7 +46077,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 595, + "weight": 460, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -45758,7 +46194,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 596, + "weight": 461, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -45857,7 +46293,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 597, + "weight": 462, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -45920,7 +46356,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 600, + "weight": 465, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -45985,7 +46421,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 601, + "weight": 466, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -46076,7 +46512,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 603, + "weight": 468, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -46148,7 +46584,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 605, + "weight": 470, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -46234,7 +46670,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 604, + "weight": 469, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -46297,7 +46733,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 606, + "weight": 471, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -46369,7 +46805,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 615, + "weight": 480, "cookies": false, "type": "", "demo": "sites\/get-usage.md", @@ -46451,7 +46887,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 609, + "weight": 474, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -46511,7 +46947,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 607, + "weight": 561, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -46603,7 +47039,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 608, + "weight": 473, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -46673,7 +47109,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 610, + "weight": 475, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -46767,7 +47203,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 611, + "weight": 476, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -46839,7 +47275,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 530, + "weight": 522, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -46925,7 +47361,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 528, + "weight": 520, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -47061,7 +47497,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 529, + "weight": 521, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -47122,7 +47558,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 531, + "weight": 523, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -47255,7 +47691,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 532, + "weight": 524, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -47318,7 +47754,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 535, + "weight": 527, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -47417,7 +47853,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 781, + "weight": 734, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -47519,7 +47955,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 534, + "weight": 526, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -47593,7 +48029,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 536, + "weight": 528, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -47685,7 +48121,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 537, + "weight": 529, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -47754,7 +48190,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 539, + "weight": 531, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -47834,7 +48270,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 538, + "weight": 530, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -48064,7 +48500,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 540, + "weight": 532, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -48151,7 +48587,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 542, + "weight": 534, "cookies": false, "type": "", "demo": "storage\/get-usage.md", @@ -48224,7 +48660,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 543, + "weight": 535, "cookies": false, "type": "", "demo": "storage\/get-bucket-usage.md", @@ -48307,7 +48743,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 338, + "weight": 316, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -48393,7 +48829,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 334, + "weight": 312, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -48474,7 +48910,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 405, + "weight": 383, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -48544,7 +48980,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 401, + "weight": 379, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -48618,7 +49054,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 402, + "weight": 380, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -48685,7 +49121,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 403, + "weight": 381, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -48766,7 +49202,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 404, + "weight": 382, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -48835,7 +49271,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 406, + "weight": 384, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -48923,7 +49359,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 340, + "weight": 318, "cookies": false, "type": "", "demo": "tablesdb\/list-usage.md", @@ -49022,7 +49458,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 335, + "weight": 313, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -49083,7 +49519,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 336, + "weight": 314, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -49158,7 +49594,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 337, + "weight": 315, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -49221,7 +49657,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 345, + "weight": 323, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -49320,7 +49756,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 341, + "weight": 319, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -49446,7 +49882,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 342, + "weight": 320, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -49520,7 +49956,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 343, + "weight": 321, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -49622,7 +50058,7 @@ "x-appwrite": { "method": "deleteTable", "group": "tables", - "weight": 344, + "weight": 322, "cookies": false, "type": "", "demo": "tablesdb\/delete-table.md", @@ -49698,7 +50134,7 @@ "x-appwrite": { "method": "listColumns", "group": "columns", - "weight": 350, + "weight": 328, "cookies": false, "type": "", "demo": "tablesdb\/list-columns.md", @@ -49798,7 +50234,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 351, + "weight": 329, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -49910,7 +50346,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 352, + "weight": 330, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -50027,7 +50463,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 353, + "weight": 331, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -50139,7 +50575,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 354, + "weight": 332, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -50256,7 +50692,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 355, + "weight": 333, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -50369,7 +50805,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 356, + "weight": 334, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -50487,7 +50923,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 357, + "weight": 335, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -50608,7 +51044,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 358, + "weight": 336, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -50734,7 +51170,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 359, + "weight": 337, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -50861,7 +51297,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 360, + "weight": 338, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -50993,7 +51429,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 361, + "weight": 339, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -51120,7 +51556,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 362, + "weight": 340, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -51252,7 +51688,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 363, + "weight": 341, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -51364,7 +51800,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 364, + "weight": 342, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -51481,7 +51917,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 365, + "weight": 343, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -51595,7 +52031,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 366, + "weight": 344, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -51718,7 +52154,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 383, + "weight": 361, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -51835,7 +52271,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 384, + "weight": 362, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -51952,7 +52388,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 381, + "weight": 359, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -52069,7 +52505,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 382, + "weight": 360, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -52186,7 +52622,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 367, + "weight": 345, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -52300,7 +52736,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 368, + "weight": 346, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -52423,7 +52859,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 369, + "weight": 347, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -52537,7 +52973,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 370, + "weight": 348, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -52660,7 +53096,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 371, + "weight": 349, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -52798,7 +53234,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 373, + "weight": 351, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -52926,7 +53362,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 374, + "weight": 352, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -53054,7 +53490,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 379, + "weight": 357, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -53171,7 +53607,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 380, + "weight": 358, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -53288,7 +53724,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 375, + "weight": 353, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -53401,7 +53837,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 376, + "weight": 354, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -53519,7 +53955,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 377, + "weight": 355, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -53643,7 +54079,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 378, + "weight": 356, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -53798,7 +54234,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 348, + "weight": 326, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -53874,7 +54310,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 349, + "weight": 327, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -53959,7 +54395,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 372, + "weight": 350, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -54074,7 +54510,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 388, + "weight": 366, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -54172,7 +54608,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 385, + "weight": 363, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -54312,7 +54748,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 386, + "weight": 364, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -54388,7 +54824,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 387, + "weight": 365, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -54473,7 +54909,7 @@ "x-appwrite": { "method": "listTableLogs", "group": "tables", - "weight": 346, + "weight": 324, "cookies": false, "type": "", "demo": "tablesdb\/list-table-logs.md", @@ -54560,7 +54996,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 397, + "weight": 375, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -54645,6 +55081,18 @@ "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" } ] }, @@ -54671,7 +55119,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 389, + "weight": 367, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -54853,7 +55301,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 394, + "weight": 372, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -54985,7 +55433,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 392, + "weight": 370, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -55089,7 +55537,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 396, + "weight": 374, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -55190,7 +55638,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 390, + "weight": 368, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -55300,7 +55748,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 393, + "weight": 371, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -55450,7 +55898,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 391, + "weight": 369, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -55561,7 +56009,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 395, + "weight": 373, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -55667,7 +56115,7 @@ "x-appwrite": { "method": "listRowLogs", "group": "logs", - "weight": 398, + "weight": 376, "cookies": false, "type": "", "demo": "tablesdb\/list-row-logs.md", @@ -55764,7 +56212,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 400, + "weight": 378, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -55892,7 +56340,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 399, + "weight": 377, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -56020,7 +56468,7 @@ "x-appwrite": { "method": "getTableUsage", "group": null, - "weight": 347, + "weight": 325, "cookies": false, "type": "", "demo": "tablesdb\/get-table-usage.md", @@ -56116,7 +56564,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 339, + "weight": 317, "cookies": false, "type": "", "demo": "tablesdb\/get-usage.md", @@ -56228,7 +56676,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 107, + "weight": 503, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -56317,7 +56765,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 106, + "weight": 501, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -56404,7 +56852,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 108, + "weight": 502, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -56468,7 +56916,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 110, + "weight": 505, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -56544,7 +56992,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 112, + "weight": 504, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -56610,7 +57058,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 119, + "weight": 514, "cookies": false, "type": "", "demo": "teams\/list-logs.md", @@ -56695,7 +57143,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 114, + "weight": 510, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -56794,7 +57242,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 113, + "weight": 508, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -56859,7 +57307,7 @@ }, "roles": { "type": "array", - "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "x-example": null, "items": { "type": "string" @@ -56910,7 +57358,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 115, + "weight": 509, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -56962,7 +57410,7 @@ ] }, "patch": { - "summary": "Update membership", + "summary": "Update team membership", "operationId": "teamsUpdateMembership", "tags": [ "teams" @@ -56984,7 +57432,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 116, + "weight": 511, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -57042,7 +57490,7 @@ "properties": { "roles": { "type": "array", - "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "x-example": null, "items": { "type": "string" @@ -57072,8 +57520,8 @@ "deprecated": false, "x-appwrite": { "method": "deleteMembership", - "group": null, - "weight": 555, + "group": "memberships", + "weight": 735, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -57149,7 +57597,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 117, + "weight": 513, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -57248,7 +57696,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 109, + "weight": 506, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -57288,7 +57736,7 @@ ] }, "put": { - "summary": "Update preferences", + "summary": "Update team preferences", "operationId": "teamsUpdatePrefs", "tags": [ "teams" @@ -57310,7 +57758,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 111, + "weight": 507, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -57393,7 +57841,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 525, + "weight": 517, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -57487,7 +57935,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 523, + "weight": 515, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -57576,7 +58024,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 524, + "weight": 516, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -57636,7 +58084,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 526, + "weight": 518, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -57706,7 +58154,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 527, + "weight": 519, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -57768,7 +58216,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 129, + "weight": 109, "cookies": false, "type": "", "demo": "users\/list.md", @@ -57854,7 +58302,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 120, + "weight": 100, "cookies": false, "type": "", "demo": "users\/create.md", @@ -57948,7 +58396,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 123, + "weight": 103, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -58037,7 +58485,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 121, + "weight": 101, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -58126,7 +58574,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 137, + "weight": 117, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -58207,7 +58655,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 160, + "weight": 140, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -58270,7 +58718,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 122, + "weight": 102, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -58359,7 +58807,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 125, + "weight": 105, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -58448,7 +58896,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 126, + "weight": 106, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -58571,7 +59019,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 127, + "weight": 107, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -58678,7 +59126,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 124, + "weight": 104, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -58787,7 +59235,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 162, + "weight": 142, "cookies": false, "type": "", "demo": "users\/get-usage.md", @@ -58860,7 +59308,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 130, + "weight": 110, "cookies": false, "type": "", "demo": "users\/get.md", @@ -58914,7 +59362,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 158, + "weight": 138, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -58977,7 +59425,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 143, + "weight": 123, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -59060,7 +59508,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 161, + "weight": 141, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -59145,7 +59593,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 139, + "weight": 119, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -59230,7 +59678,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 135, + "weight": 115, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -59317,7 +59765,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 134, + "weight": 114, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -59415,7 +59863,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 148, + "weight": 128, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -59550,7 +59998,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 153, + "weight": 133, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -59686,7 +60134,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 149, + "weight": 129, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -59805,7 +60253,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 150, + "weight": 130, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -59922,7 +60370,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 152, + "weight": 132, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -60039,7 +60487,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 151, + "weight": 131, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -60158,7 +60606,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 141, + "weight": 121, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -60240,7 +60688,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 142, + "weight": 122, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -60322,7 +60770,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 144, + "weight": 124, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -60405,7 +60853,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 131, + "weight": 111, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -60466,7 +60914,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 146, + "weight": 126, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -60548,7 +60996,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 133, + "weight": 113, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -60620,7 +61068,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 154, + "weight": 134, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -60674,7 +61122,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 157, + "weight": 137, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -60730,7 +61178,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 156, + "weight": 136, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -60803,7 +61251,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 138, + "weight": 118, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -60885,7 +61333,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 136, + "weight": 116, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -60970,7 +61418,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 128, + "weight": 108, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -61081,7 +61529,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 132, + "weight": 112, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -61152,7 +61600,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 147, + "weight": 127, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -61242,7 +61690,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 159, + "weight": 139, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -61315,7 +61763,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 155, + "weight": 135, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -61401,7 +61849,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 145, + "weight": 125, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -61483,7 +61931,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 140, + "weight": 120, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -61565,7 +62013,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 554, + "weight": 547, "cookies": false, "type": "", "demo": "vcs\/create-repository-detection.md", @@ -61662,7 +62110,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 551, + "weight": 544, "cookies": false, "type": "", "demo": "vcs\/list-repositories.md", @@ -61761,7 +62209,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 549, + "weight": 542, "cookies": false, "type": "", "demo": "vcs\/create-repository.md", @@ -61847,7 +62295,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 550, + "weight": 543, "cookies": false, "type": "", "demo": "vcs\/get-repository.md", @@ -61918,7 +62366,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 552, + "weight": 545, "cookies": false, "type": "", "demo": "vcs\/list-repository-branches.md", @@ -61989,7 +62437,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 553, + "weight": 546, "cookies": false, "type": "", "demo": "vcs\/get-repository-contents.md", @@ -62075,7 +62523,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 164, + "weight": 745, "cookies": false, "type": "", "demo": "vcs\/update-external-deployments.md", @@ -62165,7 +62613,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 547, + "weight": 540, "cookies": false, "type": "", "demo": "vcs\/list-installations.md", @@ -62251,7 +62699,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 546, + "weight": 539, "cookies": false, "type": "", "demo": "vcs\/get-installation.md", @@ -62303,7 +62751,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 548, + "weight": 541, "cookies": false, "type": "", "demo": "vcs\/delete-installation.md", @@ -62339,6 +62787,481 @@ } ] } + }, + "\/webhooks": { + "get": { + "summary": "List webhooks", + "operationId": "webhooksList", + "tags": [ + "webhooks" + ], + "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Webhooks List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhookList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 550, + "cookies": false, + "type": "", + "demo": "webhooks\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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. You may filter on the following attributes: name, url, httpUser, security, events, enabled, logs, attempts", + "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 webhook", + "operationId": "webhooksCreate", + "tags": [ + "webhooks" + ], + "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "responses": { + "201": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 549, + "cookies": false, + "type": "", + "demo": "webhooks\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "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>" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "x-example": null + }, + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "x-example": "<NAME>" + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "x-example": false + }, + "security": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "x-example": false + }, + "httpUser": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "x-example": "<HTTP_USER>" + }, + "httpPass": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "x-example": "<HTTP_PASS>" + } + }, + "required": [ + "webhookId", + "url", + "name", + "events" + ] + } + } + } + } + } + }, + "\/webhooks\/{webhookId}": { + "get": { + "summary": "Get webhook", + "operationId": "webhooksGet", + "tags": [ + "webhooks" + ], + "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 551, + "cookies": false, + "type": "", + "demo": "webhooks\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<WEBHOOK_ID>" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update webhook", + "operationId": "webhooksUpdate", + "tags": [ + "webhooks" + ], + "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 553, + "cookies": false, + "type": "", + "demo": "webhooks\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<WEBHOOK_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "x-example": "<NAME>" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "x-example": null + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "x-example": false + }, + "security": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "x-example": false + }, + "httpUser": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "x-example": "<HTTP_USER>" + }, + "httpPass": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "x-example": "<HTTP_PASS>" + } + }, + "required": [ + "name", + "url", + "events" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete webhook", + "operationId": "webhooksDelete", + "tags": [ + "webhooks" + ], + "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 552, + "cookies": false, + "type": "", + "demo": "webhooks\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<WEBHOOK_ID>" + }, + "in": "path" + } + ] + } + }, + "\/webhooks\/{webhookId}\/signature": { + "patch": { + "summary": "Update webhook signature key", + "operationId": "webhooksUpdateSignature", + "tags": [ + "webhooks" + ], + "description": "Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSignature", + "group": null, + "weight": 554, + "cookies": false, + "type": "", + "demo": "webhooks\/update-signature.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<WEBHOOK_ID>" + }, + "in": "path" + } + ] + } } }, "tags": [ @@ -67889,8 +68812,8 @@ }, "$sequence": { "type": "integer", - "description": "Row automatically incrementing ID.", - "x-example": 1, + "description": "Row sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -67939,7 +68862,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$tableId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -67960,8 +68883,8 @@ }, "$sequence": { "type": "integer", - "description": "Document automatically incrementing ID.", - "x-example": 1, + "description": "Document sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -68010,7 +68933,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$collectionId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -69537,6 +70460,12 @@ "description": "Site framework.", "x-example": "react" }, + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, "deploymentId": { "type": "string", "description": "Site's active deployment ID.", @@ -69596,6 +70525,11 @@ "description": "The build command used to build the site.", "x-example": "npm run build" }, + "startCommand": { + "type": "string", + "description": "Custom command to use when starting site runtime.", + "x-example": "node custom-server.mjs" + }, "outputDirectory": { "type": "string", "description": "The directory where the site build output is located.", @@ -69626,9 +70560,14 @@ "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", "x-example": false }, - "specification": { + "buildSpecification": { "type": "string", - "description": "Machine specification for builds and executions.", + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { + "type": "string", + "description": "Machine specification for SSR executions.", "x-example": "s-1vcpu-512mb" }, "buildRuntime": { @@ -69656,6 +70595,7 @@ "live", "logging", "framework", + "deploymentRetention", "deploymentId", "deploymentCreatedAt", "deploymentScreenshotLight", @@ -69667,13 +70607,15 @@ "timeout", "installCommand", "buildCommand", + "startCommand", "outputDirectory", "installationId", "providerRepositoryId", "providerBranch", "providerRootDirectory", "providerSilentMode", - "specification", + "buildSpecification", + "runtimeSpecification", "buildRuntime", "adapter", "fallbackFile" @@ -69687,6 +70629,7 @@ "live": false, "logging": false, "framework": "react", + "deploymentRetention": 7, "deploymentId": "5e5ea5c16897e", "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", "deploymentScreenshotLight": "5e5ea5c16897e", @@ -69698,13 +70641,15 @@ "timeout": 300, "installCommand": "npm install", "buildCommand": "npm run build", + "startCommand": "node custom-server.mjs", "outputDirectory": "build", "installationId": "6m40at4ejk5h2u9s1hboo", "providerRepositoryId": "appwrite", "providerBranch": "main", "providerRootDirectory": "sites\/helloWorld", "providerSilentMode": false, - "specification": "s-1vcpu-512mb", + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb", "buildRuntime": "node-22", "adapter": "static", "fallbackFile": "index.html" @@ -69945,6 +70890,12 @@ "description": "Function execution and build runtime.", "x-example": "python-3.8" }, + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, "deploymentId": { "type": "string", "description": "Function's active deployment ID.", @@ -70045,9 +70996,14 @@ "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", "x-example": false }, - "specification": { + "buildSpecification": { "type": "string", - "description": "Machine specification for builds and executions.", + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { + "type": "string", + "description": "Machine specification for executions.", "x-example": "s-1vcpu-512mb" } }, @@ -70061,6 +71017,7 @@ "live", "logging", "runtime", + "deploymentRetention", "deploymentId", "deploymentCreatedAt", "latestDeploymentId", @@ -70079,7 +71036,8 @@ "providerBranch", "providerRootDirectory", "providerSilentMode", - "specification" + "buildSpecification", + "runtimeSpecification" ], "example": { "$id": "5e5ea5c16897e", @@ -70091,6 +71049,7 @@ "live": false, "logging": false, "runtime": "python-3.8", + "deploymentRetention": 7, "deploymentId": "5e5ea5c16897e", "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", "latestDeploymentId": "5e5ea5c16897e", @@ -70109,7 +71068,8 @@ "providerBranch": "main", "providerRootDirectory": "functions\/helloWorld", "providerSilentMode": false, - "specification": "s-1vcpu-512mb" + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb" } }, "templateFunction": { @@ -70443,6 +71403,16 @@ "description": "VCS (Version Control System) repository's default branch name.", "x-example": "main" }, + "providerInstallationId": { + "type": "string", + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" + }, + "authorized": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository authorized for the installation?", + "x-example": true + }, "pushedAt": { "type": "string", "description": "Last commit date in ISO 8601 format.", @@ -70467,6 +71437,8 @@ "provider", "private", "defaultBranch", + "providerInstallationId", + "authorized", "pushedAt", "variables" ], @@ -70477,6 +71449,8 @@ "provider": "github", "private": true, "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, "pushedAt": "datetime", "variables": [ "PORT", @@ -70518,6 +71492,16 @@ "description": "VCS (Version Control System) repository's default branch name.", "x-example": "main" }, + "providerInstallationId": { + "type": "string", + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" + }, + "authorized": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository authorized for the installation?", + "x-example": true + }, "pushedAt": { "type": "string", "description": "Last commit date in ISO 8601 format.", @@ -70547,6 +71531,8 @@ "provider", "private", "defaultBranch", + "providerInstallationId", + "authorized", "pushedAt", "variables", "framework" @@ -70558,6 +71544,8 @@ "provider": "github", "private": true, "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, "pushedAt": "datetime", "variables": [ "PORT", @@ -70600,6 +71588,16 @@ "description": "VCS (Version Control System) repository's default branch name.", "x-example": "main" }, + "providerInstallationId": { + "type": "string", + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" + }, + "authorized": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository authorized for the installation?", + "x-example": true + }, "pushedAt": { "type": "string", "description": "Last commit date in ISO 8601 format.", @@ -70629,6 +71627,8 @@ "provider", "private", "defaultBranch", + "providerInstallationId", + "authorized", "pushedAt", "variables", "runtime" @@ -70640,6 +71640,8 @@ "provider": "github", "private": true, "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, "pushedAt": "datetime", "variables": [ "PORT", @@ -71764,6 +72766,11 @@ "$ref": "#\/components\/schemas\/block" }, "x-example": "" + }, + "consoleAccessedAt": { + "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" } }, "required": [ @@ -71833,7 +72840,8 @@ "serviceStatusForMessaging", "region", "billingLimits", - "blocks" + "blocks", + "consoleAccessedAt" ], "example": { "$id": "5e5ea5c16897e", @@ -71908,7 +72916,8 @@ "serviceStatusForMessaging": true, "region": "fra", "billingLimits": "", - "blocks": "" + "blocks": "", + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" } }, "webhook": { @@ -74621,6 +75630,34 @@ "x-example": 0, "format": "int32" }, + "functionsExecutions": { + "type": "array", + "description": "Aggregated number of function executions per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, + "functionsExecutionsTotal": { + "type": "integer", + "description": "Total aggregated number of function executions.", + "x-example": 0, + "format": "int32" + }, + "sitesExecutions": { + "type": "array", + "description": "Aggregated number of site executions per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, + "sitesExecutionsTotal": { + "type": "integer", + "description": "Total aggregated number of site executions.", + "x-example": 0, + "format": "int32" + }, "networkTotal": { "type": "integer", "description": "Aggregated stats for total network bandwidth.", @@ -74660,6 +75697,48 @@ "description": "Total aggregated number of Imagine credits.", "x-example": 0, "format": "int32" + }, + "realtimeConnectionsTotal": { + "type": "integer", + "description": "Current aggregated number of open Realtime connections.", + "x-example": 0, + "format": "int32" + }, + "realtimeMessagesTotal": { + "type": "integer", + "description": "Total number of Realtime messages sent to clients.", + "x-example": 0, + "format": "int32" + }, + "realtimeBandwidthTotal": { + "type": "integer", + "description": "Total consumed Realtime bandwidth (in bytes).", + "x-example": 0, + "format": "int32" + }, + "realtimeConnections": { + "type": "array", + "description": "Aggregated number of open Realtime connections per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, + "realtimeMessages": { + "type": "array", + "description": "Aggregated number of Realtime messages sent to clients per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, + "realtimeBandwidth": { + "type": "array", + "description": "Aggregated consumed Realtime bandwidth (in bytes) per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] } }, "required": [ @@ -74695,12 +75774,22 @@ "databasesWrites", "imageTransformations", "imageTransformationsTotal", + "functionsExecutions", + "functionsExecutionsTotal", + "sitesExecutions", + "sitesExecutionsTotal", "networkTotal", "backupsStorageTotal", "screenshotsGenerated", "screenshotsGeneratedTotal", "imagineCredits", - "imagineCreditsTotal" + "imagineCreditsTotal", + "realtimeConnectionsTotal", + "realtimeMessagesTotal", + "realtimeBandwidthTotal", + "realtimeConnections", + "realtimeMessages", + "realtimeBandwidth" ], "example": { "executionsTotal": 0, @@ -74735,12 +75824,22 @@ "databasesWrites": [], "imageTransformations": [], "imageTransformationsTotal": 0, + "functionsExecutions": [], + "functionsExecutionsTotal": 0, + "sitesExecutions": [], + "sitesExecutionsTotal": 0, "networkTotal": 0, "backupsStorageTotal": 0, "screenshotsGenerated": [], "screenshotsGeneratedTotal": 0, "imagineCredits": [], - "imagineCreditsTotal": 0 + "imagineCreditsTotal": 0, + "realtimeConnectionsTotal": 0, + "realtimeMessagesTotal": 0, + "realtimeBandwidthTotal": 0, + "realtimeConnections": [], + "realtimeMessages": [], + "realtimeBandwidth": [] } }, "headers": { @@ -75191,6 +76290,62 @@ "type": "string", "description": "Comma-separated list of nameservers.", "x-example": "ns1.example.com,ns2.example.com" + }, + "_APP_DB_ADAPTER": { + "type": "string", + "description": "Database adapter in use.", + "x-example": "mysql" + }, + "supportForRelationships": { + "type": "boolean", + "description": "Whether the database adapter supports relationships.", + "x-example": true + }, + "supportForOperators": { + "type": "boolean", + "description": "Whether the database adapter supports operators.", + "x-example": true + }, + "supportForSpatials": { + "type": "boolean", + "description": "Whether the database adapter supports spatial attributes.", + "x-example": true + }, + "supportForSpatialIndexNull": { + "type": "boolean", + "description": "Whether the database adapter supports spatial indexes on nullable columns.", + "x-example": false + }, + "supportForFulltextWildcard": { + "type": "boolean", + "description": "Whether the database adapter supports fulltext wildcard search.", + "x-example": true + }, + "supportForMultipleFulltextIndexes": { + "type": "boolean", + "description": "Whether the database adapter supports multiple fulltext indexes per collection.", + "x-example": true + }, + "supportForAttributeResizing": { + "type": "boolean", + "description": "Whether the database adapter supports resizing attributes.", + "x-example": true + }, + "supportForSchemas": { + "type": "boolean", + "description": "Whether the database adapter supports fixed schemas with row width limits.", + "x-example": true + }, + "maxIndexLength": { + "type": "integer", + "description": "Maximum index length supported by the database adapter.", + "x-example": 768, + "format": "int32" + }, + "supportForIntegerIds": { + "type": "boolean", + "description": "Whether the database adapter uses integer sequence IDs.", + "x-example": true } }, "required": [ @@ -75208,7 +76363,18 @@ "_APP_DOMAIN_SITES", "_APP_DOMAIN_FUNCTIONS", "_APP_OPTIONS_FORCE_HTTPS", - "_APP_DOMAINS_NAMESERVERS" + "_APP_DOMAINS_NAMESERVERS", + "_APP_DB_ADAPTER", + "supportForRelationships", + "supportForOperators", + "supportForSpatials", + "supportForSpatialIndexNull", + "supportForFulltextWildcard", + "supportForMultipleFulltextIndexes", + "supportForAttributeResizing", + "supportForSchemas", + "maxIndexLength", + "supportForIntegerIds" ], "example": { "_APP_DOMAIN_TARGET_CNAME": "appwrite.io", @@ -75225,7 +76391,18 @@ "_APP_DOMAIN_SITES": "sites.localhost,sites.example.com", "_APP_DOMAIN_FUNCTIONS": "functions.localhost", "_APP_OPTIONS_FORCE_HTTPS": "enabled", - "_APP_DOMAINS_NAMESERVERS": "ns1.example.com,ns2.example.com" + "_APP_DOMAINS_NAMESERVERS": "ns1.example.com,ns2.example.com", + "_APP_DB_ADAPTER": "mysql", + "supportForRelationships": true, + "supportForOperators": true, + "supportForSpatials": true, + "supportForSpatialIndexNull": false, + "supportForFulltextWildcard": true, + "supportForMultipleFulltextIndexes": true, + "supportForAttributeResizing": true, + "supportForSchemas": true, + "maxIndexLength": 768, + "supportForIntegerIds": true } }, "mfaChallenge": { @@ -76027,6 +77204,36 @@ "x-example": 20, "format": "int32" }, + "site": { + "type": "integer", + "description": "Number of sites to be migrated.", + "x-example": 5, + "format": "int32" + }, + "provider": { + "type": "integer", + "description": "Number of providers to be migrated.", + "x-example": 5, + "format": "int32" + }, + "topic": { + "type": "integer", + "description": "Number of topics to be migrated.", + "x-example": 10, + "format": "int32" + }, + "subscriber": { + "type": "integer", + "description": "Number of subscribers to be migrated.", + "x-example": 100, + "format": "int32" + }, + "message": { + "type": "integer", + "description": "Number of messages to be migrated.", + "x-example": 50, + "format": "int32" + }, "size": { "type": "integer", "description": "Size of files to be migrated in mb.", @@ -76047,6 +77254,11 @@ "file", "bucket", "function", + "site", + "provider", + "topic", + "subscriber", + "message", "size", "version" ], @@ -76058,6 +77270,11 @@ "file": 20, "bucket": 20, "function": 20, + "site": 5, + "provider": 5, + "topic": 10, + "subscriber": 100, + "message": 50, "size": 30000, "version": "1.4.0" } @@ -76445,10 +77662,22 @@ }, "usageRealtime": { "type": "integer", - "description": "Total realtime usage for the billing period", + "description": "Peak concurrent realtime connections for the billing period", "x-example": 200, "format": "int32" }, + "usageRealtimeMessages": { + "type": "integer", + "description": "Total realtime messages sent for the billing period", + "x-example": 10000, + "format": "int32" + }, + "usageRealtimeBandwidth": { + "type": "integer", + "description": "Total realtime bandwidth usage for the billing period", + "x-example": 5000000, + "format": "int32" + }, "additionalMembers": { "type": "integer", "description": "Additional members", @@ -76536,6 +77765,8 @@ "usageExecutions", "usageBandwidth", "usageRealtime", + "usageRealtimeMessages", + "usageRealtimeBandwidth", "additionalMembers", "additionalMemberAmount", "additionalStorageAmount", @@ -76567,6 +77798,8 @@ "usageExecutions": 2000, "usageBandwidth": 2000, "usageRealtime": 200, + "usageRealtimeMessages": 10000, + "usageRealtimeBandwidth": 5000000, "additionalMembers": 5, "additionalMemberAmount": 30, "additionalStorageAmount": 40, @@ -76995,6 +78228,12 @@ "x-example": 25, "format": "int32" }, + "projectInactivityDays": { + "type": "integer", + "description": "Number of days of console inactivity before a project is paused. 0 means pausing is disabled.", + "x-example": 7, + "format": "int32" + }, "alertLimit": { "type": "integer", "description": "Alert threshold percentage", @@ -77173,6 +78412,7 @@ "authPhone", "domains", "logs", + "projectInactivityDays", "alertLimit", "usage", "addons", @@ -77230,6 +78470,7 @@ "authPhone": 10, "domains": 5, "logs": 25, + "projectInactivityDays": 7, "alertLimit": 80, "usage": null, "addons": null, @@ -79368,11 +80609,6 @@ "description": "Domain registrar (e.g. \"appwrite\" or \"third_party\").", "x-example": "appwrite" }, - "paymentStatus": { - "type": "string", - "description": "Payment status for domain purchase.", - "x-example": "pending" - }, "nameservers": { "type": "string", "description": "Nameservers setting. \"Appwrite\" or empty string.", @@ -79399,6 +80635,22 @@ "x-example": 2599, "format": "int32" }, + "transferStatus": { + "type": "string", + "description": "Transfer status for domains being transferred in.", + "x-example": "pending_registry", + "enum": [ + "transferrable", + "not_transferrable", + "pending_owner", + "pending_admin", + "pending_registry", + "completed", + "cancelled", + "service_unavailable" + ], + "x-enum-name": "DomainTransferStatusEnum" + }, "teamId": { "type": "string", "description": "Team ID.", @@ -79419,12 +80671,12 @@ "$updatedAt", "domain", "registrar", - "paymentStatus", "nameservers", "expire", "renewal", "autoRenewal", "renewalPrice", + "transferStatus", "teamId", "dnsRecords" ], @@ -79434,16 +80686,104 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "domain": "example.com", "registrar": "appwrite", - "paymentStatus": "pending", "nameservers": "Appwrite", "expire": "2020-10-15T06:38:00.000+00:00", "renewal": "2020-10-15T06:38:00.000+00:00", "autoRenewal": true, "renewalPrice": 2599, + "transferStatus": "pending_registry", "teamId": "5e5ea5c16897e", "dnsRecords": [] } }, + "domainPurchase": { + "description": "DomainPurchase", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Purchase\/invoice ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Purchase creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Purchase update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "domainId": { + "type": "string", + "description": "Domain document ID.", + "x-example": "5e5ea5c16897e" + }, + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": "example.com" + }, + "organizationId": { + "type": "string", + "description": "Team ID that owns the domain.", + "x-example": "5e5ea5c16897e" + }, + "status": { + "type": "string", + "description": "Domain purchase status.", + "x-example": "pending", + "enum": [ + "pending", + "succeeded", + "failed", + "cancelled" + ], + "x-enum-name": "DomainPurchaseStatus" + }, + "clientSecret": { + "type": "string", + "description": "Stripe client secret for 3DS; empty when not applicable.", + "x-example": "" + }, + "amount": { + "type": "number", + "description": "Purchase amount.", + "x-example": 25.99, + "format": "double" + }, + "currency": { + "type": "string", + "description": "Currency code.", + "x-example": "USD" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "domainId", + "domain", + "organizationId", + "status", + "clientSecret", + "amount", + "currency" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "domainId": "5e5ea5c16897e", + "domain": "example.com", + "organizationId": "5e5ea5c16897e", + "status": "pending", + "clientSecret": "", + "amount": 25.99, + "currency": "USD" + } + }, "dnsRecord": { "description": "DNSRecord", "type": "object", @@ -79934,6 +81274,11 @@ "description": "Price period in years.", "x-example": 1, "format": "int32" + }, + "premium": { + "type": "boolean", + "description": "Whether the domain is a premium domain.", + "x-example": false } }, "required": [ @@ -79941,14 +81286,16 @@ "tld", "available", "price", - "periodYears" + "periodYears", + "premium" ], "example": { "domain": "example.com", "tld": "com", "available": true, "price": 25.99, - "periodYears": 1 + "periodYears": 1, + "premium": false } }, "domainSuggestion": { @@ -79990,6 +81337,65 @@ "available": true } }, + "domainTransferOut": { + "description": "domainTransferOut", + "type": "object", + "properties": { + "authCode": { + "type": "string", + "description": "Domain transfer authorization code.", + "x-example": "mock_1a2b3c4d" + } + }, + "required": [ + "authCode" + ], + "example": { + "authCode": "mock_1a2b3c4d" + } + }, + "domainTransferStatus": { + "description": "domainTransferStatus", + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Transfer status.", + "x-example": "pending_registry", + "enum": [ + "transferrable", + "not_transferrable", + "pending_owner", + "pending_admin", + "pending_registry", + "completed", + "cancelled", + "service_unavailable" + ], + "x-enum-name": "DomainTransferStatusEnum" + }, + "reason": { + "type": "string", + "description": "Additional transfer status information.", + "x-example": "Transfer in progress" + }, + "timestamp": { + "type": "string", + "description": "Transfer status timestamp in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "status", + "reason", + "timestamp" + ], + "example": { + "status": "pending_registry", + "reason": "Transfer in progress", + "timestamp": "2020-10-15T06:38:00.000+00:00" + } + }, "activityEventList": { "description": "Activity event list", "type": "object", diff --git a/specs/1.8.x/open-api3-1.8.x-server.json b/specs/1.8.x/open-api3-1.8.x-server.json index 2526e786f..9c0a2afdc 100644 --- a/specs/1.8.x/open-api3-1.8.x-server.json +++ b/specs/1.8.x/open-api3-1.8.x-server.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "version": "1.8.1", + "version": "1.8.2", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -562,7 +562,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 239, + "weight": 217, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -635,7 +635,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 241, + "weight": 219, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -762,7 +762,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 242, + "weight": 220, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -905,7 +905,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 243, + "weight": 221, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1032,7 +1032,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 247, + "weight": 225, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1169,7 +1169,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 248, + "weight": 226, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1310,7 +1310,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 240, + "weight": 218, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1414,7 +1414,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 246, + "weight": 224, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1516,7 +1516,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 244, + "weight": 222, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1618,7 +1618,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 245, + "weight": 223, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -3768,7 +3768,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 779, + "weight": 732, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -3832,7 +3832,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 780, + "weight": 733, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -3889,7 +3889,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 250, + "weight": 228, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4019,7 +4019,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 249, + "weight": 227, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4155,7 +4155,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 253, + "weight": 231, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4217,7 +4217,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 251, + "weight": 229, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4709,7 +4709,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 252, + "weight": 230, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4795,7 +4795,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 255, + "weight": 233, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -4891,7 +4891,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 254, + "weight": 232, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -4987,7 +4987,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 256, + "weight": 234, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5742,7 +5742,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 749, + "weight": 700, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -5807,7 +5807,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 750, + "weight": 701, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -5894,7 +5894,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 748, + "weight": 699, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -5949,7 +5949,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 751, + "weight": 702, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -6013,7 +6013,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 744, + "weight": 695, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -6078,7 +6078,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 745, + "weight": 696, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -6194,7 +6194,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 743, + "weight": 694, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -6256,7 +6256,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 746, + "weight": 697, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -6346,7 +6346,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 747, + "weight": 698, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -6410,7 +6410,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 754, + "weight": 705, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -6507,7 +6507,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 753, + "weight": 704, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -6574,7 +6574,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 752, + "weight": 703, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -6638,7 +6638,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 264, + "weight": 242, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -6759,7 +6759,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 260, + "weight": 238, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -6878,7 +6878,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 332, + "weight": 310, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6947,7 +6947,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 328, + "weight": 306, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -7020,7 +7020,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 329, + "weight": 307, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -7086,7 +7086,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 330, + "weight": 308, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -7166,7 +7166,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 331, + "weight": 309, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -7234,7 +7234,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 333, + "weight": 311, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -7321,7 +7321,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 261, + "weight": 239, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -7417,7 +7417,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 262, + "weight": 240, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -7529,7 +7529,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 263, + "weight": 241, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -7626,7 +7626,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 272, + "weight": 250, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -7727,7 +7727,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 268, + "weight": 246, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -7855,7 +7855,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 269, + "weight": 247, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -7931,7 +7931,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 270, + "weight": 248, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -8035,7 +8035,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 271, + "weight": 249, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -8113,7 +8113,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 289, + "weight": 267, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -8215,7 +8215,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 290, + "weight": 268, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -8258,7 +8258,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "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", @@ -8329,7 +8329,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 291, + "weight": 269, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -8448,7 +8448,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 292, + "weight": 270, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -8562,7 +8562,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 293, + "weight": 271, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -8681,7 +8681,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 294, + "weight": 272, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -8796,7 +8796,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 295, + "weight": 273, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -8916,7 +8916,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 296, + "weight": 274, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -9039,7 +9039,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 297, + "weight": 275, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -9167,7 +9167,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 298, + "weight": 276, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -9296,7 +9296,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 299, + "weight": 277, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -9430,7 +9430,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 300, + "weight": 278, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -9559,7 +9559,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 301, + "weight": 279, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -9693,7 +9693,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 302, + "weight": 280, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -9807,7 +9807,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 303, + "weight": 281, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -9926,7 +9926,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 304, + "weight": 282, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -10042,7 +10042,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 305, + "weight": 283, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -10167,7 +10167,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 322, + "weight": 300, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -10282,7 +10282,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 323, + "weight": 301, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -10397,7 +10397,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 320, + "weight": 298, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -10512,7 +10512,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 321, + "weight": 299, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -10627,7 +10627,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 306, + "weight": 284, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -10743,7 +10743,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 307, + "weight": 285, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -10868,7 +10868,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 308, + "weight": 286, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -10984,7 +10984,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 309, + "weight": 287, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -11109,7 +11109,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 310, + "weight": 288, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -11225,147 +11225,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { - "post": { - "summary": "Create string attribute", - "operationId": "databasesCreateStringAttribute", - "tags": [ - "databases" - ], - "description": "Create a string attribute.\n", - "responses": { - "202": { - "description": "AttributeString", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/attributeString" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "createStringAttribute", - "group": "attributes", - "weight": 312, - "cookies": false, - "type": "", - "demo": "databases\/create-string-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createStringColumn" - }, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "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 table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "schema": { - "type": "string", - "x-example": "<COLLECTION_ID>" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": null - }, - "size": { - "type": "integer", - "description": "Attribute size for text attributes, in number of characters.", - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { "patch": { - "summary": "Update string attribute", - "operationId": "databasesUpdateStringAttribute", + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", "tags": [ "databases" ], - "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "200": { - "description": "AttributeString", + "description": "AttributeRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeString" + "$ref": "#\/components\/schemas\/attributeRelationship" } } } @@ -11373,12 +11247,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateStringAttribute", + "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 313, + "weight": 289, "cookies": false, "type": "", - "demo": "databases\/update-string-attribute.md", + "demo": "databases\/update-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11389,10 +11263,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateStringColumn" + "replaceWith": "tablesDB.updateRelationshipColumn" }, "auth": { "Project": [], @@ -11418,7 +11292,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -11442,23 +11316,17 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false - }, - "default": { + "onDelete": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string attribute.", - "x-example": 1, - "format": "int32", - "x-nullable": true + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] }, "newKey": { "type": "string", @@ -11466,45 +11334,41 @@ "x-example": null, "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } } } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { - "summary": "Create text attribute", - "operationId": "databasesCreateTextAttribute", + "summary": "Create string attribute", + "operationId": "databasesCreateStringAttribute", "tags": [ "databases" ], - "description": "Create a text attribute.\n", + "description": "Create a string attribute.\n", "responses": { "202": { - "description": "AttributeText", + "description": "AttributeString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeText" + "$ref": "#\/components\/schemas\/attributeString" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createTextAttribute", + "method": "createStringAttribute", "group": "attributes", - "weight": 318, + "weight": 290, "cookies": false, "type": "", - "demo": "databases\/create-text-attribute.md", + "demo": "databases\/create-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11515,7 +11379,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createStringColumn" + }, "auth": { "Project": [], "Key": [] @@ -11540,7 +11408,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. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -11560,6 +11428,12 @@ "description": "Attribute Key.", "x-example": null }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "x-example": 1, + "format": "int32" + }, "required": { "type": "boolean", "description": "Is attribute required?", @@ -11584,6 +11458,7 @@ }, "required": [ "key", + "size", "required" ] } @@ -11592,34 +11467,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { "patch": { - "summary": "Update text attribute", - "operationId": "databasesUpdateTextAttribute", + "summary": "Update string attribute", + "operationId": "databasesUpdateStringAttribute", "tags": [ "databases" ], - "description": "Update a text attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeText", + "description": "AttributeString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeText" + "$ref": "#\/components\/schemas\/attributeString" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateTextAttribute", + "method": "updateStringAttribute", "group": "attributes", - "weight": 319, + "weight": 291, "cookies": false, "type": "", - "demo": "databases\/update-text-attribute.md", + "demo": "databases\/update-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11630,7 +11505,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateStringColumn" + }, "auth": { "Project": [], "Key": [] @@ -11655,7 +11534,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. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -11690,6 +11569,13 @@ "x-example": "<DEFAULT>", "x-nullable": true }, + "size": { + "type": "integer", + "description": "Maximum size of the string attribute.", + "x-example": 1, + "format": "int32", + "x-nullable": true + }, "newKey": { "type": "string", "description": "New Attribute Key.", @@ -11707,34 +11593,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text": { "post": { - "summary": "Create URL attribute", - "operationId": "databasesCreateUrlAttribute", + "summary": "Create text attribute", + "operationId": "databasesCreateTextAttribute", "tags": [ "databases" ], - "description": "Create a URL attribute.\n", + "description": "Create a text attribute.\n", "responses": { "202": { - "description": "AttributeURL", + "description": "AttributeText", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeUrl" + "$ref": "#\/components\/schemas\/attributeText" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createUrlAttribute", + "method": "createTextAttribute", "group": "attributes", - "weight": 314, + "weight": 296, "cookies": false, "type": "", - "demo": "databases\/create-url-attribute.md", + "demo": "databases\/create-text-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11745,11 +11631,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createUrlColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-text-attribute.md", "auth": { "Project": [], "Key": [] @@ -11774,7 +11656,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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", @@ -11802,14 +11684,18 @@ "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "<DEFAULT>", "x-nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", + "x-example": false } }, "required": [ @@ -11822,34 +11708,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text\/{key}": { "patch": { - "summary": "Update URL attribute", - "operationId": "databasesUpdateUrlAttribute", + "summary": "Update text attribute", + "operationId": "databasesUpdateTextAttribute", "tags": [ "databases" ], - "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a text attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeURL", + "description": "AttributeText", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeUrl" + "$ref": "#\/components\/schemas\/attributeText" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateUrlAttribute", + "method": "updateTextAttribute", "group": "attributes", - "weight": 315, + "weight": 297, "cookies": false, "type": "", - "demo": "databases\/update-url-attribute.md", + "demo": "databases\/update-text-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11860,11 +11746,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateUrlColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-text-attribute.md", "auth": { "Project": [], "Key": [] @@ -11889,7 +11771,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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", @@ -11921,8 +11803,7 @@ "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "<DEFAULT>", "x-nullable": true }, "newKey": { @@ -11942,34 +11823,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { "post": { - "summary": "Create varchar attribute", - "operationId": "databasesCreateVarcharAttribute", + "summary": "Create URL attribute", + "operationId": "databasesCreateUrlAttribute", "tags": [ "databases" ], - "description": "Create a varchar attribute.\n", + "description": "Create a URL attribute.\n", "responses": { "202": { - "description": "AttributeVarchar", + "description": "AttributeURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeVarchar" + "$ref": "#\/components\/schemas\/attributeUrl" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createVarcharAttribute", + "method": "createUrlAttribute", "group": "attributes", - "weight": 316, + "weight": 292, "cookies": false, "type": "", - "demo": "databases\/create-varchar-attribute.md", + "demo": "databases\/create-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11980,7 +11861,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createUrlColumn" + }, "auth": { "Project": [], "Key": [] @@ -12005,7 +11890,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", @@ -12025,12 +11910,6 @@ "description": "Attribute Key.", "x-example": null }, - "size": { - "type": "integer", - "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", - "x-example": 1, - "format": "int32" - }, "required": { "type": "boolean", "description": "Is attribute required?", @@ -12039,23 +11918,18 @@ "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false } }, "required": [ "key", - "size", "required" ] } @@ -12064,34 +11938,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { "patch": { - "summary": "Update varchar attribute", - "operationId": "databasesUpdateVarcharAttribute", + "summary": "Update URL attribute", + "operationId": "databasesUpdateUrlAttribute", "tags": [ "databases" ], - "description": "Update a varchar attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeVarchar", + "description": "AttributeURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeVarchar" + "$ref": "#\/components\/schemas\/attributeUrl" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateVarcharAttribute", + "method": "updateUrlAttribute", "group": "attributes", - "weight": 317, + "weight": 293, "cookies": false, "type": "", - "demo": "databases\/update-varchar-attribute.md", + "demo": "databases\/update-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12102,7 +11976,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateUrlColumn" + }, "auth": { "Project": [], "Key": [] @@ -12127,7 +12005,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", @@ -12159,14 +12037,8 @@ "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar attribute.", - "x-example": 1, - "format": "int32", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "newKey": { @@ -12186,80 +12058,45 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { - "get": { - "summary": "Get attribute", - "operationId": "databasesGetAttribute", + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar": { + "post": { + "summary": "Create varchar attribute", + "operationId": "databasesCreateVarcharAttribute", "tags": [ "databases" ], - "description": "Get attribute by ID.", + "description": "Create a varchar attribute.\n", "responses": { - "200": { - "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", + "202": { + "description": "AttributeVarchar", "content": { "application\/json": { "schema": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/attributeBoolean" - }, - { - "$ref": "#\/components\/schemas\/attributeInteger" - }, - { - "$ref": "#\/components\/schemas\/attributeFloat" - }, - { - "$ref": "#\/components\/schemas\/attributeEmail" - }, - { - "$ref": "#\/components\/schemas\/attributeEnum" - }, - { - "$ref": "#\/components\/schemas\/attributeUrl" - }, - { - "$ref": "#\/components\/schemas\/attributeIp" - }, - { - "$ref": "#\/components\/schemas\/attributeDatetime" - }, - { - "$ref": "#\/components\/schemas\/attributeRelationship" - }, - { - "$ref": "#\/components\/schemas\/attributeString" - } - ] + "$ref": "#\/components\/schemas\/attributeVarchar" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getAttribute", + "method": "createVarcharAttribute", "group": "attributes", - "weight": 287, + "weight": 294, "cookies": false, "type": "", - "demo": "databases\/get-attribute.md", + "demo": "databases\/create-varchar-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "collections.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.getColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-varchar-attribute.md", "auth": { "Project": [], "Key": [] @@ -12284,7 +12121,129 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": null + }, + "size": { + "type": "integer", + "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", + "x-example": 1, + "format": "int32" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "<DEFAULT>", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar\/{key}": { + "patch": { + "summary": "Update varchar attribute", + "operationId": "databasesUpdateVarcharAttribute", + "tags": [ + "databases" + ], + "description": "Update a varchar attribute. Changing the `default` value will not update already existing documents.\n", + "responses": { + "200": { + "description": "AttributeVarchar", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeVarchar" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateVarcharAttribute", + "group": "attributes", + "weight": 295, + "cookies": false, + "type": "", + "demo": "databases\/update-varchar-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-varchar-attribute.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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", @@ -12301,42 +12260,121 @@ }, "in": "path" } - ] - }, - "delete": { - "summary": "Delete attribute", - "operationId": "databasesDeleteAttribute", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "<DEFAULT>", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the varchar attribute.", + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { + "get": { + "summary": "Get attribute", + "operationId": "databasesGetAttribute", "tags": [ "databases" ], - "description": "Deletes an attribute.", + "description": "Get attribute by ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/attributeBoolean" + }, + { + "$ref": "#\/components\/schemas\/attributeInteger" + }, + { + "$ref": "#\/components\/schemas\/attributeFloat" + }, + { + "$ref": "#\/components\/schemas\/attributeEmail" + }, + { + "$ref": "#\/components\/schemas\/attributeEnum" + }, + { + "$ref": "#\/components\/schemas\/attributeUrl" + }, + { + "$ref": "#\/components\/schemas\/attributeIp" + }, + { + "$ref": "#\/components\/schemas\/attributeDatetime" + }, + { + "$ref": "#\/components\/schemas\/attributeRelationship" + }, + { + "$ref": "#\/components\/schemas\/attributeString" + } + ] + } + } + } } }, "deprecated": true, "x-appwrite": { - "method": "deleteAttribute", + "method": "getAttribute", "group": "attributes", - "weight": 288, + "weight": 265, "cookies": false, "type": "", - "demo": "databases\/delete-attribute.md", + "demo": "databases\/get-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "collections.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteColumn" + "replaceWith": "tablesDB.getColumn" }, "auth": { "Project": [], @@ -12380,36 +12418,27 @@ "in": "path" } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship": { - "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", + }, + "delete": { + "summary": "Delete attribute", + "operationId": "databasesDeleteAttribute", "tags": [ "databases" ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "description": "Deletes an attribute.", "responses": { - "200": { - "description": "AttributeRelationship", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/attributeRelationship" - } - } - } + "204": { + "description": "No content" } }, "deprecated": true, "x-appwrite": { - "method": "updateRelationshipAttribute", + "method": "deleteAttribute", "group": "attributes", - "weight": 311, + "weight": 266, "cookies": false, "type": "", - "demo": "databases\/update-relationship-attribute.md", + "demo": "databases\/delete-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12420,10 +12449,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" + "replaceWith": "tablesDB.deleteColumn" }, "auth": { "Project": [], @@ -12466,37 +12495,7 @@ }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true - } - } - } - } - } - } + ] } }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { @@ -12523,7 +12522,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 283, + "weight": 261, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -12611,6 +12610,18 @@ "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" } ] }, @@ -12637,7 +12648,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 275, + "weight": 253, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -12832,7 +12843,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 280, + "weight": 258, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -12971,7 +12982,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 278, + "weight": 256, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -13077,7 +13088,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 282, + "weight": 260, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -13180,7 +13191,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 276, + "weight": 254, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -13293,7 +13304,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 279, + "weight": 257, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -13451,7 +13462,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 277, + "weight": 255, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -13565,7 +13576,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 281, + "weight": 259, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -13674,7 +13685,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 286, + "weight": 264, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -13805,7 +13816,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 285, + "weight": 263, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -13936,7 +13947,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 327, + "weight": 305, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -14036,7 +14047,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 324, + "weight": 302, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -14178,7 +14189,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 325, + "weight": 303, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -14256,7 +14267,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 326, + "weight": 304, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -14343,7 +14354,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 561, + "weight": 401, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -14429,7 +14440,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 558, + "weight": 556, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -14506,9 +14517,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -14563,7 +14571,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -14679,6 +14773,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -14718,10 +14814,21 @@ "description": "Path to function code in the linked repo.", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Build specification for the function deployments.", + "x-example": null + }, + "runtimeSpecification": { "type": "string", - "description": "Runtime specification for the function and builds.", + "description": "Runtime specification for the function executions.", "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" } }, "required": [ @@ -14759,7 +14866,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 563, + "weight": 403, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -14810,7 +14917,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 564, + "weight": 404, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -14861,7 +14968,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 559, + "weight": 399, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -14922,7 +15029,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 560, + "weight": 557, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -15006,9 +15113,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -15063,7 +15167,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -15179,6 +15369,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -15219,10 +15411,21 @@ "description": "Path to function code in the linked repo.", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Build specification for the function deployments.", + "x-example": null + }, + "runtimeSpecification": { "type": "string", - "description": "Runtime specification for the function and builds.", + "description": "Runtime specification for the function executions.", "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" } }, "required": [ @@ -15249,7 +15452,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 562, + "weight": 402, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -15312,7 +15515,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 567, + "weight": 407, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -15394,7 +15597,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 568, + "weight": 408, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -15490,7 +15693,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 565, + "weight": 405, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -15591,7 +15794,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 573, + "weight": 413, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -15678,7 +15881,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 570, + "weight": 410, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -15796,7 +15999,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 571, + "weight": 411, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -15895,7 +16098,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 566, + "weight": 406, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -15959,7 +16162,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 569, + "weight": 409, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -16025,7 +16228,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 572, + "weight": 412, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -16117,7 +16320,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 574, + "weight": 414, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -16190,7 +16393,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 577, + "weight": 417, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -16279,7 +16482,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 575, + "weight": 415, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -16399,7 +16602,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 576, + "weight": 416, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -16467,7 +16670,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 578, + "weight": 418, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -16540,7 +16743,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 583, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -16601,7 +16804,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 581, + "weight": 558, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -16694,7 +16897,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 582, + "weight": 422, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -16765,7 +16968,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 584, + "weight": 424, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -16860,7 +17063,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 585, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -16933,7 +17136,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 176, + "weight": 154, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -16989,7 +17192,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 175, + "weight": 153, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -17045,7 +17248,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 450, + "weight": 428, "cookies": false, "type": "", "demo": "health\/get.md", @@ -17097,7 +17300,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 459, + "weight": 437, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -17149,7 +17352,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 453, + "weight": 431, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -17201,7 +17404,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 456, + "weight": 434, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -17240,6 +17443,82 @@ ] } }, + "\/health\/console-pausing": { + "get": { + "summary": "Get console pausing health", + "operationId": "healthGetConsolePausing", + "tags": [ + "health" + ], + "description": "Get console pausing health status. Monitors projects approaching the pause threshold to detect potential issues with console access tracking.\n", + "responses": { + "200": { + "description": "Health Status", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/healthStatus" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getConsolePausing", + "group": null, + "weight": 688, + "cookies": false, + "type": "", + "demo": "health\/get-console-pausing.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-console-pausing.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "threshold", + "description": "Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 10 + }, + "in": "query" + }, + { + "name": "inactivityDays", + "description": "Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 7 + }, + "in": "query" + } + ] + } + }, "\/health\/db": { "get": { "summary": "Get DB", @@ -17264,7 +17543,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 452, + "weight": 430, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -17316,7 +17595,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 454, + "weight": 432, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -17368,7 +17647,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 460, + "weight": 438, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -17433,7 +17712,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 734, + "weight": 684, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -17498,7 +17777,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 733, + "weight": 683, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -17563,7 +17842,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 464, + "weight": 442, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -17628,7 +17907,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 735, + "weight": 685, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -17693,7 +17972,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 463, + "weight": 441, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -17758,7 +18037,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 465, + "weight": 443, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -17834,7 +18113,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 466, + "weight": 444, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -17899,7 +18178,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 473, + "weight": 451, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -17991,7 +18270,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 470, + "weight": 448, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -18056,7 +18335,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 462, + "weight": 440, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -18121,7 +18400,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 467, + "weight": 445, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -18186,7 +18465,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 468, + "weight": 446, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -18251,7 +18530,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 469, + "weight": 447, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -18316,7 +18595,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 736, + "weight": 686, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -18381,7 +18660,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 471, + "weight": 449, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -18446,7 +18725,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 472, + "weight": 450, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -18511,7 +18790,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 737, + "weight": 687, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -18576,7 +18855,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 461, + "weight": 439, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -18641,7 +18920,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 458, + "weight": 436, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -18693,7 +18972,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 457, + "weight": 435, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -18745,7 +19024,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 455, + "weight": 433, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -19245,7 +19524,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 231, + "weight": 209, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -19334,7 +19613,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 228, + "weight": 206, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -19481,7 +19760,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 235, + "weight": 213, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -19640,7 +19919,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 230, + "weight": 208, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -19819,7 +20098,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 237, + "weight": 215, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -20018,7 +20297,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 229, + "weight": 207, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -20202,7 +20481,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 236, + "weight": 214, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -20392,7 +20671,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 234, + "weight": 212, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -20447,7 +20726,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 238, + "weight": 216, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -20511,7 +20790,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 232, + "weight": 210, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -20599,7 +20878,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 233, + "weight": 211, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -20687,7 +20966,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 202, + "weight": 180, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -20776,7 +21055,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 201, + "weight": 179, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -20958,7 +21237,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 215, + "weight": 193, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -21142,7 +21421,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 200, + "weight": 178, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -21297,7 +21576,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 214, + "weight": 192, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -21453,7 +21732,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 191, + "weight": 169, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -21574,7 +21853,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 205, + "weight": 183, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -21697,7 +21976,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 195, + "weight": 173, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -21795,7 +22074,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 209, + "weight": 187, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -21896,7 +22175,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 193, + "weight": 171, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -22006,7 +22285,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 207, + "weight": 185, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -22118,7 +22397,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 192, + "weight": 170, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -22228,7 +22507,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 206, + "weight": 184, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -22340,7 +22619,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 194, + "weight": 172, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -22577,7 +22856,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 208, + "weight": 186, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -22813,7 +23092,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 196, + "weight": 174, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -22912,7 +23191,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 210, + "weight": 188, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -23013,7 +23292,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 197, + "weight": 175, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -23112,7 +23391,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 211, + "weight": 189, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -23213,7 +23492,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 198, + "weight": 176, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -23312,7 +23591,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 212, + "weight": 190, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -23413,7 +23692,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 199, + "weight": 177, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -23512,7 +23791,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 213, + "weight": 191, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -23613,7 +23892,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 204, + "weight": 182, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -23668,7 +23947,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 216, + "weight": 194, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -23732,7 +24011,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 203, + "weight": 181, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -23820,7 +24099,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 225, + "weight": 203, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -23908,7 +24187,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 218, + "weight": 196, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -23995,7 +24274,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 217, + "weight": 195, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -24080,7 +24359,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 220, + "weight": 198, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -24142,7 +24421,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 221, + "weight": 199, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -24223,7 +24502,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 222, + "weight": 200, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -24287,7 +24566,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 219, + "weight": 197, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -24375,7 +24654,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 224, + "weight": 202, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -24414,7 +24693,7 @@ }, { "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: name, provider, type, enabled", + "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: targetId, topicId, userId, providerType", "required": false, "schema": { "type": "array", @@ -24472,7 +24751,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 223, + "weight": 201, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -24565,7 +24844,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 226, + "weight": 204, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -24630,7 +24909,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 227, + "weight": 205, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -24708,7 +24987,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 590, + "weight": 455, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -24794,7 +25073,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 588, + "weight": 559, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -24885,6 +25164,11 @@ "description": "Build Command.", "x-example": "<BUILD_COMMAND>" }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "x-example": "<START_COMMAND>" + }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", @@ -24926,9 +25210,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -24983,7 +25264,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -25029,10 +25396,21 @@ "description": "Path to site code in the linked repo.", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { "type": "string", - "description": "Framework specification for the site and builds.", + "description": "Build specification for the site deployments.", "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" } }, "required": [ @@ -25071,7 +25449,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 593, + "weight": 458, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -25122,7 +25500,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 616, + "weight": 481, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -25173,7 +25551,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 589, + "weight": 454, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -25234,7 +25612,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 591, + "weight": 560, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -25332,6 +25710,11 @@ "description": "Build Command.", "x-example": "<BUILD_COMMAND>" }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "x-example": "<START_COMMAND>" + }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", @@ -25373,9 +25756,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -25430,7 +25810,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -25476,10 +25942,21 @@ "description": "Path to site code in the linked repo.", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { "type": "string", - "description": "Framework specification for the site and builds.", + "description": "Build specification for the site deployments.", "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" } }, "required": [ @@ -25507,7 +25984,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 592, + "weight": 457, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -25570,7 +26047,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 599, + "weight": 464, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -25652,7 +26129,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 598, + "weight": 463, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -25748,7 +26225,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 594, + "weight": 459, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -25822,8 +26299,7 @@ } }, "required": [ - "code", - "activate" + "code" ] } } @@ -25855,7 +26331,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 602, + "weight": 467, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -25937,7 +26413,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 595, + "weight": 460, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -26055,7 +26531,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 596, + "weight": 461, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -26155,7 +26631,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 597, + "weight": 462, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -26219,7 +26695,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 600, + "weight": 465, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -26285,7 +26761,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 601, + "weight": 466, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -26377,7 +26853,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 603, + "weight": 468, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -26450,7 +26926,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 605, + "weight": 470, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -26537,7 +27013,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 604, + "weight": 469, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -26601,7 +27077,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 606, + "weight": 471, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -26674,7 +27150,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 609, + "weight": 474, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -26735,7 +27211,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 607, + "weight": 561, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -26828,7 +27304,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 608, + "weight": 473, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -26899,7 +27375,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 610, + "weight": 475, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -26994,7 +27470,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 611, + "weight": 476, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -27067,7 +27543,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 530, + "weight": 522, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -27154,7 +27630,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 528, + "weight": 520, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -27291,7 +27767,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 529, + "weight": 521, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -27353,7 +27829,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 531, + "weight": 523, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -27487,7 +27963,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 532, + "weight": 524, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -27551,7 +28027,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 535, + "weight": 527, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -27652,7 +28128,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 781, + "weight": 734, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -27756,7 +28232,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 534, + "weight": 526, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -27832,7 +28308,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 536, + "weight": 528, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -27926,7 +28402,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 537, + "weight": 529, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -27997,7 +28473,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 539, + "weight": 531, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -28079,7 +28555,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 538, + "weight": 530, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -28311,7 +28787,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 540, + "weight": 532, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -28400,7 +28876,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 338, + "weight": 316, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -28487,7 +28963,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 334, + "weight": 312, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -28569,7 +29045,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 405, + "weight": 383, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -28641,7 +29117,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 401, + "weight": 379, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -28717,7 +29193,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 402, + "weight": 380, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -28786,7 +29262,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 403, + "weight": 381, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -28869,7 +29345,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 404, + "weight": 382, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -28940,7 +29416,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 406, + "weight": 384, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -29030,7 +29506,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 335, + "weight": 313, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -29092,7 +29568,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 336, + "weight": 314, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -29168,7 +29644,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 337, + "weight": 315, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -29232,7 +29708,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 345, + "weight": 323, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -29332,7 +29808,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 341, + "weight": 319, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -29459,7 +29935,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 342, + "weight": 320, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -29534,7 +30010,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 343, + "weight": 321, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -29637,7 +30113,7 @@ "x-appwrite": { "method": "deleteTable", "group": "tables", - "weight": 344, + "weight": 322, "cookies": false, "type": "", "demo": "tablesdb\/delete-table.md", @@ -29714,7 +30190,7 @@ "x-appwrite": { "method": "listColumns", "group": "columns", - "weight": 350, + "weight": 328, "cookies": false, "type": "", "demo": "tablesdb\/list-columns.md", @@ -29815,7 +30291,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 351, + "weight": 329, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -29928,7 +30404,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 352, + "weight": 330, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -30046,7 +30522,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 353, + "weight": 331, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -30159,7 +30635,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 354, + "weight": 332, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -30277,7 +30753,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 355, + "weight": 333, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -30391,7 +30867,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 356, + "weight": 334, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -30510,7 +30986,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 357, + "weight": 335, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -30632,7 +31108,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 358, + "weight": 336, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -30759,7 +31235,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 359, + "weight": 337, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -30887,7 +31363,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 360, + "weight": 338, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -31020,7 +31496,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 361, + "weight": 339, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -31148,7 +31624,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 362, + "weight": 340, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -31281,7 +31757,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 363, + "weight": 341, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -31394,7 +31870,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 364, + "weight": 342, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -31512,7 +31988,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 365, + "weight": 343, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -31627,7 +32103,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 366, + "weight": 344, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -31751,7 +32227,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 383, + "weight": 361, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -31869,7 +32345,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 384, + "weight": 362, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -31987,7 +32463,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 381, + "weight": 359, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -32105,7 +32581,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 382, + "weight": 360, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -32223,7 +32699,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 367, + "weight": 345, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -32338,7 +32814,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 368, + "weight": 346, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -32462,7 +32938,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 369, + "weight": 347, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -32577,7 +33053,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 370, + "weight": 348, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -32701,7 +33177,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 371, + "weight": 349, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -32840,7 +33316,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 373, + "weight": 351, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -32969,7 +33445,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 374, + "weight": 352, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -33098,7 +33574,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 379, + "weight": 357, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -33216,7 +33692,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 380, + "weight": 358, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -33334,7 +33810,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 375, + "weight": 353, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -33448,7 +33924,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 376, + "weight": 354, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -33567,7 +34043,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 377, + "weight": 355, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -33692,7 +34168,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 378, + "weight": 356, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -33848,7 +34324,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 348, + "weight": 326, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -33925,7 +34401,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 349, + "weight": 327, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -34011,7 +34487,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 372, + "weight": 350, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -34127,7 +34603,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 388, + "weight": 366, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -34226,7 +34702,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 385, + "weight": 363, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -34367,7 +34843,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 386, + "weight": 364, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -34444,7 +34920,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 387, + "weight": 365, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -34530,7 +35006,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 397, + "weight": 375, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -34617,6 +35093,18 @@ "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" } ] }, @@ -34643,7 +35131,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 389, + "weight": 367, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -34829,7 +35317,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 394, + "weight": 372, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -34963,7 +35451,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 392, + "weight": 370, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -35068,7 +35556,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 396, + "weight": 374, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -35170,7 +35658,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 390, + "weight": 368, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -35282,7 +35770,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 393, + "weight": 371, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -35435,7 +35923,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 391, + "weight": 369, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -35548,7 +36036,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 395, + "weight": 373, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -35656,7 +36144,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 400, + "weight": 378, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -35786,7 +36274,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 399, + "weight": 377, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -35916,7 +36404,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 107, + "weight": 503, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -36007,7 +36495,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 106, + "weight": 501, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -36096,7 +36584,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 108, + "weight": 502, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -36162,7 +36650,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 110, + "weight": 505, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -36240,7 +36728,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 112, + "weight": 504, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -36308,7 +36796,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 114, + "weight": 510, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -36409,7 +36897,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 113, + "weight": 508, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -36476,7 +36964,7 @@ }, "roles": { "type": "array", - "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "x-example": null, "items": { "type": "string" @@ -36527,7 +37015,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 115, + "weight": 509, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -36581,7 +37069,7 @@ ] }, "patch": { - "summary": "Update membership", + "summary": "Update team membership", "operationId": "teamsUpdateMembership", "tags": [ "teams" @@ -36603,7 +37091,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 116, + "weight": 511, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -36663,7 +37151,7 @@ "properties": { "roles": { "type": "array", - "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "x-example": null, "items": { "type": "string" @@ -36693,8 +37181,8 @@ "deprecated": false, "x-appwrite": { "method": "deleteMembership", - "group": null, - "weight": 555, + "group": "memberships", + "weight": 735, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -36772,7 +37260,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 117, + "weight": 513, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -36873,7 +37361,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 109, + "weight": 506, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -36915,7 +37403,7 @@ ] }, "put": { - "summary": "Update preferences", + "summary": "Update team preferences", "operationId": "teamsUpdatePrefs", "tags": [ "teams" @@ -36937,7 +37425,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 111, + "weight": 507, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -37022,7 +37510,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 525, + "weight": 517, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -37117,7 +37605,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 523, + "weight": 515, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -37207,7 +37695,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 524, + "weight": 516, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -37268,7 +37756,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 526, + "weight": 518, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -37339,7 +37827,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 527, + "weight": 519, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -37402,7 +37890,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 129, + "weight": 109, "cookies": false, "type": "", "demo": "users\/list.md", @@ -37489,7 +37977,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 120, + "weight": 100, "cookies": false, "type": "", "demo": "users\/create.md", @@ -37584,7 +38072,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 123, + "weight": 103, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -37674,7 +38162,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 121, + "weight": 101, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -37764,7 +38252,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 137, + "weight": 117, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -37846,7 +38334,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 160, + "weight": 140, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -37910,7 +38398,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 122, + "weight": 102, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -38000,7 +38488,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 125, + "weight": 105, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -38090,7 +38578,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 126, + "weight": 106, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -38214,7 +38702,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 127, + "weight": 107, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -38322,7 +38810,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 124, + "weight": 104, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -38432,7 +38920,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 130, + "weight": 110, "cookies": false, "type": "", "demo": "users\/get.md", @@ -38487,7 +38975,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 158, + "weight": 138, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -38551,7 +39039,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 143, + "weight": 123, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -38635,7 +39123,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 161, + "weight": 141, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -38721,7 +39209,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 139, + "weight": 119, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -38807,7 +39295,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 135, + "weight": 115, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -38895,7 +39383,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 134, + "weight": 114, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -38994,7 +39482,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 148, + "weight": 128, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -39132,7 +39620,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 153, + "weight": 133, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -39271,7 +39759,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 149, + "weight": 129, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -39393,7 +39881,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 150, + "weight": 130, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -39513,7 +40001,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 152, + "weight": 132, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -39633,7 +40121,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 151, + "weight": 131, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -39755,7 +40243,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 141, + "weight": 121, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -39838,7 +40326,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 142, + "weight": 122, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -39921,7 +40409,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 144, + "weight": 124, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -40005,7 +40493,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 131, + "weight": 111, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -40067,7 +40555,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 146, + "weight": 126, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -40150,7 +40638,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 133, + "weight": 113, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -40223,7 +40711,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 154, + "weight": 134, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -40278,7 +40766,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 157, + "weight": 137, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -40335,7 +40823,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 156, + "weight": 136, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -40409,7 +40897,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 138, + "weight": 118, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -40492,7 +40980,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 136, + "weight": 116, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -40578,7 +41066,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 128, + "weight": 108, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -40690,7 +41178,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 132, + "weight": 112, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -40762,7 +41250,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 147, + "weight": 127, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -40853,7 +41341,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 159, + "weight": 139, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -40927,7 +41415,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 155, + "weight": 135, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -41014,7 +41502,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 145, + "weight": 125, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -41097,7 +41585,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 140, + "weight": 120, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -41155,6 +41643,487 @@ } } } + }, + "\/webhooks": { + "get": { + "summary": "List webhooks", + "operationId": "webhooksList", + "tags": [ + "webhooks" + ], + "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Webhooks List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhookList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 550, + "cookies": false, + "type": "", + "demo": "webhooks\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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. You may filter on the following attributes: name, url, httpUser, security, events, enabled, logs, attempts", + "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 webhook", + "operationId": "webhooksCreate", + "tags": [ + "webhooks" + ], + "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "responses": { + "201": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 549, + "cookies": false, + "type": "", + "demo": "webhooks\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "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>" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "x-example": null + }, + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "x-example": "<NAME>" + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "x-example": false + }, + "security": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "x-example": false + }, + "httpUser": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "x-example": "<HTTP_USER>" + }, + "httpPass": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "x-example": "<HTTP_PASS>" + } + }, + "required": [ + "webhookId", + "url", + "name", + "events" + ] + } + } + } + } + } + }, + "\/webhooks\/{webhookId}": { + "get": { + "summary": "Get webhook", + "operationId": "webhooksGet", + "tags": [ + "webhooks" + ], + "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 551, + "cookies": false, + "type": "", + "demo": "webhooks\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<WEBHOOK_ID>" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update webhook", + "operationId": "webhooksUpdate", + "tags": [ + "webhooks" + ], + "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 553, + "cookies": false, + "type": "", + "demo": "webhooks\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<WEBHOOK_ID>" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "x-example": "<NAME>" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "x-example": null + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "x-example": false + }, + "security": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "x-example": false + }, + "httpUser": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "x-example": "<HTTP_USER>" + }, + "httpPass": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "x-example": "<HTTP_PASS>" + } + }, + "required": [ + "name", + "url", + "events" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete webhook", + "operationId": "webhooksDelete", + "tags": [ + "webhooks" + ], + "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 552, + "cookies": false, + "type": "", + "demo": "webhooks\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<WEBHOOK_ID>" + }, + "in": "path" + } + ] + } + }, + "\/webhooks\/{webhookId}\/signature": { + "patch": { + "summary": "Update webhook signature key", + "operationId": "webhooksUpdateSignature", + "tags": [ + "webhooks" + ], + "description": "Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSignature", + "group": null, + "weight": 554, + "cookies": false, + "type": "", + "demo": "webhooks\/update-signature.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "<WEBHOOK_ID>" + }, + "in": "path" + } + ] + } } }, "tags": [ @@ -41893,6 +42862,34 @@ "executions": "" } }, + "webhookList": { + "description": "Webhooks List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of webhooks that matched your query.", + "x-example": 5, + "format": "int32" + }, + "webhooks": { + "type": "array", + "description": "List of webhooks.", + "items": { + "$ref": "#\/components\/schemas\/webhook" + }, + "x-example": "" + } + }, + "required": [ + "total", + "webhooks" + ], + "example": { + "total": 5, + "webhooks": "" + } + }, "countryList": { "description": "Countries List", "type": "object", @@ -46285,8 +47282,8 @@ }, "$sequence": { "type": "integer", - "description": "Row automatically incrementing ID.", - "x-example": 1, + "description": "Row sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -46335,7 +47332,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$tableId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -46356,8 +47353,8 @@ }, "$sequence": { "type": "integer", - "description": "Document automatically incrementing ID.", - "x-example": 1, + "description": "Document sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -46406,7 +47403,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$collectionId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -47933,6 +48930,12 @@ "description": "Site framework.", "x-example": "react" }, + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, "deploymentId": { "type": "string", "description": "Site's active deployment ID.", @@ -47992,6 +48995,11 @@ "description": "The build command used to build the site.", "x-example": "npm run build" }, + "startCommand": { + "type": "string", + "description": "Custom command to use when starting site runtime.", + "x-example": "node custom-server.mjs" + }, "outputDirectory": { "type": "string", "description": "The directory where the site build output is located.", @@ -48022,9 +49030,14 @@ "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", "x-example": false }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { "type": "string", - "description": "Machine specification for builds and executions.", + "description": "Machine specification for SSR executions.", "x-example": "s-1vcpu-512mb" }, "buildRuntime": { @@ -48052,6 +49065,7 @@ "live", "logging", "framework", + "deploymentRetention", "deploymentId", "deploymentCreatedAt", "deploymentScreenshotLight", @@ -48063,13 +49077,15 @@ "timeout", "installCommand", "buildCommand", + "startCommand", "outputDirectory", "installationId", "providerRepositoryId", "providerBranch", "providerRootDirectory", "providerSilentMode", - "specification", + "buildSpecification", + "runtimeSpecification", "buildRuntime", "adapter", "fallbackFile" @@ -48083,6 +49099,7 @@ "live": false, "logging": false, "framework": "react", + "deploymentRetention": 7, "deploymentId": "5e5ea5c16897e", "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", "deploymentScreenshotLight": "5e5ea5c16897e", @@ -48094,13 +49111,15 @@ "timeout": 300, "installCommand": "npm install", "buildCommand": "npm run build", + "startCommand": "node custom-server.mjs", "outputDirectory": "build", "installationId": "6m40at4ejk5h2u9s1hboo", "providerRepositoryId": "appwrite", "providerBranch": "main", "providerRootDirectory": "sites\/helloWorld", "providerSilentMode": false, - "specification": "s-1vcpu-512mb", + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb", "buildRuntime": "node-22", "adapter": "static", "fallbackFile": "index.html" @@ -48158,6 +49177,12 @@ "description": "Function execution and build runtime.", "x-example": "python-3.8" }, + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, "deploymentId": { "type": "string", "description": "Function's active deployment ID.", @@ -48258,9 +49283,14 @@ "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", "x-example": false }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { "type": "string", - "description": "Machine specification for builds and executions.", + "description": "Machine specification for executions.", "x-example": "s-1vcpu-512mb" } }, @@ -48274,6 +49304,7 @@ "live", "logging", "runtime", + "deploymentRetention", "deploymentId", "deploymentCreatedAt", "latestDeploymentId", @@ -48292,7 +49323,8 @@ "providerBranch", "providerRootDirectory", "providerSilentMode", - "specification" + "buildSpecification", + "runtimeSpecification" ], "example": { "$id": "5e5ea5c16897e", @@ -48304,6 +49336,7 @@ "live": false, "logging": false, "runtime": "python-3.8", + "deploymentRetention": 7, "deploymentId": "5e5ea5c16897e", "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", "latestDeploymentId": "5e5ea5c16897e", @@ -48322,7 +49355,8 @@ "providerBranch": "main", "providerRootDirectory": "functions\/helloWorld", "providerSilentMode": false, - "specification": "s-1vcpu-512mb" + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb" } }, "runtime": { @@ -48902,6 +49936,117 @@ "scheduledAt": "2020-10-15T06:38:00.000+00:00" } }, + "webhook": { + "description": "Webhook", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Webhook ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Webhook creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Webhook update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Webhook name.", + "x-example": "My Webhook" + }, + "url": { + "type": "string", + "description": "Webhook URL endpoint.", + "x-example": "https:\/\/example.com\/webhook" + }, + "events": { + "type": "array", + "description": "Webhook trigger events.", + "items": { + "type": "string" + }, + "x-example": [ + "databases.tables.update", + "databases.collections.update" + ] + }, + "security": { + "type": "boolean", + "description": "Indicated if SSL \/ TLS Certificate verification is enabled.", + "x-example": true + }, + "httpUser": { + "type": "string", + "description": "HTTP basic authentication username.", + "x-example": "username" + }, + "httpPass": { + "type": "string", + "description": "HTTP basic authentication password.", + "x-example": "password" + }, + "signatureKey": { + "type": "string", + "description": "Signature key which can be used to validated incoming", + "x-example": "ad3d581ca230e2b7059c545e5a" + }, + "enabled": { + "type": "boolean", + "description": "Indicates if this webhook is enabled.", + "x-example": true + }, + "logs": { + "type": "string", + "description": "Webhook error logs from the most recent failure.", + "x-example": "Failed to connect to remote server." + }, + "attempts": { + "type": "integer", + "description": "Number of consecutive failed webhook attempts.", + "x-example": 10, + "format": "int32" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "url", + "events", + "security", + "httpUser", + "httpPass", + "signatureKey", + "enabled", + "logs", + "attempts" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Webhook", + "url": "https:\/\/example.com\/webhook", + "events": [ + "databases.tables.update", + "databases.collections.update" + ], + "security": true, + "httpUser": "username", + "httpPass": "password", + "signatureKey": "ad3d581ca230e2b7059c545e5a", + "enabled": true, + "logs": "Failed to connect to remote server.", + "attempts": 10 + } + }, "variable": { "description": "Variable", "type": "object", diff --git a/specs/1.8.x/swagger2-1.8.x-client.json b/specs/1.8.x/swagger2-1.8.x-client.json index c2960f64a..3cd749b52 100644 --- a/specs/1.8.x/swagger2-1.8.x-client.json +++ b/specs/1.8.x/swagger2-1.8.x-client.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "1.8.1", + "version": "1.8.2", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -612,7 +612,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 239, + "weight": 217, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -687,7 +687,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 241, + "weight": 219, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -811,7 +811,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 242, + "weight": 220, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -952,7 +952,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 243, + "weight": 221, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1076,7 +1076,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 247, + "weight": 225, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1213,7 +1213,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 248, + "weight": 226, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1353,7 +1353,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 240, + "weight": 218, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1454,7 +1454,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 246, + "weight": 224, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1555,7 +1555,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 244, + "weight": 222, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1656,7 +1656,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 245, + "weight": 223, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -4203,7 +4203,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 250, + "weight": 228, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4329,7 +4329,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 249, + "weight": 227, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4461,7 +4461,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 253, + "weight": 231, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4525,7 +4525,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 251, + "weight": 229, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -5013,7 +5013,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 252, + "weight": 230, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -5097,7 +5097,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 255, + "weight": 233, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5189,7 +5189,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 254, + "weight": 232, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5281,7 +5281,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 256, + "weight": 234, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5994,7 +5994,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 332, + "weight": 310, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6061,7 +6061,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 328, + "weight": 306, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6132,7 +6132,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 329, + "weight": 307, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6195,7 +6195,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 330, + "weight": 308, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6274,7 +6274,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 331, + "weight": 309, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6339,7 +6339,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 333, + "weight": 311, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6420,7 +6420,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 283, + "weight": 261, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -6496,6 +6496,16 @@ "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" } ] }, @@ -6524,7 +6534,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 275, + "weight": 253, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -6683,7 +6693,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 276, + "weight": 254, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -6786,7 +6796,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 279, + "weight": 257, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -6937,7 +6947,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 277, + "weight": 255, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -7047,7 +7057,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 281, + "weight": 259, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -7148,7 +7158,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 286, + "weight": 264, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -7271,7 +7281,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 285, + "weight": 263, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -7392,7 +7402,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 577, + "weight": 417, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -7475,7 +7485,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 575, + "weight": 415, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -7594,7 +7604,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 576, + "weight": 416, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -7666,7 +7676,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 176, + "weight": 154, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -7741,7 +7751,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 175, + "weight": 153, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -8240,7 +8250,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 223, + "weight": 201, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -8325,7 +8335,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 227, + "weight": 205, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -8396,7 +8406,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 535, + "weight": 527, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -8489,7 +8499,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 781, + "weight": 734, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -8580,7 +8590,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 534, + "weight": 526, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -8651,7 +8661,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 536, + "weight": 528, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -8742,7 +8752,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 537, + "weight": 529, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -8813,7 +8823,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 539, + "weight": 531, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -8893,7 +8903,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 538, + "weight": 530, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -9101,7 +9111,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 540, + "weight": 532, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -9181,7 +9191,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 405, + "weight": 383, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -9251,7 +9261,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 401, + "weight": 379, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -9325,7 +9335,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 402, + "weight": 380, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -9391,7 +9401,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 403, + "weight": 381, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -9473,7 +9483,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 404, + "weight": 382, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -9541,7 +9551,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 406, + "weight": 384, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -9625,7 +9635,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 397, + "weight": 375, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -9700,6 +9710,16 @@ "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" } ] }, @@ -9728,7 +9748,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 389, + "weight": 367, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -9882,7 +9902,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 390, + "weight": 368, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -9984,7 +10004,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 393, + "weight": 371, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -10130,7 +10150,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 391, + "weight": 369, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -10239,7 +10259,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 395, + "weight": 373, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -10339,7 +10359,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 400, + "weight": 378, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -10461,7 +10481,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 399, + "weight": 377, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -10581,7 +10601,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 107, + "weight": 503, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -10666,7 +10686,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 106, + "weight": 501, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -10757,7 +10777,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 108, + "weight": 502, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -10820,7 +10840,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 110, + "weight": 505, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -10896,7 +10916,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 112, + "weight": 504, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -10959,7 +10979,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 114, + "weight": 510, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -11052,7 +11072,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 113, + "weight": 508, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -11116,7 +11136,7 @@ }, "roles": { "type": "array", - "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "default": null, "x-example": null, "items": { @@ -11169,7 +11189,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 115, + "weight": 509, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -11216,7 +11236,7 @@ ] }, "patch": { - "summary": "Update membership", + "summary": "Update team membership", "operationId": "teamsUpdateMembership", "consumes": [ "application\/json" @@ -11240,7 +11260,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 116, + "weight": 511, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -11292,7 +11312,7 @@ "properties": { "roles": { "type": "array", - "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "default": null, "x-example": null, "items": { @@ -11313,9 +11333,7 @@ "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "teams" ], @@ -11328,8 +11346,8 @@ "deprecated": false, "x-appwrite": { "method": "deleteMembership", - "group": null, - "weight": 555, + "group": "memberships", + "weight": 735, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -11402,7 +11420,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 117, + "weight": 513, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -11498,7 +11516,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 109, + "weight": 506, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -11537,7 +11555,7 @@ ] }, "put": { - "summary": "Update preferences", + "summary": "Update team preferences", "operationId": "teamsUpdatePrefs", "consumes": [ "application\/json" @@ -11561,7 +11579,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 111, + "weight": 507, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -12175,8 +12193,8 @@ }, "$sequence": { "type": "integer", - "description": "Row automatically incrementing ID.", - "x-example": 1, + "description": "Row sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -12225,7 +12243,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$tableId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -12246,8 +12264,8 @@ }, "$sequence": { "type": "integer", - "description": "Document automatically incrementing ID.", - "x-example": 1, + "description": "Document sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -12296,7 +12314,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$collectionId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", diff --git a/specs/1.8.x/swagger2-1.8.x-console.json b/specs/1.8.x/swagger2-1.8.x-console.json index 5c050bab7..71ad476b2 100644 --- a/specs/1.8.x/swagger2-1.8.x-console.json +++ b/specs/1.8.x/swagger2-1.8.x-console.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "1.8.1", + "version": "1.8.2", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -301,7 +301,7 @@ "x-appwrite": { "method": "listBillingAddresses", "group": null, - "weight": 769, + "weight": 720, "cookies": false, "type": "", "demo": "account\/list-billing-addresses.md", @@ -364,7 +364,7 @@ "x-appwrite": { "method": "createBillingAddress", "group": null, - "weight": 767, + "weight": 718, "cookies": false, "type": "", "demo": "account\/create-billing-address.md", @@ -465,7 +465,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 768, + "weight": 719, "cookies": false, "type": "", "demo": "account\/get-billing-address.md", @@ -524,7 +524,7 @@ "x-appwrite": { "method": "updateBillingAddress", "group": null, - "weight": 770, + "weight": 721, "cookies": false, "type": "", "demo": "account\/update-billing-address.md", @@ -630,7 +630,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 771, + "weight": 722, "cookies": false, "type": "", "demo": "account\/delete-billing-address.md", @@ -689,7 +689,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 773, + "weight": 724, "cookies": false, "type": "", "demo": "account\/get-coupon.md", @@ -965,7 +965,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 772, + "weight": 723, "cookies": false, "type": "", "demo": "account\/list-invoices.md", @@ -991,7 +991,7 @@ "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\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, type, amount, currency, from, to, dueAt, attempts, status, grossAmount", "required": false, "type": "array", "collectionFormat": "multi", @@ -1087,7 +1087,7 @@ "tags": [ "account" ], - "description": "Get a list of all API keys from the current account. ", + "description": "Get a list of all API keys from the current account.", "responses": { "200": { "description": "API Keys List", @@ -1100,7 +1100,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 755, + "weight": 706, "cookies": false, "type": "", "demo": "account\/list-keys.md", @@ -1113,29 +1113,6 @@ ], "packaging": false, "public": true, - "methods": [ - { - "name": "listKeys", - "namespace": "account", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "total" - ], - "required": [], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/keyList" - } - ], - "description": "", - "demo": "account\/list-keys.md", - "public": true - } - ], "auth": { "Project": [] } @@ -1182,7 +1159,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 756, + "weight": 707, "cookies": false, "type": "", "demo": "account\/create-key.md", @@ -1195,34 +1172,6 @@ ], "packaging": false, "public": true, - "methods": [ - { - "name": "createKey", - "namespace": "account", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "name", - "scopes", - "expire" - ], - "required": [ - "name", - "scopes" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/key" - } - ], - "description": "", - "demo": "account\/create-key.md", - "public": true - } - ], "auth": { "Project": [] } @@ -1302,7 +1251,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 759, + "weight": 710, "cookies": false, "type": "", "demo": "account\/get-key.md", @@ -1315,31 +1264,6 @@ ], "packaging": false, "public": true, - "methods": [ - { - "name": "getKey", - "namespace": "account", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "keyId" - ], - "required": [ - "keyId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/key" - } - ], - "description": "", - "demo": "account\/get-key.md", - "public": true - } - ], "auth": { "Project": [] } @@ -1385,7 +1309,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 758, + "weight": 709, "cookies": false, "type": "", "demo": "account\/update-key.md", @@ -1398,36 +1322,6 @@ ], "packaging": false, "public": true, - "methods": [ - { - "name": "updateKey", - "namespace": "account", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "keyId", - "name", - "scopes", - "expire" - ], - "required": [ - "keyId", - "name", - "scopes" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/key" - } - ], - "description": "", - "demo": "account\/update-key.md", - "public": true - } - ], "auth": { "Project": [] } @@ -1512,7 +1406,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 757, + "weight": 708, "cookies": false, "type": "", "demo": "account\/delete-key.md", @@ -1525,30 +1419,6 @@ ], "packaging": false, "public": true, - "methods": [ - { - "name": "deleteKey", - "namespace": "account", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "keyId" - ], - "required": [ - "keyId" - ], - "responses": [ - { - "code": 204 - } - ], - "description": "", - "demo": "account\/delete-key.md", - "public": true - } - ], "auth": { "Project": [] } @@ -1671,7 +1541,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 239, + "weight": 217, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -1745,7 +1615,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 241, + "weight": 219, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -1868,7 +1738,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 242, + "weight": 220, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -2008,7 +1878,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 243, + "weight": 221, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -2131,7 +2001,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 247, + "weight": 225, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -2267,7 +2137,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 248, + "weight": 226, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -2406,7 +2276,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 240, + "weight": 218, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -2506,7 +2376,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 246, + "weight": 224, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -2606,7 +2476,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 244, + "weight": 222, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -2706,7 +2576,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 245, + "weight": 223, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2961,7 +2831,7 @@ "x-appwrite": { "method": "listPaymentMethods", "group": null, - "weight": 762, + "weight": 713, "cookies": false, "type": "", "demo": "account\/list-payment-methods.md", @@ -3024,7 +2894,7 @@ "x-appwrite": { "method": "createPaymentMethod", "group": null, - "weight": 760, + "weight": 711, "cookies": false, "type": "", "demo": "account\/create-payment-method.md", @@ -3073,7 +2943,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 761, + "weight": 712, "cookies": false, "type": "", "demo": "account\/get-payment-method.md", @@ -3132,7 +3002,7 @@ "x-appwrite": { "method": "updatePaymentMethod", "group": null, - "weight": 763, + "weight": 714, "cookies": false, "type": "", "demo": "account\/update-payment-method.md", @@ -3221,7 +3091,7 @@ "x-appwrite": { "method": "deletePaymentMethod", "group": null, - "weight": 766, + "weight": 717, "cookies": false, "type": "", "demo": "account\/delete-payment-method.md", @@ -3282,7 +3152,7 @@ "x-appwrite": { "method": "updatePaymentMethodProvider", "group": null, - "weight": 764, + "weight": 715, "cookies": false, "type": "", "demo": "account\/update-payment-method-provider.md", @@ -3375,7 +3245,7 @@ "x-appwrite": { "method": "updatePaymentMethodMandateOptions", "group": null, - "weight": 765, + "weight": 716, "cookies": false, "type": "", "demo": "account\/update-payment-method-mandate-options.md", @@ -5695,7 +5565,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 779, + "weight": 732, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -5756,7 +5626,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 780, + "weight": 733, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -5817,7 +5687,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 250, + "weight": 228, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -5943,7 +5813,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 249, + "weight": 227, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -6075,7 +5945,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 253, + "weight": 231, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -6139,7 +6009,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 251, + "weight": 229, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -6627,7 +6497,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 252, + "weight": 230, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -6711,7 +6581,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 255, + "weight": 233, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -6803,7 +6673,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 254, + "weight": 232, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -6895,7 +6765,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 256, + "weight": 234, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -7608,7 +7478,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 749, + "weight": 700, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -7673,7 +7543,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 750, + "weight": 701, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -7761,7 +7631,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 748, + "weight": 699, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -7819,7 +7689,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 751, + "weight": 702, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -7880,7 +7750,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 744, + "weight": 695, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -7945,7 +7815,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 745, + "weight": 696, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -8067,7 +7937,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 743, + "weight": 694, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -8128,7 +7998,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 746, + "weight": 697, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -8223,7 +8093,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 747, + "weight": 698, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -8286,7 +8156,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 754, + "weight": 705, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -8386,7 +8256,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 753, + "weight": 704, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -8451,7 +8321,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 752, + "weight": 703, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -8514,7 +8384,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 505, + "weight": 483, "cookies": false, "type": "", "demo": "assistant\/chat.md", @@ -8583,7 +8453,7 @@ "x-appwrite": { "method": "getCampaign", "group": null, - "weight": 623, + "weight": 568, "cookies": false, "type": "", "demo": "console\/get-campaign.md", @@ -8642,7 +8512,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 620, + "weight": 565, "cookies": false, "type": "", "demo": "console\/get-coupon.md", @@ -8701,7 +8571,7 @@ "x-appwrite": { "method": "getPlans", "group": null, - "weight": 618, + "weight": 563, "cookies": false, "type": "", "demo": "console\/get-plans.md", @@ -8767,7 +8637,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 619, + "weight": 564, "cookies": false, "type": "", "demo": "console\/get-plan.md", @@ -8826,7 +8696,7 @@ "x-appwrite": { "method": "getProgram", "group": null, - "weight": 621, + "weight": 566, "cookies": false, "type": "", "demo": "console\/get-program.md", @@ -8887,7 +8757,7 @@ "x-appwrite": { "method": "createProgramMembership", "group": null, - "weight": 622, + "weight": 567, "cookies": false, "type": "", "demo": "console\/create-program-membership.md", @@ -8946,7 +8816,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 617, + "weight": 562, "cookies": false, "type": "", "demo": "console\/list-regions.md", @@ -8990,7 +8860,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 506, + "weight": 484, "cookies": false, "type": "", "demo": "console\/get-resource.md", @@ -9063,7 +8933,7 @@ "x-appwrite": { "method": "createSource", "group": null, - "weight": 624, + "weight": 569, "cookies": false, "type": "", "demo": "console\/create-source.md", @@ -9159,7 +9029,7 @@ "x-appwrite": { "method": "suggestColumns", "group": null, - "weight": 625, + "weight": 570, "cookies": false, "type": "", "demo": "console\/suggest-columns.md", @@ -9254,7 +9124,7 @@ "x-appwrite": { "method": "suggestIndexes", "group": null, - "weight": 626, + "weight": 571, "cookies": false, "type": "", "demo": "console\/suggest-indexes.md", @@ -9341,7 +9211,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 504, + "weight": 482, "cookies": false, "type": "", "demo": "console\/variables.md", @@ -9390,7 +9260,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 264, + "weight": 242, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -9506,7 +9376,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 260, + "weight": 238, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -9626,7 +9496,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 332, + "weight": 310, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -9693,7 +9563,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 328, + "weight": 306, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -9764,7 +9634,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 329, + "weight": 307, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -9827,7 +9697,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 330, + "weight": 308, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -9906,7 +9776,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 331, + "weight": 309, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -9971,7 +9841,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 333, + "weight": 311, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -10052,7 +9922,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 267, + "weight": 245, "cookies": false, "type": "", "demo": "databases\/list-usage.md", @@ -10154,7 +10024,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 261, + "weight": 239, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -10248,7 +10118,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 262, + "weight": 240, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -10360,7 +10230,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 263, + "weight": 241, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -10453,7 +10323,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 272, + "weight": 250, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -10548,7 +10418,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 268, + "weight": 246, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -10678,7 +10548,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 269, + "weight": 247, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -10751,7 +10621,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 270, + "weight": 248, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -10856,7 +10726,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 271, + "weight": 249, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -10929,7 +10799,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 289, + "weight": 267, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -11025,7 +10895,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 290, + "weight": 268, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -11065,7 +10935,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "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>", @@ -11138,7 +11008,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 291, + "weight": 269, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -11253,7 +11123,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 292, + "weight": 270, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -11366,7 +11236,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 293, + "weight": 271, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -11481,7 +11351,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 294, + "weight": 272, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -11595,7 +11465,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 295, + "weight": 273, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -11711,7 +11581,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 296, + "weight": 274, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -11834,7 +11704,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 297, + "weight": 275, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -11959,7 +11829,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 298, + "weight": 276, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -12089,7 +11959,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 299, + "weight": 277, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -12221,7 +12091,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 300, + "weight": 278, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -12351,7 +12221,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 301, + "weight": 279, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -12483,7 +12353,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 302, + "weight": 280, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -12596,7 +12466,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 303, + "weight": 281, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -12711,7 +12581,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 304, + "weight": 282, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -12818,7 +12688,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 305, + "weight": 283, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -12932,7 +12802,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 322, + "weight": 300, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -13047,7 +12917,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 323, + "weight": 301, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -13158,7 +13028,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 320, + "weight": 298, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -13273,7 +13143,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 321, + "weight": 299, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -13384,7 +13254,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 306, + "weight": 284, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -13491,7 +13361,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 307, + "weight": 285, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -13605,7 +13475,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 308, + "weight": 286, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -13712,7 +13582,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 309, + "weight": 287, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -13826,7 +13696,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 310, + "weight": 288, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -13941,6 +13811,117 @@ ] } }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { + "patch": { + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "responses": { + "200": { + "description": "AttributeRelationship", + "schema": { + "$ref": "#\/definitions\/attributeRelationship" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateRelationshipAttribute", + "group": "attributes", + "weight": 289, + "cookies": false, + "type": "", + "demo": "databases\/update-relationship-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateRelationshipColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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": "key", + "description": "Attribute Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": null, + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + } + } + } + ] + } + }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { "summary": "Create string attribute", @@ -13967,7 +13948,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 312, + "weight": 290, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -14094,7 +14075,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 313, + "weight": 291, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -14217,7 +14198,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 318, + "weight": 296, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -14332,7 +14313,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 319, + "weight": 297, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -14443,7 +14424,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 314, + "weight": 292, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -14557,7 +14538,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 315, + "weight": 293, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -14673,7 +14654,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 316, + "weight": 294, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -14796,7 +14777,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 317, + "weight": 295, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -14944,7 +14925,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 287, + "weight": 265, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -15019,7 +15000,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 288, + "weight": 266, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -15075,118 +15056,6 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship": { - "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", - "responses": { - "200": { - "description": "AttributeRelationship", - "schema": { - "$ref": "#\/definitions\/attributeRelationship" - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "updateRelationshipAttribute", - "group": "attributes", - "weight": 311, - "cookies": false, - "type": "", - "demo": "databases\/update-relationship-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" - }, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "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": "key", - "description": "Attribute Key.", - "required": true, - "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "default": null, - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - } - } - } - ] - } - }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { "get": { "summary": "List documents", @@ -15211,7 +15080,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 283, + "weight": 261, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -15287,6 +15156,16 @@ "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" } ] }, @@ -15315,7 +15194,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 275, + "weight": 253, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -15506,7 +15385,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 280, + "weight": 258, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -15641,7 +15520,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 278, + "weight": 256, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -15745,7 +15624,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 282, + "weight": 260, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -15843,7 +15722,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 276, + "weight": 254, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -15946,7 +15825,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 279, + "weight": 257, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -16097,7 +15976,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 277, + "weight": 255, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -16207,7 +16086,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 281, + "weight": 259, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -16306,7 +16185,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 284, + "weight": 262, "cookies": false, "type": "", "demo": "databases\/list-document-logs.md", @@ -16399,7 +16278,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 286, + "weight": 264, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -16522,7 +16401,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 285, + "weight": 263, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -16643,7 +16522,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 327, + "weight": 305, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -16737,7 +16616,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 324, + "weight": 302, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -16877,7 +16756,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 325, + "weight": 303, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -16952,7 +16831,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 326, + "weight": 304, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -17032,7 +16911,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 273, + "weight": 251, "cookies": false, "type": "", "demo": "databases\/list-collection-logs.md", @@ -17115,7 +16994,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 274, + "weight": 252, "cookies": false, "type": "", "demo": "databases\/get-collection-usage.md", @@ -17206,7 +17085,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 265, + "weight": 243, "cookies": false, "type": "", "demo": "databases\/list-logs.md", @@ -17311,7 +17190,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 266, + "weight": 244, "cookies": false, "type": "", "demo": "databases\/get-usage.md", @@ -17424,7 +17303,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 632, + "weight": 577, "cookies": false, "type": "", "demo": "domains\/list.md", @@ -17495,7 +17374,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 627, + "weight": 572, "cookies": false, "type": "", "demo": "domains\/create.md", @@ -17570,11 +17449,11 @@ "x-appwrite": { "method": "getPrice", "group": null, - "weight": 630, + "weight": 575, "cookies": false, "type": "", "demo": "domains\/get-price.md", - "rate-limit": 50, + "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": "domains.read", @@ -17645,9 +17524,9 @@ "description": " Create a domain purchase with registrant information.", "responses": { "201": { - "description": "Domain", + "description": "DomainPurchase", "schema": { - "$ref": "#\/definitions\/domain" + "$ref": "#\/definitions\/domainPurchase" } } }, @@ -17655,14 +17534,14 @@ "x-appwrite": { "method": "createPurchase", "group": null, - "weight": 672, + "weight": 621, "cookies": false, "type": "", "demo": "domains\/create-purchase.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "billing.write", "platforms": [ "console" ], @@ -17690,11 +17569,11 @@ "default": null, "x-example": null }, - "teamId": { + "organizationId": { "type": "string", "description": "Team ID that will own the domain.", "default": null, - "x-example": "<TEAM_ID>" + "x-example": "<ORGANIZATION_ID>" }, "firstName": { "type": "string", @@ -17756,7 +17635,7 @@ }, "required": [ "domain", - "teamId", + "organizationId", "firstName", "lastName", "email", @@ -17769,6 +17648,84 @@ ] } }, + "\/domains\/purchases\/{domainId}": { + "patch": { + "summary": "Confirm a domain purchase", + "operationId": "domainsUpdatePurchase", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "domains" + ], + "description": " Confirm and complete a domain purchase after payment authentication.", + "responses": { + "200": { + "description": "DomainPurchase", + "schema": { + "$ref": "#\/definitions\/domainPurchase" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePurchase", + "group": null, + "weight": 622, + "cookies": false, + "type": "", + "demo": "domains\/update-purchase.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "domainId", + "description": "Domain ID to confirm purchase for.", + "required": true, + "type": "string", + "x-example": "<DOMAIN_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Team ID that owns the domain.", + "default": null, + "x-example": "<ORGANIZATION_ID>" + } + }, + "required": [ + "organizationId" + ] + } + } + ] + } + }, "\/domains\/suggestions": { "get": { "summary": "List domain suggestions", @@ -17793,7 +17750,7 @@ "x-appwrite": { "method": "listSuggestions", "group": null, - "weight": 671, + "weight": 620, "cookies": false, "type": "", "demo": "domains\/list-suggestions.md", @@ -17877,38 +17834,40 @@ ] } }, - "\/domains\/{domainId}": { - "get": { - "summary": "Get a single domain by its unique ID.", - "operationId": "domainsGet", - "consumes": [], + "\/domains\/transfers\/in": { + "post": { + "summary": "Create a domain transfer in.", + "operationId": "domainsCreateTransferIn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " Get a domain by its unique ID.", + "description": " Create a domain transfer in with authorization code and registrant information.", "responses": { - "200": { - "description": "Domain", + "201": { + "description": "DomainPurchase", "schema": { - "$ref": "#\/definitions\/domain" + "$ref": "#\/definitions\/domainPurchase" } } }, "deprecated": false, "x-appwrite": { - "method": "get", + "method": "createTransferIn", "group": null, - "weight": 629, + "weight": 581, "cookies": false, "type": "", - "demo": "domains\/get.md", + "demo": "domains\/create-transfer-in.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", + "scope": "billing.write", "platforms": [ "console" ], @@ -17925,18 +17884,51 @@ ], "parameters": [ { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "type": "string", - "x-example": "<DOMAIN_ID>", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name to transfer in.", + "default": null, + "x-example": null + }, + "organizationId": { + "type": "string", + "description": "Organization ID that this domain will belong to.", + "default": null, + "x-example": "<ORGANIZATION_ID>" + }, + "authCode": { + "type": "string", + "description": "Authorization code for the domain transfer.", + "default": null, + "x-example": "<AUTH_CODE>" + }, + "paymentMethodId": { + "type": "string", + "description": "Payment method ID to authorize and capture the transfer.", + "default": null, + "x-example": "<PAYMENT_METHOD_ID>" + } + }, + "required": [ + "domain", + "organizationId", + "authCode", + "paymentMethodId" + ] + } } ] - }, - "delete": { - "summary": "Delete a domain by its unique ID.", - "operationId": "domainsDelete", + } + }, + "\/domains\/transfers\/in\/{domainId}": { + "patch": { + "summary": "Confirm a domain transfer in", + "operationId": "domainsUpdateTransferIn", "consumes": [ "application\/json" ], @@ -17946,24 +17938,27 @@ "tags": [ "domains" ], - "description": "Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.\nOnce deleted, the domain will no longer be available for use and all associated resources will be removed.", + "description": " Confirm and complete a domain transfer in after payment authentication.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "DomainPurchase", + "schema": { + "$ref": "#\/definitions\/domainPurchase" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", + "method": "updateTransferIn", "group": null, - "weight": 628, + "weight": 582, "cookies": false, "type": "", - "demo": "domains\/delete.md", + "demo": "domains\/update-transfer-in.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "billing.write", "platforms": [ "console" ], @@ -17981,19 +17976,37 @@ "parameters": [ { "name": "domainId", - "description": "Domain unique ID.", + "description": "Domain ID to confirm transfer for.", "required": true, "type": "string", "x-example": "<DOMAIN_ID>", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Team ID that owns the domain.", + "default": null, + "x-example": "<ORGANIZATION_ID>" + } + }, + "required": [ + "organizationId" + ] + } } ] } }, - "\/domains\/{domainId}\/nameservers": { - "patch": { - "summary": "Verify which NS records are used and update the domain accordingly.", - "operationId": "domainsUpdateNameservers", + "\/domains\/transfers\/out": { + "post": { + "summary": "Create a domain transfer out.", + "operationId": "domainsCreateTransferOut", "consumes": [ "application\/json" ], @@ -18003,27 +18016,27 @@ "tags": [ "domains" ], - "description": " Verify which NS records are used and update the domain accordingly. This will check the domain's\n nameservers and update the domain's status based on whether the nameservers match the expected\n Appwrite nameservers.", + "description": " Create a domain transfer out and return the authorization code.", "responses": { - "200": { - "description": "Domain", + "202": { + "description": "domainTransferOut", "schema": { - "$ref": "#\/definitions\/domain" + "$ref": "#\/definitions\/domainTransferOut" } } }, "deprecated": false, "x-appwrite": { - "method": "updateNameservers", + "method": "createTransferOut", "group": null, - "weight": 633, + "weight": 583, "cookies": false, "type": "", - "demo": "domains\/update-nameservers.md", + "demo": "domains\/create-transfer-out.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "billing.write", "platforms": [ "console" ], @@ -18040,20 +18053,37 @@ ], "parameters": [ { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "type": "string", - "x-example": "<DOMAIN_ID>", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "domainId": { + "type": "string", + "description": "Domain unique ID.", + "default": null, + "x-example": "<DOMAIN_ID>" + }, + "organizationId": { + "type": "string", + "description": "Organization ID that this domain belongs to.", + "default": null, + "x-example": "<ORGANIZATION_ID>" + } + }, + "required": [ + "domainId", + "organizationId" + ] + } } ] } }, - "\/domains\/{domainId}\/presets\/google-workspace": { + "\/domains\/{domainId}": { "get": { - "summary": "Get Google Workspace preset (Records)", - "operationId": "domainsGetPresetGoogleWorkspace", + "summary": "Get a single domain by its unique ID.", + "operationId": "domainsGet", "consumes": [], "produces": [ "application\/json" @@ -18061,27 +18091,200 @@ "tags": [ "domains" ], - "description": " List Google Workspace DNS records.", + "description": " Get a domain by its unique ID.", "responses": { - "201": { - "description": "DNS records list", + "200": { + "description": "Domain", "schema": { - "$ref": "#\/definitions\/dnsRecordsList" + "$ref": "#\/definitions\/domain" } } }, "deprecated": false, "x-appwrite": { - "method": "getPresetGoogleWorkspace", + "method": "get", "group": null, - "weight": 660, + "weight": 574, "cookies": false, "type": "", - "demo": "domains\/get-preset-google-workspace.md", + "demo": "domains\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "domains.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "type": "string", + "x-example": "<DOMAIN_ID>", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete a domain by its unique ID.", + "operationId": "domainsDelete", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "domains" + ], + "description": "Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.\nOnce deleted, the domain will no longer be available for use and all associated resources will be removed.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 573, + "cookies": false, + "type": "", + "demo": "domains\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "domains.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "type": "string", + "x-example": "<DOMAIN_ID>", + "in": "path" + } + ] + } + }, + "\/domains\/{domainId}\/nameservers": { + "patch": { + "summary": "Verify which NS records are used and update the domain accordingly.", + "operationId": "domainsUpdateNameservers", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "domains" + ], + "description": " Verify which NS records are used and update the domain accordingly. This will check the domain's\n nameservers and update the domain's status based on whether the nameservers match the expected\n Appwrite nameservers.", + "responses": { + "200": { + "description": "Domain", + "schema": { + "$ref": "#\/definitions\/domain" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateNameservers", + "group": null, + "weight": 578, + "cookies": false, + "type": "", + "demo": "domains\/update-nameservers.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "domains.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "type": "string", + "x-example": "<DOMAIN_ID>", + "in": "path" + } + ] + } + }, + "\/domains\/{domainId}\/presets\/google-workspace": { + "get": { + "summary": "Get Google Workspace preset (Records)", + "operationId": "domainsGetPresetGoogleWorkspace", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "domains" + ], + "description": " List Google Workspace DNS records.", + "responses": { + "201": { + "description": "DNS records list", + "schema": { + "$ref": "#\/definitions\/dnsRecordsList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getPresetGoogleWorkspace", + "group": null, + "weight": 609, + "cookies": false, + "type": "", + "demo": "domains\/get-preset-google-workspace.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "domains.write", "platforms": [ "console" ], @@ -18132,7 +18335,7 @@ "x-appwrite": { "method": "createPresetGoogleWorkspace", "group": null, - "weight": 659, + "weight": 608, "cookies": false, "type": "", "demo": "domains\/create-preset-google-workspace.md", @@ -18190,7 +18393,7 @@ "x-appwrite": { "method": "getPresetICloud", "group": null, - "weight": 670, + "weight": 619, "cookies": false, "type": "", "demo": "domains\/get-preset-i-cloud.md", @@ -18248,7 +18451,7 @@ "x-appwrite": { "method": "createPresetICloud", "group": null, - "weight": 669, + "weight": 618, "cookies": false, "type": "", "demo": "domains\/create-preset-i-cloud.md", @@ -18306,7 +18509,7 @@ "x-appwrite": { "method": "getPresetMailgun", "group": null, - "weight": 662, + "weight": 611, "cookies": false, "type": "", "demo": "domains\/get-preset-mailgun.md", @@ -18364,7 +18567,7 @@ "x-appwrite": { "method": "createPresetMailgun", "group": null, - "weight": 661, + "weight": 610, "cookies": false, "type": "", "demo": "domains\/create-preset-mailgun.md", @@ -18422,7 +18625,7 @@ "x-appwrite": { "method": "getPresetOutlook", "group": null, - "weight": 668, + "weight": 617, "cookies": false, "type": "", "demo": "domains\/get-preset-outlook.md", @@ -18480,7 +18683,7 @@ "x-appwrite": { "method": "createPresetOutlook", "group": null, - "weight": 667, + "weight": 616, "cookies": false, "type": "", "demo": "domains\/create-preset-outlook.md", @@ -18538,7 +18741,7 @@ "x-appwrite": { "method": "getPresetProtonMail", "group": null, - "weight": 666, + "weight": 615, "cookies": false, "type": "", "demo": "domains\/get-preset-proton-mail.md", @@ -18596,7 +18799,7 @@ "x-appwrite": { "method": "createPresetProtonMail", "group": null, - "weight": 665, + "weight": 614, "cookies": false, "type": "", "demo": "domains\/create-preset-proton-mail.md", @@ -18654,7 +18857,7 @@ "x-appwrite": { "method": "getPresetZoho", "group": null, - "weight": 664, + "weight": 613, "cookies": false, "type": "", "demo": "domains\/get-preset-zoho.md", @@ -18712,7 +18915,7 @@ "x-appwrite": { "method": "createPresetZoho", "group": null, - "weight": 663, + "weight": 612, "cookies": false, "type": "", "demo": "domains\/create-preset-zoho.md", @@ -18770,7 +18973,7 @@ "x-appwrite": { "method": "listRecords", "group": null, - "weight": 658, + "weight": 607, "cookies": false, "type": "", "demo": "domains\/list-records.md", @@ -18842,7 +19045,7 @@ "x-appwrite": { "method": "createRecordA", "group": null, - "weight": 636, + "weight": 585, "cookies": false, "type": "", "demo": "domains\/create-record-a.md", @@ -18941,7 +19144,7 @@ "x-appwrite": { "method": "updateRecordA", "group": null, - "weight": 637, + "weight": 586, "cookies": false, "type": "", "demo": "domains\/update-record-a.md", @@ -19048,7 +19251,7 @@ "x-appwrite": { "method": "createRecordAAAA", "group": null, - "weight": 638, + "weight": 587, "cookies": false, "type": "", "demo": "domains\/create-record-aaaa.md", @@ -19147,7 +19350,7 @@ "x-appwrite": { "method": "updateRecordAAAA", "group": null, - "weight": 639, + "weight": 588, "cookies": false, "type": "", "demo": "domains\/update-record-aaaa.md", @@ -19254,7 +19457,7 @@ "x-appwrite": { "method": "createRecordAlias", "group": null, - "weight": 640, + "weight": 589, "cookies": false, "type": "", "demo": "domains\/create-record-alias.md", @@ -19353,7 +19556,7 @@ "x-appwrite": { "method": "updateRecordAlias", "group": null, - "weight": 641, + "weight": 590, "cookies": false, "type": "", "demo": "domains\/update-record-alias.md", @@ -19460,7 +19663,7 @@ "x-appwrite": { "method": "createRecordCAA", "group": null, - "weight": 642, + "weight": 591, "cookies": false, "type": "", "demo": "domains\/create-record-caa.md", @@ -19559,7 +19762,7 @@ "x-appwrite": { "method": "updateRecordCAA", "group": null, - "weight": 643, + "weight": 592, "cookies": false, "type": "", "demo": "domains\/update-record-caa.md", @@ -19666,7 +19869,7 @@ "x-appwrite": { "method": "createRecordCNAME", "group": null, - "weight": 644, + "weight": 593, "cookies": false, "type": "", "demo": "domains\/create-record-cname.md", @@ -19765,7 +19968,7 @@ "x-appwrite": { "method": "updateRecordCNAME", "group": null, - "weight": 645, + "weight": 594, "cookies": false, "type": "", "demo": "domains\/update-record-cname.md", @@ -19872,7 +20075,7 @@ "x-appwrite": { "method": "createRecordHTTPS", "group": null, - "weight": 646, + "weight": 595, "cookies": false, "type": "", "demo": "domains\/create-record-https.md", @@ -19971,7 +20174,7 @@ "x-appwrite": { "method": "updateRecordHTTPS", "group": null, - "weight": 647, + "weight": 596, "cookies": false, "type": "", "demo": "domains\/update-record-https.md", @@ -20078,7 +20281,7 @@ "x-appwrite": { "method": "createRecordMX", "group": null, - "weight": 648, + "weight": 597, "cookies": false, "type": "", "demo": "domains\/create-record-mx.md", @@ -20185,7 +20388,7 @@ "x-appwrite": { "method": "updateRecordMX", "group": null, - "weight": 649, + "weight": 598, "cookies": false, "type": "", "demo": "domains\/update-record-mx.md", @@ -20300,7 +20503,7 @@ "x-appwrite": { "method": "createRecordNS", "group": null, - "weight": 650, + "weight": 599, "cookies": false, "type": "", "demo": "domains\/create-record-ns.md", @@ -20399,7 +20602,7 @@ "x-appwrite": { "method": "updateRecordNS", "group": null, - "weight": 651, + "weight": 600, "cookies": false, "type": "", "demo": "domains\/update-record-ns.md", @@ -20506,7 +20709,7 @@ "x-appwrite": { "method": "createRecordSRV", "group": null, - "weight": 652, + "weight": 601, "cookies": false, "type": "", "demo": "domains\/create-record-srv.md", @@ -20629,7 +20832,7 @@ "x-appwrite": { "method": "updateRecordSRV", "group": null, - "weight": 653, + "weight": 602, "cookies": false, "type": "", "demo": "domains\/update-record-srv.md", @@ -20760,7 +20963,7 @@ "x-appwrite": { "method": "createRecordTXT", "group": null, - "weight": 654, + "weight": 603, "cookies": false, "type": "", "demo": "domains\/create-record-txt.md", @@ -20858,7 +21061,7 @@ "x-appwrite": { "method": "updateRecordTXT", "group": null, - "weight": 655, + "weight": 604, "cookies": false, "type": "", "demo": "domains\/update-record-txt.md", @@ -20963,7 +21166,7 @@ "x-appwrite": { "method": "getRecord", "group": null, - "weight": 657, + "weight": 606, "cookies": false, "type": "", "demo": "domains\/get-record.md", @@ -21026,7 +21229,7 @@ "x-appwrite": { "method": "deleteRecord", "group": null, - "weight": 656, + "weight": 605, "cookies": false, "type": "", "demo": "domains\/delete-record.md", @@ -21094,7 +21297,7 @@ "x-appwrite": { "method": "updateTeam", "group": null, - "weight": 635, + "weight": 580, "cookies": false, "type": "", "demo": "domains\/update-team.md", @@ -21146,10 +21349,10 @@ ] } }, - "\/domains\/{domainId}\/zone": { + "\/domains\/{domainId}\/transfers\/status": { "get": { - "summary": "Retrieve the DNS zone file for the given domain.", - "operationId": "domainsGetZone", + "summary": "Get domain transfer status.", + "operationId": "domainsGetTransferStatus", "consumes": [], "produces": [ "application\/json" @@ -21157,23 +21360,23 @@ "tags": [ "domains" ], - "description": " Retrieve the DNS zone file for the given domain. This endpoint will return the DNS\n zone file in a standardized format that can be used to configure DNS servers.", + "description": " Get the transfer status for a domain.", "responses": { "200": { - "description": "File", + "description": "domainTransferStatus", "schema": { - "type": "file" + "$ref": "#\/definitions\/domainTransferStatus" } } }, "deprecated": false, "x-appwrite": { - "method": "getZone", + "method": "getTransferStatus", "group": null, - "weight": 631, + "weight": 584, "cookies": false, "type": "", - "demo": "domains\/get-zone.md", + "demo": "domains\/get-transfer-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -21202,40 +21405,98 @@ "in": "path" } ] - }, - "put": { - "summary": "Update the DNS zone for the given domain using the provided zone file content. All parsed records are imported and then the main domain document is returned.", - "operationId": "domainsUpdateZone", - "consumes": [ - "application\/json" - ], + } + }, + "\/domains\/{domainId}\/zone": { + "get": { + "summary": "Retrieve the DNS zone file for the given domain.", + "operationId": "domainsGetZone", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": "Update the DNS zone for the given domain using the provided zone file content.\nAll parsed records are imported and then the main domain document is returned.", + "description": " Retrieve the DNS zone file for the given domain. This endpoint will return the DNS\n zone file in a standardized format that can be used to configure DNS servers.", "responses": { - "201": { - "description": "Domain", + "200": { + "description": "File", "schema": { - "$ref": "#\/definitions\/domain" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "updateZone", + "method": "getZone", "group": null, - "weight": 634, + "weight": 576, "cookies": false, "type": "", - "demo": "domains\/update-zone.md", + "demo": "domains\/get-zone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "domains.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "type": "string", + "x-example": "<DOMAIN_ID>", + "in": "path" + } + ] + }, + "put": { + "summary": "Update the DNS zone for the given domain using the provided zone file content. All parsed records are imported and then the main domain document is returned.", + "operationId": "domainsUpdateZone", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "domains" + ], + "description": "Update the DNS zone for the given domain using the provided zone file content.\nAll parsed records are imported and then the main domain document is returned.", + "responses": { + "201": { + "description": "Domain", + "schema": { + "$ref": "#\/definitions\/domain" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateZone", + "group": null, + "weight": 579, + "cookies": false, + "type": "", + "demo": "domains\/update-zone.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "domains.write", "platforms": [ "console" ], @@ -21304,7 +21565,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 561, + "weight": 401, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -21386,7 +21647,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 558, + "weight": 556, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -21466,9 +21727,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -21523,7 +21781,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -21648,6 +21992,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -21692,11 +22038,24 @@ "default": "", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { "type": "string", - "description": "Runtime specification for the function and builds.", + "description": "Build specification for the function deployments.", "default": {}, "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the function executions.", + "default": {}, + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } }, "required": [ @@ -21733,7 +22092,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 563, + "weight": 403, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -21783,7 +22142,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 564, + "weight": 404, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -21833,7 +22192,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 587, + "weight": 427, "cookies": false, "type": "", "demo": "functions\/list-templates.md", @@ -21896,9 +22255,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -21953,7 +22309,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -22040,7 +22482,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 586, + "weight": 426, "cookies": false, "type": "", "demo": "functions\/get-template.md", @@ -22098,7 +22540,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 580, + "weight": 420, "cookies": false, "type": "", "demo": "functions\/list-usage.md", @@ -22168,7 +22610,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 559, + "weight": 399, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -22228,7 +22670,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 560, + "weight": 557, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -22310,9 +22752,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -22367,7 +22806,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -22492,6 +23017,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -22537,11 +23064,24 @@ "default": "", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Build specification for the function deployments.", + "default": {}, + "x-example": null + }, + "runtimeSpecification": { "type": "string", - "description": "Runtime specification for the function and builds.", + "description": "Runtime specification for the function executions.", "default": {}, "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } }, "required": [ @@ -22571,7 +23111,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 562, + "weight": 402, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -22633,7 +23173,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 567, + "weight": 407, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -22711,7 +23251,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 568, + "weight": 408, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -22801,7 +23341,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 565, + "weight": 405, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -22894,7 +23434,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 573, + "weight": 413, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -22980,7 +23520,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 570, + "weight": 410, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -23101,7 +23641,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 571, + "weight": 411, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -23198,7 +23738,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 566, + "weight": 406, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -23261,7 +23801,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 569, + "weight": 409, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -23329,7 +23869,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 572, + "weight": 412, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -23415,7 +23955,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 574, + "weight": 414, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -23483,7 +24023,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 577, + "weight": 417, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -23566,7 +24106,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 575, + "weight": 415, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -23685,7 +24225,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 576, + "weight": 416, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -23750,7 +24290,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 578, + "weight": 418, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -23818,7 +24358,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 579, + "weight": 419, "cookies": false, "type": "", "demo": "functions\/get-usage.md", @@ -23896,7 +24436,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 583, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -23956,7 +24496,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 581, + "weight": 558, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -24047,7 +24587,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 582, + "weight": 422, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -24115,7 +24655,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 584, + "weight": 424, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -24210,7 +24750,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 585, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -24280,7 +24820,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 176, + "weight": 154, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -24355,7 +24895,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 175, + "weight": 153, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -24428,7 +24968,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 450, + "weight": 428, "cookies": false, "type": "", "demo": "health\/get.md", @@ -24479,7 +25019,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 459, + "weight": 437, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -24530,7 +25070,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 453, + "weight": 431, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -24581,7 +25121,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 456, + "weight": 434, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -24617,6 +25157,77 @@ ] } }, + "\/health\/console-pausing": { + "get": { + "summary": "Get console pausing health", + "operationId": "healthGetConsolePausing", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "health" + ], + "description": "Get console pausing health status. Monitors projects approaching the pause threshold to detect potential issues with console access tracking.\n", + "responses": { + "200": { + "description": "Health Status", + "schema": { + "$ref": "#\/definitions\/healthStatus" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getConsolePausing", + "group": null, + "weight": 688, + "cookies": false, + "type": "", + "demo": "health\/get-console-pausing.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-console-pausing.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "threshold", + "description": "Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.", + "required": false, + "type": "integer", + "format": "int32", + "default": 10, + "in": "query" + }, + { + "name": "inactivityDays", + "description": "Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.", + "required": false, + "type": "integer", + "format": "int32", + "default": 7, + "in": "query" + } + ] + } + }, "\/health\/db": { "get": { "summary": "Get DB", @@ -24641,7 +25252,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 452, + "weight": 430, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -24692,7 +25303,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 454, + "weight": 432, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -24743,7 +25354,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 460, + "weight": 438, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -24805,7 +25416,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 734, + "weight": 684, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -24867,7 +25478,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 733, + "weight": 683, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -24929,7 +25540,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 464, + "weight": 442, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -24991,7 +25602,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 735, + "weight": 685, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -25053,7 +25664,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 463, + "weight": 441, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -25115,7 +25726,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 465, + "weight": 443, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -25186,7 +25797,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 466, + "weight": 444, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -25248,7 +25859,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 473, + "weight": 451, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -25335,7 +25946,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 470, + "weight": 448, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -25397,7 +26008,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 462, + "weight": 440, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -25459,7 +26070,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 467, + "weight": 445, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -25521,7 +26132,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 468, + "weight": 446, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -25583,7 +26194,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 469, + "weight": 447, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -25645,7 +26256,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 736, + "weight": 686, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -25707,7 +26318,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 471, + "weight": 449, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -25769,7 +26380,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 472, + "weight": 450, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -25831,7 +26442,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 737, + "weight": 687, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -25893,7 +26504,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 461, + "weight": 439, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -25955,7 +26566,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 458, + "weight": 436, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -26006,7 +26617,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 457, + "weight": 435, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -26057,7 +26668,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 455, + "weight": 433, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -26532,7 +27143,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 231, + "weight": 209, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -26617,7 +27228,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 228, + "weight": 206, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -26777,7 +27388,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 235, + "weight": 213, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -26944,7 +27555,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 230, + "weight": 208, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -27143,7 +27754,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 237, + "weight": 215, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -27357,7 +27968,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 229, + "weight": 207, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -27547,7 +28158,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 236, + "weight": 214, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -27736,7 +28347,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 234, + "weight": 212, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -27792,7 +28403,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 238, + "weight": 216, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -27853,7 +28464,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 232, + "weight": 210, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -27935,7 +28546,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 233, + "weight": 211, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -28017,7 +28628,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 202, + "weight": 180, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -28102,7 +28713,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 201, + "weight": 179, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -28291,7 +28902,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 215, + "weight": 193, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -28477,7 +29088,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 200, + "weight": 178, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -28635,7 +29246,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 214, + "weight": 192, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -28789,7 +29400,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 191, + "weight": 169, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -28921,7 +29532,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 205, + "weight": 183, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -29050,7 +29661,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 195, + "weight": 173, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -29155,7 +29766,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 209, + "weight": 187, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -29258,7 +29869,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 193, + "weight": 171, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -29377,7 +29988,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 207, + "weight": 185, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -29493,7 +30104,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 192, + "weight": 170, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -29612,7 +30223,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 206, + "weight": 184, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -29728,7 +30339,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 194, + "weight": 172, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -29978,7 +30589,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 208, + "weight": 186, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -30222,7 +30833,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 196, + "weight": 174, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -30328,7 +30939,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 210, + "weight": 188, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -30431,7 +31042,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 197, + "weight": 175, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -30537,7 +31148,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 211, + "weight": 189, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -30640,7 +31251,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 198, + "weight": 176, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -30746,7 +31357,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 212, + "weight": 190, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -30849,7 +31460,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 199, + "weight": 177, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -30955,7 +31566,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 213, + "weight": 191, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -31056,7 +31667,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 204, + "weight": 182, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -31112,7 +31723,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 216, + "weight": 194, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -31173,7 +31784,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 203, + "weight": 181, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -31255,7 +31866,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 225, + "weight": 203, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -31337,7 +31948,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 218, + "weight": 196, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -31420,7 +32031,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 217, + "weight": 195, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -31509,7 +32120,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 220, + "weight": 198, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -31570,7 +32181,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 221, + "weight": 199, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -31652,7 +32263,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 222, + "weight": 200, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -31713,7 +32324,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 219, + "weight": 197, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -31795,7 +32406,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 224, + "weight": 202, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -31831,7 +32442,7 @@ }, { "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: name, provider, type, enabled", + "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: targetId, topicId, userId, providerType", "required": false, "type": "array", "collectionFormat": "multi", @@ -31886,7 +32497,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 223, + "weight": 201, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -31974,7 +32585,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 226, + "weight": 204, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -32038,7 +32649,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 227, + "weight": 205, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -32109,7 +32720,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 183, + "weight": 161, "cookies": false, "type": "", "demo": "migrations\/list.md", @@ -32192,7 +32803,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 177, + "weight": 155, "cookies": false, "type": "", "demo": "migrations\/create-appwrite-migration.md", @@ -32246,11 +32857,15 @@ "function", "deployment", "environment-variable", + "provider", + "topic", + "subscriber", + "message", "site", "site-deployment", "site-variable" ], - "x-enum-name": null, + "x-enum-name": "AppwriteMigrationResource", "x-enum-keys": [] } }, @@ -32309,7 +32924,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 185, + "weight": 163, "cookies": false, "type": "", "demo": "migrations\/get-appwrite-report.md", @@ -32358,11 +32973,15 @@ "function", "deployment", "environment-variable", + "provider", + "topic", + "subscriber", + "message", "site", "site-deployment", "site-variable" ], - "x-enum-name": null, + "x-enum-name": "AppwriteMigrationResource", "x-enum-keys": [] }, "in": "query" @@ -32421,7 +33040,7 @@ "x-appwrite": { "method": "createCSVExport", "group": null, - "weight": 182, + "weight": 160, "cookies": false, "type": "", "demo": "migrations\/create-csv-export.md", @@ -32547,7 +33166,7 @@ "x-appwrite": { "method": "createCSVImport", "group": null, - "weight": 181, + "weight": 159, "cookies": false, "type": "", "demo": "migrations\/create-csv-import.md", @@ -32638,7 +33257,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 178, + "weight": 156, "cookies": false, "type": "", "demo": "migrations\/create-firebase-migration.md", @@ -32687,7 +33306,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "FirebaseMigrationResource", "x-enum-keys": [] } }, @@ -32731,7 +33350,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 186, + "weight": 164, "cookies": false, "type": "", "demo": "migrations\/get-firebase-report.md", @@ -32775,7 +33394,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "FirebaseMigrationResource", "x-enum-keys": [] }, "in": "query" @@ -32817,7 +33436,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 180, + "weight": 158, "cookies": false, "type": "", "demo": "migrations\/create-n-host-migration.md", @@ -32867,7 +33486,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "NHostMigrationResource", "x-enum-keys": [] } }, @@ -32953,7 +33572,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 188, + "weight": 166, "cookies": false, "type": "", "demo": "migrations\/get-n-host-report.md", @@ -32998,7 +33617,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "NHostMigrationResource", "x-enum-keys": [] }, "in": "query" @@ -33089,7 +33708,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 179, + "weight": 157, "cookies": false, "type": "", "demo": "migrations\/create-supabase-migration.md", @@ -33139,7 +33758,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "SupabaseMigrationResource", "x-enum-keys": [] } }, @@ -33219,7 +33838,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 187, + "weight": 165, "cookies": false, "type": "", "demo": "migrations\/get-supabase-report.md", @@ -33264,7 +33883,7 @@ "bucket", "file" ], - "x-enum-name": null, + "x-enum-name": "SupabaseMigrationResource", "x-enum-keys": [] }, "in": "query" @@ -33346,7 +33965,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 184, + "weight": 162, "cookies": false, "type": "", "demo": "migrations\/get.md", @@ -33405,7 +34024,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 189, + "weight": 167, "cookies": false, "type": "", "demo": "migrations\/retry.md", @@ -33459,7 +34078,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 190, + "weight": 168, "cookies": false, "type": "", "demo": "migrations\/delete.md", @@ -33518,7 +34137,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 692, + "weight": 642, "cookies": false, "type": "", "demo": "organizations\/list.md", @@ -33597,7 +34216,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 691, + "weight": 641, "cookies": false, "type": "", "demo": "organizations\/create.md", @@ -33739,7 +34358,7 @@ "x-appwrite": { "method": "estimationCreateOrganization", "group": null, - "weight": 725, + "weight": 675, "cookies": false, "type": "", "demo": "organizations\/estimation-create-organization.md", @@ -33842,7 +34461,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 693, + "weight": 643, "cookies": false, "type": "", "demo": "organizations\/delete.md", @@ -33901,7 +34520,7 @@ "x-appwrite": { "method": "listAggregations", "group": null, - "weight": 708, + "weight": 658, "cookies": false, "type": "", "demo": "organizations\/list-aggregations.md", @@ -33972,7 +34591,7 @@ "x-appwrite": { "method": "getAggregation", "group": null, - "weight": 709, + "weight": 659, "cookies": false, "type": "", "demo": "organizations\/get-aggregation.md", @@ -34060,7 +34679,7 @@ "x-appwrite": { "method": "setBillingAddress", "group": null, - "weight": 701, + "weight": 651, "cookies": false, "type": "", "demo": "organizations\/set-billing-address.md", @@ -34134,7 +34753,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 702, + "weight": 652, "cookies": false, "type": "", "demo": "organizations\/delete-billing-address.md", @@ -34193,7 +34812,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 700, + "weight": 650, "cookies": false, "type": "", "demo": "organizations\/get-billing-address.md", @@ -34262,7 +34881,7 @@ "x-appwrite": { "method": "setBillingEmail", "group": null, - "weight": 720, + "weight": 670, "cookies": false, "type": "", "demo": "organizations\/set-billing-email.md", @@ -34342,7 +34961,7 @@ "x-appwrite": { "method": "updateBudget", "group": null, - "weight": 697, + "weight": 647, "cookies": false, "type": "", "demo": "organizations\/update-budget.md", @@ -34432,7 +35051,7 @@ "x-appwrite": { "method": "listCredits", "group": null, - "weight": 712, + "weight": 662, "cookies": false, "type": "", "demo": "organizations\/list-credits.md", @@ -34503,7 +35122,7 @@ "x-appwrite": { "method": "addCredit", "group": null, - "weight": 713, + "weight": 663, "cookies": false, "type": "", "demo": "organizations\/add-credit.md", @@ -34580,7 +35199,7 @@ "x-appwrite": { "method": "getAvailableCredits", "group": null, - "weight": 711, + "weight": 661, "cookies": false, "type": "", "demo": "organizations\/get-available-credits.md", @@ -34639,7 +35258,7 @@ "x-appwrite": { "method": "getCredit", "group": null, - "weight": 710, + "weight": 660, "cookies": false, "type": "", "demo": "organizations\/get-credit.md", @@ -34708,7 +35327,7 @@ "x-appwrite": { "method": "estimationDeleteOrganization", "group": null, - "weight": 726, + "weight": 676, "cookies": false, "type": "", "demo": "organizations\/estimation-delete-organization.md", @@ -34769,7 +35388,7 @@ "x-appwrite": { "method": "estimationUpdatePlan", "group": null, - "weight": 724, + "weight": 674, "cookies": false, "type": "", "demo": "organizations\/estimation-update-plan.md", @@ -34864,7 +35483,7 @@ "x-appwrite": { "method": "createDowngradeFeedback", "group": null, - "weight": 727, + "weight": 677, "cookies": false, "type": "", "demo": "organizations\/create-downgrade-feedback.md", @@ -34962,7 +35581,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 715, + "weight": 665, "cookies": false, "type": "", "demo": "organizations\/list-invoices.md", @@ -34996,7 +35615,7 @@ }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, type, amount, currency, from, to, dueAt, attempts, status, grossAmount", "required": false, "type": "array", "collectionFormat": "multi", @@ -35033,7 +35652,7 @@ "x-appwrite": { "method": "getInvoice", "group": null, - "weight": 714, + "weight": 664, "cookies": false, "type": "", "demo": "organizations\/get-invoice.md", @@ -35100,7 +35719,7 @@ "x-appwrite": { "method": "getInvoiceDownload", "group": null, - "weight": 718, + "weight": 668, "cookies": false, "type": "", "demo": "organizations\/get-invoice-download.md", @@ -35169,7 +35788,7 @@ "x-appwrite": { "method": "createInvoicePayment", "group": null, - "weight": 719, + "weight": 669, "cookies": false, "type": "", "demo": "organizations\/create-invoice-payment.md", @@ -35256,7 +35875,7 @@ "x-appwrite": { "method": "validateInvoice", "group": null, - "weight": 716, + "weight": 666, "cookies": false, "type": "", "demo": "organizations\/validate-invoice.md", @@ -35323,7 +35942,7 @@ "x-appwrite": { "method": "getInvoiceView", "group": null, - "weight": 717, + "weight": 667, "cookies": false, "type": "", "demo": "organizations\/get-invoice-view.md", @@ -35390,7 +36009,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 730, + "weight": 680, "cookies": false, "type": "", "demo": "organizations\/list-keys.md", @@ -35457,7 +36076,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 728, + "weight": 678, "cookies": false, "type": "", "demo": "organizations\/create-key.md", @@ -35566,7 +36185,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 732, + "weight": 682, "cookies": false, "type": "", "demo": "organizations\/get-key.md", @@ -35632,7 +36251,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 729, + "weight": 679, "cookies": false, "type": "", "demo": "organizations\/update-key.md", @@ -35746,7 +36365,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 731, + "weight": 681, "cookies": false, "type": "", "demo": "organizations\/delete-key.md", @@ -35814,7 +36433,7 @@ "x-appwrite": { "method": "setDefaultPaymentMethod", "group": null, - "weight": 704, + "weight": 654, "cookies": false, "type": "", "demo": "organizations\/set-default-payment-method.md", @@ -35891,7 +36510,7 @@ "x-appwrite": { "method": "deleteDefaultPaymentMethod", "group": null, - "weight": 706, + "weight": 656, "cookies": false, "type": "", "demo": "organizations\/delete-default-payment-method.md", @@ -35952,7 +36571,7 @@ "x-appwrite": { "method": "setBackupPaymentMethod", "group": null, - "weight": 705, + "weight": 655, "cookies": false, "type": "", "demo": "organizations\/set-backup-payment-method.md", @@ -36029,7 +36648,7 @@ "x-appwrite": { "method": "deleteBackupPaymentMethod", "group": null, - "weight": 707, + "weight": 657, "cookies": false, "type": "", "demo": "organizations\/delete-backup-payment-method.md", @@ -36088,7 +36707,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 703, + "weight": 653, "cookies": false, "type": "", "demo": "organizations\/get-payment-method.md", @@ -36155,7 +36774,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 694, + "weight": 644, "cookies": false, "type": "", "demo": "organizations\/get-plan.md", @@ -36214,7 +36833,7 @@ "x-appwrite": { "method": "updatePlan", "group": null, - "weight": 695, + "weight": 645, "cookies": false, "type": "", "demo": "organizations\/update-plan.md", @@ -36337,7 +36956,7 @@ "x-appwrite": { "method": "cancelDowngrade", "group": null, - "weight": 696, + "weight": 646, "cookies": false, "type": "", "demo": "organizations\/cancel-downgrade.md", @@ -36396,7 +37015,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 723, + "weight": 673, "cookies": false, "type": "", "demo": "organizations\/list-regions.md", @@ -36455,7 +37074,7 @@ "x-appwrite": { "method": "getScopes", "group": null, - "weight": 722, + "weight": 672, "cookies": false, "type": "", "demo": "organizations\/get-scopes.md", @@ -36525,7 +37144,7 @@ "x-appwrite": { "method": "setBillingTaxId", "group": null, - "weight": 698, + "weight": 648, "cookies": false, "type": "", "demo": "organizations\/set-billing-tax-id.md", @@ -36602,7 +37221,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 699, + "weight": 649, "cookies": false, "type": "", "demo": "organizations\/get-usage.md", @@ -36677,7 +37296,7 @@ "x-appwrite": { "method": "validatePayment", "group": null, - "weight": 721, + "weight": 671, "cookies": false, "type": "", "demo": "organizations\/validate-payment.md", @@ -36754,7 +37373,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 556, + "weight": 555, "cookies": false, "type": "", "demo": "project\/get-usage.md", @@ -36837,7 +37456,7 @@ "x-appwrite": { "method": "listVariables", "group": null, - "weight": 102, + "weight": 96, "cookies": false, "type": "", "demo": "project\/list-variables.md", @@ -36886,7 +37505,7 @@ "x-appwrite": { "method": "createVariable", "group": null, - "weight": 101, + "weight": 95, "cookies": false, "type": "", "demo": "project\/create-variable.md", @@ -36968,7 +37587,7 @@ "x-appwrite": { "method": "getVariable", "group": null, - "weight": 103, + "weight": 97, "cookies": false, "type": "", "demo": "project\/get-variable.md", @@ -37027,7 +37646,7 @@ "x-appwrite": { "method": "updateVariable", "group": null, - "weight": 104, + "weight": 98, "cookies": false, "type": "", "demo": "project\/update-variable.md", @@ -37113,7 +37732,7 @@ "x-appwrite": { "method": "deleteVariable", "group": null, - "weight": 105, + "weight": 99, "cookies": false, "type": "", "demo": "project\/delete-variable.md", @@ -37172,7 +37791,7 @@ "x-appwrite": { "method": "list", "group": "projects", - "weight": 777, + "weight": 730, "cookies": false, "type": "", "demo": "projects\/list.md", @@ -37252,7 +37871,7 @@ "x-appwrite": { "method": "create", "group": "projects", - "weight": 775, + "weight": 728, "cookies": false, "type": "", "demo": "projects\/create.md", @@ -37465,7 +38084,7 @@ "x-appwrite": { "method": "update", "group": "projects", - "weight": 776, + "weight": 729, "cookies": false, "type": "", "demo": "projects\/update.md", @@ -38681,7 +39300,7 @@ "x-appwrite": { "method": "updateSessionInvalidation", "group": "auth", - "weight": 99, + "weight": 93, "cookies": false, "type": "", "demo": "projects\/update-session-invalidation.md", @@ -38832,6 +39451,64 @@ ] } }, + "\/projects\/{projectId}\/console-access": { + "patch": { + "summary": "Record console access to a project", + "operationId": "projectsUpdateConsoleAccess", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.\n", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateConsoleAccess", + "group": null, + "weight": 725, + "cookies": false, + "type": "", + "demo": "projects\/update-console-access.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-console-access.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project ID", + "required": true, + "type": "string", + "x-example": "<PROJECT_ID>", + "in": "path" + } + ] + } + }, "\/projects\/{projectId}\/dev-keys": { "get": { "summary": "List dev keys", @@ -38856,7 +39533,7 @@ "x-appwrite": { "method": "listDevKeys", "group": "devKeys", - "weight": 410, + "weight": 388, "cookies": false, "type": "", "demo": "projects\/list-dev-keys.md", @@ -38926,7 +39603,7 @@ "x-appwrite": { "method": "createDevKey", "group": "devKeys", - "weight": 407, + "weight": 385, "cookies": false, "type": "", "demo": "projects\/create-dev-key.md", @@ -39009,7 +39686,7 @@ "x-appwrite": { "method": "getDevKey", "group": "devKeys", - "weight": 409, + "weight": 387, "cookies": false, "type": "", "demo": "projects\/get-dev-key.md", @@ -39075,7 +39752,7 @@ "x-appwrite": { "method": "updateDevKey", "group": "devKeys", - "weight": 408, + "weight": 386, "cookies": false, "type": "", "demo": "projects\/update-dev-key.md", @@ -39161,7 +39838,7 @@ "x-appwrite": { "method": "deleteDevKey", "group": "devKeys", - "weight": 411, + "weight": 389, "cookies": false, "type": "", "demo": "projects\/delete-dev-key.md", @@ -39229,7 +39906,7 @@ "x-appwrite": { "method": "createJWT", "group": "auth", - "weight": 85, + "weight": 79, "cookies": false, "type": "", "demo": "projects\/create-jwt.md", @@ -39332,6 +40009,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -39386,7 +40065,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 81, + "weight": 75, "cookies": false, "type": "", "demo": "projects\/list-keys.md", @@ -39466,7 +40145,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 80, + "weight": 74, "cookies": false, "type": "", "demo": "projects\/create-key.md", @@ -39582,6 +40261,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -39637,7 +40318,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 82, + "weight": 76, "cookies": false, "type": "", "demo": "projects\/get-key.md", @@ -39704,7 +40385,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 83, + "weight": 77, "cookies": false, "type": "", "demo": "projects\/update-key.md", @@ -39822,6 +40503,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -39872,7 +40555,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 84, + "weight": 78, "cookies": false, "type": "", "demo": "projects\/delete-key.md", @@ -39941,7 +40624,7 @@ "x-appwrite": { "method": "updateLabels", "group": "projects", - "weight": 415, + "weight": 393, "cookies": false, "type": "", "demo": "projects\/update-labels.md", @@ -40163,7 +40846,7 @@ "x-appwrite": { "method": "listPlatforms", "group": "platforms", - "weight": 87, + "weight": 81, "cookies": false, "type": "", "demo": "projects\/list-platforms.md", @@ -40231,7 +40914,7 @@ "x-appwrite": { "method": "createPlatform", "group": "platforms", - "weight": 86, + "weight": 80, "cookies": false, "type": "", "demo": "projects\/create-platform.md", @@ -40352,7 +41035,7 @@ "x-appwrite": { "method": "getPlatform", "group": "platforms", - "weight": 88, + "weight": 82, "cookies": false, "type": "", "demo": "projects\/get-platform.md", @@ -40419,7 +41102,7 @@ "x-appwrite": { "method": "updatePlatform", "group": "platforms", - "weight": 89, + "weight": 83, "cookies": false, "type": "", "demo": "projects\/update-platform.md", @@ -40517,7 +41200,7 @@ "x-appwrite": { "method": "deletePlatform", "group": "platforms", - "weight": 90, + "weight": 84, "cookies": false, "type": "", "demo": "projects\/delete-platform.md", @@ -40584,7 +41267,7 @@ "x-appwrite": { "method": "listSchedules", "group": "schedules", - "weight": 419, + "weight": 397, "cookies": false, "type": "", "demo": "projects\/list-schedules.md", @@ -40664,7 +41347,7 @@ "x-appwrite": { "method": "createSchedule", "group": "schedules", - "weight": 778, + "weight": 731, "cookies": false, "type": "", "demo": "projects\/create-schedule.md", @@ -40775,7 +41458,7 @@ "x-appwrite": { "method": "getSchedule", "group": "schedules", - "weight": 418, + "weight": 396, "cookies": false, "type": "", "demo": "projects\/get-schedule.md", @@ -41026,7 +41709,7 @@ "x-appwrite": { "method": "updateSmtp", "group": "templates", - "weight": 91, + "weight": 85, "cookies": false, "type": "", "demo": "projects\/update-smtp.md", @@ -41235,7 +41918,7 @@ "x-appwrite": { "method": "createSmtpTest", "group": "templates", - "weight": 92, + "weight": 86, "cookies": false, "type": "", "demo": "projects\/create-smtp-test.md", @@ -41431,10 +42114,10 @@ ] } }, - "\/projects\/{projectId}\/team": { + "\/projects\/{projectId}\/status": { "patch": { - "summary": "Update project team", - "operationId": "projectsUpdateTeam", + "summary": "Update the status of a project", + "operationId": "projectsUpdateStatus", "consumes": [ "application\/json" ], @@ -41444,33 +42127,30 @@ "tags": [ "projects" ], - "description": "Update the team ID of a project allowing for it to be transferred to another team.", + "description": "Update the status of a project. Can be used to archive\/restore projects, and to restore paused projects. When restoring a paused project, the console fingerprint header must be provided and the project must not be blocked for any reason other than inactivity.\n", "responses": { - "200": { - "description": "Project", - "schema": { - "$ref": "#\/definitions\/project" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateTeam", - "group": "projects", - "weight": 774, + "method": "updateStatus", + "group": null, + "weight": 726, "cookies": false, "type": "", - "demo": "projects\/update-team.md", - "rate-limit": 0, + "demo": "projects\/update-status.md", + "rate-limit": 10, "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", + "rate-key": "ip:{ip},userId:{userId}", "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-status.md", "auth": { "Project": [] } @@ -41483,7 +42163,7 @@ "parameters": [ { "name": "projectId", - "description": "Project unique ID.", + "description": "Project ID", "required": true, "type": "string", "x-example": "<PROJECT_ID>", @@ -41495,49 +42175,56 @@ "schema": { "type": "object", "properties": { - "teamId": { + "status": { "type": "string", - "description": "Team ID of the team to transfer project to.", + "description": "New status for the project", "default": null, - "x-example": "<TEAM_ID>" + "x-example": "active", + "enum": [ + "active" + ], + "x-enum-name": null, + "x-enum-keys": [] } }, "required": [ - "teamId" + "status" ] } } ] } }, - "\/projects\/{projectId}\/templates\/email\/{type}\/{locale}": { - "get": { - "summary": "Get custom email template", - "operationId": "projectsGetEmailTemplate", - "consumes": [], + "\/projects\/{projectId}\/team": { + "patch": { + "summary": "Update project team", + "operationId": "projectsUpdateTeam", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "projects" ], - "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details. ", + "description": "Update the team ID of a project allowing for it to be transferred to another team.", "responses": { "200": { - "description": "EmailTemplate", + "description": "Project", "schema": { - "$ref": "#\/definitions\/emailTemplate" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "getEmailTemplate", - "group": "templates", - "weight": 94, + "method": "updateTeam", + "group": "projects", + "weight": 727, "cookies": false, "type": "", - "demo": "projects\/get-email-template.md", + "demo": "projects\/update-team.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -41547,7 +42234,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-email-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-team.md", "auth": { "Project": [] } @@ -41567,182 +42254,38 @@ "in": "path" }, { - "name": "type", - "description": "Template type", - "required": true, - "type": "string", - "x-example": "verification", - "enum": [ - "verification", - "magicSession", - "recovery", - "invitation", - "mfaChallenge", - "sessionAlert", - "otpSession" - ], - "x-enum-name": "EmailTemplateType", - "x-enum-keys": [], - "in": "path" - }, - { - "name": "locale", - "description": "Template locale", - "required": true, - "type": "string", - "x-example": "af", - "enum": [ - "af", - "ar-ae", - "ar-bh", - "ar-dz", - "ar-eg", - "ar-iq", - "ar-jo", - "ar-kw", - "ar-lb", - "ar-ly", - "ar-ma", - "ar-om", - "ar-qa", - "ar-sa", - "ar-sy", - "ar-tn", - "ar-ye", - "as", - "az", - "be", - "bg", - "bh", - "bn", - "bs", - "ca", - "cs", - "cy", - "da", - "de", - "de-at", - "de-ch", - "de-li", - "de-lu", - "el", - "en", - "en-au", - "en-bz", - "en-ca", - "en-gb", - "en-ie", - "en-jm", - "en-nz", - "en-tt", - "en-us", - "en-za", - "eo", - "es", - "es-ar", - "es-bo", - "es-cl", - "es-co", - "es-cr", - "es-do", - "es-ec", - "es-gt", - "es-hn", - "es-mx", - "es-ni", - "es-pa", - "es-pe", - "es-pr", - "es-py", - "es-sv", - "es-uy", - "es-ve", - "et", - "eu", - "fa", - "fi", - "fo", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "fr-lu", - "ga", - "gd", - "he", - "hi", - "hr", - "hu", - "id", - "is", - "it", - "it-ch", - "ja", - "ji", - "ko", - "ku", - "lt", - "lv", - "mk", - "ml", - "ms", - "mt", - "nb", - "ne", - "nl", - "nl-be", - "nn", - "no", - "pa", - "pl", - "pt", - "pt-br", - "rm", - "ro", - "ro-md", - "ru", - "ru-md", - "sb", - "sk", - "sl", - "sq", - "sr", - "sv", - "sv-fi", - "th", - "tn", - "tr", - "ts", - "ua", - "ur", - "ve", - "vi", - "xh", - "zh-cn", - "zh-hk", - "zh-sg", - "zh-tw", - "zu" - ], - "x-enum-name": "EmailTemplateLocale", - "x-enum-keys": [], - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team ID of the team to transfer project to.", + "default": null, + "x-example": "<TEAM_ID>" + } + }, + "required": [ + "teamId" + ] + } } ] - }, - "patch": { - "summary": "Update custom email templates", - "operationId": "projectsUpdateEmailTemplate", - "consumes": [ - "application\/json" - ], + } + }, + "\/projects\/{projectId}\/templates\/email\/{type}\/{locale}": { + "get": { + "summary": "Get custom email template", + "operationId": "projectsGetEmailTemplate", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "projects" ], - "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", + "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details. ", "responses": { "200": { "description": "EmailTemplate", @@ -41753,12 +42296,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEmailTemplate", + "method": "getEmailTemplate", "group": "templates", - "weight": 96, + "weight": 88, "cookies": false, "type": "", - "demo": "projects\/update-email-template.md", + "demo": "projects\/get-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -41768,7 +42311,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-email-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-email-template.md", "auth": { "Project": [] } @@ -41948,57 +42491,12 @@ "x-enum-name": "EmailTemplateLocale", "x-enum-keys": [], "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "subject": { - "type": "string", - "description": "Email Subject", - "default": null, - "x-example": "<SUBJECT>" - }, - "message": { - "type": "string", - "description": "Template message", - "default": null, - "x-example": "<MESSAGE>" - }, - "senderName": { - "type": "string", - "description": "Name of the email sender", - "default": "", - "x-example": "<SENDER_NAME>" - }, - "senderEmail": { - "type": "string", - "description": "Email of the sender", - "default": "", - "x-example": "email@example.com", - "format": "email" - }, - "replyTo": { - "type": "string", - "description": "Reply to email", - "default": "", - "x-example": "email@example.com", - "format": "email" - } - }, - "required": [ - "subject", - "message" - ] - } } ] }, - "delete": { - "summary": "Delete custom email template", - "operationId": "projectsDeleteEmailTemplate", + "patch": { + "summary": "Update custom email templates", + "operationId": "projectsUpdateEmailTemplate", "consumes": [ "application\/json" ], @@ -42008,7 +42506,7 @@ "tags": [ "projects" ], - "description": "Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state. ", + "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", "responses": { "200": { "description": "EmailTemplate", @@ -42019,12 +42517,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteEmailTemplate", + "method": "updateEmailTemplate", "group": "templates", - "weight": 98, + "weight": 90, "cookies": false, "type": "", - "demo": "projects\/delete-email-template.md", + "demo": "projects\/update-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42034,7 +42532,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-email-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-email-template.md", "auth": { "Project": [] } @@ -42214,38 +42712,83 @@ "x-enum-name": "EmailTemplateLocale", "x-enum-keys": [], "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "subject": { + "type": "string", + "description": "Email Subject", + "default": null, + "x-example": "<SUBJECT>" + }, + "message": { + "type": "string", + "description": "Template message", + "default": null, + "x-example": "<MESSAGE>" + }, + "senderName": { + "type": "string", + "description": "Name of the email sender", + "default": "", + "x-example": "<SENDER_NAME>" + }, + "senderEmail": { + "type": "string", + "description": "Email of the sender", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "replyTo": { + "type": "string", + "description": "Reply to email", + "default": "", + "x-example": "email@example.com", + "format": "email" + } + }, + "required": [ + "subject", + "message" + ] + } } ] - } - }, - "\/projects\/{projectId}\/templates\/sms\/{type}\/{locale}": { - "get": { - "summary": "Get custom SMS template", - "operationId": "projectsGetSmsTemplate", - "consumes": [], + }, + "delete": { + "summary": "Delete custom email template", + "operationId": "projectsDeleteEmailTemplate", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "projects" ], - "description": "Get a custom SMS template for the specified locale and type returning it's contents.", + "description": "Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state. ", "responses": { "200": { - "description": "SmsTemplate", + "description": "EmailTemplate", "schema": { - "$ref": "#\/definitions\/smsTemplate" + "$ref": "#\/definitions\/emailTemplate" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getSmsTemplate", + "method": "deleteEmailTemplate", "group": "templates", - "weight": 93, + "weight": 92, "cookies": false, "type": "", - "demo": "projects\/get-sms-template.md", + "demo": "projects\/delete-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42254,72 +42797,8 @@ "console" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-sms-template.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.getSMSTemplate" - }, - "methods": [ - { - "name": "getSmsTemplate", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "projectId", - "type", - "locale" - ], - "required": [ - "projectId", - "type", - "locale" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/smsTemplate" - } - ], - "description": "Get a custom SMS template for the specified locale and type returning it's contents.", - "demo": "projects\/get-sms-template.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.getSMSTemplate" - } - }, - { - "name": "getSMSTemplate", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "projectId", - "type", - "locale" - ], - "required": [ - "projectId", - "type", - "locale" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/smsTemplate" - } - ], - "description": "Get a custom SMS template for the specified locale and type returning it's contents.", - "demo": "projects\/get-sms-template.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-email-template.md", "auth": { "Project": [] } @@ -42346,11 +42825,14 @@ "x-example": "verification", "enum": [ "verification", - "login", + "magicSession", + "recovery", "invitation", - "mfaChallenge" + "mfaChallenge", + "sessionAlert", + "otpSession" ], - "x-enum-name": "SmsTemplateType", + "x-enum-name": "EmailTemplateType", "x-enum-keys": [], "in": "path" }, @@ -42493,25 +42975,25 @@ "zh-tw", "zu" ], - "x-enum-name": "SmsTemplateLocale", + "x-enum-name": "EmailTemplateLocale", "x-enum-keys": [], "in": "path" } ] - }, - "patch": { - "summary": "Update custom SMS template", - "operationId": "projectsUpdateSmsTemplate", - "consumes": [ - "application\/json" - ], + } + }, + "\/projects\/{projectId}\/templates\/sms\/{type}\/{locale}": { + "get": { + "summary": "Get custom SMS template", + "operationId": "projectsGetSmsTemplate", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "projects" ], - "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", + "description": "Get a custom SMS template for the specified locale and type returning it's contents.", "responses": { "200": { "description": "SmsTemplate", @@ -42522,12 +43004,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateSmsTemplate", + "method": "getSmsTemplate", "group": "templates", - "weight": 95, + "weight": 87, "cookies": false, "type": "", - "demo": "projects\/update-sms-template.md", + "demo": "projects\/get-sms-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42537,14 +43019,14 @@ ], "packaging": false, "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-sms-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-sms-template.md", "deprecated": { "since": "1.8.0", - "replaceWith": "projects.updateSMSTemplate" + "replaceWith": "projects.getSMSTemplate" }, "methods": [ { - "name": "updateSmsTemplate", + "name": "getSmsTemplate", "namespace": "projects", "desc": "", "auth": { @@ -42553,14 +43035,12 @@ "parameters": [ "projectId", "type", - "locale", - "message" + "locale" ], "required": [ "projectId", "type", - "locale", - "message" + "locale" ], "responses": [ { @@ -42568,16 +43048,16 @@ "model": "#\/definitions\/smsTemplate" } ], - "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", - "demo": "projects\/update-sms-template.md", + "description": "Get a custom SMS template for the specified locale and type returning it's contents.", + "demo": "projects\/get-sms-template.md", "public": false, "deprecated": { "since": "1.8.0", - "replaceWith": "projects.updateSMSTemplate" + "replaceWith": "projects.getSMSTemplate" } }, { - "name": "updateSMSTemplate", + "name": "getSMSTemplate", "namespace": "projects", "desc": "", "auth": { @@ -42586,14 +43066,12 @@ "parameters": [ "projectId", "type", - "locale", - "message" + "locale" ], "required": [ "projectId", "type", - "locale", - "message" + "locale" ], "responses": [ { @@ -42601,8 +43079,8 @@ "model": "#\/definitions\/smsTemplate" } ], - "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", - "demo": "projects\/update-sms-template.md", + "description": "Get a custom SMS template for the specified locale and type returning it's contents.", + "demo": "projects\/get-sms-template.md", "public": true } ], @@ -42782,30 +43260,12 @@ "x-enum-name": "SmsTemplateLocale", "x-enum-keys": [], "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Template message", - "default": null, - "x-example": "<MESSAGE>" - } - }, - "required": [ - "message" - ] - } } ] }, - "delete": { - "summary": "Reset custom SMS template", - "operationId": "projectsDeleteSmsTemplate", + "patch": { + "summary": "Update custom SMS template", + "operationId": "projectsUpdateSmsTemplate", "consumes": [ "application\/json" ], @@ -42815,7 +43275,7 @@ "tags": [ "projects" ], - "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", + "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", "responses": { "200": { "description": "SmsTemplate", @@ -42826,12 +43286,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "deleteSmsTemplate", + "method": "updateSmsTemplate", "group": "templates", - "weight": 97, + "weight": 89, "cookies": false, "type": "", - "demo": "projects\/delete-sms-template.md", + "demo": "projects\/update-sms-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42841,14 +43301,14 @@ ], "packaging": false, "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-sms-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-sms-template.md", "deprecated": { "since": "1.8.0", - "replaceWith": "projects.deleteSMSTemplate" + "replaceWith": "projects.updateSMSTemplate" }, "methods": [ { - "name": "deleteSmsTemplate", + "name": "updateSmsTemplate", "namespace": "projects", "desc": "", "auth": { @@ -42857,12 +43317,14 @@ "parameters": [ "projectId", "type", - "locale" + "locale", + "message" ], "required": [ "projectId", "type", - "locale" + "locale", + "message" ], "responses": [ { @@ -42870,16 +43332,16 @@ "model": "#\/definitions\/smsTemplate" } ], - "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", - "demo": "projects\/delete-sms-template.md", + "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", + "demo": "projects\/update-sms-template.md", "public": false, "deprecated": { "since": "1.8.0", - "replaceWith": "projects.deleteSMSTemplate" + "replaceWith": "projects.updateSMSTemplate" } }, { - "name": "deleteSMSTemplate", + "name": "updateSMSTemplate", "namespace": "projects", "desc": "", "auth": { @@ -42888,12 +43350,14 @@ "parameters": [ "projectId", "type", - "locale" + "locale", + "message" ], "required": [ "projectId", "type", - "locale" + "locale", + "message" ], "responses": [ { @@ -42901,8 +43365,8 @@ "model": "#\/definitions\/smsTemplate" } ], - "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", - "demo": "projects\/delete-sms-template.md", + "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ", + "demo": "projects\/update-sms-template.md", "public": true } ], @@ -43082,133 +43546,6 @@ "x-enum-name": "SmsTemplateLocale", "x-enum-keys": [], "in": "path" - } - ] - } - }, - "\/projects\/{projectId}\/webhooks": { - "get": { - "summary": "List webhooks", - "operationId": "projectsListWebhooks", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "projects" - ], - "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results. ", - "responses": { - "200": { - "description": "Webhooks List", - "schema": { - "$ref": "#\/definitions\/webhookList" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listWebhooks", - "group": "webhooks", - "weight": 75, - "cookies": false, - "type": "", - "demo": "projects\/list-webhooks.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-webhooks.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "<PROJECT_ID>", - "in": "path" - }, - { - "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 webhook", - "operationId": "projectsCreateWebhook", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "projects" - ], - "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur. ", - "responses": { - "201": { - "description": "Webhook", - "schema": { - "$ref": "#\/definitions\/webhook" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createWebhook", - "group": "webhooks", - "weight": 74, - "cookies": false, - "type": "", - "demo": "projects\/create-webhook.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-webhook.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "<PROJECT_ID>", - "in": "path" }, { "name": "payload", @@ -43216,132 +43553,23 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Webhook name. Max length: 128 chars.", - "default": null, - "x-example": "<NAME>" - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "default": true, - "x-example": false - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "url": { + "message": { "type": "string", - "description": "Webhook URL.", - "default": null, - "x-example": null - }, - "security": { - "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", + "description": "Template message", "default": null, - "x-example": false - }, - "httpUser": { - "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "default": "", - "x-example": "<HTTP_USER>" - }, - "httpPass": { - "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "default": "", - "x-example": "<HTTP_PASS>" + "x-example": "<MESSAGE>" } }, "required": [ - "name", - "events", - "url", - "security" + "message" ] } } ] - } - }, - "\/projects\/{projectId}\/webhooks\/{webhookId}": { - "get": { - "summary": "Get webhook", - "operationId": "projectsGetWebhook", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "projects" - ], - "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", - "responses": { - "200": { - "description": "Webhook", - "schema": { - "$ref": "#\/definitions\/webhook" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getWebhook", - "group": "webhooks", - "weight": 76, - "cookies": false, - "type": "", - "demo": "projects\/get-webhook.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-webhook.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "<PROJECT_ID>", - "in": "path" - }, - { - "name": "webhookId", - "description": "Webhook unique ID.", - "required": true, - "type": "string", - "x-example": "<WEBHOOK_ID>", - "in": "path" - } - ] }, - "put": { - "summary": "Update webhook", - "operationId": "projectsUpdateWebhook", + "delete": { + "summary": "Reset custom SMS template", + "operationId": "projectsDeleteSmsTemplate", "consumes": [ "application\/json" ], @@ -43351,23 +43579,23 @@ "tags": [ "projects" ], - "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook. ", + "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", "responses": { "200": { - "description": "Webhook", + "description": "SmsTemplate", "schema": { - "$ref": "#\/definitions\/webhook" + "$ref": "#\/definitions\/smsTemplate" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateWebhook", - "group": "webhooks", - "weight": 77, + "method": "deleteSmsTemplate", + "group": "templates", + "weight": 91, "cookies": false, "type": "", - "demo": "projects\/update-webhook.md", + "demo": "projects\/delete-sms-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -43376,130 +43604,72 @@ "console" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-webhook.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "<PROJECT_ID>", - "in": "path" - }, - { - "name": "webhookId", - "description": "Webhook unique ID.", - "required": true, - "type": "string", - "x-example": "<WEBHOOK_ID>", - "in": "path" + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-sms-template.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.deleteSMSTemplate" }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Webhook name. Max length: 128 chars.", - "default": null, - "x-example": "<NAME>" - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "default": true, - "x-example": false - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "url": { - "type": "string", - "description": "Webhook URL.", - "default": null, - "x-example": null - }, - "security": { - "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", - "default": null, - "x-example": false - }, - "httpUser": { - "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "default": "", - "x-example": "<HTTP_USER>" - }, - "httpPass": { - "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "default": "", - "x-example": "<HTTP_PASS>" + "methods": [ + { + "name": "deleteSmsTemplate", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "projectId", + "type", + "locale" + ], + "required": [ + "projectId", + "type", + "locale" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/smsTemplate" } + ], + "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", + "demo": "projects\/delete-sms-template.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.deleteSMSTemplate" + } + }, + { + "name": "deleteSMSTemplate", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] }, + "parameters": [ + "projectId", + "type", + "locale" + ], "required": [ - "name", - "events", - "url", - "security" - ] + "projectId", + "type", + "locale" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/smsTemplate" + } + ], + "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ", + "demo": "projects\/delete-sms-template.md", + "public": true } - } - ] - }, - "delete": { - "summary": "Delete webhook", - "operationId": "projectsDeleteWebhook", - "consumes": [ - "application\/json" - ], - "produces": [], - "tags": [ - "projects" - ], - "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteWebhook", - "group": "webhooks", - "weight": 79, - "cookies": false, - "type": "", - "demo": "projects\/delete-webhook.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", - "platforms": [ - "console" ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-webhook.md", "auth": { "Project": [] } @@ -43519,80 +43689,162 @@ "in": "path" }, { - "name": "webhookId", - "description": "Webhook unique ID.", - "required": true, - "type": "string", - "x-example": "<WEBHOOK_ID>", - "in": "path" - } - ] - } - }, - "\/projects\/{projectId}\/webhooks\/{webhookId}\/signature": { - "patch": { - "summary": "Update webhook signature key", - "operationId": "projectsUpdateWebhookSignature", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "projects" - ], - "description": "Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook. ", - "responses": { - "200": { - "description": "Webhook", - "schema": { - "$ref": "#\/definitions\/webhook" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateWebhookSignature", - "group": "webhooks", - "weight": 78, - "cookies": false, - "type": "", - "demo": "projects\/update-webhook-signature.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-webhook-signature.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", + "name": "type", + "description": "Template type", "required": true, "type": "string", - "x-example": "<PROJECT_ID>", + "x-example": "verification", + "enum": [ + "verification", + "login", + "invitation", + "mfaChallenge" + ], + "x-enum-name": "SmsTemplateType", + "x-enum-keys": [], "in": "path" }, { - "name": "webhookId", - "description": "Webhook unique ID.", + "name": "locale", + "description": "Template locale", "required": true, "type": "string", - "x-example": "<WEBHOOK_ID>", + "x-example": "af", + "enum": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ], + "x-enum-name": "SmsTemplateLocale", + "x-enum-keys": [], "in": "path" } ] @@ -43622,7 +43874,7 @@ "x-appwrite": { "method": "listRules", "group": null, - "weight": 787, + "weight": 741, "cookies": false, "type": "", "demo": "proxy\/list-rules.md", @@ -43704,7 +43956,7 @@ "x-appwrite": { "method": "createAPIRule", "group": null, - "weight": 782, + "weight": 736, "cookies": false, "type": "", "demo": "proxy\/create-api-rule.md", @@ -43774,7 +44026,7 @@ "x-appwrite": { "method": "createFunctionRule", "group": null, - "weight": 784, + "weight": 738, "cookies": false, "type": "", "demo": "proxy\/create-function-rule.md", @@ -43857,7 +44109,7 @@ "x-appwrite": { "method": "createRedirectRule", "group": null, - "weight": 785, + "weight": 739, "cookies": false, "type": "", "demo": "proxy\/create-redirect-rule.md", @@ -43978,7 +44230,7 @@ "x-appwrite": { "method": "createSiteRule", "group": null, - "weight": 783, + "weight": 737, "cookies": false, "type": "", "demo": "proxy\/create-site-rule.md", @@ -44059,7 +44311,7 @@ "x-appwrite": { "method": "getRule", "group": null, - "weight": 786, + "weight": 740, "cookies": false, "type": "", "demo": "proxy\/get-rule.md", @@ -44112,7 +44364,7 @@ "x-appwrite": { "method": "deleteRule", "group": null, - "weight": 788, + "weight": 742, "cookies": false, "type": "", "demo": "proxy\/delete-rule.md", @@ -44172,7 +44424,7 @@ "x-appwrite": { "method": "updateRuleVerification", "group": null, - "weight": 789, + "weight": 743, "cookies": false, "type": "", "demo": "proxy\/update-rule-verification.md", @@ -44230,7 +44482,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 590, + "weight": 455, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -44312,7 +44564,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 588, + "weight": 559, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -44411,6 +44663,12 @@ "default": "", "x-example": "<BUILD_COMMAND>" }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "default": "", + "x-example": "<START_COMMAND>" + }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", @@ -44454,9 +44712,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -44511,7 +44766,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -44564,11 +44905,24 @@ "default": "", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { "type": "string", - "description": "Framework specification for the site and builds.", + "description": "Build specification for the site deployments.", "default": {}, "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "default": {}, + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } }, "required": [ @@ -44606,7 +44960,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 593, + "weight": 458, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -44656,7 +45010,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 616, + "weight": 481, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -44706,7 +45060,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 612, + "weight": 477, "cookies": false, "type": "", "demo": "sites\/list-templates.md", @@ -44832,7 +45186,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 613, + "weight": 478, "cookies": false, "type": "", "demo": "sites\/get-template.md", @@ -44890,7 +45244,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 614, + "weight": 479, "cookies": false, "type": "", "demo": "sites\/list-usage.md", @@ -44960,7 +45314,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 589, + "weight": 454, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -45020,7 +45374,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 591, + "weight": 560, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -45121,6 +45475,12 @@ "default": "", "x-example": "<BUILD_COMMAND>" }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "default": "", + "x-example": "<START_COMMAND>" + }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", @@ -45164,9 +45524,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -45221,7 +45578,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -45274,11 +45717,24 @@ "default": "", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "default": {}, + "x-example": null + }, + "runtimeSpecification": { "type": "string", - "description": "Framework specification for the site and builds.", + "description": "Runtime specification for the SSR executions.", "default": {}, "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } }, "required": [ @@ -45309,7 +45765,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 592, + "weight": 457, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -45371,7 +45827,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 599, + "weight": 464, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -45449,7 +45905,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 598, + "weight": 463, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -45539,7 +45995,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 594, + "weight": 459, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -45606,9 +46062,10 @@ { "name": "activate", "description": "Automatically activate the deployment when it is finished building.", - "required": true, + "required": false, "type": "boolean", "x-example": false, + "default": false, "in": "formData" } ] @@ -45640,7 +46097,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 602, + "weight": 467, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -45720,7 +46177,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 595, + "weight": 460, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -45841,7 +46298,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 596, + "weight": 461, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -45939,7 +46396,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 597, + "weight": 462, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -46002,7 +46459,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 600, + "weight": 465, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -46070,7 +46527,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 601, + "weight": 466, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -46156,7 +46613,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 603, + "weight": 468, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -46224,7 +46681,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 605, + "weight": 470, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -46305,7 +46762,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 604, + "weight": 469, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -46370,7 +46827,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 606, + "weight": 471, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -46438,7 +46895,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 615, + "weight": 480, "cookies": false, "type": "", "demo": "sites\/get-usage.md", @@ -46516,7 +46973,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 609, + "weight": 474, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -46576,7 +47033,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 607, + "weight": 561, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -46667,7 +47124,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 608, + "weight": 473, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -46735,7 +47192,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 610, + "weight": 475, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -46830,7 +47287,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 611, + "weight": 476, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -46898,7 +47355,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 530, + "weight": 522, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -46981,7 +47438,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 528, + "weight": 520, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -47128,7 +47585,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 529, + "weight": 521, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -47189,7 +47646,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 531, + "weight": 523, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -47332,7 +47789,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 532, + "weight": 524, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -47393,7 +47850,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 535, + "weight": 527, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -47486,7 +47943,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 781, + "weight": 734, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -47577,7 +48034,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 534, + "weight": 526, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -47648,7 +48105,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 536, + "weight": 528, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -47739,7 +48196,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 537, + "weight": 529, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -47810,7 +48267,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 539, + "weight": 531, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -47890,7 +48347,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 538, + "weight": 530, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -48098,7 +48555,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 540, + "weight": 532, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -48178,7 +48635,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 542, + "weight": 534, "cookies": false, "type": "", "demo": "storage\/get-usage.md", @@ -48249,7 +48706,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 543, + "weight": 535, "cookies": false, "type": "", "demo": "storage\/get-bucket-usage.md", @@ -48328,7 +48785,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 338, + "weight": 316, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -48411,7 +48868,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 334, + "weight": 312, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -48495,7 +48952,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 405, + "weight": 383, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -48565,7 +49022,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 401, + "weight": 379, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -48639,7 +49096,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 402, + "weight": 380, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -48705,7 +49162,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 403, + "weight": 381, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -48787,7 +49244,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 404, + "weight": 382, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -48855,7 +49312,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 406, + "weight": 384, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -48939,7 +49396,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 340, + "weight": 318, "cookies": false, "type": "", "demo": "tablesdb\/list-usage.md", @@ -49036,7 +49493,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 335, + "weight": 313, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -49097,7 +49554,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 336, + "weight": 314, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -49174,7 +49631,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 337, + "weight": 315, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -49235,7 +49692,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 345, + "weight": 323, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -49329,7 +49786,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 341, + "weight": 319, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -49458,7 +49915,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 342, + "weight": 320, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -49530,7 +49987,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 343, + "weight": 321, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -49634,7 +50091,7 @@ "x-appwrite": { "method": "deleteTable", "group": "tables", - "weight": 344, + "weight": 322, "cookies": false, "type": "", "demo": "tablesdb\/delete-table.md", @@ -49706,7 +50163,7 @@ "x-appwrite": { "method": "listColumns", "group": "columns", - "weight": 350, + "weight": 328, "cookies": false, "type": "", "demo": "tablesdb\/list-columns.md", @@ -49801,7 +50258,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 351, + "weight": 329, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -49913,7 +50370,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 352, + "weight": 330, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -50027,7 +50484,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 353, + "weight": 331, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -50139,7 +50596,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 354, + "weight": 332, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -50253,7 +50710,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 355, + "weight": 333, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -50366,7 +50823,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 356, + "weight": 334, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -50481,7 +50938,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 357, + "weight": 335, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -50603,7 +51060,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 358, + "weight": 336, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -50727,7 +51184,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 359, + "weight": 337, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -50856,7 +51313,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 360, + "weight": 338, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -50987,7 +51444,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 361, + "weight": 339, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -51116,7 +51573,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 362, + "weight": 340, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -51247,7 +51704,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 363, + "weight": 341, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -51359,7 +51816,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 364, + "weight": 342, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -51473,7 +51930,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 365, + "weight": 343, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -51579,7 +52036,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 366, + "weight": 344, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -51692,7 +52149,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 383, + "weight": 361, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -51810,7 +52267,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 384, + "weight": 362, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -51924,7 +52381,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 381, + "weight": 359, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -52042,7 +52499,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 382, + "weight": 360, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -52156,7 +52613,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 367, + "weight": 345, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -52262,7 +52719,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 368, + "weight": 346, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -52375,7 +52832,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 369, + "weight": 347, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -52481,7 +52938,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 370, + "weight": 348, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -52594,7 +53051,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 371, + "weight": 349, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -52734,7 +53191,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 373, + "weight": 351, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -52864,7 +53321,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 374, + "weight": 352, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -52990,7 +53447,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 379, + "weight": 357, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -53108,7 +53565,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 380, + "weight": 358, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -53222,7 +53679,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 375, + "weight": 353, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -53335,7 +53792,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 376, + "weight": 354, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -53450,7 +53907,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 377, + "weight": 355, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -53576,7 +54033,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 378, + "weight": 356, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -53727,7 +54184,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 348, + "weight": 326, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -53801,7 +54258,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 349, + "weight": 327, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -53882,7 +54339,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 372, + "weight": 350, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -53991,7 +54448,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 388, + "weight": 366, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -54084,7 +54541,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 385, + "weight": 363, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -54223,7 +54680,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 386, + "weight": 364, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -54297,7 +54754,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 387, + "weight": 365, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -54376,7 +54833,7 @@ "x-appwrite": { "method": "listTableLogs", "group": "tables", - "weight": 346, + "weight": 324, "cookies": false, "type": "", "demo": "tablesdb\/list-table-logs.md", @@ -54458,7 +54915,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 397, + "weight": 375, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -54533,6 +54990,16 @@ "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" } ] }, @@ -54561,7 +55028,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 389, + "weight": 367, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -54743,7 +55210,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 394, + "weight": 372, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -54873,7 +55340,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 392, + "weight": 370, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -54976,7 +55443,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 396, + "weight": 374, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -55073,7 +55540,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 390, + "weight": 368, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -55175,7 +55642,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 393, + "weight": 371, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -55321,7 +55788,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 391, + "weight": 369, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -55430,7 +55897,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 395, + "weight": 373, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -55528,7 +55995,7 @@ "x-appwrite": { "method": "listRowLogs", "group": "logs", - "weight": 398, + "weight": 376, "cookies": false, "type": "", "demo": "tablesdb\/list-row-logs.md", @@ -55620,7 +56087,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 400, + "weight": 378, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -55742,7 +56209,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 399, + "weight": 377, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -55862,7 +56329,7 @@ "x-appwrite": { "method": "getTableUsage", "group": null, - "weight": 347, + "weight": 325, "cookies": false, "type": "", "demo": "tablesdb\/get-table-usage.md", @@ -55952,7 +56419,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 339, + "weight": 317, "cookies": false, "type": "", "demo": "tablesdb\/get-usage.md", @@ -56060,7 +56527,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 107, + "weight": 503, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -56145,7 +56612,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 106, + "weight": 501, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -56236,7 +56703,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 108, + "weight": 502, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -56299,7 +56766,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 110, + "weight": 505, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -56375,7 +56842,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 112, + "weight": 504, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -56438,7 +56905,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 119, + "weight": 514, "cookies": false, "type": "", "demo": "teams\/list-logs.md", @@ -56518,7 +56985,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 114, + "weight": 510, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -56611,7 +57078,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 113, + "weight": 508, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -56675,7 +57142,7 @@ }, "roles": { "type": "array", - "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "default": null, "x-example": null, "items": { @@ -56728,7 +57195,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 115, + "weight": 509, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -56775,7 +57242,7 @@ ] }, "patch": { - "summary": "Update membership", + "summary": "Update team membership", "operationId": "teamsUpdateMembership", "consumes": [ "application\/json" @@ -56799,7 +57266,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 116, + "weight": 511, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -56851,7 +57318,7 @@ "properties": { "roles": { "type": "array", - "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "default": null, "x-example": null, "items": { @@ -56872,9 +57339,7 @@ "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "teams" ], @@ -56887,8 +57352,8 @@ "deprecated": false, "x-appwrite": { "method": "deleteMembership", - "group": null, - "weight": 555, + "group": "memberships", + "weight": 735, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -56961,7 +57426,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 117, + "weight": 513, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -57056,7 +57521,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 109, + "weight": 506, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -57094,7 +57559,7 @@ ] }, "put": { - "summary": "Update preferences", + "summary": "Update team preferences", "operationId": "teamsUpdatePrefs", "consumes": [ "application\/json" @@ -57118,7 +57583,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 111, + "weight": 507, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -57198,7 +57663,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 525, + "weight": 517, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -57287,7 +57752,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 523, + "weight": 515, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -57371,7 +57836,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 524, + "weight": 516, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -57431,7 +57896,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 526, + "weight": 518, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -57502,7 +57967,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 527, + "weight": 519, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -57562,7 +58027,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 129, + "weight": 109, "cookies": false, "type": "", "demo": "users\/list.md", @@ -57645,7 +58110,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 120, + "weight": 100, "cookies": false, "type": "", "demo": "users\/create.md", @@ -57746,7 +58211,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 123, + "weight": 103, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -57841,7 +58306,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 121, + "weight": 101, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -57934,7 +58399,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 137, + "weight": 117, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -58014,7 +58479,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 160, + "weight": 140, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -58077,7 +58542,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 122, + "weight": 102, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -58172,7 +58637,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 125, + "weight": 105, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -58267,7 +58732,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 126, + "weight": 106, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -58401,7 +58866,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 127, + "weight": 107, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -58517,7 +58982,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 124, + "weight": 104, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -58631,7 +59096,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 162, + "weight": 142, "cookies": false, "type": "", "demo": "users\/get-usage.md", @@ -58702,7 +59167,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 130, + "weight": 110, "cookies": false, "type": "", "demo": "users\/get.md", @@ -58758,7 +59223,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 158, + "weight": 138, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -58821,7 +59286,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 143, + "weight": 123, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -58903,7 +59368,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 161, + "weight": 141, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -58988,7 +59453,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 139, + "weight": 119, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -59070,7 +59535,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 135, + "weight": 115, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -59152,7 +59617,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 134, + "weight": 114, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -59245,7 +59710,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 148, + "weight": 128, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -59381,7 +59846,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 153, + "weight": 133, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -59513,7 +59978,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 149, + "weight": 129, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -59630,7 +60095,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 150, + "weight": 130, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -59747,7 +60212,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 152, + "weight": 132, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -59864,7 +60329,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 151, + "weight": 131, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -59983,7 +60448,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 141, + "weight": 121, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -60064,7 +60529,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 142, + "weight": 122, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -60145,7 +60610,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 144, + "weight": 124, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -60225,7 +60690,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 131, + "weight": 111, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -60286,7 +60751,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 146, + "weight": 126, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -60365,7 +60830,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 133, + "weight": 113, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -60435,7 +60900,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 154, + "weight": 134, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -60491,7 +60956,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 157, + "weight": 137, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -60549,7 +61014,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 156, + "weight": 136, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -60620,7 +61085,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 138, + "weight": 118, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -60699,7 +61164,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 136, + "weight": 116, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -60781,7 +61246,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 128, + "weight": 108, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -60893,7 +61358,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 132, + "weight": 112, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -60962,7 +61427,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 147, + "weight": 127, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -61053,7 +61518,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 159, + "weight": 139, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -61124,7 +61589,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 155, + "weight": 135, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -61210,7 +61675,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 145, + "weight": 125, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -61291,7 +61756,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 140, + "weight": 120, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -61372,7 +61837,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 554, + "weight": 547, "cookies": false, "type": "", "demo": "vcs\/create-repository-detection.md", @@ -61468,7 +61933,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 551, + "weight": 544, "cookies": false, "type": "", "demo": "vcs\/list-repositories.md", @@ -61562,7 +62027,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 549, + "weight": 542, "cookies": false, "type": "", "demo": "vcs\/create-repository.md", @@ -61646,7 +62111,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 550, + "weight": 543, "cookies": false, "type": "", "demo": "vcs\/get-repository.md", @@ -61713,7 +62178,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 552, + "weight": 545, "cookies": false, "type": "", "demo": "vcs\/list-repository-branches.md", @@ -61780,7 +62245,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 553, + "weight": 546, "cookies": false, "type": "", "demo": "vcs\/get-repository-contents.md", @@ -61864,7 +62329,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 164, + "weight": 745, "cookies": false, "type": "", "demo": "vcs\/update-external-deployments.md", @@ -61949,7 +62414,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 547, + "weight": 540, "cookies": false, "type": "", "demo": "vcs\/list-installations.md", @@ -62030,7 +62495,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 546, + "weight": 539, "cookies": false, "type": "", "demo": "vcs\/get-installation.md", @@ -62084,7 +62549,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 548, + "weight": 541, "cookies": false, "type": "", "demo": "vcs\/delete-installation.md", @@ -62118,6 +62583,493 @@ } ] } + }, + "\/webhooks": { + "get": { + "summary": "List webhooks", + "operationId": "webhooksList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Webhooks List", + "schema": { + "$ref": "#\/definitions\/webhookList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 550, + "cookies": false, + "type": "", + "demo": "webhooks\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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. You may filter on the following attributes: name, url, httpUser, security, events, enabled, logs, attempts", + "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 webhook", + "operationId": "webhooksCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "responses": { + "201": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 549, + "cookies": false, + "type": "", + "demo": "webhooks\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "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.", + "default": null, + "x-example": "<WEBHOOK_ID>" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "default": null, + "x-example": null + }, + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "default": null, + "x-example": "<NAME>" + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "default": true, + "x-example": false + }, + "security": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "default": false, + "x-example": false + }, + "httpUser": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "default": "", + "x-example": "<HTTP_USER>" + }, + "httpPass": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "default": "", + "x-example": "<HTTP_PASS>" + } + }, + "required": [ + "webhookId", + "url", + "name", + "events" + ] + } + } + ] + } + }, + "\/webhooks\/{webhookId}": { + "get": { + "summary": "Get webhook", + "operationId": "webhooksGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 551, + "cookies": false, + "type": "", + "demo": "webhooks\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "<WEBHOOK_ID>", + "in": "path" + } + ] + }, + "put": { + "summary": "Update webhook", + "operationId": "webhooksUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 553, + "cookies": false, + "type": "", + "demo": "webhooks\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "<WEBHOOK_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "default": null, + "x-example": "<NAME>" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "default": null, + "x-example": null + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "default": true, + "x-example": false + }, + "security": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "default": false, + "x-example": false + }, + "httpUser": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "default": "", + "x-example": "<HTTP_USER>" + }, + "httpPass": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "default": "", + "x-example": "<HTTP_PASS>" + } + }, + "required": [ + "name", + "url", + "events" + ] + } + } + ] + }, + "delete": { + "summary": "Delete webhook", + "operationId": "webhooksDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "webhooks" + ], + "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 552, + "cookies": false, + "type": "", + "demo": "webhooks\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "<WEBHOOK_ID>", + "in": "path" + } + ] + } + }, + "\/webhooks\/{webhookId}\/signature": { + "patch": { + "summary": "Update webhook signature key", + "operationId": "webhooksUpdateSignature", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSignature", + "group": null, + "weight": 554, + "cookies": false, + "type": "", + "demo": "webhooks\/update-signature.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "<WEBHOOK_ID>", + "in": "path" + } + ] + } } }, "tags": [ @@ -67685,8 +68637,8 @@ }, "$sequence": { "type": "integer", - "description": "Row automatically incrementing ID.", - "x-example": 1, + "description": "Row sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -67735,7 +68687,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$tableId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -67756,8 +68708,8 @@ }, "$sequence": { "type": "integer", - "description": "Document automatically incrementing ID.", - "x-example": 1, + "description": "Document sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -67806,7 +68758,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$collectionId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -69336,6 +70288,12 @@ "description": "Site framework.", "x-example": "react" }, + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, "deploymentId": { "type": "string", "description": "Site's active deployment ID.", @@ -69396,6 +70354,11 @@ "description": "The build command used to build the site.", "x-example": "npm run build" }, + "startCommand": { + "type": "string", + "description": "Custom command to use when starting site runtime.", + "x-example": "node custom-server.mjs" + }, "outputDirectory": { "type": "string", "description": "The directory where the site build output is located.", @@ -69426,9 +70389,14 @@ "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", "x-example": false }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { "type": "string", - "description": "Machine specification for builds and executions.", + "description": "Machine specification for SSR executions.", "x-example": "s-1vcpu-512mb" }, "buildRuntime": { @@ -69456,6 +70424,7 @@ "live", "logging", "framework", + "deploymentRetention", "deploymentId", "deploymentCreatedAt", "deploymentScreenshotLight", @@ -69467,13 +70436,15 @@ "timeout", "installCommand", "buildCommand", + "startCommand", "outputDirectory", "installationId", "providerRepositoryId", "providerBranch", "providerRootDirectory", "providerSilentMode", - "specification", + "buildSpecification", + "runtimeSpecification", "buildRuntime", "adapter", "fallbackFile" @@ -69487,6 +70458,7 @@ "live": false, "logging": false, "framework": "react", + "deploymentRetention": 7, "deploymentId": "5e5ea5c16897e", "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", "deploymentScreenshotLight": "5e5ea5c16897e", @@ -69498,13 +70470,15 @@ "timeout": 300, "installCommand": "npm install", "buildCommand": "npm run build", + "startCommand": "node custom-server.mjs", "outputDirectory": "build", "installationId": "6m40at4ejk5h2u9s1hboo", "providerRepositoryId": "appwrite", "providerBranch": "main", "providerRootDirectory": "sites\/helloWorld", "providerSilentMode": false, - "specification": "s-1vcpu-512mb", + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb", "buildRuntime": "node-22", "adapter": "static", "fallbackFile": "index.html" @@ -69747,6 +70721,12 @@ "description": "Function execution and build runtime.", "x-example": "python-3.8" }, + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, "deploymentId": { "type": "string", "description": "Function's active deployment ID.", @@ -69848,9 +70828,14 @@ "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", "x-example": false }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { "type": "string", - "description": "Machine specification for builds and executions.", + "description": "Machine specification for executions.", "x-example": "s-1vcpu-512mb" } }, @@ -69864,6 +70849,7 @@ "live", "logging", "runtime", + "deploymentRetention", "deploymentId", "deploymentCreatedAt", "latestDeploymentId", @@ -69882,7 +70868,8 @@ "providerBranch", "providerRootDirectory", "providerSilentMode", - "specification" + "buildSpecification", + "runtimeSpecification" ], "example": { "$id": "5e5ea5c16897e", @@ -69894,6 +70881,7 @@ "live": false, "logging": false, "runtime": "python-3.8", + "deploymentRetention": 7, "deploymentId": "5e5ea5c16897e", "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", "latestDeploymentId": "5e5ea5c16897e", @@ -69912,7 +70900,8 @@ "providerBranch": "main", "providerRootDirectory": "functions\/helloWorld", "providerSilentMode": false, - "specification": "s-1vcpu-512mb" + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb" } }, "templateFunction": { @@ -70248,6 +71237,16 @@ "description": "VCS (Version Control System) repository's default branch name.", "x-example": "main" }, + "providerInstallationId": { + "type": "string", + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" + }, + "authorized": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository authorized for the installation?", + "x-example": true + }, "pushedAt": { "type": "string", "description": "Last commit date in ISO 8601 format.", @@ -70272,6 +71271,8 @@ "provider", "private", "defaultBranch", + "providerInstallationId", + "authorized", "pushedAt", "variables" ], @@ -70282,6 +71283,8 @@ "provider": "github", "private": true, "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, "pushedAt": "datetime", "variables": [ "PORT", @@ -70323,6 +71326,16 @@ "description": "VCS (Version Control System) repository's default branch name.", "x-example": "main" }, + "providerInstallationId": { + "type": "string", + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" + }, + "authorized": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository authorized for the installation?", + "x-example": true + }, "pushedAt": { "type": "string", "description": "Last commit date in ISO 8601 format.", @@ -70352,6 +71365,8 @@ "provider", "private", "defaultBranch", + "providerInstallationId", + "authorized", "pushedAt", "variables", "framework" @@ -70363,6 +71378,8 @@ "provider": "github", "private": true, "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, "pushedAt": "datetime", "variables": [ "PORT", @@ -70405,6 +71422,16 @@ "description": "VCS (Version Control System) repository's default branch name.", "x-example": "main" }, + "providerInstallationId": { + "type": "string", + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" + }, + "authorized": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository authorized for the installation?", + "x-example": true + }, "pushedAt": { "type": "string", "description": "Last commit date in ISO 8601 format.", @@ -70434,6 +71461,8 @@ "provider", "private", "defaultBranch", + "providerInstallationId", + "authorized", "pushedAt", "variables", "runtime" @@ -70445,6 +71474,8 @@ "provider": "github", "private": true, "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, "pushedAt": "datetime", "variables": [ "PORT", @@ -71582,6 +72613,11 @@ "$ref": "#\/definitions\/block" }, "x-example": "" + }, + "consoleAccessedAt": { + "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" } }, "required": [ @@ -71651,7 +72687,8 @@ "serviceStatusForMessaging", "region", "billingLimits", - "blocks" + "blocks", + "consoleAccessedAt" ], "example": { "$id": "5e5ea5c16897e", @@ -71726,7 +72763,8 @@ "serviceStatusForMessaging": true, "region": "fra", "billingLimits": "", - "blocks": "" + "blocks": "", + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" } }, "webhook": { @@ -74530,6 +75568,36 @@ "x-example": 0, "format": "int32" }, + "functionsExecutions": { + "type": "array", + "description": "Aggregated number of function executions per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, + "functionsExecutionsTotal": { + "type": "integer", + "description": "Total aggregated number of function executions.", + "x-example": 0, + "format": "int32" + }, + "sitesExecutions": { + "type": "array", + "description": "Aggregated number of site executions per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, + "sitesExecutionsTotal": { + "type": "integer", + "description": "Total aggregated number of site executions.", + "x-example": 0, + "format": "int32" + }, "networkTotal": { "type": "integer", "description": "Aggregated stats for total network bandwidth.", @@ -74571,6 +75639,51 @@ "description": "Total aggregated number of Imagine credits.", "x-example": 0, "format": "int32" + }, + "realtimeConnectionsTotal": { + "type": "integer", + "description": "Current aggregated number of open Realtime connections.", + "x-example": 0, + "format": "int32" + }, + "realtimeMessagesTotal": { + "type": "integer", + "description": "Total number of Realtime messages sent to clients.", + "x-example": 0, + "format": "int32" + }, + "realtimeBandwidthTotal": { + "type": "integer", + "description": "Total consumed Realtime bandwidth (in bytes).", + "x-example": 0, + "format": "int32" + }, + "realtimeConnections": { + "type": "array", + "description": "Aggregated number of open Realtime connections per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, + "realtimeMessages": { + "type": "array", + "description": "Aggregated number of Realtime messages sent to clients per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, + "realtimeBandwidth": { + "type": "array", + "description": "Aggregated consumed Realtime bandwidth (in bytes) per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] } }, "required": [ @@ -74606,12 +75719,22 @@ "databasesWrites", "imageTransformations", "imageTransformationsTotal", + "functionsExecutions", + "functionsExecutionsTotal", + "sitesExecutions", + "sitesExecutionsTotal", "networkTotal", "backupsStorageTotal", "screenshotsGenerated", "screenshotsGeneratedTotal", "imagineCredits", - "imagineCreditsTotal" + "imagineCreditsTotal", + "realtimeConnectionsTotal", + "realtimeMessagesTotal", + "realtimeBandwidthTotal", + "realtimeConnections", + "realtimeMessages", + "realtimeBandwidth" ], "example": { "executionsTotal": 0, @@ -74646,12 +75769,22 @@ "databasesWrites": [], "imageTransformations": [], "imageTransformationsTotal": 0, + "functionsExecutions": [], + "functionsExecutionsTotal": 0, + "sitesExecutions": [], + "sitesExecutionsTotal": 0, "networkTotal": 0, "backupsStorageTotal": 0, "screenshotsGenerated": [], "screenshotsGeneratedTotal": 0, "imagineCredits": [], - "imagineCreditsTotal": 0 + "imagineCreditsTotal": 0, + "realtimeConnectionsTotal": 0, + "realtimeMessagesTotal": 0, + "realtimeBandwidthTotal": 0, + "realtimeConnections": [], + "realtimeMessages": [], + "realtimeBandwidth": [] } }, "headers": { @@ -75103,6 +76236,62 @@ "type": "string", "description": "Comma-separated list of nameservers.", "x-example": "ns1.example.com,ns2.example.com" + }, + "_APP_DB_ADAPTER": { + "type": "string", + "description": "Database adapter in use.", + "x-example": "mysql" + }, + "supportForRelationships": { + "type": "boolean", + "description": "Whether the database adapter supports relationships.", + "x-example": true + }, + "supportForOperators": { + "type": "boolean", + "description": "Whether the database adapter supports operators.", + "x-example": true + }, + "supportForSpatials": { + "type": "boolean", + "description": "Whether the database adapter supports spatial attributes.", + "x-example": true + }, + "supportForSpatialIndexNull": { + "type": "boolean", + "description": "Whether the database adapter supports spatial indexes on nullable columns.", + "x-example": false + }, + "supportForFulltextWildcard": { + "type": "boolean", + "description": "Whether the database adapter supports fulltext wildcard search.", + "x-example": true + }, + "supportForMultipleFulltextIndexes": { + "type": "boolean", + "description": "Whether the database adapter supports multiple fulltext indexes per collection.", + "x-example": true + }, + "supportForAttributeResizing": { + "type": "boolean", + "description": "Whether the database adapter supports resizing attributes.", + "x-example": true + }, + "supportForSchemas": { + "type": "boolean", + "description": "Whether the database adapter supports fixed schemas with row width limits.", + "x-example": true + }, + "maxIndexLength": { + "type": "integer", + "description": "Maximum index length supported by the database adapter.", + "x-example": 768, + "format": "int32" + }, + "supportForIntegerIds": { + "type": "boolean", + "description": "Whether the database adapter uses integer sequence IDs.", + "x-example": true } }, "required": [ @@ -75120,7 +76309,18 @@ "_APP_DOMAIN_SITES", "_APP_DOMAIN_FUNCTIONS", "_APP_OPTIONS_FORCE_HTTPS", - "_APP_DOMAINS_NAMESERVERS" + "_APP_DOMAINS_NAMESERVERS", + "_APP_DB_ADAPTER", + "supportForRelationships", + "supportForOperators", + "supportForSpatials", + "supportForSpatialIndexNull", + "supportForFulltextWildcard", + "supportForMultipleFulltextIndexes", + "supportForAttributeResizing", + "supportForSchemas", + "maxIndexLength", + "supportForIntegerIds" ], "example": { "_APP_DOMAIN_TARGET_CNAME": "appwrite.io", @@ -75137,7 +76337,18 @@ "_APP_DOMAIN_SITES": "sites.localhost,sites.example.com", "_APP_DOMAIN_FUNCTIONS": "functions.localhost", "_APP_OPTIONS_FORCE_HTTPS": "enabled", - "_APP_DOMAINS_NAMESERVERS": "ns1.example.com,ns2.example.com" + "_APP_DOMAINS_NAMESERVERS": "ns1.example.com,ns2.example.com", + "_APP_DB_ADAPTER": "mysql", + "supportForRelationships": true, + "supportForOperators": true, + "supportForSpatials": true, + "supportForSpatialIndexNull": false, + "supportForFulltextWildcard": true, + "supportForMultipleFulltextIndexes": true, + "supportForAttributeResizing": true, + "supportForSchemas": true, + "maxIndexLength": 768, + "supportForIntegerIds": true } }, "mfaChallenge": { @@ -75945,6 +77156,36 @@ "x-example": 20, "format": "int32" }, + "site": { + "type": "integer", + "description": "Number of sites to be migrated.", + "x-example": 5, + "format": "int32" + }, + "provider": { + "type": "integer", + "description": "Number of providers to be migrated.", + "x-example": 5, + "format": "int32" + }, + "topic": { + "type": "integer", + "description": "Number of topics to be migrated.", + "x-example": 10, + "format": "int32" + }, + "subscriber": { + "type": "integer", + "description": "Number of subscribers to be migrated.", + "x-example": 100, + "format": "int32" + }, + "message": { + "type": "integer", + "description": "Number of messages to be migrated.", + "x-example": 50, + "format": "int32" + }, "size": { "type": "integer", "description": "Size of files to be migrated in mb.", @@ -75965,6 +77206,11 @@ "file", "bucket", "function", + "site", + "provider", + "topic", + "subscriber", + "message", "size", "version" ], @@ -75976,6 +77222,11 @@ "file": 20, "bucket": 20, "function": 20, + "site": 5, + "provider": 5, + "topic": 10, + "subscriber": 100, + "message": 50, "size": 30000, "version": "1.4.0" } @@ -76363,10 +77614,22 @@ }, "usageRealtime": { "type": "integer", - "description": "Total realtime usage for the billing period", + "description": "Peak concurrent realtime connections for the billing period", "x-example": 200, "format": "int32" }, + "usageRealtimeMessages": { + "type": "integer", + "description": "Total realtime messages sent for the billing period", + "x-example": 10000, + "format": "int32" + }, + "usageRealtimeBandwidth": { + "type": "integer", + "description": "Total realtime bandwidth usage for the billing period", + "x-example": 5000000, + "format": "int32" + }, "additionalMembers": { "type": "integer", "description": "Additional members", @@ -76456,6 +77719,8 @@ "usageExecutions", "usageBandwidth", "usageRealtime", + "usageRealtimeMessages", + "usageRealtimeBandwidth", "additionalMembers", "additionalMemberAmount", "additionalStorageAmount", @@ -76487,6 +77752,8 @@ "usageExecutions": 2000, "usageBandwidth": 2000, "usageRealtime": 200, + "usageRealtimeMessages": 10000, + "usageRealtimeBandwidth": 5000000, "additionalMembers": 5, "additionalMemberAmount": 30, "additionalStorageAmount": 40, @@ -76916,6 +78183,12 @@ "x-example": 25, "format": "int32" }, + "projectInactivityDays": { + "type": "integer", + "description": "Number of days of console inactivity before a project is paused. 0 means pausing is disabled.", + "x-example": 7, + "format": "int32" + }, "alertLimit": { "type": "integer", "description": "Alert threshold percentage", @@ -77098,6 +78371,7 @@ "authPhone", "domains", "logs", + "projectInactivityDays", "alertLimit", "usage", "addons", @@ -77155,6 +78429,7 @@ "authPhone": 10, "domains": 5, "logs": 25, + "projectInactivityDays": 7, "alertLimit": 80, "usage": null, "addons": null, @@ -79316,11 +80591,6 @@ "description": "Domain registrar (e.g. \"appwrite\" or \"third_party\").", "x-example": "appwrite" }, - "paymentStatus": { - "type": "string", - "description": "Payment status for domain purchase.", - "x-example": "pending" - }, "nameservers": { "type": "string", "description": "Nameservers setting. \"Appwrite\" or empty string.", @@ -79347,6 +80617,22 @@ "x-example": 2599, "format": "int32" }, + "transferStatus": { + "type": "string", + "description": "Transfer status for domains being transferred in.", + "x-example": "pending_registry", + "enum": [ + "transferrable", + "not_transferrable", + "pending_owner", + "pending_admin", + "pending_registry", + "completed", + "cancelled", + "service_unavailable" + ], + "x-enum-name": "DomainTransferStatusEnum" + }, "teamId": { "type": "string", "description": "Team ID.", @@ -79368,12 +80654,12 @@ "$updatedAt", "domain", "registrar", - "paymentStatus", "nameservers", "expire", "renewal", "autoRenewal", "renewalPrice", + "transferStatus", "teamId", "dnsRecords" ], @@ -79383,16 +80669,104 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "domain": "example.com", "registrar": "appwrite", - "paymentStatus": "pending", "nameservers": "Appwrite", "expire": "2020-10-15T06:38:00.000+00:00", "renewal": "2020-10-15T06:38:00.000+00:00", "autoRenewal": true, "renewalPrice": 2599, + "transferStatus": "pending_registry", "teamId": "5e5ea5c16897e", "dnsRecords": [] } }, + "domainPurchase": { + "description": "DomainPurchase", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Purchase\/invoice ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Purchase creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Purchase update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "domainId": { + "type": "string", + "description": "Domain document ID.", + "x-example": "5e5ea5c16897e" + }, + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": "example.com" + }, + "organizationId": { + "type": "string", + "description": "Team ID that owns the domain.", + "x-example": "5e5ea5c16897e" + }, + "status": { + "type": "string", + "description": "Domain purchase status.", + "x-example": "pending", + "enum": [ + "pending", + "succeeded", + "failed", + "cancelled" + ], + "x-enum-name": "DomainPurchaseStatus" + }, + "clientSecret": { + "type": "string", + "description": "Stripe client secret for 3DS; empty when not applicable.", + "x-example": "" + }, + "amount": { + "type": "number", + "description": "Purchase amount.", + "x-example": 25.99, + "format": "double" + }, + "currency": { + "type": "string", + "description": "Currency code.", + "x-example": "USD" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "domainId", + "domain", + "organizationId", + "status", + "clientSecret", + "amount", + "currency" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "domainId": "5e5ea5c16897e", + "domain": "example.com", + "organizationId": "5e5ea5c16897e", + "status": "pending", + "clientSecret": "", + "amount": 25.99, + "currency": "USD" + } + }, "dnsRecord": { "description": "DNSRecord", "type": "object", @@ -79897,6 +81271,11 @@ "description": "Price period in years.", "x-example": 1, "format": "int32" + }, + "premium": { + "type": "boolean", + "description": "Whether the domain is a premium domain.", + "x-example": false } }, "required": [ @@ -79904,14 +81283,16 @@ "tld", "available", "price", - "periodYears" + "periodYears", + "premium" ], "example": { "domain": "example.com", "tld": "com", "available": true, "price": 25.99, - "periodYears": 1 + "periodYears": 1, + "premium": false } }, "domainSuggestion": { @@ -79953,6 +81334,65 @@ "available": true } }, + "domainTransferOut": { + "description": "domainTransferOut", + "type": "object", + "properties": { + "authCode": { + "type": "string", + "description": "Domain transfer authorization code.", + "x-example": "mock_1a2b3c4d" + } + }, + "required": [ + "authCode" + ], + "example": { + "authCode": "mock_1a2b3c4d" + } + }, + "domainTransferStatus": { + "description": "domainTransferStatus", + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Transfer status.", + "x-example": "pending_registry", + "enum": [ + "transferrable", + "not_transferrable", + "pending_owner", + "pending_admin", + "pending_registry", + "completed", + "cancelled", + "service_unavailable" + ], + "x-enum-name": "DomainTransferStatusEnum" + }, + "reason": { + "type": "string", + "description": "Additional transfer status information.", + "x-example": "Transfer in progress" + }, + "timestamp": { + "type": "string", + "description": "Transfer status timestamp in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "status", + "reason", + "timestamp" + ], + "example": { + "status": "pending_registry", + "reason": "Transfer in progress", + "timestamp": "2020-10-15T06:38:00.000+00:00" + } + }, "activityEventList": { "description": "Activity event list", "type": "object", diff --git a/specs/1.8.x/swagger2-1.8.x-server.json b/specs/1.8.x/swagger2-1.8.x-server.json index 37fd85396..699a5e7c7 100644 --- a/specs/1.8.x/swagger2-1.8.x-server.json +++ b/specs/1.8.x/swagger2-1.8.x-server.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "1.8.1", + "version": "1.8.2", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -628,7 +628,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 239, + "weight": 217, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -704,7 +704,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 241, + "weight": 219, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -831,7 +831,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 242, + "weight": 220, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -975,7 +975,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 243, + "weight": 221, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1102,7 +1102,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 247, + "weight": 225, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1242,7 +1242,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 248, + "weight": 226, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1385,7 +1385,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 240, + "weight": 218, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1489,7 +1489,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 246, + "weight": 224, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1593,7 +1593,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 244, + "weight": 222, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1697,7 +1697,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 245, + "weight": 223, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -3919,7 +3919,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 779, + "weight": 732, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -3981,7 +3981,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 780, + "weight": 733, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -4043,7 +4043,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 250, + "weight": 228, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4171,7 +4171,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 249, + "weight": 227, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4305,7 +4305,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 253, + "weight": 231, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4371,7 +4371,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 251, + "weight": 229, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4861,7 +4861,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 252, + "weight": 230, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4947,7 +4947,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 255, + "weight": 233, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5041,7 +5041,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 254, + "weight": 232, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5135,7 +5135,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 256, + "weight": 234, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5850,7 +5850,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 749, + "weight": 700, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -5916,7 +5916,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 750, + "weight": 701, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -6005,7 +6005,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 748, + "weight": 699, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -6064,7 +6064,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 751, + "weight": 702, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -6126,7 +6126,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 744, + "weight": 695, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -6192,7 +6192,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 745, + "weight": 696, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -6315,7 +6315,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 743, + "weight": 694, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -6377,7 +6377,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 746, + "weight": 697, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -6473,7 +6473,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 747, + "weight": 698, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -6537,7 +6537,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 754, + "weight": 705, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -6638,7 +6638,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 753, + "weight": 704, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -6704,7 +6704,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 752, + "weight": 703, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -6766,7 +6766,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 264, + "weight": 242, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -6884,7 +6884,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 260, + "weight": 238, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -7006,7 +7006,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 332, + "weight": 310, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -7075,7 +7075,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 328, + "weight": 306, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -7148,7 +7148,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 329, + "weight": 307, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -7213,7 +7213,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 330, + "weight": 308, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -7294,7 +7294,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 331, + "weight": 309, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -7361,7 +7361,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 333, + "weight": 311, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -7444,7 +7444,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 261, + "weight": 239, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -7540,7 +7540,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 262, + "weight": 240, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -7654,7 +7654,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 263, + "weight": 241, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -7749,7 +7749,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 272, + "weight": 250, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -7845,7 +7845,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 268, + "weight": 246, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -7976,7 +7976,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 269, + "weight": 247, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -8050,7 +8050,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 270, + "weight": 248, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -8156,7 +8156,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 271, + "weight": 249, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -8230,7 +8230,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 289, + "weight": 267, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -8327,7 +8327,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 290, + "weight": 268, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -8368,7 +8368,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "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>", @@ -8441,7 +8441,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 291, + "weight": 269, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -8557,7 +8557,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 292, + "weight": 270, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -8671,7 +8671,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 293, + "weight": 271, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -8787,7 +8787,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 294, + "weight": 272, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -8902,7 +8902,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 295, + "weight": 273, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -9019,7 +9019,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 296, + "weight": 274, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -9143,7 +9143,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 297, + "weight": 275, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -9269,7 +9269,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 298, + "weight": 276, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -9400,7 +9400,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 299, + "weight": 277, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -9533,7 +9533,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 300, + "weight": 278, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -9664,7 +9664,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 301, + "weight": 279, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -9797,7 +9797,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 302, + "weight": 280, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -9911,7 +9911,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 303, + "weight": 281, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -10027,7 +10027,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 304, + "weight": 282, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -10135,7 +10135,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 305, + "weight": 283, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -10250,7 +10250,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 322, + "weight": 300, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -10366,7 +10366,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 323, + "weight": 301, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -10478,7 +10478,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 320, + "weight": 298, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -10594,7 +10594,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 321, + "weight": 299, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -10706,7 +10706,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 306, + "weight": 284, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -10814,7 +10814,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 307, + "weight": 285, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -10929,7 +10929,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 308, + "weight": 286, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -11037,7 +11037,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 309, + "weight": 287, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -11152,7 +11152,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 310, + "weight": 288, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -11268,138 +11268,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { - "post": { - "summary": "Create string attribute", - "operationId": "databasesCreateStringAttribute", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "Create a string attribute.\n", - "responses": { - "202": { - "description": "AttributeString", - "schema": { - "$ref": "#\/definitions\/attributeString" - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "createStringAttribute", - "group": "attributes", - "weight": 312, - "cookies": false, - "type": "", - "demo": "databases\/create-string-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createStringColumn" - }, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "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 table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "type": "string", - "x-example": "<COLLECTION_ID>", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "default": null, - "x-example": null - }, - "size": { - "type": "integer", - "description": "Attribute size for text attributes, in number of characters.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "<DEFAULT>", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } - } - ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { "patch": { - "summary": "Update string attribute", - "operationId": "databasesUpdateStringAttribute", + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", "consumes": [ "application\/json" ], @@ -11409,23 +11281,23 @@ "tags": [ "databases" ], - "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "200": { - "description": "AttributeString", + "description": "AttributeRelationship", "schema": { - "$ref": "#\/definitions\/attributeString" + "$ref": "#\/definitions\/attributeRelationship" } } }, "deprecated": true, "x-appwrite": { - "method": "updateStringAttribute", + "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 313, + "weight": 289, "cookies": false, "type": "", - "demo": "databases\/update-string-attribute.md", + "demo": "databases\/update-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11436,10 +11308,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateStringColumn" + "replaceWith": "tablesDB.updateRelationshipColumn" }, "auth": { "Project": [], @@ -11463,7 +11335,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "<COLLECTION_ID>", @@ -11482,26 +11354,18 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { + "onDelete": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "<DEFAULT>", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string attribute.", + "description": "Constraints option", "default": null, - "x-example": 1, - "format": "int32", - "x-nullable": true + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] }, "newKey": { "type": "string", @@ -11510,20 +11374,16 @@ "x-example": null, "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { - "summary": "Create text attribute", - "operationId": "databasesCreateTextAttribute", + "summary": "Create string attribute", + "operationId": "databasesCreateStringAttribute", "consumes": [ "application\/json" ], @@ -11533,23 +11393,23 @@ "tags": [ "databases" ], - "description": "Create a text attribute.\n", + "description": "Create a string attribute.\n", "responses": { "202": { - "description": "AttributeText", + "description": "AttributeString", "schema": { - "$ref": "#\/definitions\/attributeText" + "$ref": "#\/definitions\/attributeString" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createTextAttribute", + "method": "createStringAttribute", "group": "attributes", - "weight": 318, + "weight": 290, "cookies": false, "type": "", - "demo": "databases\/create-text-attribute.md", + "demo": "databases\/create-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11560,7 +11420,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createStringColumn" + }, "auth": { "Project": [], "Key": [] @@ -11583,7 +11447,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. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "<COLLECTION_ID>", @@ -11601,6 +11465,13 @@ "default": null, "x-example": null }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "default": null, + "x-example": 1, + "format": "int32" + }, "required": { "type": "boolean", "description": "Is attribute required?", @@ -11629,6 +11500,7 @@ }, "required": [ "key", + "size", "required" ] } @@ -11636,10 +11508,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { "patch": { - "summary": "Update text attribute", - "operationId": "databasesUpdateTextAttribute", + "summary": "Update string attribute", + "operationId": "databasesUpdateStringAttribute", "consumes": [ "application\/json" ], @@ -11649,23 +11521,23 @@ "tags": [ "databases" ], - "description": "Update a text attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeText", + "description": "AttributeString", "schema": { - "$ref": "#\/definitions\/attributeText" + "$ref": "#\/definitions\/attributeString" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateTextAttribute", + "method": "updateStringAttribute", "group": "attributes", - "weight": 319, + "weight": 291, "cookies": false, "type": "", - "demo": "databases\/update-text-attribute.md", + "demo": "databases\/update-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11676,7 +11548,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateStringColumn" + }, "auth": { "Project": [], "Key": [] @@ -11699,7 +11575,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. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "<COLLECTION_ID>", @@ -11731,6 +11607,14 @@ "x-example": "<DEFAULT>", "x-nullable": true }, + "size": { + "type": "integer", + "description": "Maximum size of the string attribute.", + "default": null, + "x-example": 1, + "format": "int32", + "x-nullable": true + }, "newKey": { "type": "string", "description": "New Attribute Key.", @@ -11748,10 +11632,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text": { "post": { - "summary": "Create URL attribute", - "operationId": "databasesCreateUrlAttribute", + "summary": "Create text attribute", + "operationId": "databasesCreateTextAttribute", "consumes": [ "application\/json" ], @@ -11761,23 +11645,23 @@ "tags": [ "databases" ], - "description": "Create a URL attribute.\n", + "description": "Create a text attribute.\n", "responses": { "202": { - "description": "AttributeURL", + "description": "AttributeText", "schema": { - "$ref": "#\/definitions\/attributeUrl" + "$ref": "#\/definitions\/attributeText" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createUrlAttribute", + "method": "createTextAttribute", "group": "attributes", - "weight": 314, + "weight": 296, "cookies": false, "type": "", - "demo": "databases\/create-url-attribute.md", + "demo": "databases\/create-text-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11788,11 +11672,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createUrlColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-text-attribute.md", "auth": { "Project": [], "Key": [] @@ -11815,7 +11695,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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>", @@ -11843,8 +11723,7 @@ "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "<DEFAULT>", "x-nullable": true }, "array": { @@ -11852,6 +11731,12 @@ "description": "Is attribute an array?", "default": false, "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", + "default": false, + "x-example": false } }, "required": [ @@ -11863,10 +11748,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text\/{key}": { "patch": { - "summary": "Update URL attribute", - "operationId": "databasesUpdateUrlAttribute", + "summary": "Update text attribute", + "operationId": "databasesUpdateTextAttribute", "consumes": [ "application\/json" ], @@ -11876,23 +11761,23 @@ "tags": [ "databases" ], - "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a text attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeURL", + "description": "AttributeText", "schema": { - "$ref": "#\/definitions\/attributeUrl" + "$ref": "#\/definitions\/attributeText" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateUrlAttribute", + "method": "updateTextAttribute", "group": "attributes", - "weight": 315, + "weight": 297, "cookies": false, "type": "", - "demo": "databases\/update-url-attribute.md", + "demo": "databases\/update-text-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11903,11 +11788,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateUrlColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-text-attribute.md", "auth": { "Project": [], "Key": [] @@ -11930,7 +11811,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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>", @@ -11959,8 +11840,7 @@ "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "<DEFAULT>", "x-nullable": true }, "newKey": { @@ -11980,10 +11860,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { "post": { - "summary": "Create varchar attribute", - "operationId": "databasesCreateVarcharAttribute", + "summary": "Create URL attribute", + "operationId": "databasesCreateUrlAttribute", "consumes": [ "application\/json" ], @@ -11993,23 +11873,23 @@ "tags": [ "databases" ], - "description": "Create a varchar attribute.\n", + "description": "Create a URL attribute.\n", "responses": { "202": { - "description": "AttributeVarchar", + "description": "AttributeURL", "schema": { - "$ref": "#\/definitions\/attributeVarchar" + "$ref": "#\/definitions\/attributeUrl" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createVarcharAttribute", + "method": "createUrlAttribute", "group": "attributes", - "weight": 316, + "weight": 292, "cookies": false, "type": "", - "demo": "databases\/create-varchar-attribute.md", + "demo": "databases\/create-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12020,7 +11900,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createUrlColumn" + }, "auth": { "Project": [], "Key": [] @@ -12043,7 +11927,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>", @@ -12061,13 +11945,6 @@ "default": null, "x-example": null }, - "size": { - "type": "integer", - "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", - "default": null, - "x-example": 1, - "format": "int32" - }, "required": { "type": "boolean", "description": "Is attribute required?", @@ -12078,7 +11955,8 @@ "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "<DEFAULT>", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "array": { @@ -12086,17 +11964,10 @@ "description": "Is attribute an array?", "default": false, "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false } }, "required": [ "key", - "size", "required" ] } @@ -12104,10 +11975,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { "patch": { - "summary": "Update varchar attribute", - "operationId": "databasesUpdateVarcharAttribute", + "summary": "Update URL attribute", + "operationId": "databasesUpdateUrlAttribute", "consumes": [ "application\/json" ], @@ -12117,23 +11988,23 @@ "tags": [ "databases" ], - "description": "Update a varchar attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeVarchar", + "description": "AttributeURL", "schema": { - "$ref": "#\/definitions\/attributeVarchar" + "$ref": "#\/definitions\/attributeUrl" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateVarcharAttribute", + "method": "updateUrlAttribute", "group": "attributes", - "weight": 317, + "weight": 293, "cookies": false, "type": "", - "demo": "databases\/update-varchar-attribute.md", + "demo": "databases\/update-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12144,7 +12015,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateUrlColumn" + }, "auth": { "Project": [], "Key": [] @@ -12167,7 +12042,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>", @@ -12196,15 +12071,8 @@ "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "<DEFAULT>", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar attribute.", - "default": null, - "x-example": 1, - "format": "int32", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "newKey": { @@ -12224,80 +12092,47 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { - "get": { - "summary": "Get attribute", - "operationId": "databasesGetAttribute", - "consumes": [], + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar": { + "post": { + "summary": "Create varchar attribute", + "operationId": "databasesCreateVarcharAttribute", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Get attribute by ID.", + "description": "Create a varchar attribute.\n", "responses": { - "200": { - "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", + "202": { + "description": "AttributeVarchar", "schema": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/attributeBoolean" - }, - { - "$ref": "#\/definitions\/attributeInteger" - }, - { - "$ref": "#\/definitions\/attributeFloat" - }, - { - "$ref": "#\/definitions\/attributeEmail" - }, - { - "$ref": "#\/definitions\/attributeEnum" - }, - { - "$ref": "#\/definitions\/attributeUrl" - }, - { - "$ref": "#\/definitions\/attributeIp" - }, - { - "$ref": "#\/definitions\/attributeDatetime" - }, - { - "$ref": "#\/definitions\/attributeRelationship" - }, - { - "$ref": "#\/definitions\/attributeString" - } - ] + "$ref": "#\/definitions\/attributeVarchar" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getAttribute", + "method": "createVarcharAttribute", "group": "attributes", - "weight": 287, + "weight": 294, "cookies": false, "type": "", - "demo": "databases\/get-attribute.md", + "demo": "databases\/create-varchar-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "collections.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.getColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-varchar-attribute.md", "auth": { "Project": [], "Key": [] @@ -12320,7 +12155,131 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "default": null, + "x-example": null + }, + "size": { + "type": "integer", + "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "default": null, + "x-example": "<DEFAULT>", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar\/{key}": { + "patch": { + "summary": "Update varchar attribute", + "operationId": "databasesUpdateVarcharAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Update a varchar attribute. Changing the `default` value will not update already existing documents.\n", + "responses": { + "200": { + "description": "AttributeVarchar", + "schema": { + "$ref": "#\/definitions\/attributeVarchar" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateVarcharAttribute", + "group": "attributes", + "weight": 295, + "cookies": false, + "type": "", + "demo": "databases\/update-varchar-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-varchar-attribute.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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>", @@ -12332,47 +12291,124 @@ "required": true, "type": "string", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "default": null, + "x-example": "<DEFAULT>", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the varchar attribute.", + "default": null, + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] - }, - "delete": { - "summary": "Delete attribute", - "operationId": "databasesDeleteAttribute", - "consumes": [ + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { + "get": { + "summary": "Get attribute", + "operationId": "databasesGetAttribute", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ "databases" ], - "description": "Deletes an attribute.", + "description": "Get attribute by ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", + "schema": { + "x-oneOf": [ + { + "$ref": "#\/definitions\/attributeBoolean" + }, + { + "$ref": "#\/definitions\/attributeInteger" + }, + { + "$ref": "#\/definitions\/attributeFloat" + }, + { + "$ref": "#\/definitions\/attributeEmail" + }, + { + "$ref": "#\/definitions\/attributeEnum" + }, + { + "$ref": "#\/definitions\/attributeUrl" + }, + { + "$ref": "#\/definitions\/attributeIp" + }, + { + "$ref": "#\/definitions\/attributeDatetime" + }, + { + "$ref": "#\/definitions\/attributeRelationship" + }, + { + "$ref": "#\/definitions\/attributeString" + } + ] + } } }, "deprecated": true, "x-appwrite": { - "method": "deleteAttribute", + "method": "getAttribute", "group": "attributes", - "weight": 288, + "weight": 265, "cookies": false, "type": "", - "demo": "databases\/delete-attribute.md", + "demo": "databases\/get-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "collections.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteColumn" + "replaceWith": "tablesDB.getColumn" }, "auth": { "Project": [], @@ -12410,38 +12446,31 @@ "in": "path" } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship": { - "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", + }, + "delete": { + "summary": "Delete attribute", + "operationId": "databasesDeleteAttribute", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "databases" ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "description": "Deletes an attribute.", "responses": { - "200": { - "description": "AttributeRelationship", - "schema": { - "$ref": "#\/definitions\/attributeRelationship" - } + "204": { + "description": "No content" } }, "deprecated": true, "x-appwrite": { - "method": "updateRelationshipAttribute", + "method": "deleteAttribute", "group": "attributes", - "weight": 311, + "weight": 266, "cookies": false, "type": "", - "demo": "databases\/update-relationship-attribute.md", + "demo": "databases\/delete-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12452,10 +12481,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" + "replaceWith": "tablesDB.deleteColumn" }, "auth": { "Project": [], @@ -12491,36 +12520,6 @@ "required": true, "type": "string", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "default": null, - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - } - } } ] } @@ -12549,7 +12548,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 283, + "weight": 261, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -12627,6 +12626,16 @@ "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" } ] }, @@ -12655,7 +12664,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 275, + "weight": 253, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -12850,7 +12859,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 280, + "weight": 258, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -12987,7 +12996,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 278, + "weight": 256, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -13092,7 +13101,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 282, + "weight": 260, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -13191,7 +13200,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 276, + "weight": 254, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -13296,7 +13305,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 279, + "weight": 257, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -13450,7 +13459,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 277, + "weight": 255, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -13562,7 +13571,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 281, + "weight": 259, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -13665,7 +13674,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 286, + "weight": 264, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -13790,7 +13799,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 285, + "weight": 263, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -13913,7 +13922,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 327, + "weight": 305, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -14008,7 +14017,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 324, + "weight": 302, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -14149,7 +14158,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 325, + "weight": 303, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -14225,7 +14234,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 326, + "weight": 304, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -14306,7 +14315,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 561, + "weight": 401, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -14389,7 +14398,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 558, + "weight": 556, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -14470,9 +14479,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -14527,7 +14533,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -14652,6 +14744,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -14696,11 +14790,24 @@ "default": "", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Build specification for the function deployments.", + "default": {}, + "x-example": null + }, + "runtimeSpecification": { "type": "string", - "description": "Runtime specification for the function and builds.", + "description": "Runtime specification for the function executions.", "default": {}, "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } }, "required": [ @@ -14737,7 +14844,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 563, + "weight": 403, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -14788,7 +14895,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 564, + "weight": 404, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -14839,7 +14946,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 559, + "weight": 399, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -14900,7 +15007,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 560, + "weight": 557, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -14983,9 +15090,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -15040,7 +15144,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -15165,6 +15355,8 @@ "assistant.read", "tokens.read", "tokens.write", + "webhooks.read", + "webhooks.write", "policies.write", "policies.read", "archives.read", @@ -15210,11 +15402,24 @@ "default": "", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Build specification for the function deployments.", + "default": {}, + "x-example": null + }, + "runtimeSpecification": { "type": "string", - "description": "Runtime specification for the function and builds.", + "description": "Runtime specification for the function executions.", "default": {}, "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } }, "required": [ @@ -15244,7 +15449,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 562, + "weight": 402, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -15307,7 +15512,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 567, + "weight": 407, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -15386,7 +15591,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 568, + "weight": 408, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -15477,7 +15682,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 565, + "weight": 405, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -15571,7 +15776,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 573, + "weight": 413, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -15658,7 +15863,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 570, + "weight": 410, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -15780,7 +15985,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 571, + "weight": 411, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -15878,7 +16083,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 566, + "weight": 406, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -15942,7 +16147,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 569, + "weight": 409, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -16011,7 +16216,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 572, + "weight": 412, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -16098,7 +16303,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 574, + "weight": 414, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -16167,7 +16372,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 577, + "weight": 417, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -16252,7 +16457,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 575, + "weight": 415, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -16373,7 +16578,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 576, + "weight": 416, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -16440,7 +16645,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 578, + "weight": 418, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -16509,7 +16714,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 583, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -16570,7 +16775,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 581, + "weight": 558, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -16662,7 +16867,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 582, + "weight": 422, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -16731,7 +16936,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 584, + "weight": 424, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -16827,7 +17032,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 585, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -16898,7 +17103,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 176, + "weight": 154, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -16975,7 +17180,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 175, + "weight": 153, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -17050,7 +17255,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 450, + "weight": 428, "cookies": false, "type": "", "demo": "health\/get.md", @@ -17102,7 +17307,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 459, + "weight": 437, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -17154,7 +17359,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 453, + "weight": 431, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -17206,7 +17411,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 456, + "weight": 434, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -17243,6 +17448,78 @@ ] } }, + "\/health\/console-pausing": { + "get": { + "summary": "Get console pausing health", + "operationId": "healthGetConsolePausing", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "health" + ], + "description": "Get console pausing health status. Monitors projects approaching the pause threshold to detect potential issues with console access tracking.\n", + "responses": { + "200": { + "description": "Health Status", + "schema": { + "$ref": "#\/definitions\/healthStatus" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getConsolePausing", + "group": null, + "weight": 688, + "cookies": false, + "type": "", + "demo": "health\/get-console-pausing.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-console-pausing.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "threshold", + "description": "Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.", + "required": false, + "type": "integer", + "format": "int32", + "default": 10, + "in": "query" + }, + { + "name": "inactivityDays", + "description": "Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.", + "required": false, + "type": "integer", + "format": "int32", + "default": 7, + "in": "query" + } + ] + } + }, "\/health\/db": { "get": { "summary": "Get DB", @@ -17267,7 +17544,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 452, + "weight": 430, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -17319,7 +17596,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 454, + "weight": 432, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -17371,7 +17648,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 460, + "weight": 438, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -17434,7 +17711,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 734, + "weight": 684, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -17497,7 +17774,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 733, + "weight": 683, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -17560,7 +17837,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 464, + "weight": 442, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -17623,7 +17900,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 735, + "weight": 685, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -17686,7 +17963,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 463, + "weight": 441, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -17749,7 +18026,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 465, + "weight": 443, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -17821,7 +18098,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 466, + "weight": 444, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -17884,7 +18161,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 473, + "weight": 451, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -17972,7 +18249,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 470, + "weight": 448, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -18035,7 +18312,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 462, + "weight": 440, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -18098,7 +18375,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 467, + "weight": 445, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -18161,7 +18438,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 468, + "weight": 446, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -18224,7 +18501,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 469, + "weight": 447, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -18287,7 +18564,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 736, + "weight": 686, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -18350,7 +18627,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 471, + "weight": 449, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -18413,7 +18690,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 472, + "weight": 450, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -18476,7 +18753,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 737, + "weight": 687, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -18539,7 +18816,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 461, + "weight": 439, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -18602,7 +18879,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 458, + "weight": 436, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -18654,7 +18931,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 457, + "weight": 435, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -18706,7 +18983,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 455, + "weight": 433, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -19198,7 +19475,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 231, + "weight": 209, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -19284,7 +19561,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 228, + "weight": 206, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -19445,7 +19722,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 235, + "weight": 213, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -19613,7 +19890,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 230, + "weight": 208, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -19813,7 +20090,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 237, + "weight": 215, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -20028,7 +20305,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 229, + "weight": 207, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -20221,7 +20498,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 236, + "weight": 214, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -20413,7 +20690,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 234, + "weight": 212, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -20470,7 +20747,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 238, + "weight": 216, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -20532,7 +20809,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 232, + "weight": 210, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -20615,7 +20892,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 233, + "weight": 211, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -20698,7 +20975,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 202, + "weight": 180, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -20784,7 +21061,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 201, + "weight": 179, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -20976,7 +21253,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 215, + "weight": 193, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -21165,7 +21442,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 200, + "weight": 178, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -21326,7 +21603,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 214, + "weight": 192, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -21483,7 +21760,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 191, + "weight": 169, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -21616,7 +21893,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 205, + "weight": 183, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -21746,7 +22023,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 195, + "weight": 173, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -21852,7 +22129,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 209, + "weight": 187, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -21956,7 +22233,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 193, + "weight": 171, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -22076,7 +22353,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 207, + "weight": 185, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -22193,7 +22470,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 192, + "weight": 170, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -22313,7 +22590,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 206, + "weight": 184, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -22430,7 +22707,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 194, + "weight": 172, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -22683,7 +22960,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 208, + "weight": 186, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -22930,7 +23207,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 196, + "weight": 174, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -23037,7 +23314,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 210, + "weight": 188, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -23141,7 +23418,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 197, + "weight": 175, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -23248,7 +23525,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 211, + "weight": 189, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -23352,7 +23629,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 198, + "weight": 176, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -23459,7 +23736,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 212, + "weight": 190, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -23563,7 +23840,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 199, + "weight": 177, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -23670,7 +23947,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 213, + "weight": 191, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -23772,7 +24049,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 204, + "weight": 182, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -23829,7 +24106,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 216, + "weight": 194, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -23891,7 +24168,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 203, + "weight": 181, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -23974,7 +24251,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 225, + "weight": 203, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -24057,7 +24334,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 218, + "weight": 196, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -24141,7 +24418,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 217, + "weight": 195, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -24231,7 +24508,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 220, + "weight": 198, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -24293,7 +24570,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 221, + "weight": 199, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -24376,7 +24653,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 222, + "weight": 200, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -24438,7 +24715,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 219, + "weight": 197, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -24521,7 +24798,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 224, + "weight": 202, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -24558,7 +24835,7 @@ }, { "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: name, provider, type, enabled", + "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: targetId, topicId, userId, providerType", "required": false, "type": "array", "collectionFormat": "multi", @@ -24613,7 +24890,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 223, + "weight": 201, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -24703,7 +24980,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 226, + "weight": 204, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -24768,7 +25045,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 227, + "weight": 205, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -24841,7 +25118,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 590, + "weight": 455, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -24924,7 +25201,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 588, + "weight": 559, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -25024,6 +25301,12 @@ "default": "", "x-example": "<BUILD_COMMAND>" }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "default": "", + "x-example": "<START_COMMAND>" + }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", @@ -25067,9 +25350,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -25124,7 +25404,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -25177,11 +25543,24 @@ "default": "", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "default": {}, + "x-example": null + }, + "runtimeSpecification": { "type": "string", - "description": "Framework specification for the site and builds.", + "description": "Runtime specification for the SSR executions.", "default": {}, "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } }, "required": [ @@ -25219,7 +25598,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 593, + "weight": 458, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -25270,7 +25649,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 616, + "weight": 481, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -25321,7 +25700,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 589, + "weight": 454, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -25382,7 +25761,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 591, + "weight": 560, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -25484,6 +25863,12 @@ "default": "", "x-example": "<BUILD_COMMAND>" }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "default": "", + "x-example": "<START_COMMAND>" + }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", @@ -25527,9 +25912,6 @@ "python-ml-3.11", "python-ml-3.12", "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", "deno-1.40", "deno-1.46", "deno-2.0", @@ -25584,7 +25966,93 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" ], "x-enum-name": null, "x-enum-keys": [] @@ -25637,11 +26105,24 @@ "default": "", "x-example": "<PROVIDER_ROOT_DIRECTORY>" }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "default": {}, + "x-example": null + }, + "runtimeSpecification": { "type": "string", - "description": "Framework specification for the site and builds.", + "description": "Runtime specification for the SSR executions.", "default": {}, "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } }, "required": [ @@ -25672,7 +26153,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 592, + "weight": 457, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -25735,7 +26216,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 599, + "weight": 464, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -25814,7 +26295,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 598, + "weight": 463, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -25905,7 +26386,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 594, + "weight": 459, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -25973,9 +26454,10 @@ { "name": "activate", "description": "Automatically activate the deployment when it is finished building.", - "required": true, + "required": false, "type": "boolean", "x-example": false, + "default": false, "in": "formData" } ] @@ -26007,7 +26489,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 602, + "weight": 467, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -26088,7 +26570,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 595, + "weight": 460, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -26210,7 +26692,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 596, + "weight": 461, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -26309,7 +26791,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 597, + "weight": 462, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -26373,7 +26855,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 600, + "weight": 465, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -26442,7 +26924,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 601, + "weight": 466, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -26529,7 +27011,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 603, + "weight": 468, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -26598,7 +27080,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 605, + "weight": 470, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -26680,7 +27162,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 604, + "weight": 469, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -26746,7 +27228,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 606, + "weight": 471, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -26815,7 +27297,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 609, + "weight": 474, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -26876,7 +27358,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 607, + "weight": 561, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -26968,7 +27450,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 608, + "weight": 473, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -27037,7 +27519,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 610, + "weight": 475, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -27133,7 +27615,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 611, + "weight": 476, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -27202,7 +27684,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 530, + "weight": 522, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -27286,7 +27768,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 528, + "weight": 520, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -27434,7 +27916,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 529, + "weight": 521, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -27496,7 +27978,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 531, + "weight": 523, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -27640,7 +28122,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 532, + "weight": 524, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -27702,7 +28184,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 535, + "weight": 527, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -27797,7 +28279,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 781, + "weight": 734, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -27890,7 +28372,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 534, + "weight": 526, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -27963,7 +28445,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 536, + "weight": 528, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -28056,7 +28538,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 537, + "weight": 529, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -28129,7 +28611,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 539, + "weight": 531, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -28211,7 +28693,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 538, + "weight": 530, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -28421,7 +28903,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 540, + "weight": 532, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -28503,7 +28985,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 338, + "weight": 316, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -28587,7 +29069,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 334, + "weight": 312, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -28672,7 +29154,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 405, + "weight": 383, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -28744,7 +29226,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 401, + "weight": 379, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -28820,7 +29302,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 402, + "weight": 380, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -28888,7 +29370,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 403, + "weight": 381, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -28972,7 +29454,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 404, + "weight": 382, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -29042,7 +29524,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 406, + "weight": 384, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -29128,7 +29610,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 335, + "weight": 313, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -29190,7 +29672,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 336, + "weight": 314, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -29268,7 +29750,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 337, + "weight": 315, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -29330,7 +29812,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 345, + "weight": 323, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -29425,7 +29907,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 341, + "weight": 319, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -29555,7 +30037,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 342, + "weight": 320, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -29628,7 +30110,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 343, + "weight": 321, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -29733,7 +30215,7 @@ "x-appwrite": { "method": "deleteTable", "group": "tables", - "weight": 344, + "weight": 322, "cookies": false, "type": "", "demo": "tablesdb\/delete-table.md", @@ -29806,7 +30288,7 @@ "x-appwrite": { "method": "listColumns", "group": "columns", - "weight": 350, + "weight": 328, "cookies": false, "type": "", "demo": "tablesdb\/list-columns.md", @@ -29902,7 +30384,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 351, + "weight": 329, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -30015,7 +30497,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 352, + "weight": 330, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -30130,7 +30612,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 353, + "weight": 331, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -30243,7 +30725,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 354, + "weight": 332, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -30358,7 +30840,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 355, + "weight": 333, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -30472,7 +30954,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 356, + "weight": 334, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -30588,7 +31070,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 357, + "weight": 335, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -30711,7 +31193,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 358, + "weight": 336, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -30836,7 +31318,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 359, + "weight": 337, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -30966,7 +31448,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 360, + "weight": 338, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -31098,7 +31580,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 361, + "weight": 339, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -31228,7 +31710,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 362, + "weight": 340, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -31360,7 +31842,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 363, + "weight": 341, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -31473,7 +31955,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 364, + "weight": 342, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -31588,7 +32070,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 365, + "weight": 343, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -31695,7 +32177,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 366, + "weight": 344, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -31809,7 +32291,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 383, + "weight": 361, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -31928,7 +32410,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 384, + "weight": 362, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -32043,7 +32525,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 381, + "weight": 359, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -32162,7 +32644,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 382, + "weight": 360, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -32277,7 +32759,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 367, + "weight": 345, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -32384,7 +32866,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 368, + "weight": 346, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -32498,7 +32980,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 369, + "weight": 347, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -32605,7 +33087,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 370, + "weight": 348, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -32719,7 +33201,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 371, + "weight": 349, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -32860,7 +33342,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 373, + "weight": 351, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -32991,7 +33473,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 374, + "weight": 352, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -33118,7 +33600,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 379, + "weight": 357, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -33237,7 +33719,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 380, + "weight": 358, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -33352,7 +33834,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 375, + "weight": 353, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -33466,7 +33948,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 376, + "weight": 354, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -33582,7 +34064,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 377, + "weight": 355, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -33709,7 +34191,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 378, + "weight": 356, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -33861,7 +34343,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 348, + "weight": 326, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -33936,7 +34418,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 349, + "weight": 327, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -34018,7 +34500,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 372, + "weight": 350, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -34128,7 +34610,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 388, + "weight": 366, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -34222,7 +34704,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 385, + "weight": 363, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -34362,7 +34844,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 386, + "weight": 364, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -34437,7 +34919,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 387, + "weight": 365, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -34517,7 +34999,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 397, + "weight": 375, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -34594,6 +35076,16 @@ "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" } ] }, @@ -34622,7 +35114,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 389, + "weight": 367, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -34808,7 +35300,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 394, + "weight": 372, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -34940,7 +35432,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 392, + "weight": 370, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -35044,7 +35536,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 396, + "weight": 374, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -35142,7 +35634,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 390, + "weight": 368, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -35246,7 +35738,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 393, + "weight": 371, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -35395,7 +35887,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 391, + "weight": 369, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -35506,7 +35998,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 395, + "weight": 373, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -35608,7 +36100,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 400, + "weight": 378, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -35732,7 +36224,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 399, + "weight": 377, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -35854,7 +36346,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 107, + "weight": 503, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -35941,7 +36433,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 106, + "weight": 501, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -36034,7 +36526,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 108, + "weight": 502, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -36099,7 +36591,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 110, + "weight": 505, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -36177,7 +36669,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 112, + "weight": 504, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -36242,7 +36734,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 114, + "weight": 510, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -36337,7 +36829,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 113, + "weight": 508, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -36403,7 +36895,7 @@ }, "roles": { "type": "array", - "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "default": null, "x-example": null, "items": { @@ -36456,7 +36948,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 115, + "weight": 509, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -36505,7 +36997,7 @@ ] }, "patch": { - "summary": "Update membership", + "summary": "Update team membership", "operationId": "teamsUpdateMembership", "consumes": [ "application\/json" @@ -36529,7 +37021,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 116, + "weight": 511, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -36583,7 +37075,7 @@ "properties": { "roles": { "type": "array", - "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "default": null, "x-example": null, "items": { @@ -36604,9 +37096,7 @@ "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "teams" ], @@ -36619,8 +37109,8 @@ "deprecated": false, "x-appwrite": { "method": "deleteMembership", - "group": null, - "weight": 555, + "group": "memberships", + "weight": 735, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -36695,7 +37185,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 117, + "weight": 513, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -36792,7 +37282,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 109, + "weight": 506, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -36832,7 +37322,7 @@ ] }, "put": { - "summary": "Update preferences", + "summary": "Update team preferences", "operationId": "teamsUpdatePrefs", "consumes": [ "application\/json" @@ -36856,7 +37346,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 111, + "weight": 507, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -36938,7 +37428,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 525, + "weight": 517, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -37028,7 +37518,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 523, + "weight": 515, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -37113,7 +37603,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 524, + "weight": 516, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -37174,7 +37664,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 526, + "weight": 518, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -37246,7 +37736,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 527, + "weight": 519, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -37307,7 +37797,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 129, + "weight": 109, "cookies": false, "type": "", "demo": "users\/list.md", @@ -37391,7 +37881,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 120, + "weight": 100, "cookies": false, "type": "", "demo": "users\/create.md", @@ -37493,7 +37983,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 123, + "weight": 103, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -37589,7 +38079,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 121, + "weight": 101, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -37683,7 +38173,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 137, + "weight": 117, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -37764,7 +38254,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 160, + "weight": 140, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -37828,7 +38318,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 122, + "weight": 102, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -37924,7 +38414,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 125, + "weight": 105, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -38020,7 +38510,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 126, + "weight": 106, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -38155,7 +38645,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 127, + "weight": 107, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -38272,7 +38762,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 124, + "weight": 104, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -38387,7 +38877,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 130, + "weight": 110, "cookies": false, "type": "", "demo": "users\/get.md", @@ -38444,7 +38934,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 158, + "weight": 138, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -38508,7 +38998,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 143, + "weight": 123, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -38591,7 +39081,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 161, + "weight": 141, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -38677,7 +39167,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 139, + "weight": 119, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -38760,7 +39250,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 135, + "weight": 115, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -38843,7 +39333,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 134, + "weight": 114, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -38937,7 +39427,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 148, + "weight": 128, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -39076,7 +39566,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 153, + "weight": 133, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -39211,7 +39701,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 149, + "weight": 129, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -39331,7 +39821,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 150, + "weight": 130, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -39451,7 +39941,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 152, + "weight": 132, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -39571,7 +40061,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 151, + "weight": 131, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -39693,7 +40183,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 141, + "weight": 121, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -39775,7 +40265,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 142, + "weight": 122, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -39857,7 +40347,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 144, + "weight": 124, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -39938,7 +40428,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 131, + "weight": 111, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -40000,7 +40490,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 146, + "weight": 126, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -40080,7 +40570,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 133, + "weight": 113, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -40151,7 +40641,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 154, + "weight": 134, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -40208,7 +40698,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 157, + "weight": 137, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -40267,7 +40757,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 156, + "weight": 136, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -40339,7 +40829,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 138, + "weight": 118, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -40419,7 +40909,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 136, + "weight": 116, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -40502,7 +40992,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 128, + "weight": 108, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -40615,7 +41105,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 132, + "weight": 112, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -40685,7 +41175,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 147, + "weight": 127, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -40777,7 +41267,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 159, + "weight": 139, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -40849,7 +41339,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 155, + "weight": 135, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -40936,7 +41426,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 145, + "weight": 125, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -41018,7 +41508,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 140, + "weight": 120, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -41073,6 +41563,499 @@ } ] } + }, + "\/webhooks": { + "get": { + "summary": "List webhooks", + "operationId": "webhooksList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Webhooks List", + "schema": { + "$ref": "#\/definitions\/webhookList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 550, + "cookies": false, + "type": "", + "demo": "webhooks\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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. You may filter on the following attributes: name, url, httpUser, security, events, enabled, logs, attempts", + "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 webhook", + "operationId": "webhooksCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "responses": { + "201": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 549, + "cookies": false, + "type": "", + "demo": "webhooks\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "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.", + "default": null, + "x-example": "<WEBHOOK_ID>" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "default": null, + "x-example": null + }, + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "default": null, + "x-example": "<NAME>" + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "default": true, + "x-example": false + }, + "security": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "default": false, + "x-example": false + }, + "httpUser": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "default": "", + "x-example": "<HTTP_USER>" + }, + "httpPass": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "default": "", + "x-example": "<HTTP_PASS>" + } + }, + "required": [ + "webhookId", + "url", + "name", + "events" + ] + } + } + ] + } + }, + "\/webhooks\/{webhookId}": { + "get": { + "summary": "Get webhook", + "operationId": "webhooksGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 551, + "cookies": false, + "type": "", + "demo": "webhooks\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "<WEBHOOK_ID>", + "in": "path" + } + ] + }, + "put": { + "summary": "Update webhook", + "operationId": "webhooksUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 553, + "cookies": false, + "type": "", + "demo": "webhooks\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "<WEBHOOK_ID>", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "default": null, + "x-example": "<NAME>" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "default": null, + "x-example": null + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "default": true, + "x-example": false + }, + "security": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "default": false, + "x-example": false + }, + "httpUser": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "default": "", + "x-example": "<HTTP_USER>" + }, + "httpPass": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "default": "", + "x-example": "<HTTP_PASS>" + } + }, + "required": [ + "name", + "url", + "events" + ] + } + } + ] + }, + "delete": { + "summary": "Delete webhook", + "operationId": "webhooksDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "webhooks" + ], + "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 552, + "cookies": false, + "type": "", + "demo": "webhooks\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "<WEBHOOK_ID>", + "in": "path" + } + ] + } + }, + "\/webhooks\/{webhookId}\/signature": { + "patch": { + "summary": "Update webhook signature key", + "operationId": "webhooksUpdateSignature", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSignature", + "group": null, + "weight": 554, + "cookies": false, + "type": "", + "demo": "webhooks\/update-signature.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "<WEBHOOK_ID>", + "in": "path" + } + ] + } } }, "tags": [ @@ -41794,6 +42777,35 @@ "executions": "" } }, + "webhookList": { + "description": "Webhooks List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of webhooks that matched your query.", + "x-example": 5, + "format": "int32" + }, + "webhooks": { + "type": "array", + "description": "List of webhooks.", + "items": { + "type": "object", + "$ref": "#\/definitions\/webhook" + }, + "x-example": "" + } + }, + "required": [ + "total", + "webhooks" + ], + "example": { + "total": 5, + "webhooks": "" + } + }, "countryList": { "description": "Countries List", "type": "object", @@ -46205,8 +47217,8 @@ }, "$sequence": { "type": "integer", - "description": "Row automatically incrementing ID.", - "x-example": 1, + "description": "Row sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -46255,7 +47267,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$tableId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -46276,8 +47288,8 @@ }, "$sequence": { "type": "integer", - "description": "Document automatically incrementing ID.", - "x-example": 1, + "description": "Document sequence ID.", + "x-example": "1", "format": "int32", "readOnly": true }, @@ -46326,7 +47338,7 @@ ], "example": { "$id": "5e5ea5c16897e", - "$sequence": 1, + "$sequence": "1", "$collectionId": "5e5ea5c15117e", "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -47856,6 +48868,12 @@ "description": "Site framework.", "x-example": "react" }, + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, "deploymentId": { "type": "string", "description": "Site's active deployment ID.", @@ -47916,6 +48934,11 @@ "description": "The build command used to build the site.", "x-example": "npm run build" }, + "startCommand": { + "type": "string", + "description": "Custom command to use when starting site runtime.", + "x-example": "node custom-server.mjs" + }, "outputDirectory": { "type": "string", "description": "The directory where the site build output is located.", @@ -47946,9 +48969,14 @@ "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", "x-example": false }, - "specification": { + "buildSpecification": { + "type": "string", + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { "type": "string", - "description": "Machine specification for builds and executions.", + "description": "Machine specification for SSR executions.", "x-example": "s-1vcpu-512mb" }, "buildRuntime": { @@ -47976,6 +49004,7 @@ "live", "logging", "framework", + "deploymentRetention", "deploymentId", "deploymentCreatedAt", "deploymentScreenshotLight", @@ -47987,13 +49016,15 @@ "timeout", "installCommand", "buildCommand", + "startCommand", "outputDirectory", "installationId", "providerRepositoryId", "providerBranch", "providerRootDirectory", "providerSilentMode", - "specification", + "buildSpecification", + "runtimeSpecification", "buildRuntime", "adapter", "fallbackFile" @@ -48007,6 +49038,7 @@ "live": false, "logging": false, "framework": "react", + "deploymentRetention": 7, "deploymentId": "5e5ea5c16897e", "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", "deploymentScreenshotLight": "5e5ea5c16897e", @@ -48018,13 +49050,15 @@ "timeout": 300, "installCommand": "npm install", "buildCommand": "npm run build", + "startCommand": "node custom-server.mjs", "outputDirectory": "build", "installationId": "6m40at4ejk5h2u9s1hboo", "providerRepositoryId": "appwrite", "providerBranch": "main", "providerRootDirectory": "sites\/helloWorld", "providerSilentMode": false, - "specification": "s-1vcpu-512mb", + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb", "buildRuntime": "node-22", "adapter": "static", "fallbackFile": "index.html" @@ -48082,6 +49116,12 @@ "description": "Function execution and build runtime.", "x-example": "python-3.8" }, + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, "deploymentId": { "type": "string", "description": "Function's active deployment ID.", @@ -48183,9 +49223,14 @@ "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", "x-example": false }, - "specification": { + "buildSpecification": { "type": "string", - "description": "Machine specification for builds and executions.", + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { + "type": "string", + "description": "Machine specification for executions.", "x-example": "s-1vcpu-512mb" } }, @@ -48199,6 +49244,7 @@ "live", "logging", "runtime", + "deploymentRetention", "deploymentId", "deploymentCreatedAt", "latestDeploymentId", @@ -48217,7 +49263,8 @@ "providerBranch", "providerRootDirectory", "providerSilentMode", - "specification" + "buildSpecification", + "runtimeSpecification" ], "example": { "$id": "5e5ea5c16897e", @@ -48229,6 +49276,7 @@ "live": false, "logging": false, "runtime": "python-3.8", + "deploymentRetention": 7, "deploymentId": "5e5ea5c16897e", "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", "latestDeploymentId": "5e5ea5c16897e", @@ -48247,7 +49295,8 @@ "providerBranch": "main", "providerRootDirectory": "functions\/helloWorld", "providerSilentMode": false, - "specification": "s-1vcpu-512mb" + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb" } }, "runtime": { @@ -48830,6 +49879,117 @@ "scheduledAt": "2020-10-15T06:38:00.000+00:00" } }, + "webhook": { + "description": "Webhook", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Webhook ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Webhook creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Webhook update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Webhook name.", + "x-example": "My Webhook" + }, + "url": { + "type": "string", + "description": "Webhook URL endpoint.", + "x-example": "https:\/\/example.com\/webhook" + }, + "events": { + "type": "array", + "description": "Webhook trigger events.", + "items": { + "type": "string" + }, + "x-example": [ + "databases.tables.update", + "databases.collections.update" + ] + }, + "security": { + "type": "boolean", + "description": "Indicated if SSL \/ TLS Certificate verification is enabled.", + "x-example": true + }, + "httpUser": { + "type": "string", + "description": "HTTP basic authentication username.", + "x-example": "username" + }, + "httpPass": { + "type": "string", + "description": "HTTP basic authentication password.", + "x-example": "password" + }, + "signatureKey": { + "type": "string", + "description": "Signature key which can be used to validated incoming", + "x-example": "ad3d581ca230e2b7059c545e5a" + }, + "enabled": { + "type": "boolean", + "description": "Indicates if this webhook is enabled.", + "x-example": true + }, + "logs": { + "type": "string", + "description": "Webhook error logs from the most recent failure.", + "x-example": "Failed to connect to remote server." + }, + "attempts": { + "type": "integer", + "description": "Number of consecutive failed webhook attempts.", + "x-example": 10, + "format": "int32" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "url", + "events", + "security", + "httpUser", + "httpPass", + "signatureKey", + "enabled", + "logs", + "attempts" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Webhook", + "url": "https:\/\/example.com\/webhook", + "events": [ + "databases.tables.update", + "databases.collections.update" + ], + "security": true, + "httpUser": "username", + "httpPass": "password", + "signatureKey": "ad3d581ca230e2b7059c545e5a", + "enabled": true, + "logs": "Failed to connect to remote server.", + "attempts": 10 + } + }, "variable": { "description": "Variable", "type": "object",