@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,7 +1,7 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
-
import { BillingPlan } from '../enums/billing-plan';
|
|
4
3
|
import { Platform } from '../enums/platform';
|
|
4
|
+
import { Scopes } from '../enums/scopes';
|
|
5
5
|
export declare class Organizations {
|
|
6
6
|
client: Client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -33,7 +33,7 @@ export declare class Organizations {
|
|
|
33
33
|
*
|
|
34
34
|
* @param {string} params.organizationId - Organization ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
35
35
|
* @param {string} params.name - Organization name. Max length: 128 chars.
|
|
36
|
-
* @param {
|
|
36
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
37
37
|
* @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
38
38
|
* @param {string} params.billingAddressId - Unique ID of billing address
|
|
39
39
|
* @param {string[]} params.invites - Additional member invites
|
|
@@ -47,7 +47,7 @@ export declare class Organizations {
|
|
|
47
47
|
create<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
48
48
|
organizationId: string;
|
|
49
49
|
name: string;
|
|
50
|
-
billingPlan:
|
|
50
|
+
billingPlan: string;
|
|
51
51
|
paymentMethodId?: string;
|
|
52
52
|
billingAddressId?: string;
|
|
53
53
|
invites?: string[];
|
|
@@ -62,7 +62,7 @@ export declare class Organizations {
|
|
|
62
62
|
*
|
|
63
63
|
* @param {string} organizationId - Organization ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
64
64
|
* @param {string} name - Organization name. Max length: 128 chars.
|
|
65
|
-
* @param {
|
|
65
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
66
66
|
* @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
67
67
|
* @param {string} billingAddressId - Unique ID of billing address
|
|
68
68
|
* @param {string[]} invites - Additional member invites
|
|
@@ -74,11 +74,11 @@ export declare class Organizations {
|
|
|
74
74
|
* @returns {Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>}
|
|
75
75
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
76
76
|
*/
|
|
77
|
-
create<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, name: string, billingPlan:
|
|
77
|
+
create<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, name: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number, platform?: Platform): Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>;
|
|
78
78
|
/**
|
|
79
79
|
* Get estimation for creating an organization.
|
|
80
80
|
*
|
|
81
|
-
* @param {
|
|
81
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
82
82
|
* @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
83
83
|
* @param {string[]} params.invites - Additional member invites
|
|
84
84
|
* @param {string} params.couponId - Coupon id
|
|
@@ -87,7 +87,7 @@ export declare class Organizations {
|
|
|
87
87
|
* @returns {Promise<Models.Estimation>}
|
|
88
88
|
*/
|
|
89
89
|
estimationCreateOrganization(params: {
|
|
90
|
-
billingPlan:
|
|
90
|
+
billingPlan: string;
|
|
91
91
|
paymentMethodId?: string;
|
|
92
92
|
invites?: string[];
|
|
93
93
|
couponId?: string;
|
|
@@ -96,7 +96,7 @@ export declare class Organizations {
|
|
|
96
96
|
/**
|
|
97
97
|
* Get estimation for creating an organization.
|
|
98
98
|
*
|
|
99
|
-
* @param {
|
|
99
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
100
100
|
* @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
101
101
|
* @param {string[]} invites - Additional member invites
|
|
102
102
|
* @param {string} couponId - Coupon id
|
|
@@ -105,7 +105,7 @@ export declare class Organizations {
|
|
|
105
105
|
* @returns {Promise<Models.Estimation>}
|
|
106
106
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
107
107
|
*/
|
|
108
|
-
estimationCreateOrganization(billingPlan:
|
|
108
|
+
estimationCreateOrganization(billingPlan: string, paymentMethodId?: string, invites?: string[], couponId?: string, platform?: Platform): Promise<Models.Estimation>;
|
|
109
109
|
/**
|
|
110
110
|
* Delete an organization.
|
|
111
111
|
*
|
|
@@ -395,7 +395,7 @@ export declare class Organizations {
|
|
|
395
395
|
* Get estimation for updating the organization plan.
|
|
396
396
|
*
|
|
397
397
|
* @param {string} params.organizationId - Organization ID
|
|
398
|
-
* @param {
|
|
398
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
399
399
|
* @param {string[]} params.invites - Additional member invites
|
|
400
400
|
* @param {string} params.couponId - Coupon id
|
|
401
401
|
* @throws {AppwriteException}
|
|
@@ -403,7 +403,7 @@ export declare class Organizations {
|
|
|
403
403
|
*/
|
|
404
404
|
estimationUpdatePlan(params: {
|
|
405
405
|
organizationId: string;
|
|
406
|
-
billingPlan:
|
|
406
|
+
billingPlan: string;
|
|
407
407
|
invites?: string[];
|
|
408
408
|
couponId?: string;
|
|
409
409
|
}): Promise<Models.EstimationUpdatePlan>;
|
|
@@ -411,14 +411,14 @@ export declare class Organizations {
|
|
|
411
411
|
* Get estimation for updating the organization plan.
|
|
412
412
|
*
|
|
413
413
|
* @param {string} organizationId - Organization ID
|
|
414
|
-
* @param {
|
|
414
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
415
415
|
* @param {string[]} invites - Additional member invites
|
|
416
416
|
* @param {string} couponId - Coupon id
|
|
417
417
|
* @throws {AppwriteException}
|
|
418
418
|
* @returns {Promise<Models.EstimationUpdatePlan>}
|
|
419
419
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
420
420
|
*/
|
|
421
|
-
estimationUpdatePlan(organizationId: string, billingPlan:
|
|
421
|
+
estimationUpdatePlan(organizationId: string, billingPlan: string, invites?: string[], couponId?: string): Promise<Models.EstimationUpdatePlan>;
|
|
422
422
|
/**
|
|
423
423
|
* Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
|
|
424
424
|
*
|
|
@@ -587,6 +587,131 @@ export declare class Organizations {
|
|
|
587
587
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
588
588
|
*/
|
|
589
589
|
getInvoiceView(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
|
|
590
|
+
/**
|
|
591
|
+
* Get a list of all API keys from the current organization.
|
|
592
|
+
*
|
|
593
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
594
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
595
|
+
* @throws {AppwriteException}
|
|
596
|
+
* @returns {Promise<Models.KeyList>}
|
|
597
|
+
*/
|
|
598
|
+
listKeys(params: {
|
|
599
|
+
organizationId: string;
|
|
600
|
+
total?: boolean;
|
|
601
|
+
}): Promise<Models.KeyList>;
|
|
602
|
+
/**
|
|
603
|
+
* Get a list of all API keys from the current organization.
|
|
604
|
+
*
|
|
605
|
+
* @param {string} organizationId - Organization Unique ID
|
|
606
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
607
|
+
* @throws {AppwriteException}
|
|
608
|
+
* @returns {Promise<Models.KeyList>}
|
|
609
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
610
|
+
*/
|
|
611
|
+
listKeys(organizationId: string, total?: boolean): Promise<Models.KeyList>;
|
|
612
|
+
/**
|
|
613
|
+
* Create a new organization API key.
|
|
614
|
+
*
|
|
615
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
616
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
617
|
+
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
618
|
+
* @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.
|
|
619
|
+
* @throws {AppwriteException}
|
|
620
|
+
* @returns {Promise<Models.Key>}
|
|
621
|
+
*/
|
|
622
|
+
createKey(params: {
|
|
623
|
+
organizationId: string;
|
|
624
|
+
name: string;
|
|
625
|
+
scopes: Scopes[];
|
|
626
|
+
expire?: string;
|
|
627
|
+
}): Promise<Models.Key>;
|
|
628
|
+
/**
|
|
629
|
+
* Create a new organization API key.
|
|
630
|
+
*
|
|
631
|
+
* @param {string} organizationId - Organization Unique ID
|
|
632
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
633
|
+
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
634
|
+
* @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.
|
|
635
|
+
* @throws {AppwriteException}
|
|
636
|
+
* @returns {Promise<Models.Key>}
|
|
637
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
638
|
+
*/
|
|
639
|
+
createKey(organizationId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
|
|
640
|
+
/**
|
|
641
|
+
* Get a key by its unique ID. This endpoint returns details about a specific API key in your organization including it's scopes.
|
|
642
|
+
*
|
|
643
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
644
|
+
* @param {string} params.keyId - Key unique ID.
|
|
645
|
+
* @throws {AppwriteException}
|
|
646
|
+
* @returns {Promise<Models.Key>}
|
|
647
|
+
*/
|
|
648
|
+
getKey(params: {
|
|
649
|
+
organizationId: string;
|
|
650
|
+
keyId: string;
|
|
651
|
+
}): Promise<Models.Key>;
|
|
652
|
+
/**
|
|
653
|
+
* Get a key by its unique ID. This endpoint returns details about a specific API key in your organization including it's scopes.
|
|
654
|
+
*
|
|
655
|
+
* @param {string} organizationId - Organization Unique ID
|
|
656
|
+
* @param {string} keyId - Key unique ID.
|
|
657
|
+
* @throws {AppwriteException}
|
|
658
|
+
* @returns {Promise<Models.Key>}
|
|
659
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
660
|
+
*/
|
|
661
|
+
getKey(organizationId: string, keyId: string): Promise<Models.Key>;
|
|
662
|
+
/**
|
|
663
|
+
* Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
|
|
664
|
+
*
|
|
665
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
666
|
+
* @param {string} params.keyId - Key unique ID.
|
|
667
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
668
|
+
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
669
|
+
* @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.
|
|
670
|
+
* @throws {AppwriteException}
|
|
671
|
+
* @returns {Promise<Models.Key>}
|
|
672
|
+
*/
|
|
673
|
+
updateKey(params: {
|
|
674
|
+
organizationId: string;
|
|
675
|
+
keyId: string;
|
|
676
|
+
name: string;
|
|
677
|
+
scopes: Scopes[];
|
|
678
|
+
expire?: string;
|
|
679
|
+
}): Promise<Models.Key>;
|
|
680
|
+
/**
|
|
681
|
+
* Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
|
|
682
|
+
*
|
|
683
|
+
* @param {string} organizationId - Organization Unique ID
|
|
684
|
+
* @param {string} keyId - Key unique ID.
|
|
685
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
686
|
+
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
687
|
+
* @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.
|
|
688
|
+
* @throws {AppwriteException}
|
|
689
|
+
* @returns {Promise<Models.Key>}
|
|
690
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
691
|
+
*/
|
|
692
|
+
updateKey(organizationId: string, keyId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
|
|
693
|
+
/**
|
|
694
|
+
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
695
|
+
*
|
|
696
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
697
|
+
* @param {string} params.keyId - Key unique ID.
|
|
698
|
+
* @throws {AppwriteException}
|
|
699
|
+
* @returns {Promise<{}>}
|
|
700
|
+
*/
|
|
701
|
+
deleteKey(params: {
|
|
702
|
+
organizationId: string;
|
|
703
|
+
keyId: string;
|
|
704
|
+
}): Promise<{}>;
|
|
705
|
+
/**
|
|
706
|
+
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
707
|
+
*
|
|
708
|
+
* @param {string} organizationId - Organization Unique ID
|
|
709
|
+
* @param {string} keyId - Key unique ID.
|
|
710
|
+
* @throws {AppwriteException}
|
|
711
|
+
* @returns {Promise<{}>}
|
|
712
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
713
|
+
*/
|
|
714
|
+
deleteKey(organizationId: string, keyId: string): Promise<{}>;
|
|
590
715
|
/**
|
|
591
716
|
* Set a organization's default payment method.
|
|
592
717
|
*
|
|
@@ -716,7 +841,7 @@ export declare class Organizations {
|
|
|
716
841
|
* Update the billing plan for an organization.
|
|
717
842
|
*
|
|
718
843
|
* @param {string} params.organizationId - Organization Unique ID
|
|
719
|
-
* @param {
|
|
844
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
720
845
|
* @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
721
846
|
* @param {string} params.billingAddressId - Unique ID of billing address
|
|
722
847
|
* @param {string[]} params.invites - Additional member invites
|
|
@@ -728,7 +853,7 @@ export declare class Organizations {
|
|
|
728
853
|
*/
|
|
729
854
|
updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
730
855
|
organizationId: string;
|
|
731
|
-
billingPlan:
|
|
856
|
+
billingPlan: string;
|
|
732
857
|
paymentMethodId?: string;
|
|
733
858
|
billingAddressId?: string;
|
|
734
859
|
invites?: string[];
|
|
@@ -740,7 +865,7 @@ export declare class Organizations {
|
|
|
740
865
|
* Update the billing plan for an organization.
|
|
741
866
|
*
|
|
742
867
|
* @param {string} organizationId - Organization Unique ID
|
|
743
|
-
* @param {
|
|
868
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
744
869
|
* @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
745
870
|
* @param {string} billingAddressId - Unique ID of billing address
|
|
746
871
|
* @param {string[]} invites - Additional member invites
|
|
@@ -751,7 +876,7 @@ export declare class Organizations {
|
|
|
751
876
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
752
877
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
753
878
|
*/
|
|
754
|
-
updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingPlan:
|
|
879
|
+
updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
|
|
755
880
|
/**
|
|
756
881
|
* Cancel the downgrade initiated for an organization.
|
|
757
882
|
*
|
|
@@ -772,27 +897,24 @@ export declare class Organizations {
|
|
|
772
897
|
*/
|
|
773
898
|
cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
774
899
|
/**
|
|
775
|
-
*
|
|
900
|
+
* Get all available regions for an organization.
|
|
776
901
|
*
|
|
777
|
-
* @param {string} params.organizationId -
|
|
778
|
-
* @param {string[]} params.projects - List of project IDs to be selected for the organization
|
|
902
|
+
* @param {string} params.organizationId - Team ID.
|
|
779
903
|
* @throws {AppwriteException}
|
|
780
|
-
* @returns {Promise<Models.
|
|
904
|
+
* @returns {Promise<Models.ConsoleRegionList>}
|
|
781
905
|
*/
|
|
782
|
-
|
|
906
|
+
listRegions(params: {
|
|
783
907
|
organizationId: string;
|
|
784
|
-
|
|
785
|
-
}): Promise<Models.Organization<Preferences>>;
|
|
908
|
+
}): Promise<Models.ConsoleRegionList>;
|
|
786
909
|
/**
|
|
787
|
-
*
|
|
910
|
+
* Get all available regions for an organization.
|
|
788
911
|
*
|
|
789
|
-
* @param {string} organizationId -
|
|
790
|
-
* @param {string[]} projects - List of project IDs to be selected for the organization
|
|
912
|
+
* @param {string} organizationId - Team ID.
|
|
791
913
|
* @throws {AppwriteException}
|
|
792
|
-
* @returns {Promise<Models.
|
|
914
|
+
* @returns {Promise<Models.ConsoleRegionList>}
|
|
793
915
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
794
916
|
*/
|
|
795
|
-
|
|
917
|
+
listRegions(organizationId: string): Promise<Models.ConsoleRegionList>;
|
|
796
918
|
/**
|
|
797
919
|
* Get Scopes
|
|
798
920
|
*
|
|
@@ -3,11 +3,11 @@ import type { Models } from '../models';
|
|
|
3
3
|
import { Region } from '../enums/region';
|
|
4
4
|
import { Api } from '../enums/api';
|
|
5
5
|
import { AuthMethod } from '../enums/auth-method';
|
|
6
|
+
import { Scopes } from '../enums/scopes';
|
|
6
7
|
import { OAuthProvider } from '../enums/o-auth-provider';
|
|
7
8
|
import { PlatformType } from '../enums/platform-type';
|
|
8
9
|
import { ApiService } from '../enums/api-service';
|
|
9
10
|
import { SMTPSecure } from '../enums/smtp-secure';
|
|
10
|
-
import { Status } from '../enums/status';
|
|
11
11
|
import { EmailTemplateType } from '../enums/email-template-type';
|
|
12
12
|
import { EmailTemplateLocale } from '../enums/email-template-locale';
|
|
13
13
|
import { SmsTemplateType } from '../enums/sms-template-type';
|
|
@@ -652,55 +652,59 @@ export declare class Projects {
|
|
|
652
652
|
* Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
|
|
653
653
|
*
|
|
654
654
|
* @param {string} params.projectId - Project unique ID.
|
|
655
|
-
* @param {
|
|
655
|
+
* @param {Scopes[]} params.scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
|
|
656
656
|
* @param {number} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
657
657
|
* @throws {AppwriteException}
|
|
658
658
|
* @returns {Promise<Models.Jwt>}
|
|
659
659
|
*/
|
|
660
660
|
createJWT(params: {
|
|
661
661
|
projectId: string;
|
|
662
|
-
scopes:
|
|
662
|
+
scopes: Scopes[];
|
|
663
663
|
duration?: number;
|
|
664
664
|
}): Promise<Models.Jwt>;
|
|
665
665
|
/**
|
|
666
666
|
* Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
|
|
667
667
|
*
|
|
668
668
|
* @param {string} projectId - Project unique ID.
|
|
669
|
-
* @param {
|
|
669
|
+
* @param {Scopes[]} scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
|
|
670
670
|
* @param {number} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
671
671
|
* @throws {AppwriteException}
|
|
672
672
|
* @returns {Promise<Models.Jwt>}
|
|
673
673
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
674
674
|
*/
|
|
675
|
-
createJWT(projectId: string, scopes:
|
|
675
|
+
createJWT(projectId: string, scopes: Scopes[], duration?: number): Promise<Models.Jwt>;
|
|
676
676
|
/**
|
|
677
677
|
* Get a list of all API keys from the current project.
|
|
678
678
|
*
|
|
679
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
|
|
680
681
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
681
682
|
* @throws {AppwriteException}
|
|
682
683
|
* @returns {Promise<Models.KeyList>}
|
|
683
684
|
*/
|
|
684
685
|
listKeys(params: {
|
|
685
686
|
projectId: string;
|
|
687
|
+
queries?: string[];
|
|
686
688
|
total?: boolean;
|
|
687
689
|
}): Promise<Models.KeyList>;
|
|
688
690
|
/**
|
|
689
691
|
* Get a list of all API keys from the current project.
|
|
690
692
|
*
|
|
691
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
|
|
692
695
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
693
696
|
* @throws {AppwriteException}
|
|
694
697
|
* @returns {Promise<Models.KeyList>}
|
|
695
698
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
696
699
|
*/
|
|
697
|
-
listKeys(projectId: string, total?: boolean): Promise<Models.KeyList>;
|
|
700
|
+
listKeys(projectId: string, queries?: string[], total?: boolean): Promise<Models.KeyList>;
|
|
698
701
|
/**
|
|
699
702
|
* Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
700
703
|
*
|
|
701
704
|
* @param {string} params.projectId - Project unique ID.
|
|
702
705
|
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
703
|
-
* @param {
|
|
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.
|
|
704
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.
|
|
705
709
|
* @throws {AppwriteException}
|
|
706
710
|
* @returns {Promise<Models.Key>}
|
|
@@ -708,7 +712,8 @@ export declare class Projects {
|
|
|
708
712
|
createKey(params: {
|
|
709
713
|
projectId: string;
|
|
710
714
|
name: string;
|
|
711
|
-
scopes?:
|
|
715
|
+
scopes?: Scopes[];
|
|
716
|
+
keyId?: string;
|
|
712
717
|
expire?: string;
|
|
713
718
|
}): Promise<Models.Key>;
|
|
714
719
|
/**
|
|
@@ -716,13 +721,14 @@ export declare class Projects {
|
|
|
716
721
|
*
|
|
717
722
|
* @param {string} projectId - Project unique ID.
|
|
718
723
|
* @param {string} name - Key name. Max length: 128 chars.
|
|
719
|
-
* @param {
|
|
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.
|
|
720
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.
|
|
721
727
|
* @throws {AppwriteException}
|
|
722
728
|
* @returns {Promise<Models.Key>}
|
|
723
729
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
724
730
|
*/
|
|
725
|
-
createKey(projectId: string, name: string, scopes?:
|
|
731
|
+
createKey(projectId: string, name: string, scopes?: Scopes[], keyId?: string, expire?: string): Promise<Models.Key>;
|
|
726
732
|
/**
|
|
727
733
|
* Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.
|
|
728
734
|
*
|
|
@@ -751,7 +757,7 @@ export declare class Projects {
|
|
|
751
757
|
* @param {string} params.projectId - Project unique ID.
|
|
752
758
|
* @param {string} params.keyId - Key unique ID.
|
|
753
759
|
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
754
|
-
* @param {
|
|
760
|
+
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 events are allowed.
|
|
755
761
|
* @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.
|
|
756
762
|
* @throws {AppwriteException}
|
|
757
763
|
* @returns {Promise<Models.Key>}
|
|
@@ -760,7 +766,7 @@ export declare class Projects {
|
|
|
760
766
|
projectId: string;
|
|
761
767
|
keyId: string;
|
|
762
768
|
name: string;
|
|
763
|
-
scopes?:
|
|
769
|
+
scopes?: Scopes[];
|
|
764
770
|
expire?: string;
|
|
765
771
|
}): Promise<Models.Key>;
|
|
766
772
|
/**
|
|
@@ -769,13 +775,13 @@ export declare class Projects {
|
|
|
769
775
|
* @param {string} projectId - Project unique ID.
|
|
770
776
|
* @param {string} keyId - Key unique ID.
|
|
771
777
|
* @param {string} name - Key name. Max length: 128 chars.
|
|
772
|
-
* @param {
|
|
778
|
+
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 events are allowed.
|
|
773
779
|
* @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.
|
|
774
780
|
* @throws {AppwriteException}
|
|
775
781
|
* @returns {Promise<Models.Key>}
|
|
776
782
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
777
783
|
*/
|
|
778
|
-
updateKey(projectId: string, keyId: string, name: string, scopes?:
|
|
784
|
+
updateKey(projectId: string, keyId: string, name: string, scopes?: Scopes[], expire?: string): Promise<Models.Key>;
|
|
779
785
|
/**
|
|
780
786
|
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
781
787
|
*
|
|
@@ -1218,28 +1224,6 @@ export declare class Projects {
|
|
|
1218
1224
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1219
1225
|
*/
|
|
1220
1226
|
createSMTPTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
|
|
1221
|
-
/**
|
|
1222
|
-
* Update the status of a project
|
|
1223
|
-
*
|
|
1224
|
-
* @param {string} params.projectId - Project ID
|
|
1225
|
-
* @param {Status} params.status - New status for the project
|
|
1226
|
-
* @throws {AppwriteException}
|
|
1227
|
-
* @returns {Promise<{}>}
|
|
1228
|
-
*/
|
|
1229
|
-
updateStatus(params: {
|
|
1230
|
-
projectId: string;
|
|
1231
|
-
status: Status;
|
|
1232
|
-
}): Promise<{}>;
|
|
1233
|
-
/**
|
|
1234
|
-
* Update the status of a project
|
|
1235
|
-
*
|
|
1236
|
-
* @param {string} projectId - Project ID
|
|
1237
|
-
* @param {Status} status - New status for the project
|
|
1238
|
-
* @throws {AppwriteException}
|
|
1239
|
-
* @returns {Promise<{}>}
|
|
1240
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1241
|
-
*/
|
|
1242
|
-
updateStatus(projectId: string, status: Status): Promise<{}>;
|
|
1243
1227
|
/**
|
|
1244
1228
|
* Update the team ID of a project allowing for it to be transferred to another team.
|
|
1245
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;
|
|
@@ -3,6 +3,8 @@ import type { Models } from '../models';
|
|
|
3
3
|
import { Framework } from '../enums/framework';
|
|
4
4
|
import { BuildRuntime } from '../enums/build-runtime';
|
|
5
5
|
import { Adapter } from '../enums/adapter';
|
|
6
|
+
import { Frameworks } from '../enums/frameworks';
|
|
7
|
+
import { UseCases } from '../enums/use-cases';
|
|
6
8
|
import { UsageRange } from '../enums/usage-range';
|
|
7
9
|
import { TemplateReferenceType } from '../enums/template-reference-type';
|
|
8
10
|
import { VCSReferenceType } from '../enums/vcs-reference-type';
|
|
@@ -122,31 +124,31 @@ export declare class Sites {
|
|
|
122
124
|
/**
|
|
123
125
|
* List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
|
|
124
126
|
*
|
|
125
|
-
* @param {
|
|
126
|
-
* @param {
|
|
127
|
+
* @param {Frameworks[]} params.frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
|
|
128
|
+
* @param {UseCases[]} params.useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
|
|
127
129
|
* @param {number} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
128
130
|
* @param {number} params.offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
129
131
|
* @throws {AppwriteException}
|
|
130
132
|
* @returns {Promise<Models.TemplateSiteList>}
|
|
131
133
|
*/
|
|
132
134
|
listTemplates(params?: {
|
|
133
|
-
frameworks?:
|
|
134
|
-
useCases?:
|
|
135
|
+
frameworks?: Frameworks[];
|
|
136
|
+
useCases?: UseCases[];
|
|
135
137
|
limit?: number;
|
|
136
138
|
offset?: number;
|
|
137
139
|
}): Promise<Models.TemplateSiteList>;
|
|
138
140
|
/**
|
|
139
141
|
* List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
|
|
140
142
|
*
|
|
141
|
-
* @param {
|
|
142
|
-
* @param {
|
|
143
|
+
* @param {Frameworks[]} frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
|
|
144
|
+
* @param {UseCases[]} useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
|
|
143
145
|
* @param {number} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
144
146
|
* @param {number} offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
145
147
|
* @throws {AppwriteException}
|
|
146
148
|
* @returns {Promise<Models.TemplateSiteList>}
|
|
147
149
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
148
150
|
*/
|
|
149
|
-
listTemplates(frameworks?:
|
|
151
|
+
listTemplates(frameworks?: Frameworks[], useCases?: UseCases[], limit?: number, offset?: number): Promise<Models.TemplateSiteList>;
|
|
150
152
|
/**
|
|
151
153
|
* Get a site template using ID. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
|
|
152
154
|
*
|