@appwrite.io/console 2.1.3 → 2.3.0
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 +18 -0
- package/README.md +1 -1
- package/dist/cjs/sdk.js +2201 -692
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +2202 -693
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +2201 -692
- 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 +17 -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 +15 -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 +15 -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 +15 -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 +18 -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/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 +7 -5
- 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/{get-regions.md → list-regions.md} +3 -3
- 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 +4 -2
- 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 +20 -0
- package/docs/examples/databases/create-mediumtext-attribute.md +20 -0
- 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 +20 -0
- 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 +21 -0
- 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 +3 -1
- 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 +20 -0
- package/docs/examples/databases/update-mediumtext-attribute.md +20 -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 +20 -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 +21 -0
- package/docs/examples/databases/update.md +3 -1
- 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 +4 -2
- 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 +5 -3
- 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 +4 -2
- 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 +4 -2
- 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 +4 -2
- package/docs/examples/migrations/create-n-host-migration.md +4 -2
- package/docs/examples/migrations/create-supabase-migration.md +4 -2
- package/docs/examples/migrations/delete.md +2 -0
- package/docs/examples/migrations/get-appwrite-report.md +4 -2
- package/docs/examples/migrations/get-firebase-report.md +4 -2
- package/docs/examples/migrations/get-n-host-report.md +4 -2
- package/docs/examples/migrations/get-supabase-report.md +4 -2
- 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 +18 -0
- package/docs/examples/organizations/create.md +4 -2
- 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 +16 -0
- package/docs/examples/organizations/delete.md +2 -0
- package/docs/examples/organizations/estimation-create-organization.md +4 -2
- package/docs/examples/organizations/estimation-delete-organization.md +2 -0
- package/docs/examples/organizations/estimation-update-plan.md +4 -2
- 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/{update-projects.md → get-key.md} +4 -2
- 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 +16 -0
- package/docs/examples/organizations/list-regions.md +15 -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 +19 -0
- package/docs/examples/organizations/update-plan.md +4 -2
- 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 +4 -2
- package/docs/examples/projects/create-key.md +5 -2
- 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 +4 -2
- 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 +5 -3
- 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 +4 -2
- 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 +20 -0
- package/docs/examples/tablesdb/create-mediumtext-column.md +20 -0
- 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 +20 -0
- 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 +21 -0
- 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 +20 -0
- package/docs/examples/tablesdb/update-mediumtext-column.md +20 -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 +3 -1
- package/docs/examples/tablesdb/update-text-column.md +20 -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 +21 -0
- package/docs/examples/tablesdb/update.md +3 -1
- 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 +2 -0
- 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 +2 -0
- 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 +38 -22
- package/src/client.ts +110 -49
- package/src/enums/backup-services.ts +5 -0
- package/src/enums/browser-permission.ts +22 -0
- package/src/enums/build-runtime.ts +5 -0
- package/src/enums/deployment-status.ts +1 -0
- package/src/enums/frameworks.ts +17 -0
- package/src/enums/order-by.ts +4 -0
- package/src/enums/registration-type.ts +6 -0
- package/src/enums/resources.ts +13 -0
- package/src/enums/runtime.ts +5 -0
- package/src/enums/runtimes.ts +71 -0
- package/src/enums/scopes.ts +66 -0
- package/src/enums/use-cases.ts +11 -0
- package/src/index.ts +9 -2
- package/src/models.ts +394 -4
- package/src/services/account.ts +375 -67
- package/src/services/assistant.ts +1 -1
- package/src/services/avatars.ts +20 -19
- package/src/services/backups.ts +37 -36
- package/src/services/console.ts +12 -43
- package/src/services/databases.ts +1061 -281
- package/src/services/domains.ts +114 -44
- package/src/services/functions.ts +61 -58
- package/src/services/graphql.ts +4 -4
- package/src/services/health.ts +23 -21
- package/src/services/messaging.ts +56 -56
- package/src/services/migrations.ts +79 -78
- package/src/services/organizations.ts +430 -94
- package/src/services/project.ts +5 -5
- package/src/services/projects.ts +106 -155
- package/src/services/proxy.ts +8 -8
- package/src/services/realtime.ts +135 -58
- package/src/services/sites.ts +43 -41
- package/src/services/storage.ts +17 -17
- package/src/services/tables-db.ts +1051 -269
- package/src/services/teams.ts +14 -14
- package/src/services/tokens.ts +5 -5
- package/src/services/users.ts +50 -50
- package/src/services/vcs.ts +10 -10
- package/types/channel.d.ts +9 -7
- package/types/client.d.ts +7 -2
- package/types/enums/backup-services.d.ts +5 -0
- package/types/enums/browser-permission.d.ts +22 -0
- package/types/enums/build-runtime.d.ts +6 -1
- package/types/enums/deployment-status.d.ts +1 -0
- package/types/enums/frameworks.d.ts +17 -0
- package/types/enums/order-by.d.ts +4 -0
- package/types/enums/registration-type.d.ts +6 -0
- package/types/enums/resources.d.ts +13 -0
- package/types/enums/runtime.d.ts +6 -1
- package/types/enums/runtimes.d.ts +71 -0
- package/types/enums/scopes.d.ts +66 -0
- package/types/enums/use-cases.d.ts +11 -0
- package/types/index.d.ts +9 -2
- package/types/models.d.ts +385 -4
- package/types/services/account.d.ts +111 -0
- package/types/services/avatars.d.ts +5 -4
- package/types/services/backups.d.ts +13 -12
- package/types/services/console.d.ts +1 -13
- package/types/services/databases.d.ts +303 -8
- package/types/services/domains.d.ts +26 -0
- package/types/services/functions.d.ts +18 -15
- package/types/services/health.d.ts +2 -0
- package/types/services/migrations.d.ts +33 -32
- package/types/services/organizations.d.ts +151 -29
- package/types/services/projects.d.ts +20 -36
- package/types/services/realtime.d.ts +13 -6
- package/types/services/sites.d.ts +9 -7
- package/types/services/tables-db.d.ts +305 -8
- package/docs/examples/projects/update-status.md +0 -14
- package/src/enums/billing-plan.ts +0 -17
- package/src/enums/status.ts +0 -4
- package/types/enums/billing-plan.d.ts +0 -17
- package/types/enums/status.d.ts +0 -4
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
+
import { BackupServices } from '../enums/backup-services';
|
|
3
4
|
export declare class Backups {
|
|
4
5
|
client: Client;
|
|
5
6
|
constructor(client: Client);
|
|
@@ -25,25 +26,25 @@ export declare class Backups {
|
|
|
25
26
|
/**
|
|
26
27
|
* Create a new archive asynchronously for a project.
|
|
27
28
|
*
|
|
28
|
-
* @param {
|
|
29
|
+
* @param {BackupServices[]} params.services - Array of services to backup
|
|
29
30
|
* @param {string} params.resourceId - Resource ID. When set, only this single resource will be backed up.
|
|
30
31
|
* @throws {AppwriteException}
|
|
31
32
|
* @returns {Promise<Models.BackupArchive>}
|
|
32
33
|
*/
|
|
33
34
|
createArchive(params: {
|
|
34
|
-
services:
|
|
35
|
+
services: BackupServices[];
|
|
35
36
|
resourceId?: string;
|
|
36
37
|
}): Promise<Models.BackupArchive>;
|
|
37
38
|
/**
|
|
38
39
|
* Create a new archive asynchronously for a project.
|
|
39
40
|
*
|
|
40
|
-
* @param {
|
|
41
|
+
* @param {BackupServices[]} services - Array of services to backup
|
|
41
42
|
* @param {string} resourceId - Resource ID. When set, only this single resource will be backed up.
|
|
42
43
|
* @throws {AppwriteException}
|
|
43
44
|
* @returns {Promise<Models.BackupArchive>}
|
|
44
45
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
45
46
|
*/
|
|
46
|
-
createArchive(services:
|
|
47
|
+
createArchive(services: BackupServices[], resourceId?: string): Promise<Models.BackupArchive>;
|
|
47
48
|
/**
|
|
48
49
|
* Get a backup archive using it's ID.
|
|
49
50
|
*
|
|
@@ -105,7 +106,7 @@ export declare class Backups {
|
|
|
105
106
|
* Create a new backup policy.
|
|
106
107
|
*
|
|
107
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.
|
|
108
|
-
* @param {
|
|
109
|
+
* @param {BackupServices[]} params.services - Array of services to backup
|
|
109
110
|
* @param {number} params.retention - Days to keep backups before deletion
|
|
110
111
|
* @param {string} params.schedule - Schedule CRON syntax.
|
|
111
112
|
* @param {string} params.name - Policy name. Max length: 128 chars.
|
|
@@ -116,7 +117,7 @@ export declare class Backups {
|
|
|
116
117
|
*/
|
|
117
118
|
createPolicy(params: {
|
|
118
119
|
policyId: string;
|
|
119
|
-
services:
|
|
120
|
+
services: BackupServices[];
|
|
120
121
|
retention: number;
|
|
121
122
|
schedule: string;
|
|
122
123
|
name?: string;
|
|
@@ -127,7 +128,7 @@ export declare class Backups {
|
|
|
127
128
|
* Create a new backup policy.
|
|
128
129
|
*
|
|
129
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.
|
|
130
|
-
* @param {
|
|
131
|
+
* @param {BackupServices[]} services - Array of services to backup
|
|
131
132
|
* @param {number} retention - Days to keep backups before deletion
|
|
132
133
|
* @param {string} schedule - Schedule CRON syntax.
|
|
133
134
|
* @param {string} name - Policy name. Max length: 128 chars.
|
|
@@ -137,7 +138,7 @@ export declare class Backups {
|
|
|
137
138
|
* @returns {Promise<Models.BackupPolicy>}
|
|
138
139
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
139
140
|
*/
|
|
140
|
-
createPolicy(policyId: string, services:
|
|
141
|
+
createPolicy(policyId: string, services: BackupServices[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
|
|
141
142
|
/**
|
|
142
143
|
* Get a backup policy using it's ID.
|
|
143
144
|
*
|
|
@@ -211,7 +212,7 @@ export declare class Backups {
|
|
|
211
212
|
* Create and trigger a new restoration for a backup on a project.
|
|
212
213
|
*
|
|
213
214
|
* @param {string} params.archiveId - Backup archive ID to restore
|
|
214
|
-
* @param {
|
|
215
|
+
* @param {BackupServices[]} params.services - Array of services to restore
|
|
215
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.
|
|
216
217
|
* @param {string} params.newResourceName - Database name. Max length: 128 chars.
|
|
217
218
|
* @throws {AppwriteException}
|
|
@@ -219,7 +220,7 @@ export declare class Backups {
|
|
|
219
220
|
*/
|
|
220
221
|
createRestoration(params: {
|
|
221
222
|
archiveId: string;
|
|
222
|
-
services:
|
|
223
|
+
services: BackupServices[];
|
|
223
224
|
newResourceId?: string;
|
|
224
225
|
newResourceName?: string;
|
|
225
226
|
}): Promise<Models.BackupRestoration>;
|
|
@@ -227,14 +228,14 @@ export declare class Backups {
|
|
|
227
228
|
* Create and trigger a new restoration for a backup on a project.
|
|
228
229
|
*
|
|
229
230
|
* @param {string} archiveId - Backup archive ID to restore
|
|
230
|
-
* @param {
|
|
231
|
+
* @param {BackupServices[]} services - Array of services to restore
|
|
231
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.
|
|
232
233
|
* @param {string} newResourceName - Database name. Max length: 128 chars.
|
|
233
234
|
* @throws {AppwriteException}
|
|
234
235
|
* @returns {Promise<Models.BackupRestoration>}
|
|
235
236
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
236
237
|
*/
|
|
237
|
-
createRestoration(archiveId: string, services:
|
|
238
|
+
createRestoration(archiveId: string, services: BackupServices[], newResourceId?: string, newResourceName?: string): Promise<Models.BackupRestoration>;
|
|
238
239
|
/**
|
|
239
240
|
* List all backup restorations for a project.
|
|
240
241
|
*
|
|
@@ -122,22 +122,10 @@ export declare class Console {
|
|
|
122
122
|
/**
|
|
123
123
|
* Get all available regions for the console.
|
|
124
124
|
*
|
|
125
|
-
* @param {string} params.organizationId - Team ID.
|
|
126
125
|
* @throws {AppwriteException}
|
|
127
126
|
* @returns {Promise<Models.ConsoleRegionList>}
|
|
128
127
|
*/
|
|
129
|
-
|
|
130
|
-
organizationId: string;
|
|
131
|
-
}): Promise<Models.ConsoleRegionList>;
|
|
132
|
-
/**
|
|
133
|
-
* Get all available regions for the console.
|
|
134
|
-
*
|
|
135
|
-
* @param {string} organizationId - Team ID.
|
|
136
|
-
* @throws {AppwriteException}
|
|
137
|
-
* @returns {Promise<Models.ConsoleRegionList>}
|
|
138
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
139
|
-
*/
|
|
140
|
-
getRegions(organizationId: string): Promise<Models.ConsoleRegionList>;
|
|
128
|
+
listRegions(): Promise<Models.ConsoleRegionList>;
|
|
141
129
|
/**
|
|
142
130
|
* Check if a resource ID is available.
|
|
143
131
|
*
|
|
@@ -4,6 +4,7 @@ import { UsageRange } from '../enums/usage-range';
|
|
|
4
4
|
import { RelationshipType } from '../enums/relationship-type';
|
|
5
5
|
import { RelationMutate } from '../enums/relation-mutate';
|
|
6
6
|
import { IndexType } from '../enums/index-type';
|
|
7
|
+
import { OrderBy } from '../enums/order-by';
|
|
7
8
|
export declare class Databases {
|
|
8
9
|
client: Client;
|
|
9
10
|
constructor(client: Client);
|
|
@@ -236,7 +237,7 @@ export declare class Databases {
|
|
|
236
237
|
*/
|
|
237
238
|
update(params: {
|
|
238
239
|
databaseId: string;
|
|
239
|
-
name
|
|
240
|
+
name?: string;
|
|
240
241
|
enabled?: boolean;
|
|
241
242
|
}): Promise<Models.Database>;
|
|
242
243
|
/**
|
|
@@ -249,7 +250,7 @@ export declare class Databases {
|
|
|
249
250
|
* @returns {Promise<Models.Database>}
|
|
250
251
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
251
252
|
*/
|
|
252
|
-
update(databaseId: string, name
|
|
253
|
+
update(databaseId: string, name?: string, enabled?: boolean): Promise<Models.Database>;
|
|
253
254
|
/**
|
|
254
255
|
* Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
|
|
255
256
|
*
|
|
@@ -379,7 +380,7 @@ export declare class Databases {
|
|
|
379
380
|
updateCollection(params: {
|
|
380
381
|
databaseId: string;
|
|
381
382
|
collectionId: string;
|
|
382
|
-
name
|
|
383
|
+
name?: string;
|
|
383
384
|
permissions?: string[];
|
|
384
385
|
documentSecurity?: boolean;
|
|
385
386
|
enabled?: boolean;
|
|
@@ -397,7 +398,7 @@ export declare class Databases {
|
|
|
397
398
|
* @returns {Promise<Models.Collection>}
|
|
398
399
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
399
400
|
*/
|
|
400
|
-
updateCollection(databaseId: string, collectionId: string, name
|
|
401
|
+
updateCollection(databaseId: string, collectionId: string, name?: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
|
|
401
402
|
/**
|
|
402
403
|
* Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.
|
|
403
404
|
*
|
|
@@ -1059,6 +1060,150 @@ export declare class Databases {
|
|
|
1059
1060
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1060
1061
|
*/
|
|
1061
1062
|
updateLineAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.AttributeLine>;
|
|
1063
|
+
/**
|
|
1064
|
+
* Create a longtext attribute.
|
|
1065
|
+
*
|
|
1066
|
+
*
|
|
1067
|
+
* @param {string} params.databaseId - Database ID.
|
|
1068
|
+
* @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1069
|
+
* @param {string} params.key - Attribute Key.
|
|
1070
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1071
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1072
|
+
* @param {boolean} params.array - Is attribute an array?
|
|
1073
|
+
* @throws {AppwriteException}
|
|
1074
|
+
* @returns {Promise<Models.AttributeLongtext>}
|
|
1075
|
+
*/
|
|
1076
|
+
createLongtextAttribute(params: {
|
|
1077
|
+
databaseId: string;
|
|
1078
|
+
collectionId: string;
|
|
1079
|
+
key: string;
|
|
1080
|
+
required: boolean;
|
|
1081
|
+
xdefault?: string;
|
|
1082
|
+
array?: boolean;
|
|
1083
|
+
}): Promise<Models.AttributeLongtext>;
|
|
1084
|
+
/**
|
|
1085
|
+
* Create a longtext attribute.
|
|
1086
|
+
*
|
|
1087
|
+
*
|
|
1088
|
+
* @param {string} databaseId - Database ID.
|
|
1089
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1090
|
+
* @param {string} key - Attribute Key.
|
|
1091
|
+
* @param {boolean} required - Is attribute required?
|
|
1092
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1093
|
+
* @param {boolean} array - Is attribute an array?
|
|
1094
|
+
* @throws {AppwriteException}
|
|
1095
|
+
* @returns {Promise<Models.AttributeLongtext>}
|
|
1096
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1097
|
+
*/
|
|
1098
|
+
createLongtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeLongtext>;
|
|
1099
|
+
/**
|
|
1100
|
+
* Update a longtext attribute. Changing the `default` value will not update already existing documents.
|
|
1101
|
+
*
|
|
1102
|
+
*
|
|
1103
|
+
* @param {string} params.databaseId - Database ID.
|
|
1104
|
+
* @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1105
|
+
* @param {string} params.key - Attribute Key.
|
|
1106
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1107
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1108
|
+
* @param {string} params.newKey - New Attribute Key.
|
|
1109
|
+
* @throws {AppwriteException}
|
|
1110
|
+
* @returns {Promise<Models.AttributeLongtext>}
|
|
1111
|
+
*/
|
|
1112
|
+
updateLongtextAttribute(params: {
|
|
1113
|
+
databaseId: string;
|
|
1114
|
+
collectionId: string;
|
|
1115
|
+
key: string;
|
|
1116
|
+
required: boolean;
|
|
1117
|
+
xdefault?: string;
|
|
1118
|
+
newKey?: string;
|
|
1119
|
+
}): Promise<Models.AttributeLongtext>;
|
|
1120
|
+
/**
|
|
1121
|
+
* Update a longtext attribute. Changing the `default` value will not update already existing documents.
|
|
1122
|
+
*
|
|
1123
|
+
*
|
|
1124
|
+
* @param {string} databaseId - Database ID.
|
|
1125
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1126
|
+
* @param {string} key - Attribute Key.
|
|
1127
|
+
* @param {boolean} required - Is attribute required?
|
|
1128
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1129
|
+
* @param {string} newKey - New Attribute Key.
|
|
1130
|
+
* @throws {AppwriteException}
|
|
1131
|
+
* @returns {Promise<Models.AttributeLongtext>}
|
|
1132
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1133
|
+
*/
|
|
1134
|
+
updateLongtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeLongtext>;
|
|
1135
|
+
/**
|
|
1136
|
+
* Create a mediumtext attribute.
|
|
1137
|
+
*
|
|
1138
|
+
*
|
|
1139
|
+
* @param {string} params.databaseId - Database ID.
|
|
1140
|
+
* @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1141
|
+
* @param {string} params.key - Attribute Key.
|
|
1142
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1143
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1144
|
+
* @param {boolean} params.array - Is attribute an array?
|
|
1145
|
+
* @throws {AppwriteException}
|
|
1146
|
+
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1147
|
+
*/
|
|
1148
|
+
createMediumtextAttribute(params: {
|
|
1149
|
+
databaseId: string;
|
|
1150
|
+
collectionId: string;
|
|
1151
|
+
key: string;
|
|
1152
|
+
required: boolean;
|
|
1153
|
+
xdefault?: string;
|
|
1154
|
+
array?: boolean;
|
|
1155
|
+
}): Promise<Models.AttributeMediumtext>;
|
|
1156
|
+
/**
|
|
1157
|
+
* Create a mediumtext attribute.
|
|
1158
|
+
*
|
|
1159
|
+
*
|
|
1160
|
+
* @param {string} databaseId - Database ID.
|
|
1161
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1162
|
+
* @param {string} key - Attribute Key.
|
|
1163
|
+
* @param {boolean} required - Is attribute required?
|
|
1164
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1165
|
+
* @param {boolean} array - Is attribute an array?
|
|
1166
|
+
* @throws {AppwriteException}
|
|
1167
|
+
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1168
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1169
|
+
*/
|
|
1170
|
+
createMediumtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeMediumtext>;
|
|
1171
|
+
/**
|
|
1172
|
+
* Update a mediumtext attribute. Changing the `default` value will not update already existing documents.
|
|
1173
|
+
*
|
|
1174
|
+
*
|
|
1175
|
+
* @param {string} params.databaseId - Database ID.
|
|
1176
|
+
* @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1177
|
+
* @param {string} params.key - Attribute Key.
|
|
1178
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1179
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1180
|
+
* @param {string} params.newKey - New Attribute Key.
|
|
1181
|
+
* @throws {AppwriteException}
|
|
1182
|
+
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1183
|
+
*/
|
|
1184
|
+
updateMediumtextAttribute(params: {
|
|
1185
|
+
databaseId: string;
|
|
1186
|
+
collectionId: string;
|
|
1187
|
+
key: string;
|
|
1188
|
+
required: boolean;
|
|
1189
|
+
xdefault?: string;
|
|
1190
|
+
newKey?: string;
|
|
1191
|
+
}): Promise<Models.AttributeMediumtext>;
|
|
1192
|
+
/**
|
|
1193
|
+
* Update a mediumtext attribute. Changing the `default` value will not update already existing documents.
|
|
1194
|
+
*
|
|
1195
|
+
*
|
|
1196
|
+
* @param {string} databaseId - Database ID.
|
|
1197
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1198
|
+
* @param {string} key - Attribute Key.
|
|
1199
|
+
* @param {boolean} required - Is attribute required?
|
|
1200
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1201
|
+
* @param {string} newKey - New Attribute Key.
|
|
1202
|
+
* @throws {AppwriteException}
|
|
1203
|
+
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1204
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1205
|
+
*/
|
|
1206
|
+
updateMediumtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeMediumtext>;
|
|
1062
1207
|
/**
|
|
1063
1208
|
* Create a geometric point attribute.
|
|
1064
1209
|
*
|
|
@@ -1319,6 +1464,78 @@ export declare class Databases {
|
|
|
1319
1464
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1320
1465
|
*/
|
|
1321
1466
|
updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.AttributeString>;
|
|
1467
|
+
/**
|
|
1468
|
+
* Create a text attribute.
|
|
1469
|
+
*
|
|
1470
|
+
*
|
|
1471
|
+
* @param {string} params.databaseId - Database ID.
|
|
1472
|
+
* @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1473
|
+
* @param {string} params.key - Attribute Key.
|
|
1474
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1475
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1476
|
+
* @param {boolean} params.array - Is attribute an array?
|
|
1477
|
+
* @throws {AppwriteException}
|
|
1478
|
+
* @returns {Promise<Models.AttributeText>}
|
|
1479
|
+
*/
|
|
1480
|
+
createTextAttribute(params: {
|
|
1481
|
+
databaseId: string;
|
|
1482
|
+
collectionId: string;
|
|
1483
|
+
key: string;
|
|
1484
|
+
required: boolean;
|
|
1485
|
+
xdefault?: string;
|
|
1486
|
+
array?: boolean;
|
|
1487
|
+
}): Promise<Models.AttributeText>;
|
|
1488
|
+
/**
|
|
1489
|
+
* Create a text attribute.
|
|
1490
|
+
*
|
|
1491
|
+
*
|
|
1492
|
+
* @param {string} databaseId - Database ID.
|
|
1493
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1494
|
+
* @param {string} key - Attribute Key.
|
|
1495
|
+
* @param {boolean} required - Is attribute required?
|
|
1496
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1497
|
+
* @param {boolean} array - Is attribute an array?
|
|
1498
|
+
* @throws {AppwriteException}
|
|
1499
|
+
* @returns {Promise<Models.AttributeText>}
|
|
1500
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1501
|
+
*/
|
|
1502
|
+
createTextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeText>;
|
|
1503
|
+
/**
|
|
1504
|
+
* Update a text attribute. Changing the `default` value will not update already existing documents.
|
|
1505
|
+
*
|
|
1506
|
+
*
|
|
1507
|
+
* @param {string} params.databaseId - Database ID.
|
|
1508
|
+
* @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1509
|
+
* @param {string} params.key - Attribute Key.
|
|
1510
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1511
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1512
|
+
* @param {string} params.newKey - New Attribute Key.
|
|
1513
|
+
* @throws {AppwriteException}
|
|
1514
|
+
* @returns {Promise<Models.AttributeText>}
|
|
1515
|
+
*/
|
|
1516
|
+
updateTextAttribute(params: {
|
|
1517
|
+
databaseId: string;
|
|
1518
|
+
collectionId: string;
|
|
1519
|
+
key: string;
|
|
1520
|
+
required: boolean;
|
|
1521
|
+
xdefault?: string;
|
|
1522
|
+
newKey?: string;
|
|
1523
|
+
}): Promise<Models.AttributeText>;
|
|
1524
|
+
/**
|
|
1525
|
+
* Update a text attribute. Changing the `default` value will not update already existing documents.
|
|
1526
|
+
*
|
|
1527
|
+
*
|
|
1528
|
+
* @param {string} databaseId - Database ID.
|
|
1529
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1530
|
+
* @param {string} key - Attribute Key.
|
|
1531
|
+
* @param {boolean} required - Is attribute required?
|
|
1532
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1533
|
+
* @param {string} newKey - New Attribute Key.
|
|
1534
|
+
* @throws {AppwriteException}
|
|
1535
|
+
* @returns {Promise<Models.AttributeText>}
|
|
1536
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1537
|
+
*/
|
|
1538
|
+
updateTextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeText>;
|
|
1322
1539
|
/**
|
|
1323
1540
|
* Create a URL attribute.
|
|
1324
1541
|
*
|
|
@@ -1393,6 +1610,84 @@ export declare class Databases {
|
|
|
1393
1610
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1394
1611
|
*/
|
|
1395
1612
|
updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeUrl>;
|
|
1613
|
+
/**
|
|
1614
|
+
* Create a varchar attribute.
|
|
1615
|
+
*
|
|
1616
|
+
*
|
|
1617
|
+
* @param {string} params.databaseId - Database ID.
|
|
1618
|
+
* @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1619
|
+
* @param {string} params.key - Attribute Key.
|
|
1620
|
+
* @param {number} params.size - Attribute size for varchar attributes, in number of characters. Maximum size is 16381.
|
|
1621
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1622
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1623
|
+
* @param {boolean} params.array - Is attribute an array?
|
|
1624
|
+
* @throws {AppwriteException}
|
|
1625
|
+
* @returns {Promise<Models.AttributeVarchar>}
|
|
1626
|
+
*/
|
|
1627
|
+
createVarcharAttribute(params: {
|
|
1628
|
+
databaseId: string;
|
|
1629
|
+
collectionId: string;
|
|
1630
|
+
key: string;
|
|
1631
|
+
size: number;
|
|
1632
|
+
required: boolean;
|
|
1633
|
+
xdefault?: string;
|
|
1634
|
+
array?: boolean;
|
|
1635
|
+
}): Promise<Models.AttributeVarchar>;
|
|
1636
|
+
/**
|
|
1637
|
+
* Create a varchar attribute.
|
|
1638
|
+
*
|
|
1639
|
+
*
|
|
1640
|
+
* @param {string} databaseId - Database ID.
|
|
1641
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1642
|
+
* @param {string} key - Attribute Key.
|
|
1643
|
+
* @param {number} size - Attribute size for varchar attributes, in number of characters. Maximum size is 16381.
|
|
1644
|
+
* @param {boolean} required - Is attribute required?
|
|
1645
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1646
|
+
* @param {boolean} array - Is attribute an array?
|
|
1647
|
+
* @throws {AppwriteException}
|
|
1648
|
+
* @returns {Promise<Models.AttributeVarchar>}
|
|
1649
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1650
|
+
*/
|
|
1651
|
+
createVarcharAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeVarchar>;
|
|
1652
|
+
/**
|
|
1653
|
+
* Update a varchar attribute. Changing the `default` value will not update already existing documents.
|
|
1654
|
+
*
|
|
1655
|
+
*
|
|
1656
|
+
* @param {string} params.databaseId - Database ID.
|
|
1657
|
+
* @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1658
|
+
* @param {string} params.key - Attribute Key.
|
|
1659
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1660
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1661
|
+
* @param {number} params.size - Maximum size of the varchar attribute.
|
|
1662
|
+
* @param {string} params.newKey - New Attribute Key.
|
|
1663
|
+
* @throws {AppwriteException}
|
|
1664
|
+
* @returns {Promise<Models.AttributeVarchar>}
|
|
1665
|
+
*/
|
|
1666
|
+
updateVarcharAttribute(params: {
|
|
1667
|
+
databaseId: string;
|
|
1668
|
+
collectionId: string;
|
|
1669
|
+
key: string;
|
|
1670
|
+
required: boolean;
|
|
1671
|
+
xdefault?: string;
|
|
1672
|
+
size?: number;
|
|
1673
|
+
newKey?: string;
|
|
1674
|
+
}): Promise<Models.AttributeVarchar>;
|
|
1675
|
+
/**
|
|
1676
|
+
* Update a varchar attribute. Changing the `default` value will not update already existing documents.
|
|
1677
|
+
*
|
|
1678
|
+
*
|
|
1679
|
+
* @param {string} databaseId - Database ID.
|
|
1680
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1681
|
+
* @param {string} key - Attribute Key.
|
|
1682
|
+
* @param {boolean} required - Is attribute required?
|
|
1683
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1684
|
+
* @param {number} size - Maximum size of the varchar attribute.
|
|
1685
|
+
* @param {string} newKey - New Attribute Key.
|
|
1686
|
+
* @throws {AppwriteException}
|
|
1687
|
+
* @returns {Promise<Models.AttributeVarchar>}
|
|
1688
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1689
|
+
*/
|
|
1690
|
+
updateVarcharAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.AttributeVarchar>;
|
|
1396
1691
|
/**
|
|
1397
1692
|
* Get attribute by ID.
|
|
1398
1693
|
*
|
|
@@ -1941,7 +2236,7 @@ export declare class Databases {
|
|
|
1941
2236
|
* @param {string} params.key - Index Key.
|
|
1942
2237
|
* @param {IndexType} params.type - Index type.
|
|
1943
2238
|
* @param {string[]} params.attributes - Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
|
|
1944
|
-
* @param {
|
|
2239
|
+
* @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1945
2240
|
* @param {number[]} params.lengths - Length of index. Maximum of 100
|
|
1946
2241
|
* @throws {AppwriteException}
|
|
1947
2242
|
* @returns {Promise<Models.Index>}
|
|
@@ -1953,7 +2248,7 @@ export declare class Databases {
|
|
|
1953
2248
|
key: string;
|
|
1954
2249
|
type: IndexType;
|
|
1955
2250
|
attributes: string[];
|
|
1956
|
-
orders?:
|
|
2251
|
+
orders?: OrderBy[];
|
|
1957
2252
|
lengths?: number[];
|
|
1958
2253
|
}): Promise<Models.Index>;
|
|
1959
2254
|
/**
|
|
@@ -1965,13 +2260,13 @@ export declare class Databases {
|
|
|
1965
2260
|
* @param {string} key - Index Key.
|
|
1966
2261
|
* @param {IndexType} type - Index type.
|
|
1967
2262
|
* @param {string[]} attributes - Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
|
|
1968
|
-
* @param {
|
|
2263
|
+
* @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1969
2264
|
* @param {number[]} lengths - Length of index. Maximum of 100
|
|
1970
2265
|
* @throws {AppwriteException}
|
|
1971
2266
|
* @returns {Promise<Models.Index>}
|
|
1972
2267
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1973
2268
|
*/
|
|
1974
|
-
createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?:
|
|
2269
|
+
createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.Index>;
|
|
1975
2270
|
/**
|
|
1976
2271
|
* Get an index by its unique ID.
|
|
1977
2272
|
*
|
|
@@ -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
|
*
|