@appwrite.io/console 2.2.0 → 2.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/README.md +1 -1
- package/dist/cjs/sdk.js +412 -202
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +412 -203
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +412 -202
- package/docs/examples/account/create-anonymous-session.md +2 -0
- package/docs/examples/account/create-billing-address.md +2 -0
- package/docs/examples/account/create-email-password-session.md +2 -0
- package/docs/examples/account/create-email-token.md +2 -0
- package/docs/examples/account/create-email-verification.md +2 -0
- package/docs/examples/account/create-jwt.md +2 -0
- package/docs/examples/account/create-key.md +2 -0
- package/docs/examples/account/create-magic-url-token.md +2 -0
- package/docs/examples/account/create-mfa-authenticator.md +2 -0
- package/docs/examples/account/create-mfa-challenge.md +2 -0
- package/docs/examples/account/create-mfa-recovery-codes.md +2 -0
- package/docs/examples/account/create-o-auth-2-session.md +2 -0
- package/docs/examples/account/create-o-auth-2-token.md +2 -0
- package/docs/examples/account/create-payment-method.md +2 -0
- package/docs/examples/account/create-phone-token.md +2 -0
- package/docs/examples/account/create-phone-verification.md +2 -0
- package/docs/examples/account/create-push-target.md +2 -0
- package/docs/examples/account/create-recovery.md +2 -0
- package/docs/examples/account/create-session.md +2 -0
- package/docs/examples/account/create-verification.md +2 -0
- package/docs/examples/account/create.md +2 -0
- package/docs/examples/account/delete-billing-address.md +2 -0
- package/docs/examples/account/delete-identity.md +2 -0
- package/docs/examples/account/delete-key.md +2 -0
- package/docs/examples/account/delete-mfa-authenticator.md +2 -0
- package/docs/examples/account/delete-payment-method.md +2 -0
- package/docs/examples/account/delete-push-target.md +2 -0
- package/docs/examples/account/delete-session.md +2 -0
- package/docs/examples/account/delete-sessions.md +2 -0
- package/docs/examples/account/delete.md +2 -0
- package/docs/examples/account/get-billing-address.md +2 -0
- package/docs/examples/account/get-coupon.md +2 -0
- package/docs/examples/account/get-key.md +2 -0
- package/docs/examples/account/get-mfa-recovery-codes.md +2 -0
- package/docs/examples/account/get-payment-method.md +2 -0
- package/docs/examples/account/get-prefs.md +2 -0
- package/docs/examples/account/get-session.md +2 -0
- package/docs/examples/account/get.md +2 -0
- package/docs/examples/account/list-billing-addresses.md +2 -0
- package/docs/examples/account/list-identities.md +2 -0
- package/docs/examples/account/list-invoices.md +2 -0
- package/docs/examples/account/list-keys.md +2 -0
- package/docs/examples/account/list-logs.md +2 -0
- package/docs/examples/account/list-mfa-factors.md +2 -0
- package/docs/examples/account/list-payment-methods.md +2 -0
- package/docs/examples/account/list-sessions.md +2 -0
- package/docs/examples/account/update-billing-address.md +2 -0
- package/docs/examples/account/update-email-verification.md +2 -0
- package/docs/examples/account/update-email.md +2 -0
- package/docs/examples/account/update-key.md +2 -0
- package/docs/examples/account/update-magic-url-session.md +2 -0
- package/docs/examples/account/update-mfa-authenticator.md +2 -0
- package/docs/examples/account/update-mfa-challenge.md +2 -0
- package/docs/examples/account/update-mfa-recovery-codes.md +2 -0
- package/docs/examples/account/update-mfa.md +2 -0
- package/docs/examples/account/update-name.md +2 -0
- package/docs/examples/account/update-password.md +2 -0
- package/docs/examples/account/update-payment-method-mandate-options.md +2 -0
- package/docs/examples/account/update-payment-method-provider.md +2 -0
- package/docs/examples/account/update-payment-method.md +2 -0
- package/docs/examples/account/update-phone-session.md +2 -0
- package/docs/examples/account/update-phone-verification.md +2 -0
- package/docs/examples/account/update-phone.md +2 -0
- package/docs/examples/account/update-prefs.md +2 -0
- package/docs/examples/account/update-push-target.md +2 -0
- package/docs/examples/account/update-recovery.md +2 -0
- package/docs/examples/account/update-session.md +2 -0
- package/docs/examples/account/update-status.md +2 -0
- package/docs/examples/account/update-verification.md +2 -0
- package/docs/examples/activities/get-event.md +15 -0
- package/docs/examples/activities/list-events.md +15 -0
- package/docs/examples/assistant/chat.md +2 -0
- package/docs/examples/avatars/get-browser.md +2 -0
- package/docs/examples/avatars/get-credit-card.md +2 -0
- package/docs/examples/avatars/get-favicon.md +2 -0
- package/docs/examples/avatars/get-flag.md +2 -0
- package/docs/examples/avatars/get-image.md +2 -0
- package/docs/examples/avatars/get-initials.md +2 -0
- package/docs/examples/avatars/get-qr.md +2 -0
- package/docs/examples/avatars/get-screenshot.md +2 -0
- package/docs/examples/backups/create-archive.md +4 -2
- package/docs/examples/backups/create-policy.md +4 -2
- package/docs/examples/backups/create-restoration.md +4 -2
- package/docs/examples/backups/delete-archive.md +2 -0
- package/docs/examples/backups/delete-policy.md +2 -0
- package/docs/examples/backups/get-archive.md +2 -0
- package/docs/examples/backups/get-policy.md +2 -0
- package/docs/examples/backups/get-restoration.md +2 -0
- package/docs/examples/backups/list-archives.md +2 -0
- package/docs/examples/backups/list-policies.md +2 -0
- package/docs/examples/backups/list-restorations.md +2 -0
- package/docs/examples/backups/update-policy.md +2 -0
- package/docs/examples/console/create-program-membership.md +2 -0
- package/docs/examples/console/create-source.md +2 -0
- package/docs/examples/console/get-campaign.md +2 -0
- package/docs/examples/console/get-coupon.md +2 -0
- package/docs/examples/console/get-plan.md +2 -0
- package/docs/examples/console/get-plans.md +2 -0
- package/docs/examples/console/get-program.md +2 -0
- package/docs/examples/console/get-resource.md +2 -0
- package/docs/examples/console/list-regions.md +2 -0
- package/docs/examples/console/suggest-columns.md +2 -0
- package/docs/examples/console/suggest-indexes.md +2 -0
- package/docs/examples/console/variables.md +2 -0
- package/docs/examples/databases/create-boolean-attribute.md +2 -0
- package/docs/examples/databases/create-collection.md +2 -0
- package/docs/examples/databases/create-datetime-attribute.md +2 -0
- package/docs/examples/databases/create-document.md +2 -0
- package/docs/examples/databases/create-documents.md +2 -0
- package/docs/examples/databases/create-email-attribute.md +2 -0
- package/docs/examples/databases/create-enum-attribute.md +2 -0
- package/docs/examples/databases/create-float-attribute.md +2 -0
- package/docs/examples/databases/create-index.md +2 -0
- package/docs/examples/databases/create-integer-attribute.md +2 -0
- package/docs/examples/databases/create-ip-attribute.md +2 -0
- package/docs/examples/databases/create-line-attribute.md +2 -0
- package/docs/examples/databases/create-longtext-attribute.md +4 -1
- package/docs/examples/databases/create-mediumtext-attribute.md +4 -1
- package/docs/examples/databases/create-operations.md +2 -0
- package/docs/examples/databases/create-point-attribute.md +2 -0
- package/docs/examples/databases/create-polygon-attribute.md +2 -0
- package/docs/examples/databases/create-relationship-attribute.md +2 -0
- package/docs/examples/databases/create-string-attribute.md +2 -0
- package/docs/examples/databases/create-text-attribute.md +4 -1
- package/docs/examples/databases/create-transaction.md +2 -0
- package/docs/examples/databases/create-url-attribute.md +2 -0
- package/docs/examples/databases/create-varchar-attribute.md +4 -1
- package/docs/examples/databases/create.md +2 -0
- package/docs/examples/databases/decrement-document-attribute.md +2 -0
- package/docs/examples/databases/delete-attribute.md +2 -0
- package/docs/examples/databases/delete-collection.md +2 -0
- package/docs/examples/databases/delete-document.md +2 -0
- package/docs/examples/databases/delete-documents.md +2 -0
- package/docs/examples/databases/delete-index.md +2 -0
- package/docs/examples/databases/delete-transaction.md +2 -0
- package/docs/examples/databases/delete.md +2 -0
- package/docs/examples/databases/get-attribute.md +2 -0
- package/docs/examples/databases/get-collection-usage.md +2 -0
- package/docs/examples/databases/get-collection.md +2 -0
- package/docs/examples/databases/get-document.md +2 -0
- package/docs/examples/databases/get-index.md +2 -0
- package/docs/examples/databases/get-transaction.md +2 -0
- package/docs/examples/databases/get-usage.md +2 -0
- package/docs/examples/databases/get.md +2 -0
- package/docs/examples/databases/increment-document-attribute.md +2 -0
- package/docs/examples/databases/list-attributes.md +2 -0
- package/docs/examples/databases/list-collection-logs.md +2 -0
- package/docs/examples/databases/list-collections.md +2 -0
- package/docs/examples/databases/list-document-logs.md +2 -0
- package/docs/examples/databases/list-documents.md +2 -0
- package/docs/examples/databases/list-indexes.md +2 -0
- package/docs/examples/databases/list-logs.md +2 -0
- package/docs/examples/databases/list-transactions.md +2 -0
- package/docs/examples/databases/list-usage.md +2 -0
- package/docs/examples/databases/list.md +2 -0
- package/docs/examples/databases/update-boolean-attribute.md +2 -0
- package/docs/examples/databases/update-collection.md +2 -0
- package/docs/examples/databases/update-datetime-attribute.md +2 -0
- package/docs/examples/databases/update-document.md +2 -0
- package/docs/examples/databases/update-documents.md +2 -0
- package/docs/examples/databases/update-email-attribute.md +2 -0
- package/docs/examples/databases/update-enum-attribute.md +2 -0
- package/docs/examples/databases/update-float-attribute.md +2 -0
- package/docs/examples/databases/update-integer-attribute.md +2 -0
- package/docs/examples/databases/update-ip-attribute.md +2 -0
- package/docs/examples/databases/update-line-attribute.md +2 -0
- package/docs/examples/databases/update-longtext-attribute.md +2 -0
- package/docs/examples/databases/update-mediumtext-attribute.md +2 -0
- package/docs/examples/databases/update-point-attribute.md +2 -0
- package/docs/examples/databases/update-polygon-attribute.md +2 -0
- package/docs/examples/databases/update-relationship-attribute.md +2 -0
- package/docs/examples/databases/update-string-attribute.md +2 -0
- package/docs/examples/databases/update-text-attribute.md +2 -0
- package/docs/examples/databases/update-transaction.md +2 -0
- package/docs/examples/databases/update-url-attribute.md +2 -0
- package/docs/examples/databases/update-varchar-attribute.md +2 -0
- package/docs/examples/databases/update.md +2 -0
- package/docs/examples/databases/upsert-document.md +2 -0
- package/docs/examples/databases/upsert-documents.md +2 -0
- package/docs/examples/domains/create-preset-google-workspace.md +2 -0
- package/docs/examples/domains/create-preset-i-cloud.md +2 -0
- package/docs/examples/domains/create-preset-mailgun.md +2 -0
- package/docs/examples/domains/create-preset-outlook.md +2 -0
- package/docs/examples/domains/create-preset-proton-mail.md +2 -0
- package/docs/examples/domains/create-preset-zoho.md +2 -0
- package/docs/examples/domains/create-record-a.md +2 -0
- package/docs/examples/domains/create-record-aaaa.md +2 -0
- package/docs/examples/domains/create-record-alias.md +2 -0
- package/docs/examples/domains/create-record-caa.md +2 -0
- package/docs/examples/domains/create-record-cname.md +2 -0
- package/docs/examples/domains/create-record-https.md +2 -0
- package/docs/examples/domains/create-record-mx.md +2 -0
- package/docs/examples/domains/create-record-ns.md +2 -0
- package/docs/examples/domains/create-record-srv.md +2 -0
- package/docs/examples/domains/create-record-txt.md +2 -0
- package/docs/examples/domains/create.md +2 -0
- package/docs/examples/domains/delete-record.md +2 -0
- package/docs/examples/domains/delete.md +2 -0
- package/docs/examples/domains/get-preset-google-workspace.md +2 -0
- package/docs/examples/domains/get-preset-i-cloud.md +2 -0
- package/docs/examples/domains/get-preset-mailgun.md +2 -0
- package/docs/examples/domains/get-preset-outlook.md +2 -0
- package/docs/examples/domains/get-preset-proton-mail.md +2 -0
- package/docs/examples/domains/get-preset-zoho.md +2 -0
- package/docs/examples/domains/get-price.md +17 -0
- package/docs/examples/domains/get-record.md +2 -0
- package/docs/examples/domains/get-zone.md +2 -0
- package/docs/examples/domains/get.md +2 -0
- package/docs/examples/domains/list-records.md +2 -0
- package/docs/examples/domains/list-suggestions.md +2 -0
- package/docs/examples/domains/list.md +2 -0
- package/docs/examples/domains/update-nameservers.md +2 -0
- package/docs/examples/domains/update-record-a.md +2 -0
- package/docs/examples/domains/update-record-aaaa.md +2 -0
- package/docs/examples/domains/update-record-alias.md +2 -0
- package/docs/examples/domains/update-record-caa.md +2 -0
- package/docs/examples/domains/update-record-cname.md +2 -0
- package/docs/examples/domains/update-record-https.md +2 -0
- package/docs/examples/domains/update-record-mx.md +2 -0
- package/docs/examples/domains/update-record-ns.md +2 -0
- package/docs/examples/domains/update-record-srv.md +2 -0
- package/docs/examples/domains/update-record-txt.md +2 -0
- package/docs/examples/domains/update-team.md +2 -0
- package/docs/examples/domains/update-zone.md +2 -0
- package/docs/examples/functions/create-deployment.md +2 -0
- package/docs/examples/functions/create-duplicate-deployment.md +2 -0
- package/docs/examples/functions/create-execution.md +2 -0
- package/docs/examples/functions/create-template-deployment.md +2 -0
- package/docs/examples/functions/create-variable.md +2 -0
- package/docs/examples/functions/create-vcs-deployment.md +2 -0
- package/docs/examples/functions/create.md +2 -0
- package/docs/examples/functions/delete-deployment.md +2 -0
- package/docs/examples/functions/delete-execution.md +2 -0
- package/docs/examples/functions/delete-variable.md +2 -0
- package/docs/examples/functions/delete.md +2 -0
- package/docs/examples/functions/get-deployment-download.md +2 -0
- package/docs/examples/functions/get-deployment.md +2 -0
- package/docs/examples/functions/get-execution.md +2 -0
- package/docs/examples/functions/get-template.md +2 -0
- package/docs/examples/functions/get-usage.md +2 -0
- package/docs/examples/functions/get-variable.md +2 -0
- package/docs/examples/functions/get.md +2 -0
- package/docs/examples/functions/list-deployments.md +2 -0
- package/docs/examples/functions/list-executions.md +2 -0
- package/docs/examples/functions/list-runtimes.md +2 -0
- package/docs/examples/functions/list-specifications.md +2 -0
- package/docs/examples/functions/list-templates.md +2 -0
- package/docs/examples/functions/list-usage.md +2 -0
- package/docs/examples/functions/list-variables.md +2 -0
- package/docs/examples/functions/list.md +2 -0
- package/docs/examples/functions/update-deployment-status.md +2 -0
- package/docs/examples/functions/update-function-deployment.md +2 -0
- package/docs/examples/functions/update-variable.md +2 -0
- package/docs/examples/functions/update.md +2 -0
- package/docs/examples/graphql/mutation.md +2 -0
- package/docs/examples/graphql/query.md +2 -0
- package/docs/examples/health/get-antivirus.md +2 -0
- package/docs/examples/health/get-cache.md +2 -0
- package/docs/examples/health/get-certificate.md +2 -0
- package/docs/examples/health/get-db.md +2 -0
- package/docs/examples/health/get-failed-jobs.md +2 -0
- package/docs/examples/health/get-pub-sub.md +2 -0
- package/docs/examples/health/get-queue-audits.md +2 -0
- package/docs/examples/health/get-queue-billing-project-aggregation.md +2 -0
- package/docs/examples/health/get-queue-billing-team-aggregation.md +2 -0
- package/docs/examples/health/get-queue-builds.md +2 -0
- package/docs/examples/health/get-queue-certificates.md +2 -0
- package/docs/examples/health/get-queue-databases.md +2 -0
- package/docs/examples/health/get-queue-deletes.md +2 -0
- package/docs/examples/health/get-queue-functions.md +2 -0
- package/docs/examples/health/get-queue-logs.md +2 -0
- package/docs/examples/health/get-queue-mails.md +2 -0
- package/docs/examples/health/get-queue-messaging.md +2 -0
- package/docs/examples/health/get-queue-migrations.md +2 -0
- package/docs/examples/health/get-queue-priority-builds.md +2 -0
- package/docs/examples/health/get-queue-region-manager.md +2 -0
- package/docs/examples/health/get-queue-stats-resources.md +2 -0
- package/docs/examples/health/get-queue-threats.md +2 -0
- package/docs/examples/health/get-queue-usage.md +2 -0
- package/docs/examples/health/get-queue-webhooks.md +2 -0
- package/docs/examples/health/get-storage-local.md +2 -0
- package/docs/examples/health/get-storage.md +2 -0
- package/docs/examples/health/get-time.md +2 -0
- package/docs/examples/health/get.md +2 -0
- package/docs/examples/locale/get.md +2 -0
- package/docs/examples/locale/list-codes.md +2 -0
- package/docs/examples/locale/list-continents.md +2 -0
- package/docs/examples/locale/list-countries-eu.md +2 -0
- package/docs/examples/locale/list-countries-phones.md +2 -0
- package/docs/examples/locale/list-countries.md +2 -0
- package/docs/examples/locale/list-currencies.md +2 -0
- package/docs/examples/locale/list-languages.md +2 -0
- package/docs/examples/messaging/create-apns-provider.md +2 -0
- package/docs/examples/messaging/create-email.md +2 -0
- package/docs/examples/messaging/create-fcm-provider.md +2 -0
- package/docs/examples/messaging/create-mailgun-provider.md +2 -0
- package/docs/examples/messaging/create-msg-91-provider.md +2 -0
- package/docs/examples/messaging/create-push.md +2 -0
- package/docs/examples/messaging/create-resend-provider.md +2 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +2 -0
- package/docs/examples/messaging/create-sms.md +2 -0
- package/docs/examples/messaging/create-smtp-provider.md +2 -0
- package/docs/examples/messaging/create-subscriber.md +2 -0
- package/docs/examples/messaging/create-telesign-provider.md +2 -0
- package/docs/examples/messaging/create-textmagic-provider.md +2 -0
- package/docs/examples/messaging/create-topic.md +2 -0
- package/docs/examples/messaging/create-twilio-provider.md +2 -0
- package/docs/examples/messaging/create-vonage-provider.md +2 -0
- package/docs/examples/messaging/delete-provider.md +2 -0
- package/docs/examples/messaging/delete-subscriber.md +2 -0
- package/docs/examples/messaging/delete-topic.md +2 -0
- package/docs/examples/messaging/delete.md +2 -0
- package/docs/examples/messaging/get-message.md +2 -0
- package/docs/examples/messaging/get-provider.md +2 -0
- package/docs/examples/messaging/get-subscriber.md +2 -0
- package/docs/examples/messaging/get-topic.md +2 -0
- package/docs/examples/messaging/list-message-logs.md +2 -0
- package/docs/examples/messaging/list-messages.md +2 -0
- package/docs/examples/messaging/list-provider-logs.md +2 -0
- package/docs/examples/messaging/list-providers.md +2 -0
- package/docs/examples/messaging/list-subscriber-logs.md +2 -0
- package/docs/examples/messaging/list-subscribers.md +2 -0
- package/docs/examples/messaging/list-targets.md +2 -0
- package/docs/examples/messaging/list-topic-logs.md +2 -0
- package/docs/examples/messaging/list-topics.md +2 -0
- package/docs/examples/messaging/update-apns-provider.md +2 -0
- package/docs/examples/messaging/update-email.md +2 -0
- package/docs/examples/messaging/update-fcm-provider.md +2 -0
- package/docs/examples/messaging/update-mailgun-provider.md +2 -0
- package/docs/examples/messaging/update-msg-91-provider.md +2 -0
- package/docs/examples/messaging/update-push.md +2 -0
- package/docs/examples/messaging/update-resend-provider.md +2 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +2 -0
- package/docs/examples/messaging/update-sms.md +2 -0
- package/docs/examples/messaging/update-smtp-provider.md +2 -0
- package/docs/examples/messaging/update-telesign-provider.md +2 -0
- package/docs/examples/messaging/update-textmagic-provider.md +2 -0
- package/docs/examples/messaging/update-topic.md +2 -0
- package/docs/examples/messaging/update-twilio-provider.md +2 -0
- package/docs/examples/messaging/update-vonage-provider.md +2 -0
- package/docs/examples/migrations/create-appwrite-migration.md +2 -0
- package/docs/examples/migrations/create-csv-export.md +2 -0
- package/docs/examples/migrations/create-csv-import.md +2 -0
- package/docs/examples/migrations/create-firebase-migration.md +2 -0
- package/docs/examples/migrations/create-n-host-migration.md +2 -0
- package/docs/examples/migrations/create-supabase-migration.md +2 -0
- package/docs/examples/migrations/delete.md +2 -0
- package/docs/examples/migrations/get-appwrite-report.md +2 -0
- package/docs/examples/migrations/get-firebase-report.md +2 -0
- package/docs/examples/migrations/get-n-host-report.md +2 -0
- package/docs/examples/migrations/get-supabase-report.md +2 -0
- package/docs/examples/migrations/get.md +2 -0
- package/docs/examples/migrations/list.md +2 -0
- package/docs/examples/migrations/retry.md +2 -0
- package/docs/examples/organizations/add-credit.md +2 -0
- package/docs/examples/organizations/cancel-downgrade.md +2 -0
- package/docs/examples/organizations/create-downgrade-feedback.md +2 -0
- package/docs/examples/organizations/create-invoice-payment.md +2 -0
- package/docs/examples/organizations/create-key.md +2 -0
- package/docs/examples/organizations/create.md +2 -0
- package/docs/examples/organizations/delete-backup-payment-method.md +2 -0
- package/docs/examples/organizations/delete-billing-address.md +2 -0
- package/docs/examples/organizations/delete-default-payment-method.md +2 -0
- package/docs/examples/organizations/delete-key.md +2 -0
- package/docs/examples/organizations/delete.md +2 -0
- package/docs/examples/organizations/estimation-create-organization.md +2 -0
- package/docs/examples/organizations/estimation-delete-organization.md +2 -0
- package/docs/examples/organizations/estimation-update-plan.md +2 -0
- package/docs/examples/organizations/get-aggregation.md +2 -0
- package/docs/examples/organizations/get-available-credits.md +2 -0
- package/docs/examples/organizations/get-billing-address.md +2 -0
- package/docs/examples/organizations/get-credit.md +2 -0
- package/docs/examples/organizations/get-invoice-download.md +2 -0
- package/docs/examples/organizations/get-invoice-view.md +2 -0
- package/docs/examples/organizations/get-invoice.md +2 -0
- package/docs/examples/organizations/get-key.md +2 -0
- package/docs/examples/organizations/get-payment-method.md +2 -0
- package/docs/examples/organizations/get-plan.md +2 -0
- package/docs/examples/organizations/get-scopes.md +2 -0
- package/docs/examples/organizations/get-usage.md +2 -0
- package/docs/examples/organizations/list-aggregations.md +2 -0
- package/docs/examples/organizations/list-credits.md +2 -0
- package/docs/examples/organizations/list-invoices.md +2 -0
- package/docs/examples/organizations/list-keys.md +2 -0
- package/docs/examples/organizations/list-regions.md +2 -0
- package/docs/examples/organizations/list.md +2 -0
- package/docs/examples/organizations/set-backup-payment-method.md +2 -0
- package/docs/examples/organizations/set-billing-address.md +2 -0
- package/docs/examples/organizations/set-billing-email.md +2 -0
- package/docs/examples/organizations/set-billing-tax-id.md +2 -0
- package/docs/examples/organizations/set-default-payment-method.md +2 -0
- package/docs/examples/organizations/update-budget.md +2 -0
- package/docs/examples/organizations/update-key.md +2 -0
- package/docs/examples/organizations/update-plan.md +2 -0
- package/docs/examples/organizations/validate-invoice.md +2 -0
- package/docs/examples/organizations/validate-payment.md +2 -0
- package/docs/examples/project/create-variable.md +2 -0
- package/docs/examples/project/delete-variable.md +2 -0
- package/docs/examples/project/get-usage.md +2 -0
- package/docs/examples/project/get-variable.md +2 -0
- package/docs/examples/project/list-variables.md +2 -0
- package/docs/examples/project/update-variable.md +2 -0
- package/docs/examples/projects/create-dev-key.md +2 -0
- package/docs/examples/projects/create-jwt.md +2 -0
- package/docs/examples/projects/create-key.md +3 -0
- package/docs/examples/projects/create-platform.md +2 -0
- package/docs/examples/projects/create-smtp-test.md +2 -0
- package/docs/examples/projects/create-webhook.md +2 -0
- package/docs/examples/projects/create.md +2 -0
- package/docs/examples/projects/delete-dev-key.md +2 -0
- package/docs/examples/projects/delete-email-template.md +2 -0
- package/docs/examples/projects/delete-key.md +2 -0
- package/docs/examples/projects/delete-platform.md +2 -0
- package/docs/examples/projects/delete-sms-template.md +2 -0
- package/docs/examples/projects/delete-webhook.md +2 -0
- package/docs/examples/projects/delete.md +2 -0
- package/docs/examples/projects/get-dev-key.md +2 -0
- package/docs/examples/projects/get-email-template.md +2 -0
- package/docs/examples/projects/get-key.md +2 -0
- package/docs/examples/projects/get-platform.md +2 -0
- package/docs/examples/projects/get-sms-template.md +2 -0
- package/docs/examples/projects/get-webhook.md +2 -0
- package/docs/examples/projects/get.md +2 -0
- package/docs/examples/projects/list-dev-keys.md +2 -0
- package/docs/examples/projects/list-keys.md +3 -0
- package/docs/examples/projects/list-platforms.md +2 -0
- package/docs/examples/projects/list-webhooks.md +2 -0
- package/docs/examples/projects/list.md +2 -0
- package/docs/examples/projects/update-api-status-all.md +2 -0
- package/docs/examples/projects/update-api-status.md +2 -0
- package/docs/examples/projects/update-auth-duration.md +2 -0
- package/docs/examples/projects/update-auth-limit.md +2 -0
- package/docs/examples/projects/update-auth-password-dictionary.md +2 -0
- package/docs/examples/projects/update-auth-password-history.md +2 -0
- package/docs/examples/projects/update-auth-sessions-limit.md +2 -0
- package/docs/examples/projects/update-auth-status.md +2 -0
- package/docs/examples/projects/update-dev-key.md +2 -0
- package/docs/examples/projects/update-email-template.md +2 -0
- package/docs/examples/projects/update-key.md +2 -0
- package/docs/examples/projects/update-labels.md +2 -0
- package/docs/examples/projects/update-memberships-privacy.md +2 -0
- package/docs/examples/projects/update-mock-numbers.md +2 -0
- package/docs/examples/projects/update-o-auth-2.md +2 -0
- package/docs/examples/projects/update-personal-data-check.md +2 -0
- package/docs/examples/projects/update-platform.md +2 -0
- package/docs/examples/projects/update-service-status-all.md +2 -0
- package/docs/examples/projects/update-service-status.md +2 -0
- package/docs/examples/projects/update-session-alerts.md +2 -0
- package/docs/examples/projects/update-session-invalidation.md +2 -0
- package/docs/examples/projects/update-sms-template.md +2 -0
- package/docs/examples/projects/update-smtp.md +2 -0
- package/docs/examples/projects/update-team.md +2 -0
- package/docs/examples/projects/update-webhook-signature.md +2 -0
- package/docs/examples/projects/update-webhook.md +2 -0
- package/docs/examples/projects/update.md +2 -0
- package/docs/examples/proxy/create-api-rule.md +2 -0
- package/docs/examples/proxy/create-function-rule.md +2 -0
- package/docs/examples/proxy/create-redirect-rule.md +2 -0
- package/docs/examples/proxy/create-site-rule.md +2 -0
- package/docs/examples/proxy/delete-rule.md +2 -0
- package/docs/examples/proxy/get-rule.md +2 -0
- package/docs/examples/proxy/list-rules.md +2 -0
- package/docs/examples/proxy/update-rule-verification.md +2 -0
- package/docs/examples/sites/create-deployment.md +2 -0
- package/docs/examples/sites/create-duplicate-deployment.md +2 -0
- package/docs/examples/sites/create-template-deployment.md +2 -0
- package/docs/examples/sites/create-variable.md +2 -0
- package/docs/examples/sites/create-vcs-deployment.md +2 -0
- package/docs/examples/sites/create.md +2 -0
- package/docs/examples/sites/delete-deployment.md +2 -0
- package/docs/examples/sites/delete-log.md +2 -0
- package/docs/examples/sites/delete-variable.md +2 -0
- package/docs/examples/sites/delete.md +2 -0
- package/docs/examples/sites/get-deployment-download.md +2 -0
- package/docs/examples/sites/get-deployment.md +2 -0
- package/docs/examples/sites/get-log.md +2 -0
- package/docs/examples/sites/get-template.md +2 -0
- package/docs/examples/sites/get-usage.md +2 -0
- package/docs/examples/sites/get-variable.md +2 -0
- package/docs/examples/sites/get.md +2 -0
- package/docs/examples/sites/list-deployments.md +2 -0
- package/docs/examples/sites/list-frameworks.md +2 -0
- package/docs/examples/sites/list-logs.md +2 -0
- package/docs/examples/sites/list-specifications.md +2 -0
- package/docs/examples/sites/list-templates.md +2 -0
- package/docs/examples/sites/list-usage.md +2 -0
- package/docs/examples/sites/list-variables.md +2 -0
- package/docs/examples/sites/list.md +2 -0
- package/docs/examples/sites/update-deployment-status.md +2 -0
- package/docs/examples/sites/update-site-deployment.md +2 -0
- package/docs/examples/sites/update-variable.md +2 -0
- package/docs/examples/sites/update.md +2 -0
- package/docs/examples/storage/create-bucket.md +2 -0
- package/docs/examples/storage/create-file.md +2 -0
- package/docs/examples/storage/delete-bucket.md +2 -0
- package/docs/examples/storage/delete-file.md +2 -0
- package/docs/examples/storage/get-bucket-usage.md +2 -0
- package/docs/examples/storage/get-bucket.md +2 -0
- package/docs/examples/storage/get-file-download.md +2 -0
- package/docs/examples/storage/get-file-preview.md +2 -0
- package/docs/examples/storage/get-file-view.md +2 -0
- package/docs/examples/storage/get-file.md +2 -0
- package/docs/examples/storage/get-usage.md +2 -0
- package/docs/examples/storage/list-buckets.md +2 -0
- package/docs/examples/storage/list-files.md +2 -0
- package/docs/examples/storage/update-bucket.md +2 -0
- package/docs/examples/storage/update-file.md +2 -0
- package/docs/examples/tablesdb/create-boolean-column.md +2 -0
- package/docs/examples/tablesdb/create-datetime-column.md +2 -0
- package/docs/examples/tablesdb/create-email-column.md +2 -0
- package/docs/examples/tablesdb/create-enum-column.md +2 -0
- package/docs/examples/tablesdb/create-float-column.md +2 -0
- package/docs/examples/tablesdb/create-index.md +2 -0
- package/docs/examples/tablesdb/create-integer-column.md +2 -0
- package/docs/examples/tablesdb/create-ip-column.md +2 -0
- package/docs/examples/tablesdb/create-line-column.md +2 -0
- package/docs/examples/tablesdb/create-longtext-column.md +4 -1
- package/docs/examples/tablesdb/create-mediumtext-column.md +4 -1
- package/docs/examples/tablesdb/create-operations.md +2 -0
- package/docs/examples/tablesdb/create-point-column.md +2 -0
- package/docs/examples/tablesdb/create-polygon-column.md +2 -0
- package/docs/examples/tablesdb/create-relationship-column.md +2 -0
- package/docs/examples/tablesdb/create-row.md +2 -0
- package/docs/examples/tablesdb/create-rows.md +2 -0
- package/docs/examples/tablesdb/create-string-column.md +2 -0
- package/docs/examples/tablesdb/create-table.md +2 -0
- package/docs/examples/tablesdb/create-text-column.md +4 -1
- package/docs/examples/tablesdb/create-transaction.md +2 -0
- package/docs/examples/tablesdb/create-url-column.md +2 -0
- package/docs/examples/tablesdb/create-varchar-column.md +4 -1
- package/docs/examples/tablesdb/create.md +2 -0
- package/docs/examples/tablesdb/decrement-row-column.md +2 -0
- package/docs/examples/tablesdb/delete-column.md +2 -0
- package/docs/examples/tablesdb/delete-index.md +2 -0
- package/docs/examples/tablesdb/delete-row.md +2 -0
- package/docs/examples/tablesdb/delete-rows.md +2 -0
- package/docs/examples/tablesdb/delete-table.md +2 -0
- package/docs/examples/tablesdb/delete-transaction.md +2 -0
- package/docs/examples/tablesdb/delete.md +2 -0
- package/docs/examples/tablesdb/get-column.md +2 -0
- package/docs/examples/tablesdb/get-index.md +2 -0
- package/docs/examples/tablesdb/get-row.md +2 -0
- package/docs/examples/tablesdb/get-table-usage.md +2 -0
- package/docs/examples/tablesdb/get-table.md +2 -0
- package/docs/examples/tablesdb/get-transaction.md +2 -0
- package/docs/examples/tablesdb/get-usage.md +2 -0
- package/docs/examples/tablesdb/get.md +2 -0
- package/docs/examples/tablesdb/increment-row-column.md +2 -0
- package/docs/examples/tablesdb/list-columns.md +2 -0
- package/docs/examples/tablesdb/list-indexes.md +2 -0
- package/docs/examples/tablesdb/list-row-logs.md +2 -0
- package/docs/examples/tablesdb/list-rows.md +2 -0
- package/docs/examples/tablesdb/list-table-logs.md +2 -0
- package/docs/examples/tablesdb/list-tables.md +2 -0
- package/docs/examples/tablesdb/list-transactions.md +2 -0
- package/docs/examples/tablesdb/list-usage.md +2 -0
- package/docs/examples/tablesdb/list.md +2 -0
- package/docs/examples/tablesdb/update-boolean-column.md +2 -0
- package/docs/examples/tablesdb/update-datetime-column.md +2 -0
- package/docs/examples/tablesdb/update-email-column.md +2 -0
- package/docs/examples/tablesdb/update-enum-column.md +2 -0
- package/docs/examples/tablesdb/update-float-column.md +2 -0
- package/docs/examples/tablesdb/update-integer-column.md +2 -0
- package/docs/examples/tablesdb/update-ip-column.md +2 -0
- package/docs/examples/tablesdb/update-line-column.md +2 -0
- package/docs/examples/tablesdb/update-longtext-column.md +2 -0
- package/docs/examples/tablesdb/update-mediumtext-column.md +2 -0
- package/docs/examples/tablesdb/update-point-column.md +2 -0
- package/docs/examples/tablesdb/update-polygon-column.md +2 -0
- package/docs/examples/tablesdb/update-relationship-column.md +2 -0
- package/docs/examples/tablesdb/update-row.md +2 -0
- package/docs/examples/tablesdb/update-rows.md +2 -0
- package/docs/examples/tablesdb/update-string-column.md +2 -0
- package/docs/examples/tablesdb/update-table.md +2 -0
- package/docs/examples/tablesdb/update-text-column.md +2 -0
- package/docs/examples/tablesdb/update-transaction.md +2 -0
- package/docs/examples/tablesdb/update-url-column.md +2 -0
- package/docs/examples/tablesdb/update-varchar-column.md +2 -0
- package/docs/examples/tablesdb/update.md +2 -0
- package/docs/examples/tablesdb/upsert-row.md +2 -0
- package/docs/examples/tablesdb/upsert-rows.md +2 -0
- package/docs/examples/teams/create-membership.md +4 -2
- package/docs/examples/teams/create.md +2 -0
- package/docs/examples/teams/delete-membership.md +2 -0
- package/docs/examples/teams/delete.md +2 -0
- package/docs/examples/teams/get-membership.md +2 -0
- package/docs/examples/teams/get-prefs.md +2 -0
- package/docs/examples/teams/get.md +2 -0
- package/docs/examples/teams/list-logs.md +2 -0
- package/docs/examples/teams/list-memberships.md +2 -0
- package/docs/examples/teams/list.md +2 -0
- package/docs/examples/teams/update-membership-status.md +2 -0
- package/docs/examples/teams/update-membership.md +4 -2
- package/docs/examples/teams/update-name.md +2 -0
- package/docs/examples/teams/update-prefs.md +2 -0
- package/docs/examples/tokens/create-file-token.md +2 -0
- package/docs/examples/tokens/delete.md +2 -0
- package/docs/examples/tokens/get.md +2 -0
- package/docs/examples/tokens/list.md +2 -0
- package/docs/examples/tokens/update.md +2 -0
- package/docs/examples/users/create-argon-2-user.md +2 -0
- package/docs/examples/users/create-bcrypt-user.md +2 -0
- package/docs/examples/users/create-jwt.md +2 -0
- package/docs/examples/users/create-md-5-user.md +2 -0
- package/docs/examples/users/create-mfa-recovery-codes.md +2 -0
- package/docs/examples/users/create-ph-pass-user.md +2 -0
- package/docs/examples/users/create-scrypt-modified-user.md +2 -0
- package/docs/examples/users/create-scrypt-user.md +2 -0
- package/docs/examples/users/create-session.md +2 -0
- package/docs/examples/users/create-sha-user.md +2 -0
- package/docs/examples/users/create-target.md +2 -0
- package/docs/examples/users/create-token.md +2 -0
- package/docs/examples/users/create.md +2 -0
- package/docs/examples/users/delete-identity.md +2 -0
- package/docs/examples/users/delete-mfa-authenticator.md +2 -0
- package/docs/examples/users/delete-session.md +2 -0
- package/docs/examples/users/delete-sessions.md +2 -0
- package/docs/examples/users/delete-target.md +2 -0
- package/docs/examples/users/delete.md +2 -0
- package/docs/examples/users/get-mfa-recovery-codes.md +2 -0
- package/docs/examples/users/get-prefs.md +2 -0
- package/docs/examples/users/get-target.md +2 -0
- package/docs/examples/users/get-usage.md +2 -0
- package/docs/examples/users/get.md +2 -0
- package/docs/examples/users/list-identities.md +2 -0
- package/docs/examples/users/list-logs.md +2 -0
- package/docs/examples/users/list-memberships.md +2 -0
- package/docs/examples/users/list-mfa-factors.md +2 -0
- package/docs/examples/users/list-sessions.md +2 -0
- package/docs/examples/users/list-targets.md +2 -0
- package/docs/examples/users/list.md +2 -0
- package/docs/examples/users/update-email-verification.md +2 -0
- package/docs/examples/users/update-email.md +2 -0
- package/docs/examples/users/update-labels.md +2 -0
- package/docs/examples/users/update-mfa-recovery-codes.md +2 -0
- package/docs/examples/users/update-mfa.md +2 -0
- package/docs/examples/users/update-name.md +2 -0
- package/docs/examples/users/update-password.md +2 -0
- package/docs/examples/users/update-phone-verification.md +2 -0
- package/docs/examples/users/update-phone.md +2 -0
- package/docs/examples/users/update-prefs.md +2 -0
- package/docs/examples/users/update-status.md +2 -0
- package/docs/examples/users/update-target.md +2 -0
- package/docs/examples/vcs/create-repository-detection.md +2 -0
- package/docs/examples/vcs/create-repository.md +2 -0
- package/docs/examples/vcs/delete-installation.md +2 -0
- package/docs/examples/vcs/get-installation.md +2 -0
- package/docs/examples/vcs/get-repository-contents.md +2 -0
- package/docs/examples/vcs/get-repository.md +2 -0
- package/docs/examples/vcs/list-installations.md +2 -0
- package/docs/examples/vcs/list-repositories.md +2 -0
- package/docs/examples/vcs/list-repository-branches.md +2 -0
- package/docs/examples/vcs/update-external-deployments.md +2 -0
- package/package.json +1 -1
- package/src/channel.ts +30 -18
- package/src/client.ts +108 -22
- package/src/enums/{services.ts → backup-services.ts} +1 -1
- package/src/enums/build-runtime.ts +2 -0
- package/src/enums/registration-type.ts +6 -0
- package/src/enums/runtime.ts +2 -0
- package/src/enums/runtimes.ts +2 -0
- package/src/enums/scopes.ts +1 -0
- package/src/index.ts +3 -3
- package/src/models.ts +227 -5
- package/src/services/account.ts +11 -11
- package/src/services/activities.ts +116 -0
- package/src/services/avatars.ts +3 -3
- package/src/services/backups.ts +28 -28
- package/src/services/console.ts +1 -1
- package/src/services/databases.ts +57 -29
- package/src/services/domains.ts +70 -0
- package/src/services/functions.ts +2 -2
- package/src/services/graphql.ts +2 -2
- package/src/services/health.ts +1 -1
- package/src/services/migrations.ts +10 -10
- package/src/services/organizations.ts +0 -60
- package/src/services/projects.ts +28 -78
- package/src/services/realtime.ts +135 -58
- package/src/services/sites.ts +2 -2
- package/src/services/storage.ts +1 -1
- package/src/services/tables-db.ts +57 -29
- package/src/services/teams.ts +18 -19
- package/src/services/users.ts +1 -1
- package/types/channel.d.ts +4 -3
- package/types/client.d.ts +7 -2
- package/types/enums/{services.d.ts → backup-services.d.ts} +1 -1
- package/types/enums/build-runtime.d.ts +3 -1
- package/types/enums/registration-type.d.ts +6 -0
- package/types/enums/runtime.d.ts +3 -1
- package/types/enums/runtimes.d.ts +3 -1
- package/types/enums/scopes.d.ts +2 -1
- package/types/index.d.ts +3 -3
- package/types/models.d.ts +224 -5
- package/types/services/activities.d.ts +46 -0
- package/types/services/backups.d.ts +13 -13
- package/types/services/databases.d.ts +16 -4
- package/types/services/domains.d.ts +26 -0
- package/types/services/migrations.d.ts +2 -2
- package/types/services/organizations.d.ts +0 -22
- package/types/services/projects.d.ts +8 -25
- package/types/services/realtime.d.ts +13 -6
- package/types/services/tables-db.d.ts +16 -4
- package/types/services/teams.d.ts +8 -9
- package/docs/examples/organizations/update-projects.md +0 -14
- package/docs/examples/projects/update-status.md +0 -14
- package/src/enums/roles.ts +0 -7
- package/src/enums/status.ts +0 -4
- package/types/enums/roles.d.ts +0 -7
- package/types/enums/status.d.ts +0 -4
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { Client } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
export declare class Activities {
|
|
4
|
+
client: Client;
|
|
5
|
+
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* List all events for selected filters.
|
|
8
|
+
*
|
|
9
|
+
* @param {string} params.queries - 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 attributes such as userId, teamId, etc.
|
|
10
|
+
* @throws {AppwriteException}
|
|
11
|
+
* @returns {Promise<Models.ActivityEventList>}
|
|
12
|
+
*/
|
|
13
|
+
listEvents(params?: {
|
|
14
|
+
queries?: string;
|
|
15
|
+
}): Promise<Models.ActivityEventList>;
|
|
16
|
+
/**
|
|
17
|
+
* List all events for selected filters.
|
|
18
|
+
*
|
|
19
|
+
* @param {string} queries - 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 attributes such as userId, teamId, etc.
|
|
20
|
+
* @throws {AppwriteException}
|
|
21
|
+
* @returns {Promise<Models.ActivityEventList>}
|
|
22
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
23
|
+
*/
|
|
24
|
+
listEvents(queries?: string): Promise<Models.ActivityEventList>;
|
|
25
|
+
/**
|
|
26
|
+
* Get event by ID.
|
|
27
|
+
*
|
|
28
|
+
*
|
|
29
|
+
* @param {string} params.eventId - Event ID.
|
|
30
|
+
* @throws {AppwriteException}
|
|
31
|
+
* @returns {Promise<Models.ActivityEvent>}
|
|
32
|
+
*/
|
|
33
|
+
getEvent(params: {
|
|
34
|
+
eventId: string;
|
|
35
|
+
}): Promise<Models.ActivityEvent>;
|
|
36
|
+
/**
|
|
37
|
+
* Get event by ID.
|
|
38
|
+
*
|
|
39
|
+
*
|
|
40
|
+
* @param {string} eventId - Event ID.
|
|
41
|
+
* @throws {AppwriteException}
|
|
42
|
+
* @returns {Promise<Models.ActivityEvent>}
|
|
43
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
44
|
+
*/
|
|
45
|
+
getEvent(eventId: string): Promise<Models.ActivityEvent>;
|
|
46
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
-
import {
|
|
3
|
+
import { BackupServices } from '../enums/backup-services';
|
|
4
4
|
export declare class Backups {
|
|
5
5
|
client: Client;
|
|
6
6
|
constructor(client: Client);
|
|
@@ -26,25 +26,25 @@ export declare class Backups {
|
|
|
26
26
|
/**
|
|
27
27
|
* Create a new archive asynchronously for a project.
|
|
28
28
|
*
|
|
29
|
-
* @param {
|
|
29
|
+
* @param {BackupServices[]} params.services - Array of services to backup
|
|
30
30
|
* @param {string} params.resourceId - Resource ID. When set, only this single resource will be backed up.
|
|
31
31
|
* @throws {AppwriteException}
|
|
32
32
|
* @returns {Promise<Models.BackupArchive>}
|
|
33
33
|
*/
|
|
34
34
|
createArchive(params: {
|
|
35
|
-
services:
|
|
35
|
+
services: BackupServices[];
|
|
36
36
|
resourceId?: string;
|
|
37
37
|
}): Promise<Models.BackupArchive>;
|
|
38
38
|
/**
|
|
39
39
|
* Create a new archive asynchronously for a project.
|
|
40
40
|
*
|
|
41
|
-
* @param {
|
|
41
|
+
* @param {BackupServices[]} services - Array of services to backup
|
|
42
42
|
* @param {string} resourceId - Resource ID. When set, only this single resource will be backed up.
|
|
43
43
|
* @throws {AppwriteException}
|
|
44
44
|
* @returns {Promise<Models.BackupArchive>}
|
|
45
45
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
46
46
|
*/
|
|
47
|
-
createArchive(services:
|
|
47
|
+
createArchive(services: BackupServices[], resourceId?: string): Promise<Models.BackupArchive>;
|
|
48
48
|
/**
|
|
49
49
|
* Get a backup archive using it's ID.
|
|
50
50
|
*
|
|
@@ -106,7 +106,7 @@ export declare class Backups {
|
|
|
106
106
|
* Create a new backup policy.
|
|
107
107
|
*
|
|
108
108
|
* @param {string} params.policyId - Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
109
|
-
* @param {
|
|
109
|
+
* @param {BackupServices[]} params.services - Array of services to backup
|
|
110
110
|
* @param {number} params.retention - Days to keep backups before deletion
|
|
111
111
|
* @param {string} params.schedule - Schedule CRON syntax.
|
|
112
112
|
* @param {string} params.name - Policy name. Max length: 128 chars.
|
|
@@ -117,7 +117,7 @@ export declare class Backups {
|
|
|
117
117
|
*/
|
|
118
118
|
createPolicy(params: {
|
|
119
119
|
policyId: string;
|
|
120
|
-
services:
|
|
120
|
+
services: BackupServices[];
|
|
121
121
|
retention: number;
|
|
122
122
|
schedule: string;
|
|
123
123
|
name?: string;
|
|
@@ -128,7 +128,7 @@ export declare class Backups {
|
|
|
128
128
|
* Create a new backup policy.
|
|
129
129
|
*
|
|
130
130
|
* @param {string} policyId - Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
131
|
-
* @param {
|
|
131
|
+
* @param {BackupServices[]} services - Array of services to backup
|
|
132
132
|
* @param {number} retention - Days to keep backups before deletion
|
|
133
133
|
* @param {string} schedule - Schedule CRON syntax.
|
|
134
134
|
* @param {string} name - Policy name. Max length: 128 chars.
|
|
@@ -138,7 +138,7 @@ export declare class Backups {
|
|
|
138
138
|
* @returns {Promise<Models.BackupPolicy>}
|
|
139
139
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
140
140
|
*/
|
|
141
|
-
createPolicy(policyId: string, services:
|
|
141
|
+
createPolicy(policyId: string, services: BackupServices[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
|
|
142
142
|
/**
|
|
143
143
|
* Get a backup policy using it's ID.
|
|
144
144
|
*
|
|
@@ -212,7 +212,7 @@ export declare class Backups {
|
|
|
212
212
|
* Create and trigger a new restoration for a backup on a project.
|
|
213
213
|
*
|
|
214
214
|
* @param {string} params.archiveId - Backup archive ID to restore
|
|
215
|
-
* @param {
|
|
215
|
+
* @param {BackupServices[]} params.services - Array of services to restore
|
|
216
216
|
* @param {string} params.newResourceId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
217
217
|
* @param {string} params.newResourceName - Database name. Max length: 128 chars.
|
|
218
218
|
* @throws {AppwriteException}
|
|
@@ -220,7 +220,7 @@ export declare class Backups {
|
|
|
220
220
|
*/
|
|
221
221
|
createRestoration(params: {
|
|
222
222
|
archiveId: string;
|
|
223
|
-
services:
|
|
223
|
+
services: BackupServices[];
|
|
224
224
|
newResourceId?: string;
|
|
225
225
|
newResourceName?: string;
|
|
226
226
|
}): Promise<Models.BackupRestoration>;
|
|
@@ -228,14 +228,14 @@ export declare class Backups {
|
|
|
228
228
|
* Create and trigger a new restoration for a backup on a project.
|
|
229
229
|
*
|
|
230
230
|
* @param {string} archiveId - Backup archive ID to restore
|
|
231
|
-
* @param {
|
|
231
|
+
* @param {BackupServices[]} services - Array of services to restore
|
|
232
232
|
* @param {string} newResourceId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
233
233
|
* @param {string} newResourceName - Database name. Max length: 128 chars.
|
|
234
234
|
* @throws {AppwriteException}
|
|
235
235
|
* @returns {Promise<Models.BackupRestoration>}
|
|
236
236
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
237
237
|
*/
|
|
238
|
-
createRestoration(archiveId: string, services:
|
|
238
|
+
createRestoration(archiveId: string, services: BackupServices[], newResourceId?: string, newResourceName?: string): Promise<Models.BackupRestoration>;
|
|
239
239
|
/**
|
|
240
240
|
* List all backup restorations for a project.
|
|
241
241
|
*
|
|
@@ -1070,6 +1070,7 @@ export declare class Databases {
|
|
|
1070
1070
|
* @param {boolean} params.required - Is attribute required?
|
|
1071
1071
|
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1072
1072
|
* @param {boolean} params.array - Is attribute an array?
|
|
1073
|
+
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1073
1074
|
* @throws {AppwriteException}
|
|
1074
1075
|
* @returns {Promise<Models.AttributeLongtext>}
|
|
1075
1076
|
*/
|
|
@@ -1080,6 +1081,7 @@ export declare class Databases {
|
|
|
1080
1081
|
required: boolean;
|
|
1081
1082
|
xdefault?: string;
|
|
1082
1083
|
array?: boolean;
|
|
1084
|
+
encrypt?: boolean;
|
|
1083
1085
|
}): Promise<Models.AttributeLongtext>;
|
|
1084
1086
|
/**
|
|
1085
1087
|
* Create a longtext attribute.
|
|
@@ -1091,11 +1093,12 @@ export declare class Databases {
|
|
|
1091
1093
|
* @param {boolean} required - Is attribute required?
|
|
1092
1094
|
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1093
1095
|
* @param {boolean} array - Is attribute an array?
|
|
1096
|
+
* @param {boolean} encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1094
1097
|
* @throws {AppwriteException}
|
|
1095
1098
|
* @returns {Promise<Models.AttributeLongtext>}
|
|
1096
1099
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1097
1100
|
*/
|
|
1098
|
-
createLongtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeLongtext>;
|
|
1101
|
+
createLongtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeLongtext>;
|
|
1099
1102
|
/**
|
|
1100
1103
|
* Update a longtext attribute. Changing the `default` value will not update already existing documents.
|
|
1101
1104
|
*
|
|
@@ -1142,6 +1145,7 @@ export declare class Databases {
|
|
|
1142
1145
|
* @param {boolean} params.required - Is attribute required?
|
|
1143
1146
|
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1144
1147
|
* @param {boolean} params.array - Is attribute an array?
|
|
1148
|
+
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1145
1149
|
* @throws {AppwriteException}
|
|
1146
1150
|
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1147
1151
|
*/
|
|
@@ -1152,6 +1156,7 @@ export declare class Databases {
|
|
|
1152
1156
|
required: boolean;
|
|
1153
1157
|
xdefault?: string;
|
|
1154
1158
|
array?: boolean;
|
|
1159
|
+
encrypt?: boolean;
|
|
1155
1160
|
}): Promise<Models.AttributeMediumtext>;
|
|
1156
1161
|
/**
|
|
1157
1162
|
* Create a mediumtext attribute.
|
|
@@ -1163,11 +1168,12 @@ export declare class Databases {
|
|
|
1163
1168
|
* @param {boolean} required - Is attribute required?
|
|
1164
1169
|
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1165
1170
|
* @param {boolean} array - Is attribute an array?
|
|
1171
|
+
* @param {boolean} encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1166
1172
|
* @throws {AppwriteException}
|
|
1167
1173
|
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1168
1174
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1169
1175
|
*/
|
|
1170
|
-
createMediumtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeMediumtext>;
|
|
1176
|
+
createMediumtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeMediumtext>;
|
|
1171
1177
|
/**
|
|
1172
1178
|
* Update a mediumtext attribute. Changing the `default` value will not update already existing documents.
|
|
1173
1179
|
*
|
|
@@ -1474,6 +1480,7 @@ export declare class Databases {
|
|
|
1474
1480
|
* @param {boolean} params.required - Is attribute required?
|
|
1475
1481
|
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1476
1482
|
* @param {boolean} params.array - Is attribute an array?
|
|
1483
|
+
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1477
1484
|
* @throws {AppwriteException}
|
|
1478
1485
|
* @returns {Promise<Models.AttributeText>}
|
|
1479
1486
|
*/
|
|
@@ -1484,6 +1491,7 @@ export declare class Databases {
|
|
|
1484
1491
|
required: boolean;
|
|
1485
1492
|
xdefault?: string;
|
|
1486
1493
|
array?: boolean;
|
|
1494
|
+
encrypt?: boolean;
|
|
1487
1495
|
}): Promise<Models.AttributeText>;
|
|
1488
1496
|
/**
|
|
1489
1497
|
* Create a text attribute.
|
|
@@ -1495,11 +1503,12 @@ export declare class Databases {
|
|
|
1495
1503
|
* @param {boolean} required - Is attribute required?
|
|
1496
1504
|
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1497
1505
|
* @param {boolean} array - Is attribute an array?
|
|
1506
|
+
* @param {boolean} encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1498
1507
|
* @throws {AppwriteException}
|
|
1499
1508
|
* @returns {Promise<Models.AttributeText>}
|
|
1500
1509
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1501
1510
|
*/
|
|
1502
|
-
createTextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeText>;
|
|
1511
|
+
createTextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeText>;
|
|
1503
1512
|
/**
|
|
1504
1513
|
* Update a text attribute. Changing the `default` value will not update already existing documents.
|
|
1505
1514
|
*
|
|
@@ -1621,6 +1630,7 @@ export declare class Databases {
|
|
|
1621
1630
|
* @param {boolean} params.required - Is attribute required?
|
|
1622
1631
|
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1623
1632
|
* @param {boolean} params.array - Is attribute an array?
|
|
1633
|
+
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1624
1634
|
* @throws {AppwriteException}
|
|
1625
1635
|
* @returns {Promise<Models.AttributeVarchar>}
|
|
1626
1636
|
*/
|
|
@@ -1632,6 +1642,7 @@ export declare class Databases {
|
|
|
1632
1642
|
required: boolean;
|
|
1633
1643
|
xdefault?: string;
|
|
1634
1644
|
array?: boolean;
|
|
1645
|
+
encrypt?: boolean;
|
|
1635
1646
|
}): Promise<Models.AttributeVarchar>;
|
|
1636
1647
|
/**
|
|
1637
1648
|
* Create a varchar attribute.
|
|
@@ -1644,11 +1655,12 @@ export declare class Databases {
|
|
|
1644
1655
|
* @param {boolean} required - Is attribute required?
|
|
1645
1656
|
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1646
1657
|
* @param {boolean} array - Is attribute an array?
|
|
1658
|
+
* @param {boolean} encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1647
1659
|
* @throws {AppwriteException}
|
|
1648
1660
|
* @returns {Promise<Models.AttributeVarchar>}
|
|
1649
1661
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1650
1662
|
*/
|
|
1651
|
-
createVarcharAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeVarchar>;
|
|
1663
|
+
createVarcharAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeVarchar>;
|
|
1652
1664
|
/**
|
|
1653
1665
|
* Update a varchar attribute. Changing the `default` value will not update already existing documents.
|
|
1654
1666
|
*
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
+
import { RegistrationType } from '../enums/registration-type';
|
|
3
4
|
import { FilterType } from '../enums/filter-type';
|
|
4
5
|
export declare class Domains {
|
|
5
6
|
client: Client;
|
|
@@ -48,6 +49,31 @@ export declare class Domains {
|
|
|
48
49
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
49
50
|
*/
|
|
50
51
|
create(teamId: string, domain: string): Promise<Models.Domain>;
|
|
52
|
+
/**
|
|
53
|
+
* Get the registration price for a domain name.
|
|
54
|
+
*
|
|
55
|
+
* @param {string} params.domain - Domain name to get price for.
|
|
56
|
+
* @param {number} params.periodYears - Number of years to calculate the domain price for. Must be at least 1.
|
|
57
|
+
* @param {RegistrationType} params.registrationType - Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.
|
|
58
|
+
* @throws {AppwriteException}
|
|
59
|
+
* @returns {Promise<Models.DomainPrice>}
|
|
60
|
+
*/
|
|
61
|
+
getPrice(params: {
|
|
62
|
+
domain: string;
|
|
63
|
+
periodYears?: number;
|
|
64
|
+
registrationType?: RegistrationType;
|
|
65
|
+
}): Promise<Models.DomainPrice>;
|
|
66
|
+
/**
|
|
67
|
+
* Get the registration price for a domain name.
|
|
68
|
+
*
|
|
69
|
+
* @param {string} domain - Domain name to get price for.
|
|
70
|
+
* @param {number} periodYears - Number of years to calculate the domain price for. Must be at least 1.
|
|
71
|
+
* @param {RegistrationType} registrationType - Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.
|
|
72
|
+
* @throws {AppwriteException}
|
|
73
|
+
* @returns {Promise<Models.DomainPrice>}
|
|
74
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
75
|
+
*/
|
|
76
|
+
getPrice(domain: string, periodYears?: number, registrationType?: RegistrationType): Promise<Models.DomainPrice>;
|
|
51
77
|
/**
|
|
52
78
|
* List domain suggestions.
|
|
53
79
|
*
|
|
@@ -7,7 +7,7 @@ export declare class Migrations {
|
|
|
7
7
|
/**
|
|
8
8
|
* List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
|
|
9
9
|
*
|
|
10
|
-
* @param {string[]} params.queries - 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: status, stage, source, destination, resources, statusCounters, resourceData, errors
|
|
10
|
+
* @param {string[]} params.queries - 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: status, stage, source, destination, resources, resourceId, resourceType, statusCounters, resourceData, errors
|
|
11
11
|
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
12
12
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
13
13
|
* @throws {AppwriteException}
|
|
@@ -21,7 +21,7 @@ export declare class Migrations {
|
|
|
21
21
|
/**
|
|
22
22
|
* List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
|
|
23
23
|
*
|
|
24
|
-
* @param {string[]} queries - 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: status, stage, source, destination, resources, statusCounters, resourceData, errors
|
|
24
|
+
* @param {string[]} queries - 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: status, stage, source, destination, resources, resourceId, resourceType, statusCounters, resourceData, errors
|
|
25
25
|
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
26
26
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
27
27
|
* @throws {AppwriteException}
|
|
@@ -896,28 +896,6 @@ export declare class Organizations {
|
|
|
896
896
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
897
897
|
*/
|
|
898
898
|
cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
899
|
-
/**
|
|
900
|
-
* Update selected projects to keep in the organization.
|
|
901
|
-
*
|
|
902
|
-
* @param {string} params.organizationId - Organization Unique ID
|
|
903
|
-
* @param {string[]} params.projects - List of project IDs to be selected for the organization
|
|
904
|
-
* @throws {AppwriteException}
|
|
905
|
-
* @returns {Promise<Models.Organization<Preferences>>}
|
|
906
|
-
*/
|
|
907
|
-
updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
908
|
-
organizationId: string;
|
|
909
|
-
projects?: string[];
|
|
910
|
-
}): Promise<Models.Organization<Preferences>>;
|
|
911
|
-
/**
|
|
912
|
-
* Update selected projects to keep in the organization.
|
|
913
|
-
*
|
|
914
|
-
* @param {string} organizationId - Organization Unique ID
|
|
915
|
-
* @param {string[]} projects - List of project IDs to be selected for the organization
|
|
916
|
-
* @throws {AppwriteException}
|
|
917
|
-
* @returns {Promise<Models.Organization<Preferences>>}
|
|
918
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
919
|
-
*/
|
|
920
|
-
updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, projects?: string[]): Promise<Models.Organization<Preferences>>;
|
|
921
899
|
/**
|
|
922
900
|
* Get all available regions for an organization.
|
|
923
901
|
*
|
|
@@ -8,7 +8,6 @@ import { OAuthProvider } from '../enums/o-auth-provider';
|
|
|
8
8
|
import { PlatformType } from '../enums/platform-type';
|
|
9
9
|
import { ApiService } from '../enums/api-service';
|
|
10
10
|
import { SMTPSecure } from '../enums/smtp-secure';
|
|
11
|
-
import { Status } from '../enums/status';
|
|
12
11
|
import { EmailTemplateType } from '../enums/email-template-type';
|
|
13
12
|
import { EmailTemplateLocale } from '../enums/email-template-locale';
|
|
14
13
|
import { SmsTemplateType } from '../enums/sms-template-type';
|
|
@@ -678,30 +677,34 @@ export declare class Projects {
|
|
|
678
677
|
* Get a list of all API keys from the current project.
|
|
679
678
|
*
|
|
680
679
|
* @param {string} params.projectId - Project unique ID.
|
|
680
|
+
* @param {string[]} params.queries - 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: expire, accessedAt, name, scopes
|
|
681
681
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
682
682
|
* @throws {AppwriteException}
|
|
683
683
|
* @returns {Promise<Models.KeyList>}
|
|
684
684
|
*/
|
|
685
685
|
listKeys(params: {
|
|
686
686
|
projectId: string;
|
|
687
|
+
queries?: string[];
|
|
687
688
|
total?: boolean;
|
|
688
689
|
}): Promise<Models.KeyList>;
|
|
689
690
|
/**
|
|
690
691
|
* Get a list of all API keys from the current project.
|
|
691
692
|
*
|
|
692
693
|
* @param {string} projectId - Project unique ID.
|
|
694
|
+
* @param {string[]} queries - 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: expire, accessedAt, name, scopes
|
|
693
695
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
694
696
|
* @throws {AppwriteException}
|
|
695
697
|
* @returns {Promise<Models.KeyList>}
|
|
696
698
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
697
699
|
*/
|
|
698
|
-
listKeys(projectId: string, total?: boolean): Promise<Models.KeyList>;
|
|
700
|
+
listKeys(projectId: string, queries?: string[], total?: boolean): Promise<Models.KeyList>;
|
|
699
701
|
/**
|
|
700
702
|
* Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
701
703
|
*
|
|
702
704
|
* @param {string} params.projectId - Project unique ID.
|
|
703
705
|
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
704
706
|
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
707
|
+
* @param {string} params.keyId - Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
705
708
|
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
706
709
|
* @throws {AppwriteException}
|
|
707
710
|
* @returns {Promise<Models.Key>}
|
|
@@ -710,6 +713,7 @@ export declare class Projects {
|
|
|
710
713
|
projectId: string;
|
|
711
714
|
name: string;
|
|
712
715
|
scopes?: Scopes[];
|
|
716
|
+
keyId?: string;
|
|
713
717
|
expire?: string;
|
|
714
718
|
}): Promise<Models.Key>;
|
|
715
719
|
/**
|
|
@@ -718,12 +722,13 @@ export declare class Projects {
|
|
|
718
722
|
* @param {string} projectId - Project unique ID.
|
|
719
723
|
* @param {string} name - Key name. Max length: 128 chars.
|
|
720
724
|
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
725
|
+
* @param {string} keyId - Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
721
726
|
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
722
727
|
* @throws {AppwriteException}
|
|
723
728
|
* @returns {Promise<Models.Key>}
|
|
724
729
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
725
730
|
*/
|
|
726
|
-
createKey(projectId: string, name: string, scopes?: Scopes[], expire?: string): Promise<Models.Key>;
|
|
731
|
+
createKey(projectId: string, name: string, scopes?: Scopes[], keyId?: string, expire?: string): Promise<Models.Key>;
|
|
727
732
|
/**
|
|
728
733
|
* Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.
|
|
729
734
|
*
|
|
@@ -1219,28 +1224,6 @@ export declare class Projects {
|
|
|
1219
1224
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1220
1225
|
*/
|
|
1221
1226
|
createSMTPTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
|
|
1222
|
-
/**
|
|
1223
|
-
* Update the status of a project
|
|
1224
|
-
*
|
|
1225
|
-
* @param {string} params.projectId - Project ID
|
|
1226
|
-
* @param {Status} params.status - New status for the project
|
|
1227
|
-
* @throws {AppwriteException}
|
|
1228
|
-
* @returns {Promise<{}>}
|
|
1229
|
-
*/
|
|
1230
|
-
updateStatus(params: {
|
|
1231
|
-
projectId: string;
|
|
1232
|
-
status: Status;
|
|
1233
|
-
}): Promise<{}>;
|
|
1234
|
-
/**
|
|
1235
|
-
* Update the status of a project
|
|
1236
|
-
*
|
|
1237
|
-
* @param {string} projectId - Project ID
|
|
1238
|
-
* @param {Status} status - New status for the project
|
|
1239
|
-
* @throws {AppwriteException}
|
|
1240
|
-
* @returns {Promise<{}>}
|
|
1241
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1242
|
-
*/
|
|
1243
|
-
updateStatus(projectId: string, status: Status): Promise<{}>;
|
|
1244
1227
|
/**
|
|
1245
1228
|
* Update the team ID of a project allowing for it to be transferred to another team.
|
|
1246
1229
|
*
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import { Channel, ActionableChannel, ResolvedChannel } from '../channel';
|
|
3
|
+
import { Query } from '../query';
|
|
3
4
|
export declare type RealtimeSubscription = {
|
|
4
5
|
close: () => Promise<void>;
|
|
5
6
|
};
|
|
6
7
|
export declare type RealtimeCallback<T = any> = {
|
|
7
8
|
channels: Set<string>;
|
|
9
|
+
queries: string[];
|
|
8
10
|
callback: (event: RealtimeResponseEvent<T>) => void;
|
|
9
11
|
};
|
|
10
12
|
export declare type RealtimeResponse = {
|
|
@@ -16,10 +18,14 @@ export declare type RealtimeResponseEvent<T = any> = {
|
|
|
16
18
|
channels: string[];
|
|
17
19
|
timestamp: string;
|
|
18
20
|
payload: T;
|
|
21
|
+
subscriptions: string[];
|
|
19
22
|
};
|
|
20
23
|
export declare type RealtimeResponseConnected = {
|
|
21
24
|
channels: string[];
|
|
22
25
|
user?: object;
|
|
26
|
+
subscriptions?: {
|
|
27
|
+
[slot: string]: string;
|
|
28
|
+
};
|
|
23
29
|
};
|
|
24
30
|
export declare type RealtimeRequest = {
|
|
25
31
|
type: 'authentication';
|
|
@@ -41,12 +47,14 @@ export declare class Realtime {
|
|
|
41
47
|
private readonly HEARTBEAT_INTERVAL;
|
|
42
48
|
private client;
|
|
43
49
|
private socket?;
|
|
44
|
-
private activeChannels;
|
|
45
50
|
private activeSubscriptions;
|
|
51
|
+
private slotToSubscriptionId;
|
|
52
|
+
private subscriptionIdToSlot;
|
|
46
53
|
private heartbeatTimer?;
|
|
47
54
|
private subCallDepth;
|
|
48
55
|
private reconnectAttempts;
|
|
49
56
|
private subscriptionsCounter;
|
|
57
|
+
private connectionId;
|
|
50
58
|
private reconnect;
|
|
51
59
|
private onErrorCallbacks;
|
|
52
60
|
private onCloseCallbacks;
|
|
@@ -94,7 +102,7 @@ export declare class Realtime {
|
|
|
94
102
|
* @param {Function} callback - Callback function to handle events
|
|
95
103
|
* @returns {Promise<RealtimeSubscription>} Subscription object with close method
|
|
96
104
|
*/
|
|
97
|
-
subscribe(channel: string | Channel<any> | ActionableChannel | ResolvedChannel, callback: (event: RealtimeResponseEvent<any>) => void): Promise<RealtimeSubscription>;
|
|
105
|
+
subscribe(channel: string | Channel<any> | ActionableChannel | ResolvedChannel, callback: (event: RealtimeResponseEvent<any>) => void, queries?: (string | Query)[]): Promise<RealtimeSubscription>;
|
|
98
106
|
/**
|
|
99
107
|
* Subscribe to multiple channels
|
|
100
108
|
*
|
|
@@ -102,7 +110,7 @@ export declare class Realtime {
|
|
|
102
110
|
* @param {Function} callback - Callback function to handle events
|
|
103
111
|
* @returns {Promise<RealtimeSubscription>} Subscription object with close method
|
|
104
112
|
*/
|
|
105
|
-
subscribe(channels: (string | Channel<any> | ActionableChannel | ResolvedChannel)[], callback: (event: RealtimeResponseEvent<any>) => void): Promise<RealtimeSubscription>;
|
|
113
|
+
subscribe(channels: (string | Channel<any> | ActionableChannel | ResolvedChannel)[], callback: (event: RealtimeResponseEvent<any>) => void, queries?: (string | Query)[]): Promise<RealtimeSubscription>;
|
|
106
114
|
/**
|
|
107
115
|
* Subscribe to a single channel with typed payload
|
|
108
116
|
*
|
|
@@ -110,7 +118,7 @@ export declare class Realtime {
|
|
|
110
118
|
* @param {Function} callback - Callback function to handle events with typed payload
|
|
111
119
|
* @returns {Promise<RealtimeSubscription>} Subscription object with close method
|
|
112
120
|
*/
|
|
113
|
-
subscribe<T>(channel: string | Channel<any> | ActionableChannel | ResolvedChannel, callback: (event: RealtimeResponseEvent<T>) => void): Promise<RealtimeSubscription>;
|
|
121
|
+
subscribe<T>(channel: string | Channel<any> | ActionableChannel | ResolvedChannel, callback: (event: RealtimeResponseEvent<T>) => void, queries?: (string | Query)[]): Promise<RealtimeSubscription>;
|
|
114
122
|
/**
|
|
115
123
|
* Subscribe to multiple channels with typed payload
|
|
116
124
|
*
|
|
@@ -118,8 +126,7 @@ export declare class Realtime {
|
|
|
118
126
|
* @param {Function} callback - Callback function to handle events with typed payload
|
|
119
127
|
* @returns {Promise<RealtimeSubscription>} Subscription object with close method
|
|
120
128
|
*/
|
|
121
|
-
subscribe<T>(channels: (string | Channel<any> | ActionableChannel | ResolvedChannel)[], callback: (event: RealtimeResponseEvent<T>) => void): Promise<RealtimeSubscription>;
|
|
122
|
-
private cleanUp;
|
|
129
|
+
subscribe<T>(channels: (string | Channel<any> | ActionableChannel | ResolvedChannel)[], callback: (event: RealtimeResponseEvent<T>) => void, queries?: (string | Query)[]): Promise<RealtimeSubscription>;
|
|
123
130
|
private handleMessage;
|
|
124
131
|
private handleResponseConnected;
|
|
125
132
|
private handleResponseError;
|