@appwrite.io/console 1.9.0 → 2.0.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/.github/workflows/publish.yml +9 -8
- package/CHANGELOG.md +51 -6
- package/LICENSE +1 -1
- package/README.md +84 -4
- package/dist/cjs/sdk.js +15258 -6036
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +15256 -6037
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +15258 -6036
- package/docs/examples/account/create-billing-address.md +8 -8
- package/docs/examples/account/create-email-password-session.md +4 -4
- package/docs/examples/account/create-email-token.md +5 -5
- package/docs/examples/account/{update-magic-u-r-l-session.md → create-email-verification.md} +3 -4
- package/docs/examples/account/{update-m-f-a.md → create-jwt.md} +3 -3
- package/docs/examples/account/{create-magic-u-r-l-token.md → create-magic-url-token.md} +6 -6
- package/docs/examples/account/create-mfa-authenticator.md +3 -3
- package/docs/examples/account/create-mfa-challenge.md +3 -3
- package/docs/examples/account/create-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-o-auth2token.md → create-o-auth-2-session.md} +6 -6
- package/docs/examples/account/{create-o-auth2session.md → create-o-auth-2-token.md} +6 -6
- package/docs/examples/account/create-phone-token.md +4 -4
- package/docs/examples/account/create-push-target.md +5 -5
- package/docs/examples/account/create-recovery.md +4 -4
- package/docs/examples/account/create-session.md +4 -4
- package/docs/examples/account/create-verification.md +3 -3
- package/docs/examples/account/create.md +6 -6
- package/docs/examples/account/delete-billing-address.md +3 -3
- package/docs/examples/account/delete-identity.md +3 -3
- package/docs/examples/account/delete-mfa-authenticator.md +3 -3
- package/docs/examples/account/delete-payment-method.md +3 -3
- package/docs/examples/account/delete-push-target.md +3 -3
- package/docs/examples/account/delete-session.md +3 -3
- package/docs/examples/account/get-billing-address.md +3 -3
- package/docs/examples/account/get-coupon.md +3 -3
- package/docs/examples/account/get-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/get-payment-method.md +3 -3
- package/docs/examples/account/get-session.md +3 -3
- package/docs/examples/account/list-billing-addresses.md +3 -3
- package/docs/examples/account/list-identities.md +4 -3
- package/docs/examples/account/list-invoices.md +3 -3
- package/docs/examples/account/list-logs.md +4 -3
- package/docs/examples/account/list-mfa-factors.md +1 -1
- package/docs/examples/account/list-payment-methods.md +3 -3
- package/docs/examples/account/update-billing-address.md +9 -9
- package/docs/examples/account/update-email-verification.md +14 -0
- package/docs/examples/account/update-email.md +4 -4
- package/docs/examples/account/update-magic-url-session.md +14 -0
- package/docs/examples/account/update-mfa-authenticator.md +4 -4
- package/docs/examples/account/update-mfa-challenge.md +4 -4
- package/docs/examples/account/update-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-j-w-t.md → update-mfa.md} +3 -1
- package/docs/examples/account/update-name.md +3 -3
- package/docs/examples/account/update-password.md +4 -4
- package/docs/examples/account/update-payment-method-mandate-options.md +3 -3
- package/docs/examples/account/update-payment-method-provider.md +6 -5
- package/docs/examples/account/update-payment-method.md +6 -5
- package/docs/examples/account/update-phone-session.md +4 -4
- package/docs/examples/account/update-phone-verification.md +4 -4
- package/docs/examples/account/update-phone.md +4 -4
- package/docs/examples/account/update-prefs.md +7 -3
- package/docs/examples/account/update-push-target.md +4 -4
- package/docs/examples/account/update-recovery.md +5 -5
- package/docs/examples/account/update-session.md +3 -3
- package/docs/examples/account/update-verification.md +4 -4
- package/docs/examples/assistant/chat.md +3 -3
- package/docs/examples/avatars/get-browser.md +6 -6
- package/docs/examples/avatars/get-credit-card.md +6 -6
- package/docs/examples/avatars/get-favicon.md +3 -3
- package/docs/examples/avatars/get-flag.md +6 -6
- package/docs/examples/avatars/get-image.md +5 -5
- package/docs/examples/avatars/get-initials.md +6 -6
- package/docs/examples/avatars/{get-q-r.md → get-qr.md} +6 -6
- package/docs/examples/avatars/get-screenshot.md +35 -0
- package/docs/examples/backups/create-archive.md +4 -4
- package/docs/examples/backups/create-policy.md +9 -9
- package/docs/examples/backups/create-restoration.md +6 -6
- package/docs/examples/backups/delete-archive.md +3 -3
- package/docs/examples/backups/delete-policy.md +3 -3
- package/docs/examples/backups/get-archive.md +3 -3
- package/docs/examples/backups/get-policy.md +3 -3
- package/docs/examples/backups/get-restoration.md +3 -3
- package/docs/examples/backups/list-archives.md +3 -3
- package/docs/examples/backups/list-policies.md +3 -3
- package/docs/examples/backups/list-restorations.md +3 -3
- package/docs/examples/backups/update-policy.md +7 -7
- package/docs/examples/console/create-program-membership.md +3 -3
- package/docs/examples/console/create-source.md +7 -7
- package/docs/examples/console/get-campaign.md +3 -3
- package/docs/examples/console/get-coupon.md +3 -3
- package/docs/examples/console/{plans.md → get-plan.md} +3 -1
- package/docs/examples/console/get-plans.md +13 -0
- package/docs/examples/console/{regions.md → get-program.md} +3 -1
- package/docs/examples/console/get-regions.md +13 -0
- package/docs/examples/console/get-resource.md +4 -4
- package/docs/examples/console/suggest-columns.md +17 -0
- package/docs/examples/console/suggest-indexes.md +16 -0
- package/docs/examples/databases/create-boolean-attribute.md +8 -8
- package/docs/examples/databases/create-collection.md +11 -9
- package/docs/examples/databases/create-datetime-attribute.md +8 -8
- package/docs/examples/databases/create-document.md +16 -11
- package/docs/examples/databases/create-documents.md +7 -6
- package/docs/examples/databases/create-email-attribute.md +8 -8
- package/docs/examples/databases/create-enum-attribute.md +9 -9
- package/docs/examples/databases/create-float-attribute.md +10 -10
- package/docs/examples/databases/create-index.md +9 -9
- package/docs/examples/databases/create-integer-attribute.md +10 -10
- package/docs/examples/databases/create-ip-attribute.md +8 -8
- package/docs/examples/databases/create-line-attribute.md +17 -0
- package/docs/examples/databases/create-operations.md +24 -0
- package/docs/examples/databases/create-point-attribute.md +17 -0
- package/docs/examples/databases/create-polygon-attribute.md +17 -0
- package/docs/examples/databases/create-relationship-attribute.md +10 -10
- package/docs/examples/databases/create-string-attribute.md +10 -10
- package/docs/examples/databases/create-transaction.md +13 -0
- package/docs/examples/databases/create-url-attribute.md +8 -8
- package/docs/examples/databases/create.md +5 -5
- package/docs/examples/databases/decrement-document-attribute.md +9 -8
- package/docs/examples/databases/delete-attribute.md +5 -5
- package/docs/examples/databases/delete-collection.md +4 -4
- package/docs/examples/databases/delete-document.md +6 -5
- package/docs/examples/databases/delete-documents.md +6 -5
- package/docs/examples/databases/delete-index.md +5 -5
- package/docs/examples/databases/{get-database-usage.md → delete-transaction.md} +4 -5
- package/docs/examples/databases/delete.md +3 -3
- package/docs/examples/databases/get-attribute.md +5 -5
- package/docs/examples/databases/get-collection-usage.md +6 -6
- package/docs/examples/databases/get-collection.md +4 -4
- package/docs/examples/databases/get-document.md +7 -6
- package/docs/examples/databases/get-index.md +5 -5
- package/docs/examples/databases/get-transaction.md +13 -0
- package/docs/examples/databases/get-usage.md +5 -4
- package/docs/examples/databases/get.md +3 -3
- package/docs/examples/databases/increment-document-attribute.md +9 -8
- package/docs/examples/databases/list-attributes.md +6 -5
- package/docs/examples/databases/list-collection-logs.md +5 -5
- package/docs/examples/databases/list-collections.md +6 -5
- package/docs/examples/databases/list-document-logs.md +6 -6
- package/docs/examples/databases/list-documents.md +7 -5
- package/docs/examples/databases/list-indexes.md +6 -5
- package/docs/examples/databases/list-logs.md +4 -4
- package/docs/examples/databases/list-transactions.md +13 -0
- package/docs/examples/databases/list-usage.md +13 -0
- package/docs/examples/databases/list.md +5 -4
- package/docs/examples/databases/update-boolean-attribute.md +8 -8
- package/docs/examples/databases/update-collection.md +9 -9
- package/docs/examples/databases/update-datetime-attribute.md +8 -8
- package/docs/examples/databases/update-document.md +15 -8
- package/docs/examples/databases/update-documents.md +13 -6
- package/docs/examples/databases/update-email-attribute.md +8 -8
- package/docs/examples/databases/update-enum-attribute.md +9 -9
- package/docs/examples/databases/update-float-attribute.md +10 -10
- package/docs/examples/databases/update-integer-attribute.md +10 -10
- package/docs/examples/databases/update-ip-attribute.md +8 -8
- package/docs/examples/databases/update-line-attribute.md +18 -0
- package/docs/examples/databases/update-point-attribute.md +18 -0
- package/docs/examples/databases/update-polygon-attribute.md +18 -0
- package/docs/examples/databases/update-relationship-attribute.md +7 -7
- package/docs/examples/databases/update-string-attribute.md +9 -9
- package/docs/examples/databases/update-transaction.md +15 -0
- package/docs/examples/databases/update-url-attribute.md +8 -8
- package/docs/examples/databases/update.md +5 -5
- package/docs/examples/databases/upsert-document.md +15 -8
- package/docs/examples/databases/upsert-documents.md +6 -5
- package/docs/examples/domains/create-preset-google-workspace.md +3 -3
- package/docs/examples/domains/create-preset-i-cloud.md +3 -3
- package/docs/examples/domains/create-preset-mailgun.md +3 -3
- package/docs/examples/domains/create-preset-outlook.md +3 -3
- package/docs/examples/domains/create-preset-proton-mail.md +3 -3
- package/docs/examples/domains/create-preset-zoho.md +3 -3
- package/docs/examples/domains/create-record-a.md +7 -7
- package/docs/examples/domains/{create-record-a-a-a-a.md → create-record-aaaa.md} +7 -7
- package/docs/examples/domains/create-record-alias.md +7 -7
- package/docs/examples/domains/{create-record-n-s.md → create-record-caa.md} +7 -7
- package/docs/examples/domains/{create-record-c-a-a.md → create-record-cname.md} +7 -7
- package/docs/examples/domains/{create-record-h-t-t-p-s.md → create-record-https.md} +7 -7
- package/docs/examples/domains/create-record-mx.md +18 -0
- package/docs/examples/domains/create-record-ns.md +17 -0
- package/docs/examples/domains/create-record-srv.md +20 -0
- package/docs/examples/domains/{create-record-c-n-a-m-e.md → create-record-txt.md} +7 -7
- package/docs/examples/domains/create.md +4 -4
- package/docs/examples/domains/delete-record.md +4 -4
- package/docs/examples/domains/delete.md +3 -3
- package/docs/examples/domains/get-preset-google-workspace.md +3 -3
- package/docs/examples/domains/get-preset-i-cloud.md +3 -3
- package/docs/examples/domains/get-preset-mailgun.md +3 -3
- package/docs/examples/domains/get-preset-outlook.md +3 -3
- package/docs/examples/domains/get-preset-proton-mail.md +3 -3
- package/docs/examples/domains/get-preset-zoho.md +3 -3
- package/docs/examples/domains/get-record.md +4 -4
- package/docs/examples/domains/get-zone.md +3 -3
- package/docs/examples/domains/get.md +3 -3
- package/docs/examples/domains/list-records.md +4 -4
- package/docs/examples/domains/list.md +4 -4
- package/docs/examples/domains/update-nameservers.md +3 -3
- package/docs/examples/domains/update-record-a.md +8 -8
- package/docs/examples/domains/update-record-aaaa.md +18 -0
- package/docs/examples/domains/update-record-alias.md +8 -8
- package/docs/examples/domains/update-record-caa.md +18 -0
- package/docs/examples/domains/update-record-cname.md +18 -0
- package/docs/examples/domains/update-record-https.md +18 -0
- package/docs/examples/domains/update-record-mx.md +19 -0
- package/docs/examples/domains/update-record-ns.md +18 -0
- package/docs/examples/domains/update-record-srv.md +21 -0
- package/docs/examples/domains/update-record-txt.md +18 -0
- package/docs/examples/domains/update-team.md +4 -4
- package/docs/examples/domains/update-zone.md +4 -4
- package/docs/examples/functions/create-deployment.md +7 -7
- package/docs/examples/functions/create-duplicate-deployment.md +5 -5
- package/docs/examples/functions/create-execution.md +9 -9
- package/docs/examples/functions/create-template-deployment.md +10 -9
- package/docs/examples/functions/create-variable.md +6 -6
- package/docs/examples/functions/create-vcs-deployment.md +7 -7
- package/docs/examples/functions/create.md +21 -21
- package/docs/examples/functions/delete-deployment.md +4 -4
- package/docs/examples/functions/delete-execution.md +4 -4
- package/docs/examples/functions/delete-variable.md +4 -4
- package/docs/examples/functions/delete.md +3 -3
- package/docs/examples/functions/get-deployment-download.md +5 -5
- package/docs/examples/functions/get-deployment.md +4 -4
- package/docs/examples/functions/get-execution.md +4 -4
- package/docs/examples/functions/get-template.md +3 -3
- package/docs/examples/functions/get-usage.md +5 -5
- package/docs/examples/functions/get-variable.md +4 -4
- package/docs/examples/functions/get.md +3 -3
- package/docs/examples/functions/list-deployments.md +6 -5
- package/docs/examples/functions/list-executions.md +5 -4
- package/docs/examples/functions/list-templates.md +7 -6
- package/docs/examples/functions/list-usage.md +4 -4
- package/docs/examples/functions/list-variables.md +3 -3
- package/docs/examples/functions/list.md +5 -4
- package/docs/examples/functions/update-deployment-status.md +4 -4
- package/docs/examples/functions/update-function-deployment.md +4 -4
- package/docs/examples/functions/update-variable.md +7 -7
- package/docs/examples/functions/update.md +21 -21
- package/docs/examples/graphql/mutation.md +3 -3
- package/docs/examples/graphql/query.md +3 -3
- package/docs/examples/health/get-certificate.md +3 -3
- package/docs/examples/health/get-failed-jobs.md +5 -5
- package/docs/examples/health/get-queue-billing-project-aggregation.md +3 -3
- package/docs/examples/health/get-queue-billing-team-aggregation.md +3 -3
- package/docs/examples/health/get-queue-builds.md +3 -3
- package/docs/examples/health/get-queue-certificates.md +3 -3
- package/docs/examples/health/get-queue-databases.md +4 -4
- package/docs/examples/health/get-queue-deletes.md +3 -3
- package/docs/examples/health/get-queue-functions.md +3 -3
- package/docs/examples/health/get-queue-logs.md +3 -3
- package/docs/examples/health/get-queue-mails.md +3 -3
- package/docs/examples/health/get-queue-messaging.md +3 -3
- package/docs/examples/health/get-queue-migrations.md +3 -3
- package/docs/examples/health/get-queue-priority-builds.md +3 -3
- package/docs/examples/health/get-queue-region-manager.md +3 -3
- package/docs/examples/health/get-queue-stats-resources.md +3 -3
- package/docs/examples/health/get-queue-threats.md +13 -0
- package/docs/examples/health/get-queue-usage.md +3 -3
- package/docs/examples/health/get-queue-webhooks.md +3 -3
- package/docs/examples/messaging/create-apns-provider.md +10 -10
- package/docs/examples/messaging/create-email.md +14 -14
- package/docs/examples/messaging/create-fcm-provider.md +6 -6
- package/docs/examples/messaging/create-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{create-msg91provider.md → create-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/create-push.md +21 -21
- package/docs/examples/messaging/create-resend-provider.md +20 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/create-sms.md +9 -9
- package/docs/examples/messaging/create-smtp-provider.md +16 -16
- package/docs/examples/messaging/create-subscriber.md +5 -5
- package/docs/examples/messaging/create-telesign-provider.md +8 -8
- package/docs/examples/messaging/create-textmagic-provider.md +8 -8
- package/docs/examples/messaging/create-topic.md +5 -5
- package/docs/examples/messaging/create-twilio-provider.md +8 -8
- package/docs/examples/messaging/create-vonage-provider.md +8 -8
- package/docs/examples/messaging/delete-provider.md +3 -3
- package/docs/examples/messaging/delete-subscriber.md +4 -4
- package/docs/examples/messaging/delete-topic.md +3 -3
- package/docs/examples/messaging/delete.md +3 -3
- package/docs/examples/messaging/get-message.md +3 -3
- package/docs/examples/messaging/get-provider.md +3 -3
- package/docs/examples/messaging/get-subscriber.md +4 -4
- package/docs/examples/messaging/get-topic.md +3 -3
- package/docs/examples/messaging/list-message-logs.md +5 -4
- package/docs/examples/messaging/list-messages.md +5 -4
- package/docs/examples/messaging/list-provider-logs.md +5 -4
- package/docs/examples/messaging/list-providers.md +5 -4
- package/docs/examples/messaging/list-subscriber-logs.md +5 -4
- package/docs/examples/messaging/list-subscribers.md +6 -5
- package/docs/examples/messaging/list-targets.md +5 -4
- package/docs/examples/messaging/list-topic-logs.md +5 -4
- package/docs/examples/messaging/list-topics.md +5 -4
- package/docs/examples/messaging/update-apns-provider.md +10 -10
- package/docs/examples/messaging/update-email.md +14 -14
- package/docs/examples/messaging/update-fcm-provider.md +6 -6
- package/docs/examples/messaging/update-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{update-msg91provider.md → update-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/update-push.md +21 -21
- package/docs/examples/messaging/update-resend-provider.md +20 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/update-sms.md +9 -9
- package/docs/examples/messaging/update-smtp-provider.md +16 -16
- package/docs/examples/messaging/update-telesign-provider.md +8 -8
- package/docs/examples/messaging/update-textmagic-provider.md +8 -8
- package/docs/examples/messaging/update-topic.md +5 -5
- package/docs/examples/messaging/update-twilio-provider.md +8 -8
- package/docs/examples/messaging/update-vonage-provider.md +8 -8
- package/docs/examples/migrations/create-appwrite-migration.md +6 -6
- package/docs/examples/migrations/create-csv-export.md +21 -0
- package/docs/examples/migrations/{create-csv-migration.md → create-csv-import.md} +6 -5
- package/docs/examples/migrations/create-firebase-migration.md +4 -4
- package/docs/examples/migrations/create-n-host-migration.md +10 -10
- package/docs/examples/migrations/create-supabase-migration.md +9 -9
- package/docs/examples/migrations/delete.md +3 -3
- package/docs/examples/migrations/get-appwrite-report.md +6 -6
- package/docs/examples/migrations/get-firebase-report.md +4 -4
- package/docs/examples/migrations/get-n-host-report.md +10 -10
- package/docs/examples/migrations/get-supabase-report.md +9 -9
- package/docs/examples/migrations/get.md +3 -3
- package/docs/examples/migrations/list.md +5 -4
- package/docs/examples/migrations/retry.md +3 -3
- package/docs/examples/organizations/add-credit.md +4 -4
- package/docs/examples/organizations/cancel-downgrade.md +3 -3
- package/docs/examples/organizations/create-downgrade-feedback.md +17 -0
- package/docs/examples/organizations/create-invoice-payment.md +5 -5
- package/docs/examples/organizations/create.md +13 -12
- package/docs/examples/organizations/delete-backup-payment-method.md +3 -3
- package/docs/examples/organizations/delete-billing-address.md +3 -3
- package/docs/examples/organizations/delete-default-payment-method.md +3 -3
- package/docs/examples/organizations/delete.md +3 -3
- package/docs/examples/organizations/estimation-create-organization.md +8 -7
- package/docs/examples/organizations/estimation-delete-organization.md +3 -3
- package/docs/examples/organizations/estimation-update-plan.md +7 -7
- package/docs/examples/organizations/get-aggregation.md +6 -4
- package/docs/examples/organizations/get-available-credits.md +13 -0
- package/docs/examples/organizations/get-billing-address.md +4 -4
- package/docs/examples/organizations/get-credit.md +4 -4
- package/docs/examples/organizations/get-invoice-download.md +4 -4
- package/docs/examples/organizations/get-invoice-view.md +4 -4
- package/docs/examples/organizations/get-invoice.md +4 -4
- package/docs/examples/organizations/get-payment-method.md +4 -4
- package/docs/examples/organizations/get-plan.md +3 -3
- package/docs/examples/organizations/get-scopes.md +3 -3
- package/docs/examples/organizations/get-usage.md +5 -5
- package/docs/examples/organizations/list-aggregations.md +4 -4
- package/docs/examples/organizations/list-credits.md +4 -4
- package/docs/examples/organizations/list-invoices.md +4 -4
- package/docs/examples/organizations/list.md +4 -4
- package/docs/examples/organizations/set-backup-payment-method.md +4 -4
- package/docs/examples/organizations/set-billing-address.md +4 -4
- package/docs/examples/organizations/set-billing-email.md +4 -4
- package/docs/examples/organizations/set-billing-tax-id.md +4 -4
- package/docs/examples/organizations/set-default-payment-method.md +4 -4
- package/docs/examples/organizations/update-budget.md +5 -5
- package/docs/examples/organizations/update-plan.md +11 -11
- package/docs/examples/organizations/update-projects.md +14 -0
- package/docs/examples/organizations/validate-invoice.md +4 -4
- package/docs/examples/organizations/validate-payment.md +4 -4
- package/docs/examples/project/create-variable.md +5 -5
- package/docs/examples/project/delete-variable.md +3 -3
- package/docs/examples/project/get-usage.md +5 -5
- package/docs/examples/project/get-variable.md +3 -3
- package/docs/examples/project/update-variable.md +6 -6
- package/docs/examples/projects/create-dev-key.md +5 -5
- package/docs/examples/projects/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/projects/create-key.md +6 -6
- package/docs/examples/projects/create-platform.md +8 -8
- package/docs/examples/projects/create-smtp-test.md +12 -12
- package/docs/examples/projects/create-webhook.md +10 -10
- package/docs/examples/projects/create.md +16 -16
- package/docs/examples/projects/delete-dev-key.md +4 -4
- package/docs/examples/projects/delete-email-template.md +5 -5
- package/docs/examples/projects/delete-key.md +4 -4
- package/docs/examples/projects/delete-platform.md +4 -4
- package/docs/examples/projects/delete-sms-template.md +5 -5
- package/docs/examples/projects/delete-webhook.md +4 -4
- package/docs/examples/projects/delete.md +3 -3
- package/docs/examples/projects/get-dev-key.md +4 -4
- package/docs/examples/projects/get-email-template.md +5 -5
- package/docs/examples/projects/get-key.md +4 -4
- package/docs/examples/projects/get-platform.md +4 -4
- package/docs/examples/projects/get-sms-template.md +5 -5
- package/docs/examples/projects/get-webhook.md +4 -4
- package/docs/examples/projects/get.md +3 -3
- package/docs/examples/projects/list-dev-keys.md +4 -4
- package/docs/examples/projects/list-keys.md +4 -3
- package/docs/examples/projects/list-platforms.md +4 -3
- package/docs/examples/projects/list-webhooks.md +4 -3
- package/docs/examples/projects/list.md +5 -4
- package/docs/examples/projects/update-api-status-all.md +4 -4
- package/docs/examples/projects/update-api-status.md +6 -6
- package/docs/examples/projects/update-auth-duration.md +4 -4
- package/docs/examples/projects/update-auth-limit.md +4 -4
- package/docs/examples/projects/update-auth-password-dictionary.md +4 -4
- package/docs/examples/projects/update-auth-password-history.md +4 -4
- package/docs/examples/projects/update-auth-sessions-limit.md +4 -4
- package/docs/examples/projects/update-auth-status.md +5 -5
- package/docs/examples/projects/update-dev-key.md +6 -6
- package/docs/examples/projects/update-email-template.md +10 -10
- package/docs/examples/projects/update-key.md +7 -7
- package/docs/examples/projects/update-memberships-privacy.md +6 -6
- package/docs/examples/projects/update-mock-numbers.md +4 -4
- package/docs/examples/projects/{update-o-auth2.md → update-o-auth-2.md} +7 -7
- package/docs/examples/projects/update-personal-data-check.md +4 -4
- package/docs/examples/projects/update-platform.md +8 -8
- package/docs/examples/projects/update-service-status-all.md +4 -4
- package/docs/examples/projects/update-service-status.md +5 -5
- package/docs/examples/projects/update-session-alerts.md +4 -4
- package/docs/examples/projects/update-session-invalidation.md +14 -0
- package/docs/examples/projects/update-sms-template.md +6 -6
- package/docs/examples/projects/update-smtp.md +12 -12
- package/docs/examples/projects/update-status.md +14 -0
- package/docs/examples/projects/update-team.md +4 -4
- package/docs/examples/projects/update-webhook-signature.md +4 -4
- package/docs/examples/projects/update-webhook.md +11 -11
- package/docs/examples/projects/update.md +13 -13
- package/docs/examples/proxy/{create-a-p-i-rule.md → create-api-rule.md} +3 -3
- package/docs/examples/proxy/create-function-rule.md +5 -5
- package/docs/examples/proxy/create-redirect-rule.md +8 -8
- package/docs/examples/proxy/create-site-rule.md +5 -5
- package/docs/examples/proxy/delete-rule.md +3 -3
- package/docs/examples/proxy/get-rule.md +3 -3
- package/docs/examples/proxy/list-rules.md +5 -4
- package/docs/examples/proxy/update-rule-verification.md +3 -3
- package/docs/examples/sites/create-deployment.md +8 -8
- package/docs/examples/sites/create-duplicate-deployment.md +4 -4
- package/docs/examples/sites/create-template-deployment.md +10 -9
- package/docs/examples/sites/create-variable.md +6 -6
- package/docs/examples/sites/create-vcs-deployment.md +7 -7
- package/docs/examples/sites/create.md +21 -21
- package/docs/examples/sites/delete-deployment.md +4 -4
- package/docs/examples/sites/delete-log.md +4 -4
- package/docs/examples/sites/delete-variable.md +4 -4
- package/docs/examples/sites/delete.md +3 -3
- package/docs/examples/sites/get-deployment-download.md +5 -5
- package/docs/examples/sites/get-deployment.md +4 -4
- package/docs/examples/sites/get-log.md +4 -4
- package/docs/examples/sites/get-template.md +3 -3
- package/docs/examples/sites/get-usage.md +5 -5
- package/docs/examples/sites/get-variable.md +4 -4
- package/docs/examples/sites/get.md +3 -3
- package/docs/examples/sites/list-deployments.md +6 -5
- package/docs/examples/sites/list-logs.md +5 -4
- package/docs/examples/sites/list-templates.md +6 -6
- package/docs/examples/sites/list-usage.md +4 -4
- package/docs/examples/sites/list-variables.md +3 -3
- package/docs/examples/sites/list.md +5 -4
- package/docs/examples/sites/update-deployment-status.md +4 -4
- package/docs/examples/sites/update-site-deployment.md +4 -4
- package/docs/examples/sites/update-variable.md +7 -7
- package/docs/examples/sites/update.md +21 -21
- package/docs/examples/storage/create-bucket.md +14 -13
- package/docs/examples/storage/create-file.md +7 -7
- package/docs/examples/storage/delete-bucket.md +3 -3
- package/docs/examples/storage/delete-file.md +4 -4
- package/docs/examples/storage/get-bucket-usage.md +5 -5
- package/docs/examples/storage/get-bucket.md +3 -3
- package/docs/examples/storage/get-file-download.md +5 -5
- package/docs/examples/storage/get-file-preview.md +16 -16
- package/docs/examples/storage/get-file-view.md +5 -5
- package/docs/examples/storage/get-file.md +4 -4
- package/docs/examples/storage/get-usage.md +4 -4
- package/docs/examples/storage/list-buckets.md +5 -4
- package/docs/examples/storage/list-files.md +6 -5
- package/docs/examples/storage/update-bucket.md +14 -13
- package/docs/examples/storage/update-file.md +7 -7
- package/docs/examples/tablesdb/create-boolean-column.md +18 -0
- package/docs/examples/tablesdb/create-datetime-column.md +18 -0
- package/docs/examples/tablesdb/create-email-column.md +18 -0
- package/docs/examples/tablesdb/create-enum-column.md +19 -0
- package/docs/examples/tablesdb/create-float-column.md +20 -0
- package/docs/examples/tablesdb/create-index.md +19 -0
- package/docs/examples/tablesdb/create-integer-column.md +20 -0
- package/docs/examples/tablesdb/create-ip-column.md +18 -0
- package/docs/examples/tablesdb/create-line-column.md +17 -0
- package/docs/examples/tablesdb/create-operations.md +24 -0
- package/docs/examples/tablesdb/create-point-column.md +17 -0
- package/docs/examples/tablesdb/create-polygon-column.md +17 -0
- package/docs/examples/tablesdb/create-relationship-column.md +20 -0
- package/docs/examples/tablesdb/create-row.md +24 -0
- package/docs/examples/tablesdb/create-rows.md +16 -0
- package/docs/examples/tablesdb/create-string-column.md +20 -0
- package/docs/examples/tablesdb/create-table.md +20 -0
- package/docs/examples/tablesdb/create-transaction.md +13 -0
- package/docs/examples/tablesdb/create-url-column.md +18 -0
- package/docs/examples/tablesdb/create.md +15 -0
- package/docs/examples/tablesdb/decrement-row-column.md +19 -0
- package/docs/examples/tablesdb/delete-column.md +15 -0
- package/docs/examples/tablesdb/delete-index.md +15 -0
- package/docs/examples/tablesdb/delete-row.md +16 -0
- package/docs/examples/tablesdb/delete-rows.md +16 -0
- package/docs/examples/tablesdb/delete-table.md +14 -0
- package/docs/examples/tablesdb/delete-transaction.md +13 -0
- package/docs/examples/tablesdb/delete.md +13 -0
- package/docs/examples/tablesdb/get-column.md +15 -0
- package/docs/examples/tablesdb/get-index.md +15 -0
- package/docs/examples/tablesdb/get-row.md +17 -0
- package/docs/examples/tablesdb/get-table-usage.md +15 -0
- package/docs/examples/tablesdb/get-table.md +14 -0
- package/docs/examples/tablesdb/get-transaction.md +13 -0
- package/docs/examples/tablesdb/get-usage.md +14 -0
- package/docs/examples/tablesdb/get.md +13 -0
- package/docs/examples/tablesdb/increment-row-column.md +19 -0
- package/docs/examples/tablesdb/list-columns.md +16 -0
- package/docs/examples/tablesdb/list-indexes.md +16 -0
- package/docs/examples/tablesdb/list-row-logs.md +16 -0
- package/docs/examples/tablesdb/list-rows.md +17 -0
- package/docs/examples/tablesdb/list-table-logs.md +15 -0
- package/docs/examples/tablesdb/list-tables.md +16 -0
- package/docs/examples/tablesdb/list-transactions.md +13 -0
- package/docs/examples/tablesdb/list-usage.md +13 -0
- package/docs/examples/tablesdb/list.md +15 -0
- package/docs/examples/tablesdb/update-boolean-column.md +18 -0
- package/docs/examples/tablesdb/update-datetime-column.md +18 -0
- package/docs/examples/tablesdb/update-email-column.md +18 -0
- package/docs/examples/tablesdb/update-enum-column.md +19 -0
- package/docs/examples/tablesdb/update-float-column.md +20 -0
- package/docs/examples/tablesdb/update-integer-column.md +20 -0
- package/docs/examples/tablesdb/update-ip-column.md +18 -0
- package/docs/examples/tablesdb/update-line-column.md +18 -0
- package/docs/examples/tablesdb/update-point-column.md +18 -0
- package/docs/examples/tablesdb/update-polygon-column.md +18 -0
- package/docs/examples/tablesdb/update-relationship-column.md +17 -0
- package/docs/examples/tablesdb/update-row.md +24 -0
- package/docs/examples/tablesdb/update-rows.md +23 -0
- package/docs/examples/tablesdb/update-string-column.md +19 -0
- package/docs/examples/tablesdb/update-table.md +18 -0
- package/docs/examples/tablesdb/update-transaction.md +15 -0
- package/docs/examples/tablesdb/update-url-column.md +18 -0
- package/docs/examples/tablesdb/update.md +15 -0
- package/docs/examples/tablesdb/upsert-row.md +24 -0
- package/docs/examples/tablesdb/upsert-rows.md +16 -0
- package/docs/examples/teams/create-membership.md +9 -9
- package/docs/examples/teams/create.md +5 -5
- package/docs/examples/teams/delete-membership.md +4 -4
- package/docs/examples/teams/delete.md +3 -3
- package/docs/examples/teams/get-membership.md +4 -4
- package/docs/examples/teams/get-prefs.md +3 -3
- package/docs/examples/teams/get.md +3 -3
- package/docs/examples/teams/list-logs.md +5 -4
- package/docs/examples/teams/list-memberships.md +6 -5
- package/docs/examples/teams/list.md +5 -4
- package/docs/examples/teams/update-membership-status.md +6 -6
- package/docs/examples/teams/update-membership.md +5 -5
- package/docs/examples/teams/update-name.md +4 -4
- package/docs/examples/teams/update-prefs.md +4 -4
- package/docs/examples/tokens/create-file-token.md +5 -5
- package/docs/examples/tokens/delete.md +3 -3
- package/docs/examples/tokens/get.md +3 -3
- package/docs/examples/tokens/list.md +6 -5
- package/docs/examples/tokens/update.md +4 -4
- package/docs/examples/users/{create-m-d5user.md → create-argon-2-user.md} +6 -6
- package/docs/examples/users/create-bcrypt-user.md +6 -6
- package/docs/examples/users/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/users/{create-argon2user.md → create-md-5-user.md} +6 -6
- package/docs/examples/users/create-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/{create-p-h-pass-user.md → create-ph-pass-user.md} +6 -6
- package/docs/examples/users/create-scrypt-modified-user.md +9 -9
- package/docs/examples/users/create-scrypt-user.md +11 -11
- package/docs/examples/users/create-session.md +3 -3
- package/docs/examples/users/{create-s-h-a-user.md → create-sha-user.md} +7 -7
- package/docs/examples/users/create-target.md +8 -8
- package/docs/examples/users/create-token.md +5 -5
- package/docs/examples/users/create.md +7 -7
- package/docs/examples/users/delete-identity.md +3 -3
- package/docs/examples/users/delete-mfa-authenticator.md +4 -4
- package/docs/examples/users/delete-session.md +4 -4
- package/docs/examples/users/delete-sessions.md +3 -3
- package/docs/examples/users/delete-target.md +4 -4
- package/docs/examples/users/delete.md +3 -3
- package/docs/examples/users/get-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/get-prefs.md +3 -3
- package/docs/examples/users/get-target.md +4 -4
- package/docs/examples/users/get-usage.md +4 -4
- package/docs/examples/users/get.md +3 -3
- package/docs/examples/users/list-identities.md +5 -4
- package/docs/examples/users/list-logs.md +5 -4
- package/docs/examples/users/list-memberships.md +6 -5
- package/docs/examples/users/list-mfa-factors.md +3 -3
- package/docs/examples/users/list-sessions.md +4 -3
- package/docs/examples/users/list-targets.md +5 -4
- package/docs/examples/users/list.md +5 -4
- package/docs/examples/users/update-email-verification.md +4 -4
- package/docs/examples/users/update-email.md +4 -4
- package/docs/examples/users/update-labels.md +4 -4
- package/docs/examples/users/update-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/update-mfa.md +4 -4
- package/docs/examples/users/update-name.md +4 -4
- package/docs/examples/users/update-password.md +4 -4
- package/docs/examples/users/update-phone-verification.md +4 -4
- package/docs/examples/users/update-phone.md +4 -4
- package/docs/examples/users/update-prefs.md +4 -4
- package/docs/examples/users/update-status.md +4 -4
- package/docs/examples/users/update-target.md +7 -7
- package/docs/examples/vcs/create-repository-detection.md +6 -6
- package/docs/examples/vcs/create-repository.md +5 -5
- package/docs/examples/vcs/delete-installation.md +3 -3
- package/docs/examples/vcs/get-installation.md +3 -3
- package/docs/examples/vcs/get-repository-contents.md +6 -5
- package/docs/examples/vcs/get-repository.md +4 -4
- package/docs/examples/vcs/list-installations.md +5 -4
- package/docs/examples/vcs/list-repositories.md +6 -5
- package/docs/examples/vcs/list-repository-branches.md +4 -4
- package/docs/examples/vcs/update-external-deployments.md +5 -5
- package/package.json +4 -4
- package/src/client.ts +42 -7
- package/src/enums/api-service.ts +1 -0
- package/src/enums/attribute-status.ts +7 -0
- package/src/enums/billing-plan-group.ts +5 -0
- package/src/enums/build-runtime.ts +2 -0
- package/src/enums/column-status.ts +7 -0
- package/src/enums/credit-card.ts +1 -1
- package/src/enums/database-type.ts +4 -0
- package/src/enums/deployment-status.ts +7 -0
- package/src/enums/execution-method.ts +1 -0
- package/src/enums/execution-status.ts +7 -0
- package/src/enums/execution-trigger.ts +5 -0
- package/src/enums/framework.ts +1 -0
- package/src/enums/health-antivirus-status.ts +5 -0
- package/src/enums/health-check-status.ts +4 -0
- package/src/enums/index-status.ts +7 -0
- package/src/enums/index-type.ts +1 -0
- package/src/enums/message-status.ts +7 -0
- package/src/enums/o-auth-provider.ts +3 -0
- package/src/enums/platform.ts +4 -0
- package/src/enums/proxy-rule-deployment-resource-type.ts +4 -0
- package/src/enums/proxy-rule-status.ts +6 -0
- package/src/enums/region.ts +3 -0
- package/src/enums/runtime.ts +2 -0
- package/src/enums/status.ts +4 -0
- package/src/enums/template-reference-type.ts +5 -0
- package/src/enums/theme.ts +4 -0
- package/src/enums/timezone.ts +421 -0
- package/src/enums/{user-usage-range.ts → usage-range.ts} +1 -1
- package/src/enums/{v-c-s-deployment-type.ts → vcs-reference-type.ts} +1 -1
- package/src/index.ts +27 -11
- package/src/models.ts +1925 -239
- package/src/operator.ts +308 -0
- package/src/query.ts +246 -2
- package/src/services/account.ts +2278 -235
- package/src/services/assistant.ts +29 -3
- package/src/services/avatars.ts +511 -52
- package/src/services/backups.ts +400 -42
- package/src/services/console.ts +499 -19
- package/src/services/databases.ts +3584 -430
- package/src/services/domains.ts +1795 -266
- package/src/services/functions.ts +1197 -155
- package/src/services/graphql.ts +56 -4
- package/src/services/health.ts +586 -42
- package/src/services/locale.ts +18 -2
- package/src/services/messaging.ts +3418 -386
- package/src/services/migrations.ts +653 -65
- package/src/services/organizations.ts +1411 -126
- package/src/services/project.ts +173 -17
- package/src/services/projects.ts +2808 -282
- package/src/services/proxy.ts +272 -26
- package/src/services/realtime.ts +437 -0
- package/src/services/sites.ts +1129 -143
- package/src/services/storage.ts +672 -89
- package/src/services/tables-db.ts +5439 -0
- package/src/services/teams.ts +535 -65
- package/src/services/tokens.ts +171 -16
- package/src/services/users.ts +1916 -182
- package/src/services/vcs.ts +373 -41
- package/types/client.d.ts +14 -5
- package/types/enums/api-service.d.ts +1 -0
- package/types/enums/attribute-status.d.ts +7 -0
- package/types/enums/billing-plan-group.d.ts +5 -0
- package/types/enums/build-runtime.d.ts +3 -1
- package/types/enums/column-status.d.ts +7 -0
- package/types/enums/credit-card.d.ts +1 -1
- package/types/enums/database-type.d.ts +4 -0
- package/types/enums/deployment-status.d.ts +7 -0
- package/types/enums/execution-method.d.ts +2 -1
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/framework.d.ts +1 -0
- package/types/enums/health-antivirus-status.d.ts +5 -0
- package/types/enums/health-check-status.d.ts +4 -0
- package/types/enums/index-status.d.ts +7 -0
- package/types/enums/index-type.d.ts +2 -1
- package/types/enums/message-status.d.ts +7 -0
- package/types/enums/o-auth-provider.d.ts +4 -1
- package/types/enums/platform.d.ts +4 -0
- package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
- package/types/enums/proxy-rule-status.d.ts +6 -0
- package/types/enums/region.d.ts +4 -1
- package/types/enums/runtime.d.ts +3 -1
- package/types/enums/status.d.ts +4 -0
- package/types/enums/template-reference-type.d.ts +5 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +421 -0
- package/types/enums/{site-usage-range.d.ts → usage-range.d.ts} +1 -1
- package/types/enums/{v-c-s-deployment-type.d.ts → vcs-reference-type.d.ts} +1 -1
- package/types/index.d.ts +27 -11
- package/types/models.d.ts +1877 -422
- package/types/operator.d.ts +180 -0
- package/types/query.d.ts +198 -2
- package/types/services/account.d.ts +1020 -158
- package/types/services/assistant.d.ts +13 -2
- package/types/services/avatars.d.ts +263 -45
- package/types/services/backups.d.ts +190 -30
- package/types/services/console.d.ts +202 -15
- package/types/services/databases.d.ts +1756 -299
- package/types/services/domains.d.ts +971 -219
- package/types/services/functions.d.ts +622 -131
- package/types/services/graphql.d.ts +24 -2
- package/types/services/health.d.ts +246 -24
- package/types/services/locale.d.ts +2 -2
- package/types/services/messaging.d.ts +1670 -281
- package/types/services/migrations.d.ts +319 -53
- package/types/services/organizations.d.ts +664 -109
- package/types/services/project.d.ts +81 -12
- package/types/services/projects.d.ts +1308 -202
- package/types/services/proxy.d.ts +128 -19
- package/types/services/realtime.d.ts +118 -0
- package/types/services/sites.d.ts +580 -119
- package/types/services/storage.d.ts +362 -81
- package/types/services/tables-db.d.ts +2040 -0
- package/types/services/teams.d.ts +277 -61
- package/types/services/tokens.d.ts +80 -12
- package/types/services/users.d.ts +906 -149
- package/types/services/vcs.d.ts +182 -34
- package/docs/examples/domains/create-record-m-x.md +0 -18
- package/docs/examples/domains/create-record-s-r-v.md +0 -20
- package/docs/examples/domains/create-record-t-x-t.md +0 -17
- package/docs/examples/domains/update-record-a-a-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-n-a-m-e.md +0 -18
- package/docs/examples/domains/update-record-h-t-t-p-s.md +0 -18
- package/docs/examples/domains/update-record-m-x.md +0 -19
- package/docs/examples/domains/update-record-n-s.md +0 -18
- package/docs/examples/domains/update-record-s-r-v.md +0 -21
- package/docs/examples/domains/update-record-t-x-t.md +0 -18
- package/src/enums/billing-plan.ts +0 -5
- package/src/enums/database-usage-range.ts +0 -5
- package/src/enums/function-usage-range.ts +0 -5
- package/src/enums/site-usage-range.ts +0 -5
- package/src/enums/storage-usage-range.ts +0 -5
- package/types/enums/billing-plan.d.ts +0 -5
- package/types/enums/database-usage-range.d.ts +0 -5
- package/types/enums/function-usage-range.d.ts +0 -5
- package/types/enums/storage-usage-range.d.ts +0 -5
- package/types/enums/user-usage-range.d.ts +0 -5
- /package/docs/examples/health/{get-d-b.md → get-db.md} +0 -0
- /package/docs/examples/locale/{list-countries-e-u.md → list-countries-eu.md} +0 -0
- /package/src/enums/{s-m-t-p-secure.ts → smtp-secure.ts} +0 -0
- /package/src/enums/{v-c-s-detection-type.ts → vcs-detection-type.ts} +0 -0
- /package/types/enums/{s-m-t-p-secure.d.ts → smtp-secure.d.ts} +0 -0
- /package/types/enums/{v-c-s-detection-type.d.ts → vcs-detection-type.d.ts} +0 -0
package/src/services/backups.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { Service } from '../service';
|
|
|
2
2
|
import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
|
|
3
3
|
import type { Models } from '../models';
|
|
4
4
|
|
|
5
|
+
|
|
5
6
|
export class Backups {
|
|
6
7
|
client: Client;
|
|
7
8
|
|
|
@@ -12,11 +13,36 @@ export class Backups {
|
|
|
12
13
|
/**
|
|
13
14
|
* List all archives for a project.
|
|
14
15
|
*
|
|
15
|
-
* @param {string[]} queries
|
|
16
|
+
* @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.
|
|
17
|
+
* @throws {AppwriteException}
|
|
18
|
+
* @returns {Promise<Models.BackupArchiveList>}
|
|
19
|
+
*/
|
|
20
|
+
listArchives(params?: { queries?: string[] }): Promise<Models.BackupArchiveList>;
|
|
21
|
+
/**
|
|
22
|
+
* List all archives for a project.
|
|
23
|
+
*
|
|
24
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
16
25
|
* @throws {AppwriteException}
|
|
17
26
|
* @returns {Promise<Models.BackupArchiveList>}
|
|
27
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
18
28
|
*/
|
|
19
|
-
listArchives(queries?: string[]): Promise<Models.BackupArchiveList
|
|
29
|
+
listArchives(queries?: string[]): Promise<Models.BackupArchiveList>;
|
|
30
|
+
listArchives(
|
|
31
|
+
paramsOrFirst?: { queries?: string[] } | string[]
|
|
32
|
+
): Promise<Models.BackupArchiveList> {
|
|
33
|
+
let params: { queries?: string[] };
|
|
34
|
+
|
|
35
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
36
|
+
params = (paramsOrFirst || {}) as { queries?: string[] };
|
|
37
|
+
} else {
|
|
38
|
+
params = {
|
|
39
|
+
queries: paramsOrFirst as string[]
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
const queries = params.queries;
|
|
44
|
+
|
|
45
|
+
|
|
20
46
|
const apiPath = '/backups/archives';
|
|
21
47
|
const payload: Payload = {};
|
|
22
48
|
if (typeof queries !== 'undefined') {
|
|
@@ -34,18 +60,48 @@ export class Backups {
|
|
|
34
60
|
payload
|
|
35
61
|
);
|
|
36
62
|
}
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Create a new archive asynchronously for a project.
|
|
66
|
+
*
|
|
67
|
+
* @param {string[]} params.services - Array of services to backup
|
|
68
|
+
* @param {string} params.resourceId - Resource ID. When set, only this single resource will be backed up.
|
|
69
|
+
* @throws {AppwriteException}
|
|
70
|
+
* @returns {Promise<Models.BackupArchive>}
|
|
71
|
+
*/
|
|
72
|
+
createArchive(params: { services: string[], resourceId?: string }): Promise<Models.BackupArchive>;
|
|
37
73
|
/**
|
|
38
74
|
* Create a new archive asynchronously for a project.
|
|
39
75
|
*
|
|
40
|
-
* @param {string[]} services
|
|
41
|
-
* @param {string} resourceId
|
|
76
|
+
* @param {string[]} services - Array of services to backup
|
|
77
|
+
* @param {string} resourceId - Resource ID. When set, only this single resource will be backed up.
|
|
42
78
|
* @throws {AppwriteException}
|
|
43
79
|
* @returns {Promise<Models.BackupArchive>}
|
|
80
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
44
81
|
*/
|
|
45
|
-
createArchive(services: string[], resourceId?: string): Promise<Models.BackupArchive
|
|
82
|
+
createArchive(services: string[], resourceId?: string): Promise<Models.BackupArchive>;
|
|
83
|
+
createArchive(
|
|
84
|
+
paramsOrFirst: { services: string[], resourceId?: string } | string[],
|
|
85
|
+
...rest: [(string)?]
|
|
86
|
+
): Promise<Models.BackupArchive> {
|
|
87
|
+
let params: { services: string[], resourceId?: string };
|
|
88
|
+
|
|
89
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
90
|
+
params = (paramsOrFirst || {}) as { services: string[], resourceId?: string };
|
|
91
|
+
} else {
|
|
92
|
+
params = {
|
|
93
|
+
services: paramsOrFirst as string[],
|
|
94
|
+
resourceId: rest[0] as string
|
|
95
|
+
};
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
const services = params.services;
|
|
99
|
+
const resourceId = params.resourceId;
|
|
100
|
+
|
|
46
101
|
if (typeof services === 'undefined') {
|
|
47
102
|
throw new AppwriteException('Missing required parameter: "services"');
|
|
48
103
|
}
|
|
104
|
+
|
|
49
105
|
const apiPath = '/backups/archives';
|
|
50
106
|
const payload: Payload = {};
|
|
51
107
|
if (typeof services !== 'undefined') {
|
|
@@ -67,17 +123,43 @@ export class Backups {
|
|
|
67
123
|
payload
|
|
68
124
|
);
|
|
69
125
|
}
|
|
126
|
+
|
|
70
127
|
/**
|
|
71
|
-
* Get a backup archive using it
|
|
128
|
+
* Get a backup archive using it's ID.
|
|
72
129
|
*
|
|
73
|
-
* @param {string} archiveId
|
|
130
|
+
* @param {string} params.archiveId - Archive ID. Choose a custom ID`. 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.
|
|
74
131
|
* @throws {AppwriteException}
|
|
75
132
|
* @returns {Promise<Models.BackupArchive>}
|
|
76
133
|
*/
|
|
77
|
-
getArchive(archiveId: string): Promise<Models.BackupArchive
|
|
134
|
+
getArchive(params: { archiveId: string }): Promise<Models.BackupArchive>;
|
|
135
|
+
/**
|
|
136
|
+
* Get a backup archive using it's ID.
|
|
137
|
+
*
|
|
138
|
+
* @param {string} archiveId - Archive ID. Choose a custom ID`. 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.
|
|
139
|
+
* @throws {AppwriteException}
|
|
140
|
+
* @returns {Promise<Models.BackupArchive>}
|
|
141
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
142
|
+
*/
|
|
143
|
+
getArchive(archiveId: string): Promise<Models.BackupArchive>;
|
|
144
|
+
getArchive(
|
|
145
|
+
paramsOrFirst: { archiveId: string } | string
|
|
146
|
+
): Promise<Models.BackupArchive> {
|
|
147
|
+
let params: { archiveId: string };
|
|
148
|
+
|
|
149
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
150
|
+
params = (paramsOrFirst || {}) as { archiveId: string };
|
|
151
|
+
} else {
|
|
152
|
+
params = {
|
|
153
|
+
archiveId: paramsOrFirst as string
|
|
154
|
+
};
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
const archiveId = params.archiveId;
|
|
158
|
+
|
|
78
159
|
if (typeof archiveId === 'undefined') {
|
|
79
160
|
throw new AppwriteException('Missing required parameter: "archiveId"');
|
|
80
161
|
}
|
|
162
|
+
|
|
81
163
|
const apiPath = '/backups/archives/{archiveId}'.replace('{archiveId}', archiveId);
|
|
82
164
|
const payload: Payload = {};
|
|
83
165
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -92,17 +174,43 @@ export class Backups {
|
|
|
92
174
|
payload
|
|
93
175
|
);
|
|
94
176
|
}
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Delete an existing archive for a project.
|
|
180
|
+
*
|
|
181
|
+
* @param {string} params.archiveId - Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
182
|
+
* @throws {AppwriteException}
|
|
183
|
+
* @returns {Promise<{}>}
|
|
184
|
+
*/
|
|
185
|
+
deleteArchive(params: { archiveId: string }): Promise<{}>;
|
|
95
186
|
/**
|
|
96
187
|
* Delete an existing archive for a project.
|
|
97
188
|
*
|
|
98
|
-
* @param {string} archiveId
|
|
189
|
+
* @param {string} archiveId - Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
99
190
|
* @throws {AppwriteException}
|
|
100
191
|
* @returns {Promise<{}>}
|
|
192
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
101
193
|
*/
|
|
102
|
-
deleteArchive(archiveId: string): Promise<{}
|
|
194
|
+
deleteArchive(archiveId: string): Promise<{}>;
|
|
195
|
+
deleteArchive(
|
|
196
|
+
paramsOrFirst: { archiveId: string } | string
|
|
197
|
+
): Promise<{}> {
|
|
198
|
+
let params: { archiveId: string };
|
|
199
|
+
|
|
200
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
201
|
+
params = (paramsOrFirst || {}) as { archiveId: string };
|
|
202
|
+
} else {
|
|
203
|
+
params = {
|
|
204
|
+
archiveId: paramsOrFirst as string
|
|
205
|
+
};
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
const archiveId = params.archiveId;
|
|
209
|
+
|
|
103
210
|
if (typeof archiveId === 'undefined') {
|
|
104
211
|
throw new AppwriteException('Missing required parameter: "archiveId"');
|
|
105
212
|
}
|
|
213
|
+
|
|
106
214
|
const apiPath = '/backups/archives/{archiveId}'.replace('{archiveId}', archiveId);
|
|
107
215
|
const payload: Payload = {};
|
|
108
216
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -118,14 +226,40 @@ export class Backups {
|
|
|
118
226
|
payload
|
|
119
227
|
);
|
|
120
228
|
}
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* List all policies for a project.
|
|
232
|
+
*
|
|
233
|
+
* @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.
|
|
234
|
+
* @throws {AppwriteException}
|
|
235
|
+
* @returns {Promise<Models.BackupPolicyList>}
|
|
236
|
+
*/
|
|
237
|
+
listPolicies(params?: { queries?: string[] }): Promise<Models.BackupPolicyList>;
|
|
121
238
|
/**
|
|
122
239
|
* List all policies for a project.
|
|
123
240
|
*
|
|
124
|
-
* @param {string[]} queries
|
|
241
|
+
* @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.
|
|
125
242
|
* @throws {AppwriteException}
|
|
126
243
|
* @returns {Promise<Models.BackupPolicyList>}
|
|
244
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
127
245
|
*/
|
|
128
|
-
listPolicies(queries?: string[]): Promise<Models.BackupPolicyList
|
|
246
|
+
listPolicies(queries?: string[]): Promise<Models.BackupPolicyList>;
|
|
247
|
+
listPolicies(
|
|
248
|
+
paramsOrFirst?: { queries?: string[] } | string[]
|
|
249
|
+
): Promise<Models.BackupPolicyList> {
|
|
250
|
+
let params: { queries?: string[] };
|
|
251
|
+
|
|
252
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
253
|
+
params = (paramsOrFirst || {}) as { queries?: string[] };
|
|
254
|
+
} else {
|
|
255
|
+
params = {
|
|
256
|
+
queries: paramsOrFirst as string[]
|
|
257
|
+
};
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
const queries = params.queries;
|
|
261
|
+
|
|
262
|
+
|
|
129
263
|
const apiPath = '/backups/policies';
|
|
130
264
|
const payload: Payload = {};
|
|
131
265
|
if (typeof queries !== 'undefined') {
|
|
@@ -143,20 +277,64 @@ export class Backups {
|
|
|
143
277
|
payload
|
|
144
278
|
);
|
|
145
279
|
}
|
|
280
|
+
|
|
146
281
|
/**
|
|
147
282
|
* Create a new backup policy.
|
|
148
283
|
*
|
|
149
|
-
* @param {string} policyId
|
|
150
|
-
* @param {string[]} services
|
|
151
|
-
* @param {number} retention
|
|
152
|
-
* @param {string} schedule
|
|
153
|
-
* @param {string} name
|
|
154
|
-
* @param {string} resourceId
|
|
155
|
-
* @param {boolean} enabled
|
|
284
|
+
* @param {string} params.policyId - Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
285
|
+
* @param {string[]} params.services - Array of services to backup
|
|
286
|
+
* @param {number} params.retention - Days to keep backups before deletion
|
|
287
|
+
* @param {string} params.schedule - Schedule CRON syntax.
|
|
288
|
+
* @param {string} params.name - Policy name. Max length: 128 chars.
|
|
289
|
+
* @param {string} params.resourceId - Resource ID. When set, only this single resource will be backed up.
|
|
290
|
+
* @param {boolean} params.enabled - Is policy enabled? When set to 'disabled', no backups will be taken
|
|
156
291
|
* @throws {AppwriteException}
|
|
157
292
|
* @returns {Promise<Models.BackupPolicy>}
|
|
158
293
|
*/
|
|
159
|
-
createPolicy(policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy
|
|
294
|
+
createPolicy(params: { policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean }): Promise<Models.BackupPolicy>;
|
|
295
|
+
/**
|
|
296
|
+
* Create a new backup policy.
|
|
297
|
+
*
|
|
298
|
+
* @param {string} policyId - Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
299
|
+
* @param {string[]} services - Array of services to backup
|
|
300
|
+
* @param {number} retention - Days to keep backups before deletion
|
|
301
|
+
* @param {string} schedule - Schedule CRON syntax.
|
|
302
|
+
* @param {string} name - Policy name. Max length: 128 chars.
|
|
303
|
+
* @param {string} resourceId - Resource ID. When set, only this single resource will be backed up.
|
|
304
|
+
* @param {boolean} enabled - Is policy enabled? When set to 'disabled', no backups will be taken
|
|
305
|
+
* @throws {AppwriteException}
|
|
306
|
+
* @returns {Promise<Models.BackupPolicy>}
|
|
307
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
308
|
+
*/
|
|
309
|
+
createPolicy(policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
|
|
310
|
+
createPolicy(
|
|
311
|
+
paramsOrFirst: { policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean } | string,
|
|
312
|
+
...rest: [(string[])?, (number)?, (string)?, (string)?, (string)?, (boolean)?]
|
|
313
|
+
): Promise<Models.BackupPolicy> {
|
|
314
|
+
let params: { policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean };
|
|
315
|
+
|
|
316
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
317
|
+
params = (paramsOrFirst || {}) as { policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean };
|
|
318
|
+
} else {
|
|
319
|
+
params = {
|
|
320
|
+
policyId: paramsOrFirst as string,
|
|
321
|
+
services: rest[0] as string[],
|
|
322
|
+
retention: rest[1] as number,
|
|
323
|
+
schedule: rest[2] as string,
|
|
324
|
+
name: rest[3] as string,
|
|
325
|
+
resourceId: rest[4] as string,
|
|
326
|
+
enabled: rest[5] as boolean
|
|
327
|
+
};
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
const policyId = params.policyId;
|
|
331
|
+
const services = params.services;
|
|
332
|
+
const retention = params.retention;
|
|
333
|
+
const schedule = params.schedule;
|
|
334
|
+
const name = params.name;
|
|
335
|
+
const resourceId = params.resourceId;
|
|
336
|
+
const enabled = params.enabled;
|
|
337
|
+
|
|
160
338
|
if (typeof policyId === 'undefined') {
|
|
161
339
|
throw new AppwriteException('Missing required parameter: "policyId"');
|
|
162
340
|
}
|
|
@@ -169,6 +347,7 @@ export class Backups {
|
|
|
169
347
|
if (typeof schedule === 'undefined') {
|
|
170
348
|
throw new AppwriteException('Missing required parameter: "schedule"');
|
|
171
349
|
}
|
|
350
|
+
|
|
172
351
|
const apiPath = '/backups/policies';
|
|
173
352
|
const payload: Payload = {};
|
|
174
353
|
if (typeof policyId !== 'undefined') {
|
|
@@ -205,17 +384,43 @@ export class Backups {
|
|
|
205
384
|
payload
|
|
206
385
|
);
|
|
207
386
|
}
|
|
387
|
+
|
|
388
|
+
/**
|
|
389
|
+
* Get a backup policy using it's ID.
|
|
390
|
+
*
|
|
391
|
+
* @param {string} params.policyId - Policy ID. Choose a custom ID`. 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.
|
|
392
|
+
* @throws {AppwriteException}
|
|
393
|
+
* @returns {Promise<Models.BackupPolicy>}
|
|
394
|
+
*/
|
|
395
|
+
getPolicy(params: { policyId: string }): Promise<Models.BackupPolicy>;
|
|
208
396
|
/**
|
|
209
|
-
* Get a backup policy using it
|
|
397
|
+
* Get a backup policy using it's ID.
|
|
210
398
|
*
|
|
211
|
-
* @param {string} policyId
|
|
399
|
+
* @param {string} policyId - Policy ID. Choose a custom ID`. 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.
|
|
212
400
|
* @throws {AppwriteException}
|
|
213
401
|
* @returns {Promise<Models.BackupPolicy>}
|
|
402
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
214
403
|
*/
|
|
215
|
-
getPolicy(policyId: string): Promise<Models.BackupPolicy
|
|
404
|
+
getPolicy(policyId: string): Promise<Models.BackupPolicy>;
|
|
405
|
+
getPolicy(
|
|
406
|
+
paramsOrFirst: { policyId: string } | string
|
|
407
|
+
): Promise<Models.BackupPolicy> {
|
|
408
|
+
let params: { policyId: string };
|
|
409
|
+
|
|
410
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
411
|
+
params = (paramsOrFirst || {}) as { policyId: string };
|
|
412
|
+
} else {
|
|
413
|
+
params = {
|
|
414
|
+
policyId: paramsOrFirst as string
|
|
415
|
+
};
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
const policyId = params.policyId;
|
|
419
|
+
|
|
216
420
|
if (typeof policyId === 'undefined') {
|
|
217
421
|
throw new AppwriteException('Missing required parameter: "policyId"');
|
|
218
422
|
}
|
|
423
|
+
|
|
219
424
|
const apiPath = '/backups/policies/{policyId}'.replace('{policyId}', policyId);
|
|
220
425
|
const payload: Payload = {};
|
|
221
426
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -230,21 +435,60 @@ export class Backups {
|
|
|
230
435
|
payload
|
|
231
436
|
);
|
|
232
437
|
}
|
|
438
|
+
|
|
439
|
+
/**
|
|
440
|
+
* Update an existing policy using it's ID.
|
|
441
|
+
*
|
|
442
|
+
* @param {string} params.policyId - Policy ID. Choose a custom ID`. 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.
|
|
443
|
+
* @param {string} params.name - Policy name. Max length: 128 chars.
|
|
444
|
+
* @param {number} params.retention - Days to keep backups before deletion
|
|
445
|
+
* @param {string} params.schedule - Cron expression
|
|
446
|
+
* @param {boolean} params.enabled - Is Backup enabled? When set to 'disabled', No backup will be taken
|
|
447
|
+
* @throws {AppwriteException}
|
|
448
|
+
* @returns {Promise<Models.BackupPolicy>}
|
|
449
|
+
*/
|
|
450
|
+
updatePolicy(params: { policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean }): Promise<Models.BackupPolicy>;
|
|
233
451
|
/**
|
|
234
|
-
* Update an existing policy using it
|
|
452
|
+
* Update an existing policy using it's ID.
|
|
235
453
|
*
|
|
236
|
-
* @param {string} policyId
|
|
237
|
-
* @param {string} name
|
|
238
|
-
* @param {number} retention
|
|
239
|
-
* @param {string} schedule
|
|
240
|
-
* @param {boolean} enabled
|
|
454
|
+
* @param {string} policyId - Policy ID. Choose a custom ID`. 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.
|
|
455
|
+
* @param {string} name - Policy name. Max length: 128 chars.
|
|
456
|
+
* @param {number} retention - Days to keep backups before deletion
|
|
457
|
+
* @param {string} schedule - Cron expression
|
|
458
|
+
* @param {boolean} enabled - Is Backup enabled? When set to 'disabled', No backup will be taken
|
|
241
459
|
* @throws {AppwriteException}
|
|
242
460
|
* @returns {Promise<Models.BackupPolicy>}
|
|
461
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
243
462
|
*/
|
|
244
|
-
updatePolicy(policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean): Promise<Models.BackupPolicy
|
|
463
|
+
updatePolicy(policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
|
|
464
|
+
updatePolicy(
|
|
465
|
+
paramsOrFirst: { policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean } | string,
|
|
466
|
+
...rest: [(string)?, (number)?, (string)?, (boolean)?]
|
|
467
|
+
): Promise<Models.BackupPolicy> {
|
|
468
|
+
let params: { policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean };
|
|
469
|
+
|
|
470
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
471
|
+
params = (paramsOrFirst || {}) as { policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean };
|
|
472
|
+
} else {
|
|
473
|
+
params = {
|
|
474
|
+
policyId: paramsOrFirst as string,
|
|
475
|
+
name: rest[0] as string,
|
|
476
|
+
retention: rest[1] as number,
|
|
477
|
+
schedule: rest[2] as string,
|
|
478
|
+
enabled: rest[3] as boolean
|
|
479
|
+
};
|
|
480
|
+
}
|
|
481
|
+
|
|
482
|
+
const policyId = params.policyId;
|
|
483
|
+
const name = params.name;
|
|
484
|
+
const retention = params.retention;
|
|
485
|
+
const schedule = params.schedule;
|
|
486
|
+
const enabled = params.enabled;
|
|
487
|
+
|
|
245
488
|
if (typeof policyId === 'undefined') {
|
|
246
489
|
throw new AppwriteException('Missing required parameter: "policyId"');
|
|
247
490
|
}
|
|
491
|
+
|
|
248
492
|
const apiPath = '/backups/policies/{policyId}'.replace('{policyId}', policyId);
|
|
249
493
|
const payload: Payload = {};
|
|
250
494
|
if (typeof name !== 'undefined') {
|
|
@@ -272,17 +516,43 @@ export class Backups {
|
|
|
272
516
|
payload
|
|
273
517
|
);
|
|
274
518
|
}
|
|
519
|
+
|
|
275
520
|
/**
|
|
276
|
-
* Delete a policy using it
|
|
521
|
+
* Delete a policy using it's ID.
|
|
277
522
|
*
|
|
278
|
-
* @param {string} policyId
|
|
523
|
+
* @param {string} params.policyId - Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
279
524
|
* @throws {AppwriteException}
|
|
280
525
|
* @returns {Promise<{}>}
|
|
281
526
|
*/
|
|
282
|
-
deletePolicy(policyId: string): Promise<{}
|
|
527
|
+
deletePolicy(params: { policyId: string }): Promise<{}>;
|
|
528
|
+
/**
|
|
529
|
+
* Delete a policy using it's ID.
|
|
530
|
+
*
|
|
531
|
+
* @param {string} policyId - Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
532
|
+
* @throws {AppwriteException}
|
|
533
|
+
* @returns {Promise<{}>}
|
|
534
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
535
|
+
*/
|
|
536
|
+
deletePolicy(policyId: string): Promise<{}>;
|
|
537
|
+
deletePolicy(
|
|
538
|
+
paramsOrFirst: { policyId: string } | string
|
|
539
|
+
): Promise<{}> {
|
|
540
|
+
let params: { policyId: string };
|
|
541
|
+
|
|
542
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
543
|
+
params = (paramsOrFirst || {}) as { policyId: string };
|
|
544
|
+
} else {
|
|
545
|
+
params = {
|
|
546
|
+
policyId: paramsOrFirst as string
|
|
547
|
+
};
|
|
548
|
+
}
|
|
549
|
+
|
|
550
|
+
const policyId = params.policyId;
|
|
551
|
+
|
|
283
552
|
if (typeof policyId === 'undefined') {
|
|
284
553
|
throw new AppwriteException('Missing required parameter: "policyId"');
|
|
285
554
|
}
|
|
555
|
+
|
|
286
556
|
const apiPath = '/backups/policies/{policyId}'.replace('{policyId}', policyId);
|
|
287
557
|
const payload: Payload = {};
|
|
288
558
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -298,23 +568,59 @@ export class Backups {
|
|
|
298
568
|
payload
|
|
299
569
|
);
|
|
300
570
|
}
|
|
571
|
+
|
|
301
572
|
/**
|
|
302
573
|
* Create and trigger a new restoration for a backup on a project.
|
|
303
574
|
*
|
|
304
|
-
* @param {string} archiveId
|
|
305
|
-
* @param {string[]} services
|
|
306
|
-
* @param {string} newResourceId
|
|
307
|
-
* @param {string} newResourceName
|
|
575
|
+
* @param {string} params.archiveId - Backup archive ID to restore
|
|
576
|
+
* @param {string[]} params.services - Array of services to restore
|
|
577
|
+
* @param {string} params.newResourceId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
578
|
+
* @param {string} params.newResourceName - Database name. Max length: 128 chars.
|
|
308
579
|
* @throws {AppwriteException}
|
|
309
580
|
* @returns {Promise<Models.BackupRestoration>}
|
|
310
581
|
*/
|
|
311
|
-
createRestoration(archiveId: string, services: string[], newResourceId?: string, newResourceName?: string): Promise<Models.BackupRestoration
|
|
582
|
+
createRestoration(params: { archiveId: string, services: string[], newResourceId?: string, newResourceName?: string }): Promise<Models.BackupRestoration>;
|
|
583
|
+
/**
|
|
584
|
+
* Create and trigger a new restoration for a backup on a project.
|
|
585
|
+
*
|
|
586
|
+
* @param {string} archiveId - Backup archive ID to restore
|
|
587
|
+
* @param {string[]} services - Array of services to restore
|
|
588
|
+
* @param {string} newResourceId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
589
|
+
* @param {string} newResourceName - Database name. Max length: 128 chars.
|
|
590
|
+
* @throws {AppwriteException}
|
|
591
|
+
* @returns {Promise<Models.BackupRestoration>}
|
|
592
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
593
|
+
*/
|
|
594
|
+
createRestoration(archiveId: string, services: string[], newResourceId?: string, newResourceName?: string): Promise<Models.BackupRestoration>;
|
|
595
|
+
createRestoration(
|
|
596
|
+
paramsOrFirst: { archiveId: string, services: string[], newResourceId?: string, newResourceName?: string } | string,
|
|
597
|
+
...rest: [(string[])?, (string)?, (string)?]
|
|
598
|
+
): Promise<Models.BackupRestoration> {
|
|
599
|
+
let params: { archiveId: string, services: string[], newResourceId?: string, newResourceName?: string };
|
|
600
|
+
|
|
601
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
602
|
+
params = (paramsOrFirst || {}) as { archiveId: string, services: string[], newResourceId?: string, newResourceName?: string };
|
|
603
|
+
} else {
|
|
604
|
+
params = {
|
|
605
|
+
archiveId: paramsOrFirst as string,
|
|
606
|
+
services: rest[0] as string[],
|
|
607
|
+
newResourceId: rest[1] as string,
|
|
608
|
+
newResourceName: rest[2] as string
|
|
609
|
+
};
|
|
610
|
+
}
|
|
611
|
+
|
|
612
|
+
const archiveId = params.archiveId;
|
|
613
|
+
const services = params.services;
|
|
614
|
+
const newResourceId = params.newResourceId;
|
|
615
|
+
const newResourceName = params.newResourceName;
|
|
616
|
+
|
|
312
617
|
if (typeof archiveId === 'undefined') {
|
|
313
618
|
throw new AppwriteException('Missing required parameter: "archiveId"');
|
|
314
619
|
}
|
|
315
620
|
if (typeof services === 'undefined') {
|
|
316
621
|
throw new AppwriteException('Missing required parameter: "services"');
|
|
317
622
|
}
|
|
623
|
+
|
|
318
624
|
const apiPath = '/backups/restoration';
|
|
319
625
|
const payload: Payload = {};
|
|
320
626
|
if (typeof archiveId !== 'undefined') {
|
|
@@ -342,14 +648,40 @@ export class Backups {
|
|
|
342
648
|
payload
|
|
343
649
|
);
|
|
344
650
|
}
|
|
651
|
+
|
|
652
|
+
/**
|
|
653
|
+
* List all backup restorations for a project.
|
|
654
|
+
*
|
|
655
|
+
* @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.
|
|
656
|
+
* @throws {AppwriteException}
|
|
657
|
+
* @returns {Promise<Models.BackupRestorationList>}
|
|
658
|
+
*/
|
|
659
|
+
listRestorations(params?: { queries?: string[] }): Promise<Models.BackupRestorationList>;
|
|
345
660
|
/**
|
|
346
661
|
* List all backup restorations for a project.
|
|
347
662
|
*
|
|
348
|
-
* @param {string[]} queries
|
|
663
|
+
* @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.
|
|
349
664
|
* @throws {AppwriteException}
|
|
350
665
|
* @returns {Promise<Models.BackupRestorationList>}
|
|
666
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
351
667
|
*/
|
|
352
|
-
listRestorations(queries?: string[]): Promise<Models.BackupRestorationList
|
|
668
|
+
listRestorations(queries?: string[]): Promise<Models.BackupRestorationList>;
|
|
669
|
+
listRestorations(
|
|
670
|
+
paramsOrFirst?: { queries?: string[] } | string[]
|
|
671
|
+
): Promise<Models.BackupRestorationList> {
|
|
672
|
+
let params: { queries?: string[] };
|
|
673
|
+
|
|
674
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
675
|
+
params = (paramsOrFirst || {}) as { queries?: string[] };
|
|
676
|
+
} else {
|
|
677
|
+
params = {
|
|
678
|
+
queries: paramsOrFirst as string[]
|
|
679
|
+
};
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
const queries = params.queries;
|
|
683
|
+
|
|
684
|
+
|
|
353
685
|
const apiPath = '/backups/restorations';
|
|
354
686
|
const payload: Payload = {};
|
|
355
687
|
if (typeof queries !== 'undefined') {
|
|
@@ -367,17 +699,43 @@ export class Backups {
|
|
|
367
699
|
payload
|
|
368
700
|
);
|
|
369
701
|
}
|
|
702
|
+
|
|
370
703
|
/**
|
|
371
704
|
* Get the current status of a backup restoration.
|
|
372
705
|
*
|
|
373
|
-
* @param {string} restorationId
|
|
706
|
+
* @param {string} params.restorationId - Restoration ID. Choose a custom ID`. 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.
|
|
374
707
|
* @throws {AppwriteException}
|
|
375
708
|
* @returns {Promise<Models.BackupRestoration>}
|
|
376
709
|
*/
|
|
377
|
-
getRestoration(restorationId: string): Promise<Models.BackupRestoration
|
|
710
|
+
getRestoration(params: { restorationId: string }): Promise<Models.BackupRestoration>;
|
|
711
|
+
/**
|
|
712
|
+
* Get the current status of a backup restoration.
|
|
713
|
+
*
|
|
714
|
+
* @param {string} restorationId - Restoration ID. Choose a custom ID`. 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.
|
|
715
|
+
* @throws {AppwriteException}
|
|
716
|
+
* @returns {Promise<Models.BackupRestoration>}
|
|
717
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
718
|
+
*/
|
|
719
|
+
getRestoration(restorationId: string): Promise<Models.BackupRestoration>;
|
|
720
|
+
getRestoration(
|
|
721
|
+
paramsOrFirst: { restorationId: string } | string
|
|
722
|
+
): Promise<Models.BackupRestoration> {
|
|
723
|
+
let params: { restorationId: string };
|
|
724
|
+
|
|
725
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
726
|
+
params = (paramsOrFirst || {}) as { restorationId: string };
|
|
727
|
+
} else {
|
|
728
|
+
params = {
|
|
729
|
+
restorationId: paramsOrFirst as string
|
|
730
|
+
};
|
|
731
|
+
}
|
|
732
|
+
|
|
733
|
+
const restorationId = params.restorationId;
|
|
734
|
+
|
|
378
735
|
if (typeof restorationId === 'undefined') {
|
|
379
736
|
throw new AppwriteException('Missing required parameter: "restorationId"');
|
|
380
737
|
}
|
|
738
|
+
|
|
381
739
|
const apiPath = '/backups/restorations/{restorationId}'.replace('{restorationId}', restorationId);
|
|
382
740
|
const payload: Payload = {};
|
|
383
741
|
const uri = new URL(this.client.config.endpoint + apiPath);
|