@appwrite.io/console 1.6.0 → 1.7.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 +9 -1
- package/README.md +3 -3
- package/dist/cjs/sdk.js +6731 -3907
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +6729 -3908
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +6731 -3907
- package/docs/examples/account/create-anonymous-session.md +1 -1
- package/docs/examples/account/create-billing-address.md +1 -1
- package/docs/examples/account/create-email-password-session.md +1 -1
- package/docs/examples/account/create-email-token.md +1 -1
- package/docs/examples/account/create-j-w-t.md +1 -1
- package/docs/examples/account/create-magic-u-r-l-token.md +1 -1
- package/docs/examples/account/create-mfa-authenticator.md +1 -1
- package/docs/examples/account/create-mfa-challenge.md +1 -1
- package/docs/examples/account/create-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/create-o-auth2session.md +1 -1
- package/docs/examples/account/create-o-auth2token.md +1 -1
- package/docs/examples/account/create-payment-method.md +1 -1
- package/docs/examples/account/create-phone-token.md +1 -1
- package/docs/examples/account/create-phone-verification.md +1 -1
- package/docs/examples/account/create-push-target.md +1 -1
- package/docs/examples/account/create-recovery.md +1 -1
- package/docs/examples/account/create-session.md +1 -1
- package/docs/examples/account/create-verification.md +1 -1
- package/docs/examples/account/create.md +1 -1
- package/docs/examples/account/delete-billing-address.md +1 -1
- package/docs/examples/account/delete-identity.md +1 -1
- package/docs/examples/account/delete-mfa-authenticator.md +1 -1
- package/docs/examples/account/delete-payment-method.md +1 -1
- package/docs/examples/account/delete-push-target.md +1 -1
- package/docs/examples/account/delete-session.md +1 -1
- package/docs/examples/account/delete-sessions.md +1 -1
- package/docs/examples/account/delete.md +1 -1
- package/docs/examples/account/get-billing-address.md +1 -1
- package/docs/examples/account/get-coupon.md +1 -1
- package/docs/examples/account/get-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/get-payment-method.md +1 -1
- package/docs/examples/account/get-prefs.md +1 -1
- package/docs/examples/account/get-session.md +1 -1
- package/docs/examples/account/get.md +1 -1
- package/docs/examples/account/list-billing-addresses.md +1 -1
- package/docs/examples/account/list-identities.md +1 -1
- package/docs/examples/account/list-invoices.md +1 -1
- package/docs/examples/account/list-logs.md +1 -1
- package/docs/examples/account/list-mfa-factors.md +1 -1
- package/docs/examples/account/list-payment-methods.md +1 -1
- package/docs/examples/account/list-sessions.md +1 -1
- package/docs/examples/account/update-billing-address.md +1 -1
- package/docs/examples/account/update-email.md +1 -1
- package/docs/examples/account/update-m-f-a.md +1 -1
- package/docs/examples/account/update-magic-u-r-l-session.md +1 -1
- package/docs/examples/account/update-mfa-authenticator.md +1 -1
- package/docs/examples/account/update-mfa-challenge.md +1 -1
- package/docs/examples/account/update-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/update-name.md +1 -1
- package/docs/examples/account/update-password.md +1 -1
- package/docs/examples/account/update-payment-method-mandate-options.md +1 -1
- package/docs/examples/account/update-payment-method-provider.md +1 -1
- package/docs/examples/account/update-payment-method.md +1 -1
- package/docs/examples/account/update-phone-session.md +1 -1
- package/docs/examples/account/update-phone-verification.md +1 -1
- package/docs/examples/account/update-phone.md +1 -1
- package/docs/examples/account/update-prefs.md +1 -1
- package/docs/examples/account/update-push-target.md +1 -1
- package/docs/examples/account/update-recovery.md +1 -1
- package/docs/examples/account/update-session.md +1 -1
- package/docs/examples/account/update-status.md +1 -1
- package/docs/examples/account/update-verification.md +1 -1
- package/docs/examples/assistant/chat.md +1 -1
- package/docs/examples/avatars/get-browser.md +2 -2
- package/docs/examples/avatars/get-credit-card.md +2 -2
- package/docs/examples/avatars/get-favicon.md +1 -1
- package/docs/examples/avatars/get-flag.md +2 -2
- package/docs/examples/avatars/get-image.md +1 -1
- package/docs/examples/avatars/get-initials.md +1 -1
- package/docs/examples/avatars/get-q-r.md +1 -1
- package/docs/examples/backups/create-archive.md +1 -1
- package/docs/examples/backups/create-policy.md +1 -1
- package/docs/examples/backups/create-restoration.md +1 -1
- package/docs/examples/backups/delete-archive.md +1 -1
- package/docs/examples/backups/delete-policy.md +1 -1
- package/docs/examples/backups/get-archive.md +1 -1
- package/docs/examples/backups/get-policy.md +1 -1
- package/docs/examples/backups/get-restoration.md +1 -1
- package/docs/examples/backups/list-archives.md +1 -1
- package/docs/examples/backups/list-policies.md +1 -1
- package/docs/examples/backups/list-restorations.md +1 -1
- package/docs/examples/backups/update-policy.md +1 -1
- package/docs/examples/console/create-program-membership.md +1 -1
- package/docs/examples/console/create-source.md +1 -1
- package/docs/examples/console/get-campaign.md +1 -1
- package/docs/examples/console/get-coupon.md +1 -1
- package/docs/examples/console/get-resource.md +14 -0
- package/docs/examples/console/plans.md +1 -1
- package/docs/examples/console/regions.md +1 -1
- package/docs/examples/console/variables.md +1 -1
- package/docs/examples/databases/create-boolean-attribute.md +1 -1
- package/docs/examples/databases/create-collection.md +1 -1
- package/docs/examples/databases/create-datetime-attribute.md +1 -1
- package/docs/examples/databases/create-document.md +4 -2
- package/docs/examples/databases/create-documents.md +15 -0
- package/docs/examples/databases/create-email-attribute.md +1 -1
- package/docs/examples/databases/create-enum-attribute.md +1 -1
- package/docs/examples/databases/create-float-attribute.md +1 -1
- package/docs/examples/databases/create-index.md +3 -2
- package/docs/examples/databases/create-integer-attribute.md +1 -1
- package/docs/examples/databases/create-ip-attribute.md +1 -1
- package/docs/examples/databases/create-relationship-attribute.md +1 -1
- package/docs/examples/databases/create-string-attribute.md +1 -1
- package/docs/examples/databases/create-url-attribute.md +1 -1
- package/docs/examples/databases/create.md +1 -1
- package/docs/examples/databases/delete-attribute.md +1 -1
- package/docs/examples/databases/delete-collection.md +1 -1
- package/docs/examples/databases/delete-document.md +1 -1
- package/docs/examples/databases/delete-documents.md +15 -0
- package/docs/examples/databases/delete-index.md +1 -1
- package/docs/examples/databases/delete.md +1 -1
- package/docs/examples/databases/get-attribute.md +1 -1
- package/docs/examples/databases/get-collection-usage.md +1 -1
- package/docs/examples/databases/get-collection.md +1 -1
- package/docs/examples/databases/get-database-usage.md +1 -1
- package/docs/examples/databases/get-document.md +1 -1
- package/docs/examples/databases/get-index.md +1 -1
- package/docs/examples/databases/get-usage.md +1 -1
- package/docs/examples/databases/get.md +1 -1
- package/docs/examples/databases/list-attributes.md +1 -1
- package/docs/examples/databases/list-collection-logs.md +1 -1
- package/docs/examples/databases/list-collections.md +1 -1
- package/docs/examples/databases/list-document-logs.md +1 -1
- package/docs/examples/databases/list-documents.md +1 -1
- package/docs/examples/databases/list-indexes.md +1 -1
- package/docs/examples/databases/list-logs.md +1 -1
- package/docs/examples/databases/list.md +1 -1
- package/docs/examples/databases/update-boolean-attribute.md +1 -1
- package/docs/examples/databases/update-collection.md +1 -1
- package/docs/examples/databases/update-datetime-attribute.md +1 -1
- package/docs/examples/databases/update-document.md +1 -1
- package/docs/examples/databases/update-documents.md +16 -0
- package/docs/examples/databases/update-email-attribute.md +1 -1
- package/docs/examples/databases/update-enum-attribute.md +1 -1
- package/docs/examples/databases/update-float-attribute.md +1 -1
- package/docs/examples/databases/update-integer-attribute.md +1 -1
- package/docs/examples/databases/update-ip-attribute.md +1 -1
- package/docs/examples/databases/update-relationship-attribute.md +1 -1
- package/docs/examples/databases/update-string-attribute.md +1 -1
- package/docs/examples/databases/update-url-attribute.md +1 -1
- package/docs/examples/databases/update.md +1 -1
- package/docs/examples/databases/upsert-documents.md +15 -0
- package/docs/examples/domains/create-preset-google-workspace.md +13 -0
- package/docs/examples/domains/create-preset-i-cloud.md +13 -0
- package/docs/examples/domains/create-preset-mailgun.md +13 -0
- package/docs/examples/domains/create-preset-outlook.md +13 -0
- package/docs/examples/domains/create-preset-proton-mail.md +13 -0
- package/docs/examples/domains/create-preset-zoho.md +13 -0
- package/docs/examples/domains/create-record-a-a-a-a.md +17 -0
- package/docs/examples/domains/create-record-a.md +17 -0
- package/docs/examples/domains/create-record-alias.md +17 -0
- package/docs/examples/domains/create-record-c-a-a.md +17 -0
- package/docs/examples/domains/create-record-c-n-a-m-e.md +17 -0
- package/docs/examples/domains/create-record-h-t-t-p-s.md +17 -0
- package/docs/examples/domains/create-record-m-x.md +18 -0
- package/docs/examples/domains/create-record-n-s.md +17 -0
- package/docs/examples/domains/create-record-s-r-v.md +20 -0
- package/docs/examples/domains/create-record-t-x-t.md +17 -0
- package/docs/examples/domains/create.md +14 -0
- package/docs/examples/domains/delete-record.md +14 -0
- package/docs/examples/domains/delete.md +13 -0
- package/docs/examples/domains/get-preset-google-workspace.md +13 -0
- package/docs/examples/domains/get-preset-i-cloud.md +13 -0
- package/docs/examples/domains/get-preset-mailgun.md +13 -0
- package/docs/examples/domains/get-preset-outlook.md +13 -0
- package/docs/examples/domains/get-preset-proton-mail.md +13 -0
- package/docs/examples/domains/get-preset-zoho.md +13 -0
- package/docs/examples/domains/get-record.md +14 -0
- package/docs/examples/domains/get-zone.md +13 -0
- package/docs/examples/domains/get.md +13 -0
- package/docs/examples/domains/list-records.md +14 -0
- package/docs/examples/domains/list.md +14 -0
- package/docs/examples/domains/update-nameservers.md +13 -0
- package/docs/examples/domains/update-record-a-a-a-a.md +18 -0
- package/docs/examples/domains/update-record-a.md +18 -0
- package/docs/examples/domains/update-record-alias.md +18 -0
- package/docs/examples/domains/update-record-c-a-a.md +18 -0
- package/docs/examples/domains/update-record-c-n-a-m-e.md +18 -0
- package/docs/examples/domains/update-record-h-t-t-p-s.md +18 -0
- package/docs/examples/domains/update-record-m-x.md +19 -0
- package/docs/examples/domains/update-record-n-s.md +18 -0
- package/docs/examples/domains/update-record-s-r-v.md +21 -0
- package/docs/examples/domains/update-record-t-x-t.md +18 -0
- package/docs/examples/domains/update-team.md +14 -0
- package/docs/examples/domains/update-zone.md +14 -0
- package/docs/examples/functions/create-deployment.md +1 -1
- package/docs/examples/functions/create-duplicate-deployment.md +15 -0
- package/docs/examples/functions/create-execution.md +1 -1
- package/docs/examples/functions/create-template-deployment.md +18 -0
- package/docs/examples/functions/create-variable.md +3 -2
- package/docs/examples/functions/create-vcs-deployment.md +16 -0
- package/docs/examples/functions/create.md +3 -3
- package/docs/examples/functions/delete-deployment.md +1 -1
- package/docs/examples/functions/delete-execution.md +1 -1
- package/docs/examples/functions/delete-variable.md +1 -1
- package/docs/examples/functions/delete.md +1 -1
- package/docs/examples/functions/get-deployment-download.md +4 -3
- package/docs/examples/functions/get-deployment.md +1 -1
- package/docs/examples/functions/get-execution.md +1 -1
- package/docs/examples/functions/get-template.md +1 -1
- package/docs/examples/functions/get-usage.md +2 -1
- package/docs/examples/functions/get-variable.md +1 -1
- package/docs/examples/functions/get.md +1 -1
- package/docs/examples/functions/list-deployments.md +1 -1
- package/docs/examples/functions/list-executions.md +2 -3
- package/docs/examples/functions/list-runtimes.md +1 -1
- package/docs/examples/functions/list-specifications.md +1 -1
- package/docs/examples/functions/list-templates.md +1 -1
- package/docs/examples/functions/list-usage.md +13 -0
- package/docs/examples/functions/list-variables.md +1 -1
- package/docs/examples/functions/list.md +1 -1
- package/docs/examples/functions/update-deployment-status.md +14 -0
- package/docs/examples/functions/update-function-deployment.md +14 -0
- package/docs/examples/functions/update-variable.md +3 -2
- package/docs/examples/functions/update.md +1 -1
- package/docs/examples/graphql/mutation.md +1 -1
- package/docs/examples/graphql/query.md +1 -1
- package/docs/examples/health/get-antivirus.md +1 -1
- package/docs/examples/health/get-cache.md +1 -1
- package/docs/examples/health/get-certificate.md +1 -1
- package/docs/examples/health/get-d-b.md +1 -1
- package/docs/examples/health/get-failed-jobs.md +1 -1
- package/docs/examples/health/get-pub-sub.md +1 -1
- package/docs/examples/health/get-queue-billing-aggregation.md +1 -1
- package/docs/examples/health/get-queue-builds.md +1 -1
- package/docs/examples/health/get-queue-certificates.md +1 -1
- package/docs/examples/health/get-queue-databases.md +1 -1
- package/docs/examples/health/get-queue-deletes.md +1 -1
- package/docs/examples/health/get-queue-functions.md +1 -1
- package/docs/examples/health/get-queue-logs.md +1 -1
- package/docs/examples/health/get-queue-mails.md +1 -1
- package/docs/examples/health/get-queue-messaging.md +1 -1
- package/docs/examples/health/get-queue-migrations.md +1 -1
- package/docs/examples/health/get-queue-priority-builds.md +1 -1
- package/docs/examples/health/get-queue-region-manager.md +13 -0
- package/docs/examples/health/get-queue-stats-resources.md +1 -1
- package/docs/examples/health/get-queue-usage.md +1 -1
- package/docs/examples/health/get-queue-webhooks.md +1 -1
- package/docs/examples/health/get-storage-local.md +1 -1
- package/docs/examples/health/get-storage.md +1 -1
- package/docs/examples/health/get-time.md +1 -1
- package/docs/examples/health/get.md +1 -1
- package/docs/examples/locale/get.md +1 -1
- package/docs/examples/locale/list-codes.md +1 -1
- package/docs/examples/locale/list-continents.md +1 -1
- package/docs/examples/locale/list-countries-e-u.md +1 -1
- package/docs/examples/locale/list-countries-phones.md +1 -1
- package/docs/examples/locale/list-countries.md +1 -1
- package/docs/examples/locale/list-currencies.md +1 -1
- package/docs/examples/locale/list-languages.md +1 -1
- package/docs/examples/messaging/create-apns-provider.md +1 -1
- package/docs/examples/messaging/create-email.md +1 -1
- package/docs/examples/messaging/create-fcm-provider.md +1 -1
- package/docs/examples/messaging/create-mailgun-provider.md +1 -1
- package/docs/examples/messaging/create-msg91provider.md +1 -1
- package/docs/examples/messaging/create-push.md +1 -1
- package/docs/examples/messaging/create-sendgrid-provider.md +1 -1
- package/docs/examples/messaging/create-sms.md +1 -1
- package/docs/examples/messaging/create-smtp-provider.md +1 -1
- package/docs/examples/messaging/create-subscriber.md +1 -1
- package/docs/examples/messaging/create-telesign-provider.md +1 -1
- package/docs/examples/messaging/create-textmagic-provider.md +1 -1
- package/docs/examples/messaging/create-topic.md +1 -1
- package/docs/examples/messaging/create-twilio-provider.md +1 -1
- package/docs/examples/messaging/create-vonage-provider.md +1 -1
- package/docs/examples/messaging/delete-provider.md +1 -1
- package/docs/examples/messaging/delete-subscriber.md +1 -1
- package/docs/examples/messaging/delete-topic.md +1 -1
- package/docs/examples/messaging/delete.md +1 -1
- package/docs/examples/messaging/get-message.md +1 -1
- package/docs/examples/messaging/get-provider.md +1 -1
- package/docs/examples/messaging/get-subscriber.md +1 -1
- package/docs/examples/messaging/get-topic.md +1 -1
- package/docs/examples/messaging/list-message-logs.md +1 -1
- package/docs/examples/messaging/list-messages.md +1 -1
- package/docs/examples/messaging/list-provider-logs.md +1 -1
- package/docs/examples/messaging/list-providers.md +1 -1
- package/docs/examples/messaging/list-subscriber-logs.md +1 -1
- package/docs/examples/messaging/list-subscribers.md +1 -1
- package/docs/examples/messaging/list-targets.md +1 -1
- package/docs/examples/messaging/list-topic-logs.md +1 -1
- package/docs/examples/messaging/list-topics.md +1 -1
- package/docs/examples/messaging/update-apns-provider.md +1 -1
- package/docs/examples/messaging/update-email.md +1 -1
- package/docs/examples/messaging/update-fcm-provider.md +1 -1
- package/docs/examples/messaging/update-mailgun-provider.md +1 -1
- package/docs/examples/messaging/update-msg91provider.md +1 -1
- package/docs/examples/messaging/update-push.md +1 -1
- package/docs/examples/messaging/update-sendgrid-provider.md +1 -1
- package/docs/examples/messaging/update-sms.md +1 -1
- package/docs/examples/messaging/update-smtp-provider.md +1 -1
- package/docs/examples/messaging/update-telesign-provider.md +1 -1
- package/docs/examples/messaging/update-textmagic-provider.md +1 -1
- package/docs/examples/messaging/update-topic.md +1 -1
- package/docs/examples/messaging/update-twilio-provider.md +1 -1
- package/docs/examples/messaging/update-vonage-provider.md +1 -1
- package/docs/examples/migrations/create-appwrite-migration.md +1 -1
- package/docs/examples/migrations/create-csv-migration.md +15 -0
- package/docs/examples/migrations/create-firebase-migration.md +1 -1
- package/docs/examples/migrations/create-n-host-migration.md +1 -1
- package/docs/examples/migrations/create-supabase-migration.md +1 -1
- package/docs/examples/migrations/delete.md +1 -1
- package/docs/examples/migrations/get-appwrite-report.md +1 -1
- package/docs/examples/migrations/get-firebase-report.md +1 -1
- package/docs/examples/migrations/get-n-host-report.md +1 -1
- package/docs/examples/migrations/get-supabase-report.md +1 -1
- package/docs/examples/migrations/get.md +1 -1
- package/docs/examples/migrations/list.md +1 -1
- package/docs/examples/migrations/retry.md +1 -1
- package/docs/examples/organizations/add-credit.md +1 -1
- package/docs/examples/organizations/create-invoice-payment.md +1 -1
- package/docs/examples/organizations/create.md +1 -1
- package/docs/examples/organizations/delete-backup-payment-method.md +1 -1
- package/docs/examples/organizations/delete-billing-address.md +1 -1
- package/docs/examples/organizations/delete-default-payment-method.md +1 -1
- package/docs/examples/organizations/delete.md +1 -1
- package/docs/examples/organizations/get-aggregation.md +1 -1
- package/docs/examples/organizations/get-billing-address.md +1 -1
- package/docs/examples/organizations/get-credit.md +1 -1
- package/docs/examples/organizations/get-invoice-download.md +1 -1
- package/docs/examples/organizations/get-invoice-view.md +1 -1
- package/docs/examples/organizations/get-invoice.md +1 -1
- package/docs/examples/organizations/get-payment-method.md +1 -1
- package/docs/examples/organizations/get-plan.md +1 -1
- package/docs/examples/organizations/get-scopes.md +1 -1
- package/docs/examples/organizations/list-aggregations.md +1 -1
- package/docs/examples/organizations/list-credits.md +1 -1
- package/docs/examples/organizations/list-invoices.md +1 -1
- package/docs/examples/organizations/list.md +1 -1
- package/docs/examples/organizations/set-backup-payment-method.md +1 -1
- package/docs/examples/organizations/set-billing-address.md +1 -1
- package/docs/examples/organizations/set-billing-email.md +1 -1
- package/docs/examples/organizations/set-billing-tax-id.md +1 -1
- package/docs/examples/organizations/set-default-payment-method.md +1 -1
- package/docs/examples/organizations/update-budget.md +1 -1
- package/docs/examples/organizations/update-plan.md +1 -1
- package/docs/examples/organizations/validate-invoice.md +1 -1
- package/docs/examples/project/create-variable.md +3 -2
- package/docs/examples/project/delete-variable.md +1 -1
- package/docs/examples/project/get-usage.md +1 -1
- package/docs/examples/project/get-variable.md +1 -1
- package/docs/examples/project/list-variables.md +1 -1
- package/docs/examples/project/update-variable.md +3 -2
- package/docs/examples/projects/create-dev-key.md +15 -0
- package/docs/examples/projects/create-j-w-t.md +1 -1
- package/docs/examples/projects/create-key.md +1 -1
- package/docs/examples/projects/create-platform.md +1 -1
- package/docs/examples/projects/create-smtp-test.md +1 -1
- package/docs/examples/projects/create-webhook.md +1 -1
- package/docs/examples/projects/create.md +2 -2
- package/docs/examples/projects/delete-dev-key.md +14 -0
- package/docs/examples/projects/delete-email-template.md +1 -1
- package/docs/examples/projects/delete-key.md +1 -1
- package/docs/examples/projects/delete-platform.md +1 -1
- package/docs/examples/projects/delete-sms-template.md +1 -1
- package/docs/examples/projects/delete-webhook.md +1 -1
- package/docs/examples/projects/delete.md +1 -1
- package/docs/examples/projects/get-dev-key.md +14 -0
- package/docs/examples/projects/get-email-template.md +1 -1
- package/docs/examples/projects/get-key.md +1 -1
- package/docs/examples/projects/get-platform.md +1 -1
- package/docs/examples/projects/get-sms-template.md +1 -1
- package/docs/examples/projects/get-webhook.md +1 -1
- package/docs/examples/projects/get.md +1 -1
- package/docs/examples/projects/list-dev-keys.md +14 -0
- package/docs/examples/projects/list-keys.md +1 -1
- package/docs/examples/projects/list-platforms.md +1 -1
- package/docs/examples/projects/list-webhooks.md +1 -1
- package/docs/examples/projects/list.md +1 -1
- package/docs/examples/projects/update-api-status-all.md +1 -1
- package/docs/examples/projects/update-api-status.md +1 -1
- package/docs/examples/projects/update-auth-duration.md +1 -1
- package/docs/examples/projects/update-auth-limit.md +1 -1
- package/docs/examples/projects/update-auth-password-dictionary.md +1 -1
- package/docs/examples/projects/update-auth-password-history.md +1 -1
- package/docs/examples/projects/update-auth-sessions-limit.md +1 -1
- package/docs/examples/projects/update-auth-status.md +1 -1
- package/docs/examples/projects/update-dev-key.md +16 -0
- package/docs/examples/projects/update-email-template.md +1 -1
- package/docs/examples/projects/update-key.md +1 -1
- package/docs/examples/projects/update-memberships-privacy.md +1 -1
- package/docs/examples/projects/update-mock-numbers.md +1 -1
- package/docs/examples/projects/update-o-auth2.md +1 -1
- package/docs/examples/projects/update-personal-data-check.md +1 -1
- package/docs/examples/projects/update-platform.md +1 -1
- package/docs/examples/projects/update-service-status-all.md +1 -1
- package/docs/examples/projects/update-service-status.md +1 -1
- package/docs/examples/projects/update-session-alerts.md +1 -1
- package/docs/examples/projects/update-sms-template.md +1 -1
- package/docs/examples/projects/update-smtp.md +1 -1
- package/docs/examples/projects/update-team.md +1 -1
- package/docs/examples/projects/update-webhook-signature.md +1 -1
- package/docs/examples/projects/update-webhook.md +1 -1
- package/docs/examples/projects/update.md +1 -1
- package/docs/examples/proxy/create-a-p-i-rule.md +13 -0
- package/docs/examples/proxy/create-function-rule.md +15 -0
- package/docs/examples/proxy/create-redirect-rule.md +15 -0
- package/docs/examples/proxy/create-site-rule.md +15 -0
- package/docs/examples/proxy/delete-rule.md +1 -1
- package/docs/examples/proxy/get-rule.md +1 -1
- package/docs/examples/proxy/list-rules.md +1 -1
- package/docs/examples/proxy/update-rule-verification.md +1 -1
- package/docs/examples/sites/create-deployment.md +18 -0
- package/docs/examples/sites/create-duplicate-deployment.md +14 -0
- package/docs/examples/sites/create-template-deployment.md +18 -0
- package/docs/examples/sites/create-variable.md +16 -0
- package/docs/examples/sites/create-vcs-deployment.md +16 -0
- package/docs/examples/sites/create.md +30 -0
- package/docs/examples/sites/delete-deployment.md +14 -0
- package/docs/examples/sites/delete-log.md +14 -0
- package/docs/examples/sites/delete-variable.md +14 -0
- package/docs/examples/sites/delete.md +13 -0
- package/docs/examples/sites/get-deployment-download.md +15 -0
- package/docs/examples/sites/get-deployment.md +14 -0
- package/docs/examples/sites/get-log.md +14 -0
- package/docs/examples/sites/get-template.md +13 -0
- package/docs/examples/sites/get-usage.md +14 -0
- package/docs/examples/sites/get-variable.md +14 -0
- package/docs/examples/sites/get.md +13 -0
- package/docs/examples/sites/list-deployments.md +15 -0
- package/docs/examples/sites/list-frameworks.md +11 -0
- package/docs/examples/sites/list-logs.md +14 -0
- package/docs/examples/sites/list-specifications.md +11 -0
- package/docs/examples/sites/list-templates.md +16 -0
- package/docs/examples/sites/list-usage.md +13 -0
- package/docs/examples/sites/list-variables.md +13 -0
- package/docs/examples/sites/list.md +14 -0
- package/docs/examples/sites/update-deployment-status.md +14 -0
- package/docs/examples/sites/update-site-deployment.md +14 -0
- package/docs/examples/sites/update-variable.md +17 -0
- package/docs/examples/sites/update.md +30 -0
- package/docs/examples/storage/create-bucket.md +1 -1
- package/docs/examples/storage/create-file.md +1 -1
- package/docs/examples/storage/delete-bucket.md +1 -1
- package/docs/examples/storage/delete-file.md +1 -1
- package/docs/examples/storage/get-bucket-usage.md +1 -1
- package/docs/examples/storage/get-bucket.md +1 -1
- package/docs/examples/storage/get-file-download.md +3 -2
- package/docs/examples/storage/get-file-preview.md +4 -3
- package/docs/examples/storage/get-file-view.md +3 -2
- package/docs/examples/storage/get-file.md +1 -1
- package/docs/examples/storage/get-usage.md +1 -1
- package/docs/examples/storage/list-buckets.md +1 -1
- package/docs/examples/storage/list-files.md +1 -1
- package/docs/examples/storage/update-bucket.md +1 -1
- package/docs/examples/storage/update-file.md +1 -1
- package/docs/examples/teams/create-membership.md +1 -1
- package/docs/examples/teams/create.md +1 -1
- package/docs/examples/teams/delete-membership.md +1 -1
- package/docs/examples/teams/delete.md +1 -1
- package/docs/examples/teams/get-membership.md +1 -1
- package/docs/examples/teams/get-prefs.md +1 -1
- package/docs/examples/teams/get.md +1 -1
- package/docs/examples/teams/list-logs.md +1 -1
- package/docs/examples/teams/list-memberships.md +1 -1
- package/docs/examples/teams/list.md +1 -1
- package/docs/examples/teams/update-membership-status.md +1 -1
- package/docs/examples/teams/update-membership.md +1 -1
- package/docs/examples/teams/update-name.md +1 -1
- package/docs/examples/teams/update-prefs.md +1 -1
- package/docs/examples/tokens/create-file-token.md +15 -0
- package/docs/examples/tokens/delete.md +13 -0
- package/docs/examples/tokens/get.md +13 -0
- package/docs/examples/tokens/list.md +15 -0
- package/docs/examples/tokens/update.md +14 -0
- package/docs/examples/users/create-argon2user.md +1 -1
- package/docs/examples/users/create-bcrypt-user.md +1 -1
- package/docs/examples/users/create-j-w-t.md +1 -1
- package/docs/examples/users/create-m-d5user.md +1 -1
- package/docs/examples/users/create-mfa-recovery-codes.md +1 -1
- package/docs/examples/users/create-p-h-pass-user.md +1 -1
- package/docs/examples/users/create-s-h-a-user.md +1 -1
- package/docs/examples/users/create-scrypt-modified-user.md +1 -1
- package/docs/examples/users/create-scrypt-user.md +1 -1
- package/docs/examples/users/create-session.md +1 -1
- package/docs/examples/users/create-target.md +1 -1
- package/docs/examples/users/create-token.md +1 -1
- package/docs/examples/users/create.md +1 -1
- package/docs/examples/users/delete-identity.md +1 -1
- package/docs/examples/users/delete-mfa-authenticator.md +1 -1
- package/docs/examples/users/delete-session.md +1 -1
- package/docs/examples/users/delete-sessions.md +1 -1
- package/docs/examples/users/delete-target.md +1 -1
- package/docs/examples/users/delete.md +1 -1
- package/docs/examples/users/get-mfa-recovery-codes.md +1 -1
- package/docs/examples/users/get-prefs.md +1 -1
- package/docs/examples/users/get-target.md +1 -1
- package/docs/examples/users/get-usage.md +1 -1
- package/docs/examples/users/get.md +1 -1
- package/docs/examples/users/list-identities.md +1 -1
- package/docs/examples/users/list-logs.md +1 -1
- package/docs/examples/users/list-memberships.md +4 -2
- package/docs/examples/users/list-mfa-factors.md +1 -1
- package/docs/examples/users/list-sessions.md +1 -1
- package/docs/examples/users/list-targets.md +1 -1
- package/docs/examples/users/list.md +1 -1
- package/docs/examples/users/update-email-verification.md +1 -1
- package/docs/examples/users/update-email.md +1 -1
- package/docs/examples/users/update-labels.md +1 -1
- package/docs/examples/users/update-mfa-recovery-codes.md +1 -1
- package/docs/examples/users/update-mfa.md +1 -1
- package/docs/examples/users/update-name.md +1 -1
- package/docs/examples/users/update-password.md +1 -1
- package/docs/examples/users/update-phone-verification.md +1 -1
- package/docs/examples/users/update-phone.md +1 -1
- package/docs/examples/users/update-prefs.md +1 -1
- package/docs/examples/users/update-status.md +1 -1
- package/docs/examples/users/update-target.md +1 -1
- package/docs/examples/vcs/create-repository-detection.md +3 -2
- package/docs/examples/vcs/create-repository.md +1 -1
- package/docs/examples/vcs/delete-installation.md +1 -1
- package/docs/examples/vcs/get-installation.md +1 -1
- package/docs/examples/vcs/get-repository-contents.md +1 -1
- package/docs/examples/vcs/get-repository.md +1 -1
- package/docs/examples/vcs/list-installations.md +1 -1
- package/docs/examples/vcs/list-repositories.md +3 -2
- package/docs/examples/vcs/list-repository-branches.md +1 -1
- package/docs/examples/vcs/update-external-deployments.md +1 -1
- package/package.json +1 -1
- package/src/client.ts +12 -2
- package/src/enums/adapter.ts +4 -0
- package/src/enums/api-service.ts +1 -0
- package/src/enums/build-runtime.ts +62 -0
- package/src/enums/console-resource-type.ts +3 -0
- package/src/enums/deployment-download-type.ts +4 -0
- package/src/enums/framework.ts +16 -0
- package/src/enums/image-format.ts +0 -1
- package/src/enums/name.ts +0 -1
- package/src/enums/region.ts +2 -1
- package/src/enums/runtime.ts +4 -3
- package/src/enums/site-usage-range.ts +5 -0
- package/src/enums/status-code.ts +6 -0
- package/src/enums/v-c-s-deployment-type.ts +5 -0
- package/src/enums/v-c-s-detection-type.ts +4 -0
- package/src/index.ts +13 -2
- package/src/models.ts +1092 -221
- package/src/services/account.ts +0 -16
- package/src/services/avatars.ts +0 -7
- package/src/services/backups.ts +0 -6
- package/src/services/console.ts +36 -5
- package/src/services/databases.ts +149 -18
- package/src/services/domains.ts +1821 -0
- package/src/services/functions.ts +174 -69
- package/src/services/health.ts +9 -34
- package/src/services/locale.ts +0 -8
- package/src/services/messaging.ts +0 -13
- package/src/services/migrations.ts +43 -6
- package/src/services/organizations.ts +0 -47
- package/src/services/project.ts +10 -5
- package/src/services/projects.ts +172 -10
- package/src/services/proxy.ts +124 -14
- package/src/services/sites.ts +1104 -0
- package/src/services/storage.ts +15 -12
- package/src/services/teams.ts +0 -6
- package/src/services/tokens.ts +160 -0
- package/src/services/users.ts +9 -13
- package/src/services/vcs.ts +54 -42
- package/types/enums/adapter.d.ts +4 -0
- package/types/enums/api-service.d.ts +1 -0
- package/types/enums/build-runtime.d.ts +62 -0
- package/types/enums/console-resource-type.d.ts +3 -0
- package/types/enums/deployment-download-type.d.ts +4 -0
- package/types/enums/framework.d.ts +16 -0
- package/types/enums/image-format.d.ts +0 -1
- package/types/enums/name.d.ts +0 -1
- package/types/enums/region.d.ts +3 -2
- package/types/enums/runtime.d.ts +5 -4
- package/types/enums/site-usage-range.d.ts +5 -0
- package/types/enums/status-code.d.ts +6 -0
- package/types/enums/v-c-s-deployment-type.d.ts +5 -0
- package/types/enums/v-c-s-detection-type.d.ts +4 -0
- package/types/index.d.ts +13 -2
- package/types/models.d.ts +1092 -221
- package/types/services/console.d.ts +10 -0
- package/types/services/databases.d.ts +44 -2
- package/types/services/domains.d.ts +524 -0
- package/types/services/functions.d.ts +60 -30
- package/types/services/health.d.ts +6 -6
- package/types/services/migrations.d.ts +10 -0
- package/types/services/organizations.d.ts +0 -10
- package/types/services/project.d.ts +4 -2
- package/types/services/projects.d.ts +48 -0
- package/types/services/proxy.d.ts +33 -5
- package/types/services/sites.d.ts +319 -0
- package/types/services/storage.d.ts +6 -3
- package/types/services/tokens.d.ts +51 -0
- package/types/services/users.d.ts +3 -1
- package/types/services/vcs.d.ts +15 -12
|
@@ -3,6 +3,8 @@ import { AppwriteException, Client, type Payload, UploadProgress } from '../clie
|
|
|
3
3
|
import type { Models } from '../models';
|
|
4
4
|
import { Runtime } from '../enums/runtime';
|
|
5
5
|
import { FunctionUsageRange } from '../enums/function-usage-range';
|
|
6
|
+
import { VCSDeploymentType } from '../enums/v-c-s-deployment-type';
|
|
7
|
+
import { DeploymentDownloadType } from '../enums/deployment-download-type';
|
|
6
8
|
import { ExecutionMethod } from '../enums/execution-method';
|
|
7
9
|
|
|
8
10
|
export class Functions {
|
|
@@ -32,7 +34,6 @@ export class Functions {
|
|
|
32
34
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
33
35
|
|
|
34
36
|
const apiHeaders: { [header: string]: string } = {
|
|
35
|
-
'content-type': 'application/json',
|
|
36
37
|
}
|
|
37
38
|
|
|
38
39
|
return this.client.call(
|
|
@@ -62,15 +63,15 @@ export class Functions {
|
|
|
62
63
|
* @param {string} providerBranch
|
|
63
64
|
* @param {boolean} providerSilentMode
|
|
64
65
|
* @param {string} providerRootDirectory
|
|
66
|
+
* @param {string} specification
|
|
65
67
|
* @param {string} templateRepository
|
|
66
68
|
* @param {string} templateOwner
|
|
67
69
|
* @param {string} templateRootDirectory
|
|
68
70
|
* @param {string} templateVersion
|
|
69
|
-
* @param {string} specification
|
|
70
71
|
* @throws {AppwriteException}
|
|
71
72
|
* @returns {Promise<Models.Function>}
|
|
72
73
|
*/
|
|
73
|
-
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string,
|
|
74
|
+
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateVersion?: string): Promise<Models.Function> {
|
|
74
75
|
if (typeof functionId === 'undefined') {
|
|
75
76
|
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
76
77
|
}
|
|
@@ -133,6 +134,9 @@ export class Functions {
|
|
|
133
134
|
if (typeof providerRootDirectory !== 'undefined') {
|
|
134
135
|
payload['providerRootDirectory'] = providerRootDirectory;
|
|
135
136
|
}
|
|
137
|
+
if (typeof specification !== 'undefined') {
|
|
138
|
+
payload['specification'] = specification;
|
|
139
|
+
}
|
|
136
140
|
if (typeof templateRepository !== 'undefined') {
|
|
137
141
|
payload['templateRepository'] = templateRepository;
|
|
138
142
|
}
|
|
@@ -145,9 +149,6 @@ export class Functions {
|
|
|
145
149
|
if (typeof templateVersion !== 'undefined') {
|
|
146
150
|
payload['templateVersion'] = templateVersion;
|
|
147
151
|
}
|
|
148
|
-
if (typeof specification !== 'undefined') {
|
|
149
|
-
payload['specification'] = specification;
|
|
150
|
-
}
|
|
151
152
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
152
153
|
|
|
153
154
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -173,7 +174,6 @@ export class Functions {
|
|
|
173
174
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
174
175
|
|
|
175
176
|
const apiHeaders: { [header: string]: string } = {
|
|
176
|
-
'content-type': 'application/json',
|
|
177
177
|
}
|
|
178
178
|
|
|
179
179
|
return this.client.call(
|
|
@@ -185,7 +185,6 @@ export class Functions {
|
|
|
185
185
|
}
|
|
186
186
|
/**
|
|
187
187
|
* List allowed function specifications for this instance.
|
|
188
|
-
|
|
189
188
|
*
|
|
190
189
|
* @throws {AppwriteException}
|
|
191
190
|
* @returns {Promise<Models.SpecificationList>}
|
|
@@ -196,7 +195,6 @@ export class Functions {
|
|
|
196
195
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
197
196
|
|
|
198
197
|
const apiHeaders: { [header: string]: string } = {
|
|
199
|
-
'content-type': 'application/json',
|
|
200
198
|
}
|
|
201
199
|
|
|
202
200
|
return this.client.call(
|
|
@@ -234,7 +232,6 @@ export class Functions {
|
|
|
234
232
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
235
233
|
|
|
236
234
|
const apiHeaders: { [header: string]: string } = {
|
|
237
|
-
'content-type': 'application/json',
|
|
238
235
|
}
|
|
239
236
|
|
|
240
237
|
return this.client.call(
|
|
@@ -260,7 +257,6 @@ export class Functions {
|
|
|
260
257
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
261
258
|
|
|
262
259
|
const apiHeaders: { [header: string]: string } = {
|
|
263
|
-
'content-type': 'application/json',
|
|
264
260
|
}
|
|
265
261
|
|
|
266
262
|
return this.client.call(
|
|
@@ -271,13 +267,13 @@ export class Functions {
|
|
|
271
267
|
);
|
|
272
268
|
}
|
|
273
269
|
/**
|
|
274
|
-
* Get usage metrics and statistics for
|
|
270
|
+
* Get usage metrics and statistics for all functions in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.
|
|
275
271
|
*
|
|
276
272
|
* @param {FunctionUsageRange} range
|
|
277
273
|
* @throws {AppwriteException}
|
|
278
274
|
* @returns {Promise<Models.UsageFunctions>}
|
|
279
275
|
*/
|
|
280
|
-
|
|
276
|
+
listUsage(range?: FunctionUsageRange): Promise<Models.UsageFunctions> {
|
|
281
277
|
const apiPath = '/functions/usage';
|
|
282
278
|
const payload: Payload = {};
|
|
283
279
|
if (typeof range !== 'undefined') {
|
|
@@ -286,7 +282,6 @@ export class Functions {
|
|
|
286
282
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
287
283
|
|
|
288
284
|
const apiHeaders: { [header: string]: string } = {
|
|
289
|
-
'content-type': 'application/json',
|
|
290
285
|
}
|
|
291
286
|
|
|
292
287
|
return this.client.call(
|
|
@@ -312,7 +307,6 @@ export class Functions {
|
|
|
312
307
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
313
308
|
|
|
314
309
|
const apiHeaders: { [header: string]: string } = {
|
|
315
|
-
'content-type': 'application/json',
|
|
316
310
|
}
|
|
317
311
|
|
|
318
312
|
return this.client.call(
|
|
@@ -446,7 +440,40 @@ export class Functions {
|
|
|
446
440
|
);
|
|
447
441
|
}
|
|
448
442
|
/**
|
|
449
|
-
*
|
|
443
|
+
* Update the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.
|
|
444
|
+
*
|
|
445
|
+
* @param {string} functionId
|
|
446
|
+
* @param {string} deploymentId
|
|
447
|
+
* @throws {AppwriteException}
|
|
448
|
+
* @returns {Promise<Models.Function>}
|
|
449
|
+
*/
|
|
450
|
+
updateFunctionDeployment(functionId: string, deploymentId: string): Promise<Models.Function> {
|
|
451
|
+
if (typeof functionId === 'undefined') {
|
|
452
|
+
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
453
|
+
}
|
|
454
|
+
if (typeof deploymentId === 'undefined') {
|
|
455
|
+
throw new AppwriteException('Missing required parameter: "deploymentId"');
|
|
456
|
+
}
|
|
457
|
+
const apiPath = '/functions/{functionId}/deployment'.replace('{functionId}', functionId);
|
|
458
|
+
const payload: Payload = {};
|
|
459
|
+
if (typeof deploymentId !== 'undefined') {
|
|
460
|
+
payload['deploymentId'] = deploymentId;
|
|
461
|
+
}
|
|
462
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
463
|
+
|
|
464
|
+
const apiHeaders: { [header: string]: string } = {
|
|
465
|
+
'content-type': 'application/json',
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
return this.client.call(
|
|
469
|
+
'patch',
|
|
470
|
+
uri,
|
|
471
|
+
apiHeaders,
|
|
472
|
+
payload
|
|
473
|
+
);
|
|
474
|
+
}
|
|
475
|
+
/**
|
|
476
|
+
* Get a list of all the function's code deployments. You can use the query params to filter your results.
|
|
450
477
|
*
|
|
451
478
|
* @param {string} functionId
|
|
452
479
|
* @param {string[]} queries
|
|
@@ -469,7 +496,6 @@ export class Functions {
|
|
|
469
496
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
470
497
|
|
|
471
498
|
const apiHeaders: { [header: string]: string } = {
|
|
472
|
-
'content-type': 'application/json',
|
|
473
499
|
}
|
|
474
500
|
|
|
475
501
|
return this.client.call(
|
|
@@ -533,22 +559,29 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
533
559
|
);
|
|
534
560
|
}
|
|
535
561
|
/**
|
|
536
|
-
*
|
|
562
|
+
* Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.
|
|
537
563
|
*
|
|
538
564
|
* @param {string} functionId
|
|
539
565
|
* @param {string} deploymentId
|
|
566
|
+
* @param {string} buildId
|
|
540
567
|
* @throws {AppwriteException}
|
|
541
568
|
* @returns {Promise<Models.Deployment>}
|
|
542
569
|
*/
|
|
543
|
-
|
|
570
|
+
createDuplicateDeployment(functionId: string, deploymentId: string, buildId?: string): Promise<Models.Deployment> {
|
|
544
571
|
if (typeof functionId === 'undefined') {
|
|
545
572
|
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
546
573
|
}
|
|
547
574
|
if (typeof deploymentId === 'undefined') {
|
|
548
575
|
throw new AppwriteException('Missing required parameter: "deploymentId"');
|
|
549
576
|
}
|
|
550
|
-
const apiPath = '/functions/{functionId}/deployments/
|
|
577
|
+
const apiPath = '/functions/{functionId}/deployments/duplicate'.replace('{functionId}', functionId);
|
|
551
578
|
const payload: Payload = {};
|
|
579
|
+
if (typeof deploymentId !== 'undefined') {
|
|
580
|
+
payload['deploymentId'] = deploymentId;
|
|
581
|
+
}
|
|
582
|
+
if (typeof buildId !== 'undefined') {
|
|
583
|
+
payload['buildId'] = buildId;
|
|
584
|
+
}
|
|
552
585
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
553
586
|
|
|
554
587
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -556,29 +589,59 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
556
589
|
}
|
|
557
590
|
|
|
558
591
|
return this.client.call(
|
|
559
|
-
'
|
|
592
|
+
'post',
|
|
560
593
|
uri,
|
|
561
594
|
apiHeaders,
|
|
562
595
|
payload
|
|
563
596
|
);
|
|
564
597
|
}
|
|
565
598
|
/**
|
|
566
|
-
*
|
|
599
|
+
* Create a deployment based on a template.
|
|
600
|
+
|
|
601
|
+
Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/functions#listTemplates) to find the template details.
|
|
567
602
|
*
|
|
568
603
|
* @param {string} functionId
|
|
569
|
-
* @param {string}
|
|
604
|
+
* @param {string} repository
|
|
605
|
+
* @param {string} owner
|
|
606
|
+
* @param {string} rootDirectory
|
|
607
|
+
* @param {string} version
|
|
608
|
+
* @param {boolean} activate
|
|
570
609
|
* @throws {AppwriteException}
|
|
571
|
-
* @returns {Promise<Models.
|
|
610
|
+
* @returns {Promise<Models.Deployment>}
|
|
572
611
|
*/
|
|
573
|
-
|
|
612
|
+
createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, version: string, activate?: boolean): Promise<Models.Deployment> {
|
|
574
613
|
if (typeof functionId === 'undefined') {
|
|
575
614
|
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
576
615
|
}
|
|
577
|
-
if (typeof
|
|
578
|
-
throw new AppwriteException('Missing required parameter: "
|
|
616
|
+
if (typeof repository === 'undefined') {
|
|
617
|
+
throw new AppwriteException('Missing required parameter: "repository"');
|
|
579
618
|
}
|
|
580
|
-
|
|
619
|
+
if (typeof owner === 'undefined') {
|
|
620
|
+
throw new AppwriteException('Missing required parameter: "owner"');
|
|
621
|
+
}
|
|
622
|
+
if (typeof rootDirectory === 'undefined') {
|
|
623
|
+
throw new AppwriteException('Missing required parameter: "rootDirectory"');
|
|
624
|
+
}
|
|
625
|
+
if (typeof version === 'undefined') {
|
|
626
|
+
throw new AppwriteException('Missing required parameter: "version"');
|
|
627
|
+
}
|
|
628
|
+
const apiPath = '/functions/{functionId}/deployments/template'.replace('{functionId}', functionId);
|
|
581
629
|
const payload: Payload = {};
|
|
630
|
+
if (typeof repository !== 'undefined') {
|
|
631
|
+
payload['repository'] = repository;
|
|
632
|
+
}
|
|
633
|
+
if (typeof owner !== 'undefined') {
|
|
634
|
+
payload['owner'] = owner;
|
|
635
|
+
}
|
|
636
|
+
if (typeof rootDirectory !== 'undefined') {
|
|
637
|
+
payload['rootDirectory'] = rootDirectory;
|
|
638
|
+
}
|
|
639
|
+
if (typeof version !== 'undefined') {
|
|
640
|
+
payload['version'] = version;
|
|
641
|
+
}
|
|
642
|
+
if (typeof activate !== 'undefined') {
|
|
643
|
+
payload['activate'] = activate;
|
|
644
|
+
}
|
|
582
645
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
583
646
|
|
|
584
647
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -586,29 +649,45 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
586
649
|
}
|
|
587
650
|
|
|
588
651
|
return this.client.call(
|
|
589
|
-
'
|
|
652
|
+
'post',
|
|
590
653
|
uri,
|
|
591
654
|
apiHeaders,
|
|
592
655
|
payload
|
|
593
656
|
);
|
|
594
657
|
}
|
|
595
658
|
/**
|
|
596
|
-
*
|
|
659
|
+
* Create a deployment when a function is connected to VCS.
|
|
660
|
+
|
|
661
|
+
This endpoint lets you create deployment from a branch, commit, or a tag.
|
|
597
662
|
*
|
|
598
663
|
* @param {string} functionId
|
|
599
|
-
* @param {
|
|
664
|
+
* @param {VCSDeploymentType} type
|
|
665
|
+
* @param {string} reference
|
|
666
|
+
* @param {boolean} activate
|
|
600
667
|
* @throws {AppwriteException}
|
|
601
|
-
* @returns {Promise<
|
|
668
|
+
* @returns {Promise<Models.Deployment>}
|
|
602
669
|
*/
|
|
603
|
-
|
|
670
|
+
createVcsDeployment(functionId: string, type: VCSDeploymentType, reference: string, activate?: boolean): Promise<Models.Deployment> {
|
|
604
671
|
if (typeof functionId === 'undefined') {
|
|
605
672
|
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
606
673
|
}
|
|
607
|
-
if (typeof
|
|
608
|
-
throw new AppwriteException('Missing required parameter: "
|
|
674
|
+
if (typeof type === 'undefined') {
|
|
675
|
+
throw new AppwriteException('Missing required parameter: "type"');
|
|
609
676
|
}
|
|
610
|
-
|
|
677
|
+
if (typeof reference === 'undefined') {
|
|
678
|
+
throw new AppwriteException('Missing required parameter: "reference"');
|
|
679
|
+
}
|
|
680
|
+
const apiPath = '/functions/{functionId}/deployments/vcs'.replace('{functionId}', functionId);
|
|
611
681
|
const payload: Payload = {};
|
|
682
|
+
if (typeof type !== 'undefined') {
|
|
683
|
+
payload['type'] = type;
|
|
684
|
+
}
|
|
685
|
+
if (typeof reference !== 'undefined') {
|
|
686
|
+
payload['reference'] = reference;
|
|
687
|
+
}
|
|
688
|
+
if (typeof activate !== 'undefined') {
|
|
689
|
+
payload['activate'] = activate;
|
|
690
|
+
}
|
|
612
691
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
613
692
|
|
|
614
693
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -616,62 +695,57 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
616
695
|
}
|
|
617
696
|
|
|
618
697
|
return this.client.call(
|
|
619
|
-
'
|
|
698
|
+
'post',
|
|
620
699
|
uri,
|
|
621
700
|
apiHeaders,
|
|
622
701
|
payload
|
|
623
702
|
);
|
|
624
703
|
}
|
|
625
704
|
/**
|
|
626
|
-
*
|
|
705
|
+
* Get a function deployment by its unique ID.
|
|
627
706
|
*
|
|
628
707
|
* @param {string} functionId
|
|
629
708
|
* @param {string} deploymentId
|
|
630
|
-
* @param {string} buildId
|
|
631
709
|
* @throws {AppwriteException}
|
|
632
|
-
* @returns {Promise<
|
|
710
|
+
* @returns {Promise<Models.Deployment>}
|
|
633
711
|
*/
|
|
634
|
-
|
|
712
|
+
getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment> {
|
|
635
713
|
if (typeof functionId === 'undefined') {
|
|
636
714
|
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
637
715
|
}
|
|
638
716
|
if (typeof deploymentId === 'undefined') {
|
|
639
717
|
throw new AppwriteException('Missing required parameter: "deploymentId"');
|
|
640
718
|
}
|
|
641
|
-
const apiPath = '/functions/{functionId}/deployments/{deploymentId}
|
|
719
|
+
const apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
|
|
642
720
|
const payload: Payload = {};
|
|
643
|
-
if (typeof buildId !== 'undefined') {
|
|
644
|
-
payload['buildId'] = buildId;
|
|
645
|
-
}
|
|
646
721
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
647
722
|
|
|
648
723
|
const apiHeaders: { [header: string]: string } = {
|
|
649
|
-
'content-type': 'application/json',
|
|
650
724
|
}
|
|
651
725
|
|
|
652
726
|
return this.client.call(
|
|
653
|
-
'
|
|
727
|
+
'get',
|
|
654
728
|
uri,
|
|
655
729
|
apiHeaders,
|
|
656
730
|
payload
|
|
657
731
|
);
|
|
658
732
|
}
|
|
659
733
|
/**
|
|
660
|
-
*
|
|
734
|
+
* Delete a code deployment by its unique ID.
|
|
661
735
|
*
|
|
662
736
|
* @param {string} functionId
|
|
663
737
|
* @param {string} deploymentId
|
|
664
738
|
* @throws {AppwriteException}
|
|
665
|
-
* @returns {Promise<
|
|
739
|
+
* @returns {Promise<{}>}
|
|
666
740
|
*/
|
|
667
|
-
|
|
741
|
+
deleteDeployment(functionId: string, deploymentId: string): Promise<{}> {
|
|
668
742
|
if (typeof functionId === 'undefined') {
|
|
669
743
|
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
670
744
|
}
|
|
671
745
|
if (typeof deploymentId === 'undefined') {
|
|
672
746
|
throw new AppwriteException('Missing required parameter: "deploymentId"');
|
|
673
747
|
}
|
|
674
|
-
const apiPath = '/functions/{functionId}/deployments/{deploymentId}
|
|
748
|
+
const apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
|
|
675
749
|
const payload: Payload = {};
|
|
676
750
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
677
751
|
|
|
@@ -680,21 +754,22 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
680
754
|
}
|
|
681
755
|
|
|
682
756
|
return this.client.call(
|
|
683
|
-
'
|
|
757
|
+
'delete',
|
|
684
758
|
uri,
|
|
685
759
|
apiHeaders,
|
|
686
760
|
payload
|
|
687
761
|
);
|
|
688
762
|
}
|
|
689
763
|
/**
|
|
690
|
-
* Get a
|
|
764
|
+
* Get a function deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
|
|
691
765
|
*
|
|
692
766
|
* @param {string} functionId
|
|
693
767
|
* @param {string} deploymentId
|
|
768
|
+
* @param {DeploymentDownloadType} type
|
|
694
769
|
* @throws {AppwriteException}
|
|
695
770
|
* @returns {string}
|
|
696
771
|
*/
|
|
697
|
-
getDeploymentDownload(functionId: string, deploymentId: string): string {
|
|
772
|
+
getDeploymentDownload(functionId: string, deploymentId: string, type?: DeploymentDownloadType): string {
|
|
698
773
|
if (typeof functionId === 'undefined') {
|
|
699
774
|
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
700
775
|
}
|
|
@@ -703,10 +778,12 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
703
778
|
}
|
|
704
779
|
const apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
|
|
705
780
|
const payload: Payload = {};
|
|
781
|
+
if (typeof type !== 'undefined') {
|
|
782
|
+
payload['type'] = type;
|
|
783
|
+
}
|
|
706
784
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
707
785
|
|
|
708
786
|
const apiHeaders: { [header: string]: string } = {
|
|
709
|
-
'content-type': 'application/json',
|
|
710
787
|
}
|
|
711
788
|
|
|
712
789
|
payload['project'] = this.client.config.project;
|
|
@@ -717,16 +794,45 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
717
794
|
|
|
718
795
|
return uri.toString();
|
|
719
796
|
}
|
|
797
|
+
/**
|
|
798
|
+
* Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.
|
|
799
|
+
*
|
|
800
|
+
* @param {string} functionId
|
|
801
|
+
* @param {string} deploymentId
|
|
802
|
+
* @throws {AppwriteException}
|
|
803
|
+
* @returns {Promise<Models.Deployment>}
|
|
804
|
+
*/
|
|
805
|
+
updateDeploymentStatus(functionId: string, deploymentId: string): Promise<Models.Deployment> {
|
|
806
|
+
if (typeof functionId === 'undefined') {
|
|
807
|
+
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
808
|
+
}
|
|
809
|
+
if (typeof deploymentId === 'undefined') {
|
|
810
|
+
throw new AppwriteException('Missing required parameter: "deploymentId"');
|
|
811
|
+
}
|
|
812
|
+
const apiPath = '/functions/{functionId}/deployments/{deploymentId}/status'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
|
|
813
|
+
const payload: Payload = {};
|
|
814
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
815
|
+
|
|
816
|
+
const apiHeaders: { [header: string]: string } = {
|
|
817
|
+
'content-type': 'application/json',
|
|
818
|
+
}
|
|
819
|
+
|
|
820
|
+
return this.client.call(
|
|
821
|
+
'patch',
|
|
822
|
+
uri,
|
|
823
|
+
apiHeaders,
|
|
824
|
+
payload
|
|
825
|
+
);
|
|
826
|
+
}
|
|
720
827
|
/**
|
|
721
828
|
* Get a list of all the current user function execution logs. You can use the query params to filter your results.
|
|
722
829
|
*
|
|
723
830
|
* @param {string} functionId
|
|
724
831
|
* @param {string[]} queries
|
|
725
|
-
* @param {string} search
|
|
726
832
|
* @throws {AppwriteException}
|
|
727
833
|
* @returns {Promise<Models.ExecutionList>}
|
|
728
834
|
*/
|
|
729
|
-
listExecutions(functionId: string, queries?: string[]
|
|
835
|
+
listExecutions(functionId: string, queries?: string[]): Promise<Models.ExecutionList> {
|
|
730
836
|
if (typeof functionId === 'undefined') {
|
|
731
837
|
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
732
838
|
}
|
|
@@ -735,13 +841,9 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
735
841
|
if (typeof queries !== 'undefined') {
|
|
736
842
|
payload['queries'] = queries;
|
|
737
843
|
}
|
|
738
|
-
if (typeof search !== 'undefined') {
|
|
739
|
-
payload['search'] = search;
|
|
740
|
-
}
|
|
741
844
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
742
845
|
|
|
743
846
|
const apiHeaders: { [header: string]: string } = {
|
|
744
|
-
'content-type': 'application/json',
|
|
745
847
|
}
|
|
746
848
|
|
|
747
849
|
return this.client.call(
|
|
@@ -821,7 +923,6 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
821
923
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
822
924
|
|
|
823
925
|
const apiHeaders: { [header: string]: string } = {
|
|
824
|
-
'content-type': 'application/json',
|
|
825
926
|
}
|
|
826
927
|
|
|
827
928
|
return this.client.call(
|
|
@@ -833,7 +934,6 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
833
934
|
}
|
|
834
935
|
/**
|
|
835
936
|
* Delete a function execution by its unique ID.
|
|
836
|
-
|
|
837
937
|
*
|
|
838
938
|
* @param {string} functionId
|
|
839
939
|
* @param {string} executionId
|
|
@@ -870,7 +970,7 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
870
970
|
* @throws {AppwriteException}
|
|
871
971
|
* @returns {Promise<Models.UsageFunction>}
|
|
872
972
|
*/
|
|
873
|
-
|
|
973
|
+
getUsage(functionId: string, range?: FunctionUsageRange): Promise<Models.UsageFunction> {
|
|
874
974
|
if (typeof functionId === 'undefined') {
|
|
875
975
|
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
876
976
|
}
|
|
@@ -882,7 +982,6 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
882
982
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
883
983
|
|
|
884
984
|
const apiHeaders: { [header: string]: string } = {
|
|
885
|
-
'content-type': 'application/json',
|
|
886
985
|
}
|
|
887
986
|
|
|
888
987
|
return this.client.call(
|
|
@@ -908,7 +1007,6 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
908
1007
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
909
1008
|
|
|
910
1009
|
const apiHeaders: { [header: string]: string } = {
|
|
911
|
-
'content-type': 'application/json',
|
|
912
1010
|
}
|
|
913
1011
|
|
|
914
1012
|
return this.client.call(
|
|
@@ -924,10 +1022,11 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
924
1022
|
* @param {string} functionId
|
|
925
1023
|
* @param {string} key
|
|
926
1024
|
* @param {string} value
|
|
1025
|
+
* @param {boolean} secret
|
|
927
1026
|
* @throws {AppwriteException}
|
|
928
1027
|
* @returns {Promise<Models.Variable>}
|
|
929
1028
|
*/
|
|
930
|
-
createVariable(functionId: string, key: string, value: string): Promise<Models.Variable> {
|
|
1029
|
+
createVariable(functionId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable> {
|
|
931
1030
|
if (typeof functionId === 'undefined') {
|
|
932
1031
|
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
933
1032
|
}
|
|
@@ -945,6 +1044,9 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
945
1044
|
if (typeof value !== 'undefined') {
|
|
946
1045
|
payload['value'] = value;
|
|
947
1046
|
}
|
|
1047
|
+
if (typeof secret !== 'undefined') {
|
|
1048
|
+
payload['secret'] = secret;
|
|
1049
|
+
}
|
|
948
1050
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
949
1051
|
|
|
950
1052
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -978,7 +1080,6 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
978
1080
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
979
1081
|
|
|
980
1082
|
const apiHeaders: { [header: string]: string } = {
|
|
981
|
-
'content-type': 'application/json',
|
|
982
1083
|
}
|
|
983
1084
|
|
|
984
1085
|
return this.client.call(
|
|
@@ -995,10 +1096,11 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
995
1096
|
* @param {string} variableId
|
|
996
1097
|
* @param {string} key
|
|
997
1098
|
* @param {string} value
|
|
1099
|
+
* @param {boolean} secret
|
|
998
1100
|
* @throws {AppwriteException}
|
|
999
1101
|
* @returns {Promise<Models.Variable>}
|
|
1000
1102
|
*/
|
|
1001
|
-
updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable> {
|
|
1103
|
+
updateVariable(functionId: string, variableId: string, key: string, value?: string, secret?: boolean): Promise<Models.Variable> {
|
|
1002
1104
|
if (typeof functionId === 'undefined') {
|
|
1003
1105
|
throw new AppwriteException('Missing required parameter: "functionId"');
|
|
1004
1106
|
}
|
|
@@ -1016,6 +1118,9 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
1016
1118
|
if (typeof value !== 'undefined') {
|
|
1017
1119
|
payload['value'] = value;
|
|
1018
1120
|
}
|
|
1121
|
+
if (typeof secret !== 'undefined') {
|
|
1122
|
+
payload['secret'] = secret;
|
|
1123
|
+
}
|
|
1019
1124
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
1020
1125
|
|
|
1021
1126
|
const apiHeaders: { [header: string]: string } = {
|