@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
|
@@ -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 Migrations {
|
|
6
7
|
client: Client;
|
|
7
8
|
|
|
@@ -12,12 +13,45 @@ export class Migrations {
|
|
|
12
13
|
/**
|
|
13
14
|
* List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
|
|
14
15
|
*
|
|
15
|
-
* @param {string[]} queries
|
|
16
|
-
* @param {string} search
|
|
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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, statusCounters, resourceData, errors
|
|
17
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
18
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
17
19
|
* @throws {AppwriteException}
|
|
18
20
|
* @returns {Promise<Models.MigrationList>}
|
|
19
21
|
*/
|
|
20
|
-
list(queries?: string[], search?: string): Promise<Models.MigrationList
|
|
22
|
+
list(params?: { queries?: string[], search?: string, total?: boolean }): Promise<Models.MigrationList>;
|
|
23
|
+
/**
|
|
24
|
+
* List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
|
|
25
|
+
*
|
|
26
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, statusCounters, resourceData, errors
|
|
27
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
28
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
29
|
+
* @throws {AppwriteException}
|
|
30
|
+
* @returns {Promise<Models.MigrationList>}
|
|
31
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
32
|
+
*/
|
|
33
|
+
list(queries?: string[], search?: string, total?: boolean): Promise<Models.MigrationList>;
|
|
34
|
+
list(
|
|
35
|
+
paramsOrFirst?: { queries?: string[], search?: string, total?: boolean } | string[],
|
|
36
|
+
...rest: [(string)?, (boolean)?]
|
|
37
|
+
): Promise<Models.MigrationList> {
|
|
38
|
+
let params: { queries?: string[], search?: string, total?: boolean };
|
|
39
|
+
|
|
40
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
41
|
+
params = (paramsOrFirst || {}) as { queries?: string[], search?: string, total?: boolean };
|
|
42
|
+
} else {
|
|
43
|
+
params = {
|
|
44
|
+
queries: paramsOrFirst as string[],
|
|
45
|
+
search: rest[0] as string,
|
|
46
|
+
total: rest[1] as boolean
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
const queries = params.queries;
|
|
51
|
+
const search = params.search;
|
|
52
|
+
const total = params.total;
|
|
53
|
+
|
|
54
|
+
|
|
21
55
|
const apiPath = '/migrations';
|
|
22
56
|
const payload: Payload = {};
|
|
23
57
|
if (typeof queries !== 'undefined') {
|
|
@@ -26,6 +60,9 @@ export class Migrations {
|
|
|
26
60
|
if (typeof search !== 'undefined') {
|
|
27
61
|
payload['search'] = search;
|
|
28
62
|
}
|
|
63
|
+
if (typeof total !== 'undefined') {
|
|
64
|
+
payload['total'] = total;
|
|
65
|
+
}
|
|
29
66
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
30
67
|
|
|
31
68
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -38,17 +75,52 @@ export class Migrations {
|
|
|
38
75
|
payload
|
|
39
76
|
);
|
|
40
77
|
}
|
|
78
|
+
|
|
41
79
|
/**
|
|
42
80
|
* Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project.
|
|
43
81
|
*
|
|
44
|
-
* @param {string[]} resources
|
|
45
|
-
* @param {string} endpoint
|
|
46
|
-
* @param {string} projectId
|
|
47
|
-
* @param {string} apiKey
|
|
82
|
+
* @param {string[]} params.resources - List of resources to migrate
|
|
83
|
+
* @param {string} params.endpoint - Source Appwrite endpoint
|
|
84
|
+
* @param {string} params.projectId - Source Project ID
|
|
85
|
+
* @param {string} params.apiKey - Source API Key
|
|
48
86
|
* @throws {AppwriteException}
|
|
49
87
|
* @returns {Promise<Models.Migration>}
|
|
50
88
|
*/
|
|
51
|
-
createAppwriteMigration(resources: string[], endpoint: string, projectId: string, apiKey: string): Promise<Models.Migration
|
|
89
|
+
createAppwriteMigration(params: { resources: string[], endpoint: string, projectId: string, apiKey: string }): Promise<Models.Migration>;
|
|
90
|
+
/**
|
|
91
|
+
* Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project.
|
|
92
|
+
*
|
|
93
|
+
* @param {string[]} resources - List of resources to migrate
|
|
94
|
+
* @param {string} endpoint - Source Appwrite endpoint
|
|
95
|
+
* @param {string} projectId - Source Project ID
|
|
96
|
+
* @param {string} apiKey - Source API Key
|
|
97
|
+
* @throws {AppwriteException}
|
|
98
|
+
* @returns {Promise<Models.Migration>}
|
|
99
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
100
|
+
*/
|
|
101
|
+
createAppwriteMigration(resources: string[], endpoint: string, projectId: string, apiKey: string): Promise<Models.Migration>;
|
|
102
|
+
createAppwriteMigration(
|
|
103
|
+
paramsOrFirst: { resources: string[], endpoint: string, projectId: string, apiKey: string } | string[],
|
|
104
|
+
...rest: [(string)?, (string)?, (string)?]
|
|
105
|
+
): Promise<Models.Migration> {
|
|
106
|
+
let params: { resources: string[], endpoint: string, projectId: string, apiKey: string };
|
|
107
|
+
|
|
108
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
109
|
+
params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, projectId: string, apiKey: string };
|
|
110
|
+
} else {
|
|
111
|
+
params = {
|
|
112
|
+
resources: paramsOrFirst as string[],
|
|
113
|
+
endpoint: rest[0] as string,
|
|
114
|
+
projectId: rest[1] as string,
|
|
115
|
+
apiKey: rest[2] as string
|
|
116
|
+
};
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
const resources = params.resources;
|
|
120
|
+
const endpoint = params.endpoint;
|
|
121
|
+
const projectId = params.projectId;
|
|
122
|
+
const apiKey = params.apiKey;
|
|
123
|
+
|
|
52
124
|
if (typeof resources === 'undefined') {
|
|
53
125
|
throw new AppwriteException('Missing required parameter: "resources"');
|
|
54
126
|
}
|
|
@@ -61,6 +133,7 @@ export class Migrations {
|
|
|
61
133
|
if (typeof apiKey === 'undefined') {
|
|
62
134
|
throw new AppwriteException('Missing required parameter: "apiKey"');
|
|
63
135
|
}
|
|
136
|
+
|
|
64
137
|
const apiPath = '/migrations/appwrite';
|
|
65
138
|
const payload: Payload = {};
|
|
66
139
|
if (typeof resources !== 'undefined') {
|
|
@@ -88,17 +161,52 @@ export class Migrations {
|
|
|
88
161
|
payload
|
|
89
162
|
);
|
|
90
163
|
}
|
|
164
|
+
|
|
91
165
|
/**
|
|
92
166
|
* Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
|
93
167
|
*
|
|
94
|
-
* @param {string[]} resources
|
|
95
|
-
* @param {string} endpoint
|
|
96
|
-
* @param {string} projectID
|
|
97
|
-
* @param {string} key
|
|
168
|
+
* @param {string[]} params.resources - List of resources to migrate
|
|
169
|
+
* @param {string} params.endpoint - Source's Appwrite Endpoint
|
|
170
|
+
* @param {string} params.projectID - Source's Project ID
|
|
171
|
+
* @param {string} params.key - Source's API Key
|
|
98
172
|
* @throws {AppwriteException}
|
|
99
173
|
* @returns {Promise<Models.MigrationReport>}
|
|
100
174
|
*/
|
|
101
|
-
getAppwriteReport(resources: string[], endpoint: string, projectID: string, key: string): Promise<Models.MigrationReport
|
|
175
|
+
getAppwriteReport(params: { resources: string[], endpoint: string, projectID: string, key: string }): Promise<Models.MigrationReport>;
|
|
176
|
+
/**
|
|
177
|
+
* Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
|
178
|
+
*
|
|
179
|
+
* @param {string[]} resources - List of resources to migrate
|
|
180
|
+
* @param {string} endpoint - Source's Appwrite Endpoint
|
|
181
|
+
* @param {string} projectID - Source's Project ID
|
|
182
|
+
* @param {string} key - Source's API Key
|
|
183
|
+
* @throws {AppwriteException}
|
|
184
|
+
* @returns {Promise<Models.MigrationReport>}
|
|
185
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
186
|
+
*/
|
|
187
|
+
getAppwriteReport(resources: string[], endpoint: string, projectID: string, key: string): Promise<Models.MigrationReport>;
|
|
188
|
+
getAppwriteReport(
|
|
189
|
+
paramsOrFirst: { resources: string[], endpoint: string, projectID: string, key: string } | string[],
|
|
190
|
+
...rest: [(string)?, (string)?, (string)?]
|
|
191
|
+
): Promise<Models.MigrationReport> {
|
|
192
|
+
let params: { resources: string[], endpoint: string, projectID: string, key: string };
|
|
193
|
+
|
|
194
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
195
|
+
params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, projectID: string, key: string };
|
|
196
|
+
} else {
|
|
197
|
+
params = {
|
|
198
|
+
resources: paramsOrFirst as string[],
|
|
199
|
+
endpoint: rest[0] as string,
|
|
200
|
+
projectID: rest[1] as string,
|
|
201
|
+
key: rest[2] as string
|
|
202
|
+
};
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
const resources = params.resources;
|
|
206
|
+
const endpoint = params.endpoint;
|
|
207
|
+
const projectID = params.projectID;
|
|
208
|
+
const key = params.key;
|
|
209
|
+
|
|
102
210
|
if (typeof resources === 'undefined') {
|
|
103
211
|
throw new AppwriteException('Missing required parameter: "resources"');
|
|
104
212
|
}
|
|
@@ -111,6 +219,7 @@ export class Migrations {
|
|
|
111
219
|
if (typeof key === 'undefined') {
|
|
112
220
|
throw new AppwriteException('Missing required parameter: "key"');
|
|
113
221
|
}
|
|
222
|
+
|
|
114
223
|
const apiPath = '/migrations/appwrite/report';
|
|
115
224
|
const payload: Payload = {};
|
|
116
225
|
if (typeof resources !== 'undefined') {
|
|
@@ -137,16 +246,167 @@ export class Migrations {
|
|
|
137
246
|
payload
|
|
138
247
|
);
|
|
139
248
|
}
|
|
249
|
+
|
|
250
|
+
/**
|
|
251
|
+
* Export documents to a CSV file from your Appwrite database. This endpoint allows you to export documents to a CSV file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
|
|
252
|
+
*
|
|
253
|
+
* @param {string} params.resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.
|
|
254
|
+
* @param {string} params.filename - The name of the file to be created for the export, excluding the .csv extension.
|
|
255
|
+
* @param {string[]} params.columns - List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.
|
|
256
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
257
|
+
* @param {string} params.delimiter - The character that separates each column value. Default is comma.
|
|
258
|
+
* @param {string} params.enclosure - The character that encloses each column value. Default is double quotes.
|
|
259
|
+
* @param {string} params.escape - The escape character for the enclosure character. Default is double quotes.
|
|
260
|
+
* @param {boolean} params.header - Whether to include the header row with column names. Default is true.
|
|
261
|
+
* @param {boolean} params.notify - Set to true to receive an email when the export is complete. Default is true.
|
|
262
|
+
* @throws {AppwriteException}
|
|
263
|
+
* @returns {Promise<Models.Migration>}
|
|
264
|
+
*/
|
|
265
|
+
createCSVExport(params: { resourceId: string, filename: string, columns?: string[], queries?: string[], delimiter?: string, enclosure?: string, escape?: string, header?: boolean, notify?: boolean }): Promise<Models.Migration>;
|
|
266
|
+
/**
|
|
267
|
+
* Export documents to a CSV file from your Appwrite database. This endpoint allows you to export documents to a CSV file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
|
|
268
|
+
*
|
|
269
|
+
* @param {string} resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.
|
|
270
|
+
* @param {string} filename - The name of the file to be created for the export, excluding the .csv extension.
|
|
271
|
+
* @param {string[]} columns - List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.
|
|
272
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
273
|
+
* @param {string} delimiter - The character that separates each column value. Default is comma.
|
|
274
|
+
* @param {string} enclosure - The character that encloses each column value. Default is double quotes.
|
|
275
|
+
* @param {string} escape - The escape character for the enclosure character. Default is double quotes.
|
|
276
|
+
* @param {boolean} header - Whether to include the header row with column names. Default is true.
|
|
277
|
+
* @param {boolean} notify - Set to true to receive an email when the export is complete. Default is true.
|
|
278
|
+
* @throws {AppwriteException}
|
|
279
|
+
* @returns {Promise<Models.Migration>}
|
|
280
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
281
|
+
*/
|
|
282
|
+
createCSVExport(resourceId: string, filename: string, columns?: string[], queries?: string[], delimiter?: string, enclosure?: string, escape?: string, header?: boolean, notify?: boolean): Promise<Models.Migration>;
|
|
283
|
+
createCSVExport(
|
|
284
|
+
paramsOrFirst: { resourceId: string, filename: string, columns?: string[], queries?: string[], delimiter?: string, enclosure?: string, escape?: string, header?: boolean, notify?: boolean } | string,
|
|
285
|
+
...rest: [(string)?, (string[])?, (string[])?, (string)?, (string)?, (string)?, (boolean)?, (boolean)?]
|
|
286
|
+
): Promise<Models.Migration> {
|
|
287
|
+
let params: { resourceId: string, filename: string, columns?: string[], queries?: string[], delimiter?: string, enclosure?: string, escape?: string, header?: boolean, notify?: boolean };
|
|
288
|
+
|
|
289
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
290
|
+
params = (paramsOrFirst || {}) as { resourceId: string, filename: string, columns?: string[], queries?: string[], delimiter?: string, enclosure?: string, escape?: string, header?: boolean, notify?: boolean };
|
|
291
|
+
} else {
|
|
292
|
+
params = {
|
|
293
|
+
resourceId: paramsOrFirst as string,
|
|
294
|
+
filename: rest[0] as string,
|
|
295
|
+
columns: rest[1] as string[],
|
|
296
|
+
queries: rest[2] as string[],
|
|
297
|
+
delimiter: rest[3] as string,
|
|
298
|
+
enclosure: rest[4] as string,
|
|
299
|
+
escape: rest[5] as string,
|
|
300
|
+
header: rest[6] as boolean,
|
|
301
|
+
notify: rest[7] as boolean
|
|
302
|
+
};
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
const resourceId = params.resourceId;
|
|
306
|
+
const filename = params.filename;
|
|
307
|
+
const columns = params.columns;
|
|
308
|
+
const queries = params.queries;
|
|
309
|
+
const delimiter = params.delimiter;
|
|
310
|
+
const enclosure = params.enclosure;
|
|
311
|
+
const escape = params.escape;
|
|
312
|
+
const header = params.header;
|
|
313
|
+
const notify = params.notify;
|
|
314
|
+
|
|
315
|
+
if (typeof resourceId === 'undefined') {
|
|
316
|
+
throw new AppwriteException('Missing required parameter: "resourceId"');
|
|
317
|
+
}
|
|
318
|
+
if (typeof filename === 'undefined') {
|
|
319
|
+
throw new AppwriteException('Missing required parameter: "filename"');
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
const apiPath = '/migrations/csv/exports';
|
|
323
|
+
const payload: Payload = {};
|
|
324
|
+
if (typeof resourceId !== 'undefined') {
|
|
325
|
+
payload['resourceId'] = resourceId;
|
|
326
|
+
}
|
|
327
|
+
if (typeof filename !== 'undefined') {
|
|
328
|
+
payload['filename'] = filename;
|
|
329
|
+
}
|
|
330
|
+
if (typeof columns !== 'undefined') {
|
|
331
|
+
payload['columns'] = columns;
|
|
332
|
+
}
|
|
333
|
+
if (typeof queries !== 'undefined') {
|
|
334
|
+
payload['queries'] = queries;
|
|
335
|
+
}
|
|
336
|
+
if (typeof delimiter !== 'undefined') {
|
|
337
|
+
payload['delimiter'] = delimiter;
|
|
338
|
+
}
|
|
339
|
+
if (typeof enclosure !== 'undefined') {
|
|
340
|
+
payload['enclosure'] = enclosure;
|
|
341
|
+
}
|
|
342
|
+
if (typeof escape !== 'undefined') {
|
|
343
|
+
payload['escape'] = escape;
|
|
344
|
+
}
|
|
345
|
+
if (typeof header !== 'undefined') {
|
|
346
|
+
payload['header'] = header;
|
|
347
|
+
}
|
|
348
|
+
if (typeof notify !== 'undefined') {
|
|
349
|
+
payload['notify'] = notify;
|
|
350
|
+
}
|
|
351
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
352
|
+
|
|
353
|
+
const apiHeaders: { [header: string]: string } = {
|
|
354
|
+
'content-type': 'application/json',
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
return this.client.call(
|
|
358
|
+
'post',
|
|
359
|
+
uri,
|
|
360
|
+
apiHeaders,
|
|
361
|
+
payload
|
|
362
|
+
);
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* Import documents from a CSV file into your Appwrite database. This endpoint allows you to import documents from a CSV file uploaded to Appwrite Storage bucket.
|
|
367
|
+
*
|
|
368
|
+
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
369
|
+
* @param {string} params.fileId - File ID.
|
|
370
|
+
* @param {string} params.resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.
|
|
371
|
+
* @param {boolean} params.internalFile - Is the file stored in an internal bucket?
|
|
372
|
+
* @throws {AppwriteException}
|
|
373
|
+
* @returns {Promise<Models.Migration>}
|
|
374
|
+
*/
|
|
375
|
+
createCSVImport(params: { bucketId: string, fileId: string, resourceId: string, internalFile?: boolean }): Promise<Models.Migration>;
|
|
140
376
|
/**
|
|
141
377
|
* Import documents from a CSV file into your Appwrite database. This endpoint allows you to import documents from a CSV file uploaded to Appwrite Storage bucket.
|
|
142
378
|
*
|
|
143
|
-
* @param {string} bucketId
|
|
144
|
-
* @param {string} fileId
|
|
145
|
-
* @param {string} resourceId
|
|
379
|
+
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
380
|
+
* @param {string} fileId - File ID.
|
|
381
|
+
* @param {string} resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.
|
|
382
|
+
* @param {boolean} internalFile - Is the file stored in an internal bucket?
|
|
146
383
|
* @throws {AppwriteException}
|
|
147
384
|
* @returns {Promise<Models.Migration>}
|
|
385
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
148
386
|
*/
|
|
149
|
-
|
|
387
|
+
createCSVImport(bucketId: string, fileId: string, resourceId: string, internalFile?: boolean): Promise<Models.Migration>;
|
|
388
|
+
createCSVImport(
|
|
389
|
+
paramsOrFirst: { bucketId: string, fileId: string, resourceId: string, internalFile?: boolean } | string,
|
|
390
|
+
...rest: [(string)?, (string)?, (boolean)?]
|
|
391
|
+
): Promise<Models.Migration> {
|
|
392
|
+
let params: { bucketId: string, fileId: string, resourceId: string, internalFile?: boolean };
|
|
393
|
+
|
|
394
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
395
|
+
params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, resourceId: string, internalFile?: boolean };
|
|
396
|
+
} else {
|
|
397
|
+
params = {
|
|
398
|
+
bucketId: paramsOrFirst as string,
|
|
399
|
+
fileId: rest[0] as string,
|
|
400
|
+
resourceId: rest[1] as string,
|
|
401
|
+
internalFile: rest[2] as boolean
|
|
402
|
+
};
|
|
403
|
+
}
|
|
404
|
+
|
|
405
|
+
const bucketId = params.bucketId;
|
|
406
|
+
const fileId = params.fileId;
|
|
407
|
+
const resourceId = params.resourceId;
|
|
408
|
+
const internalFile = params.internalFile;
|
|
409
|
+
|
|
150
410
|
if (typeof bucketId === 'undefined') {
|
|
151
411
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
152
412
|
}
|
|
@@ -156,7 +416,8 @@ export class Migrations {
|
|
|
156
416
|
if (typeof resourceId === 'undefined') {
|
|
157
417
|
throw new AppwriteException('Missing required parameter: "resourceId"');
|
|
158
418
|
}
|
|
159
|
-
|
|
419
|
+
|
|
420
|
+
const apiPath = '/migrations/csv/imports';
|
|
160
421
|
const payload: Payload = {};
|
|
161
422
|
if (typeof bucketId !== 'undefined') {
|
|
162
423
|
payload['bucketId'] = bucketId;
|
|
@@ -167,6 +428,9 @@ export class Migrations {
|
|
|
167
428
|
if (typeof resourceId !== 'undefined') {
|
|
168
429
|
payload['resourceId'] = resourceId;
|
|
169
430
|
}
|
|
431
|
+
if (typeof internalFile !== 'undefined') {
|
|
432
|
+
payload['internalFile'] = internalFile;
|
|
433
|
+
}
|
|
170
434
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
171
435
|
|
|
172
436
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -180,21 +444,51 @@ export class Migrations {
|
|
|
180
444
|
payload
|
|
181
445
|
);
|
|
182
446
|
}
|
|
447
|
+
|
|
183
448
|
/**
|
|
184
449
|
* Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
|
|
185
450
|
*
|
|
186
|
-
* @param {string[]} resources
|
|
187
|
-
* @param {string} serviceAccount
|
|
451
|
+
* @param {string[]} params.resources - List of resources to migrate
|
|
452
|
+
* @param {string} params.serviceAccount - JSON of the Firebase service account credentials
|
|
188
453
|
* @throws {AppwriteException}
|
|
189
454
|
* @returns {Promise<Models.Migration>}
|
|
190
455
|
*/
|
|
191
|
-
createFirebaseMigration(resources: string[], serviceAccount: string): Promise<Models.Migration
|
|
456
|
+
createFirebaseMigration(params: { resources: string[], serviceAccount: string }): Promise<Models.Migration>;
|
|
457
|
+
/**
|
|
458
|
+
* Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
|
|
459
|
+
*
|
|
460
|
+
* @param {string[]} resources - List of resources to migrate
|
|
461
|
+
* @param {string} serviceAccount - JSON of the Firebase service account credentials
|
|
462
|
+
* @throws {AppwriteException}
|
|
463
|
+
* @returns {Promise<Models.Migration>}
|
|
464
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
465
|
+
*/
|
|
466
|
+
createFirebaseMigration(resources: string[], serviceAccount: string): Promise<Models.Migration>;
|
|
467
|
+
createFirebaseMigration(
|
|
468
|
+
paramsOrFirst: { resources: string[], serviceAccount: string } | string[],
|
|
469
|
+
...rest: [(string)?]
|
|
470
|
+
): Promise<Models.Migration> {
|
|
471
|
+
let params: { resources: string[], serviceAccount: string };
|
|
472
|
+
|
|
473
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
474
|
+
params = (paramsOrFirst || {}) as { resources: string[], serviceAccount: string };
|
|
475
|
+
} else {
|
|
476
|
+
params = {
|
|
477
|
+
resources: paramsOrFirst as string[],
|
|
478
|
+
serviceAccount: rest[0] as string
|
|
479
|
+
};
|
|
480
|
+
}
|
|
481
|
+
|
|
482
|
+
const resources = params.resources;
|
|
483
|
+
const serviceAccount = params.serviceAccount;
|
|
484
|
+
|
|
192
485
|
if (typeof resources === 'undefined') {
|
|
193
486
|
throw new AppwriteException('Missing required parameter: "resources"');
|
|
194
487
|
}
|
|
195
488
|
if (typeof serviceAccount === 'undefined') {
|
|
196
489
|
throw new AppwriteException('Missing required parameter: "serviceAccount"');
|
|
197
490
|
}
|
|
491
|
+
|
|
198
492
|
const apiPath = '/migrations/firebase';
|
|
199
493
|
const payload: Payload = {};
|
|
200
494
|
if (typeof resources !== 'undefined') {
|
|
@@ -216,21 +510,51 @@ export class Migrations {
|
|
|
216
510
|
payload
|
|
217
511
|
);
|
|
218
512
|
}
|
|
513
|
+
|
|
219
514
|
/**
|
|
220
515
|
* Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
|
221
516
|
*
|
|
222
|
-
* @param {string[]} resources
|
|
223
|
-
* @param {string} serviceAccount
|
|
517
|
+
* @param {string[]} params.resources - List of resources to migrate
|
|
518
|
+
* @param {string} params.serviceAccount - JSON of the Firebase service account credentials
|
|
224
519
|
* @throws {AppwriteException}
|
|
225
520
|
* @returns {Promise<Models.MigrationReport>}
|
|
226
521
|
*/
|
|
227
|
-
getFirebaseReport(resources: string[], serviceAccount: string): Promise<Models.MigrationReport
|
|
522
|
+
getFirebaseReport(params: { resources: string[], serviceAccount: string }): Promise<Models.MigrationReport>;
|
|
523
|
+
/**
|
|
524
|
+
* Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
|
525
|
+
*
|
|
526
|
+
* @param {string[]} resources - List of resources to migrate
|
|
527
|
+
* @param {string} serviceAccount - JSON of the Firebase service account credentials
|
|
528
|
+
* @throws {AppwriteException}
|
|
529
|
+
* @returns {Promise<Models.MigrationReport>}
|
|
530
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
531
|
+
*/
|
|
532
|
+
getFirebaseReport(resources: string[], serviceAccount: string): Promise<Models.MigrationReport>;
|
|
533
|
+
getFirebaseReport(
|
|
534
|
+
paramsOrFirst: { resources: string[], serviceAccount: string } | string[],
|
|
535
|
+
...rest: [(string)?]
|
|
536
|
+
): Promise<Models.MigrationReport> {
|
|
537
|
+
let params: { resources: string[], serviceAccount: string };
|
|
538
|
+
|
|
539
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
540
|
+
params = (paramsOrFirst || {}) as { resources: string[], serviceAccount: string };
|
|
541
|
+
} else {
|
|
542
|
+
params = {
|
|
543
|
+
resources: paramsOrFirst as string[],
|
|
544
|
+
serviceAccount: rest[0] as string
|
|
545
|
+
};
|
|
546
|
+
}
|
|
547
|
+
|
|
548
|
+
const resources = params.resources;
|
|
549
|
+
const serviceAccount = params.serviceAccount;
|
|
550
|
+
|
|
228
551
|
if (typeof resources === 'undefined') {
|
|
229
552
|
throw new AppwriteException('Missing required parameter: "resources"');
|
|
230
553
|
}
|
|
231
554
|
if (typeof serviceAccount === 'undefined') {
|
|
232
555
|
throw new AppwriteException('Missing required parameter: "serviceAccount"');
|
|
233
556
|
}
|
|
557
|
+
|
|
234
558
|
const apiPath = '/migrations/firebase/report';
|
|
235
559
|
const payload: Payload = {};
|
|
236
560
|
if (typeof resources !== 'undefined') {
|
|
@@ -251,21 +575,68 @@ export class Migrations {
|
|
|
251
575
|
payload
|
|
252
576
|
);
|
|
253
577
|
}
|
|
578
|
+
|
|
254
579
|
/**
|
|
255
580
|
* Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
|
|
256
581
|
*
|
|
257
|
-
* @param {string[]} resources
|
|
258
|
-
* @param {string} subdomain
|
|
259
|
-
* @param {string} region
|
|
260
|
-
* @param {string} adminSecret
|
|
261
|
-
* @param {string} database
|
|
262
|
-
* @param {string} username
|
|
263
|
-
* @param {string} password
|
|
264
|
-
* @param {number} port
|
|
582
|
+
* @param {string[]} params.resources - List of resources to migrate
|
|
583
|
+
* @param {string} params.subdomain - Source's Subdomain
|
|
584
|
+
* @param {string} params.region - Source's Region
|
|
585
|
+
* @param {string} params.adminSecret - Source's Admin Secret
|
|
586
|
+
* @param {string} params.database - Source's Database Name
|
|
587
|
+
* @param {string} params.username - Source's Database Username
|
|
588
|
+
* @param {string} params.password - Source's Database Password
|
|
589
|
+
* @param {number} params.port - Source's Database Port
|
|
265
590
|
* @throws {AppwriteException}
|
|
266
591
|
* @returns {Promise<Models.Migration>}
|
|
267
592
|
*/
|
|
268
|
-
createNHostMigration(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.Migration
|
|
593
|
+
createNHostMigration(params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number }): Promise<Models.Migration>;
|
|
594
|
+
/**
|
|
595
|
+
* Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
|
|
596
|
+
*
|
|
597
|
+
* @param {string[]} resources - List of resources to migrate
|
|
598
|
+
* @param {string} subdomain - Source's Subdomain
|
|
599
|
+
* @param {string} region - Source's Region
|
|
600
|
+
* @param {string} adminSecret - Source's Admin Secret
|
|
601
|
+
* @param {string} database - Source's Database Name
|
|
602
|
+
* @param {string} username - Source's Database Username
|
|
603
|
+
* @param {string} password - Source's Database Password
|
|
604
|
+
* @param {number} port - Source's Database Port
|
|
605
|
+
* @throws {AppwriteException}
|
|
606
|
+
* @returns {Promise<Models.Migration>}
|
|
607
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
608
|
+
*/
|
|
609
|
+
createNHostMigration(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.Migration>;
|
|
610
|
+
createNHostMigration(
|
|
611
|
+
paramsOrFirst: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number } | string[],
|
|
612
|
+
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
|
|
613
|
+
): Promise<Models.Migration> {
|
|
614
|
+
let params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
|
|
615
|
+
|
|
616
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
617
|
+
params = (paramsOrFirst || {}) as { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
|
|
618
|
+
} else {
|
|
619
|
+
params = {
|
|
620
|
+
resources: paramsOrFirst as string[],
|
|
621
|
+
subdomain: rest[0] as string,
|
|
622
|
+
region: rest[1] as string,
|
|
623
|
+
adminSecret: rest[2] as string,
|
|
624
|
+
database: rest[3] as string,
|
|
625
|
+
username: rest[4] as string,
|
|
626
|
+
password: rest[5] as string,
|
|
627
|
+
port: rest[6] as number
|
|
628
|
+
};
|
|
629
|
+
}
|
|
630
|
+
|
|
631
|
+
const resources = params.resources;
|
|
632
|
+
const subdomain = params.subdomain;
|
|
633
|
+
const region = params.region;
|
|
634
|
+
const adminSecret = params.adminSecret;
|
|
635
|
+
const database = params.database;
|
|
636
|
+
const username = params.username;
|
|
637
|
+
const password = params.password;
|
|
638
|
+
const port = params.port;
|
|
639
|
+
|
|
269
640
|
if (typeof resources === 'undefined') {
|
|
270
641
|
throw new AppwriteException('Missing required parameter: "resources"');
|
|
271
642
|
}
|
|
@@ -287,6 +658,7 @@ export class Migrations {
|
|
|
287
658
|
if (typeof password === 'undefined') {
|
|
288
659
|
throw new AppwriteException('Missing required parameter: "password"');
|
|
289
660
|
}
|
|
661
|
+
|
|
290
662
|
const apiPath = '/migrations/nhost';
|
|
291
663
|
const payload: Payload = {};
|
|
292
664
|
if (typeof resources !== 'undefined') {
|
|
@@ -326,21 +698,68 @@ export class Migrations {
|
|
|
326
698
|
payload
|
|
327
699
|
);
|
|
328
700
|
}
|
|
701
|
+
|
|
702
|
+
/**
|
|
703
|
+
* Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
|
704
|
+
*
|
|
705
|
+
* @param {string[]} params.resources - List of resources to migrate.
|
|
706
|
+
* @param {string} params.subdomain - Source's Subdomain.
|
|
707
|
+
* @param {string} params.region - Source's Region.
|
|
708
|
+
* @param {string} params.adminSecret - Source's Admin Secret.
|
|
709
|
+
* @param {string} params.database - Source's Database Name.
|
|
710
|
+
* @param {string} params.username - Source's Database Username.
|
|
711
|
+
* @param {string} params.password - Source's Database Password.
|
|
712
|
+
* @param {number} params.port - Source's Database Port.
|
|
713
|
+
* @throws {AppwriteException}
|
|
714
|
+
* @returns {Promise<Models.MigrationReport>}
|
|
715
|
+
*/
|
|
716
|
+
getNHostReport(params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number }): Promise<Models.MigrationReport>;
|
|
329
717
|
/**
|
|
330
718
|
* Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
|
331
719
|
*
|
|
332
|
-
* @param {string[]} resources
|
|
333
|
-
* @param {string} subdomain
|
|
334
|
-
* @param {string} region
|
|
335
|
-
* @param {string} adminSecret
|
|
336
|
-
* @param {string} database
|
|
337
|
-
* @param {string} username
|
|
338
|
-
* @param {string} password
|
|
339
|
-
* @param {number} port
|
|
720
|
+
* @param {string[]} resources - List of resources to migrate.
|
|
721
|
+
* @param {string} subdomain - Source's Subdomain.
|
|
722
|
+
* @param {string} region - Source's Region.
|
|
723
|
+
* @param {string} adminSecret - Source's Admin Secret.
|
|
724
|
+
* @param {string} database - Source's Database Name.
|
|
725
|
+
* @param {string} username - Source's Database Username.
|
|
726
|
+
* @param {string} password - Source's Database Password.
|
|
727
|
+
* @param {number} port - Source's Database Port.
|
|
340
728
|
* @throws {AppwriteException}
|
|
341
729
|
* @returns {Promise<Models.MigrationReport>}
|
|
730
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
342
731
|
*/
|
|
343
|
-
getNHostReport(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.MigrationReport
|
|
732
|
+
getNHostReport(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
|
|
733
|
+
getNHostReport(
|
|
734
|
+
paramsOrFirst: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number } | string[],
|
|
735
|
+
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
|
|
736
|
+
): Promise<Models.MigrationReport> {
|
|
737
|
+
let params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
|
|
738
|
+
|
|
739
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
740
|
+
params = (paramsOrFirst || {}) as { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
|
|
741
|
+
} else {
|
|
742
|
+
params = {
|
|
743
|
+
resources: paramsOrFirst as string[],
|
|
744
|
+
subdomain: rest[0] as string,
|
|
745
|
+
region: rest[1] as string,
|
|
746
|
+
adminSecret: rest[2] as string,
|
|
747
|
+
database: rest[3] as string,
|
|
748
|
+
username: rest[4] as string,
|
|
749
|
+
password: rest[5] as string,
|
|
750
|
+
port: rest[6] as number
|
|
751
|
+
};
|
|
752
|
+
}
|
|
753
|
+
|
|
754
|
+
const resources = params.resources;
|
|
755
|
+
const subdomain = params.subdomain;
|
|
756
|
+
const region = params.region;
|
|
757
|
+
const adminSecret = params.adminSecret;
|
|
758
|
+
const database = params.database;
|
|
759
|
+
const username = params.username;
|
|
760
|
+
const password = params.password;
|
|
761
|
+
const port = params.port;
|
|
762
|
+
|
|
344
763
|
if (typeof resources === 'undefined') {
|
|
345
764
|
throw new AppwriteException('Missing required parameter: "resources"');
|
|
346
765
|
}
|
|
@@ -362,6 +781,7 @@ export class Migrations {
|
|
|
362
781
|
if (typeof password === 'undefined') {
|
|
363
782
|
throw new AppwriteException('Missing required parameter: "password"');
|
|
364
783
|
}
|
|
784
|
+
|
|
365
785
|
const apiPath = '/migrations/nhost/report';
|
|
366
786
|
const payload: Payload = {};
|
|
367
787
|
if (typeof resources !== 'undefined') {
|
|
@@ -400,20 +820,64 @@ export class Migrations {
|
|
|
400
820
|
payload
|
|
401
821
|
);
|
|
402
822
|
}
|
|
823
|
+
|
|
403
824
|
/**
|
|
404
825
|
* Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project.
|
|
405
826
|
*
|
|
406
|
-
* @param {string[]} resources
|
|
407
|
-
* @param {string} endpoint
|
|
408
|
-
* @param {string} apiKey
|
|
409
|
-
* @param {string} databaseHost
|
|
410
|
-
* @param {string} username
|
|
411
|
-
* @param {string} password
|
|
412
|
-
* @param {number} port
|
|
827
|
+
* @param {string[]} params.resources - List of resources to migrate
|
|
828
|
+
* @param {string} params.endpoint - Source's Supabase Endpoint
|
|
829
|
+
* @param {string} params.apiKey - Source's API Key
|
|
830
|
+
* @param {string} params.databaseHost - Source's Database Host
|
|
831
|
+
* @param {string} params.username - Source's Database Username
|
|
832
|
+
* @param {string} params.password - Source's Database Password
|
|
833
|
+
* @param {number} params.port - Source's Database Port
|
|
413
834
|
* @throws {AppwriteException}
|
|
414
835
|
* @returns {Promise<Models.Migration>}
|
|
415
836
|
*/
|
|
416
|
-
createSupabaseMigration(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.Migration
|
|
837
|
+
createSupabaseMigration(params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number }): Promise<Models.Migration>;
|
|
838
|
+
/**
|
|
839
|
+
* Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project.
|
|
840
|
+
*
|
|
841
|
+
* @param {string[]} resources - List of resources to migrate
|
|
842
|
+
* @param {string} endpoint - Source's Supabase Endpoint
|
|
843
|
+
* @param {string} apiKey - Source's API Key
|
|
844
|
+
* @param {string} databaseHost - Source's Database Host
|
|
845
|
+
* @param {string} username - Source's Database Username
|
|
846
|
+
* @param {string} password - Source's Database Password
|
|
847
|
+
* @param {number} port - Source's Database Port
|
|
848
|
+
* @throws {AppwriteException}
|
|
849
|
+
* @returns {Promise<Models.Migration>}
|
|
850
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
851
|
+
*/
|
|
852
|
+
createSupabaseMigration(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.Migration>;
|
|
853
|
+
createSupabaseMigration(
|
|
854
|
+
paramsOrFirst: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number } | string[],
|
|
855
|
+
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
|
|
856
|
+
): Promise<Models.Migration> {
|
|
857
|
+
let params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
|
|
858
|
+
|
|
859
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
860
|
+
params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
|
|
861
|
+
} else {
|
|
862
|
+
params = {
|
|
863
|
+
resources: paramsOrFirst as string[],
|
|
864
|
+
endpoint: rest[0] as string,
|
|
865
|
+
apiKey: rest[1] as string,
|
|
866
|
+
databaseHost: rest[2] as string,
|
|
867
|
+
username: rest[3] as string,
|
|
868
|
+
password: rest[4] as string,
|
|
869
|
+
port: rest[5] as number
|
|
870
|
+
};
|
|
871
|
+
}
|
|
872
|
+
|
|
873
|
+
const resources = params.resources;
|
|
874
|
+
const endpoint = params.endpoint;
|
|
875
|
+
const apiKey = params.apiKey;
|
|
876
|
+
const databaseHost = params.databaseHost;
|
|
877
|
+
const username = params.username;
|
|
878
|
+
const password = params.password;
|
|
879
|
+
const port = params.port;
|
|
880
|
+
|
|
417
881
|
if (typeof resources === 'undefined') {
|
|
418
882
|
throw new AppwriteException('Missing required parameter: "resources"');
|
|
419
883
|
}
|
|
@@ -432,6 +896,7 @@ export class Migrations {
|
|
|
432
896
|
if (typeof password === 'undefined') {
|
|
433
897
|
throw new AppwriteException('Missing required parameter: "password"');
|
|
434
898
|
}
|
|
899
|
+
|
|
435
900
|
const apiPath = '/migrations/supabase';
|
|
436
901
|
const payload: Payload = {};
|
|
437
902
|
if (typeof resources !== 'undefined') {
|
|
@@ -468,20 +933,64 @@ export class Migrations {
|
|
|
468
933
|
payload
|
|
469
934
|
);
|
|
470
935
|
}
|
|
936
|
+
|
|
937
|
+
/**
|
|
938
|
+
* Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
|
939
|
+
*
|
|
940
|
+
* @param {string[]} params.resources - List of resources to migrate
|
|
941
|
+
* @param {string} params.endpoint - Source's Supabase Endpoint.
|
|
942
|
+
* @param {string} params.apiKey - Source's API Key.
|
|
943
|
+
* @param {string} params.databaseHost - Source's Database Host.
|
|
944
|
+
* @param {string} params.username - Source's Database Username.
|
|
945
|
+
* @param {string} params.password - Source's Database Password.
|
|
946
|
+
* @param {number} params.port - Source's Database Port.
|
|
947
|
+
* @throws {AppwriteException}
|
|
948
|
+
* @returns {Promise<Models.MigrationReport>}
|
|
949
|
+
*/
|
|
950
|
+
getSupabaseReport(params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number }): Promise<Models.MigrationReport>;
|
|
471
951
|
/**
|
|
472
952
|
* Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
|
473
953
|
*
|
|
474
|
-
* @param {string[]} resources
|
|
475
|
-
* @param {string} endpoint
|
|
476
|
-
* @param {string} apiKey
|
|
477
|
-
* @param {string} databaseHost
|
|
478
|
-
* @param {string} username
|
|
479
|
-
* @param {string} password
|
|
480
|
-
* @param {number} port
|
|
954
|
+
* @param {string[]} resources - List of resources to migrate
|
|
955
|
+
* @param {string} endpoint - Source's Supabase Endpoint.
|
|
956
|
+
* @param {string} apiKey - Source's API Key.
|
|
957
|
+
* @param {string} databaseHost - Source's Database Host.
|
|
958
|
+
* @param {string} username - Source's Database Username.
|
|
959
|
+
* @param {string} password - Source's Database Password.
|
|
960
|
+
* @param {number} port - Source's Database Port.
|
|
481
961
|
* @throws {AppwriteException}
|
|
482
962
|
* @returns {Promise<Models.MigrationReport>}
|
|
963
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
483
964
|
*/
|
|
484
|
-
getSupabaseReport(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.MigrationReport
|
|
965
|
+
getSupabaseReport(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
|
|
966
|
+
getSupabaseReport(
|
|
967
|
+
paramsOrFirst: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number } | string[],
|
|
968
|
+
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
|
|
969
|
+
): Promise<Models.MigrationReport> {
|
|
970
|
+
let params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
|
|
971
|
+
|
|
972
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
973
|
+
params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
|
|
974
|
+
} else {
|
|
975
|
+
params = {
|
|
976
|
+
resources: paramsOrFirst as string[],
|
|
977
|
+
endpoint: rest[0] as string,
|
|
978
|
+
apiKey: rest[1] as string,
|
|
979
|
+
databaseHost: rest[2] as string,
|
|
980
|
+
username: rest[3] as string,
|
|
981
|
+
password: rest[4] as string,
|
|
982
|
+
port: rest[5] as number
|
|
983
|
+
};
|
|
984
|
+
}
|
|
985
|
+
|
|
986
|
+
const resources = params.resources;
|
|
987
|
+
const endpoint = params.endpoint;
|
|
988
|
+
const apiKey = params.apiKey;
|
|
989
|
+
const databaseHost = params.databaseHost;
|
|
990
|
+
const username = params.username;
|
|
991
|
+
const password = params.password;
|
|
992
|
+
const port = params.port;
|
|
993
|
+
|
|
485
994
|
if (typeof resources === 'undefined') {
|
|
486
995
|
throw new AppwriteException('Missing required parameter: "resources"');
|
|
487
996
|
}
|
|
@@ -500,6 +1009,7 @@ export class Migrations {
|
|
|
500
1009
|
if (typeof password === 'undefined') {
|
|
501
1010
|
throw new AppwriteException('Missing required parameter: "password"');
|
|
502
1011
|
}
|
|
1012
|
+
|
|
503
1013
|
const apiPath = '/migrations/supabase/report';
|
|
504
1014
|
const payload: Payload = {};
|
|
505
1015
|
if (typeof resources !== 'undefined') {
|
|
@@ -535,17 +1045,43 @@ export class Migrations {
|
|
|
535
1045
|
payload
|
|
536
1046
|
);
|
|
537
1047
|
}
|
|
1048
|
+
|
|
1049
|
+
/**
|
|
1050
|
+
* Get a migration by its unique ID. This endpoint returns detailed information about a specific migration including its current status, progress, and any errors that occurred during the migration process.
|
|
1051
|
+
*
|
|
1052
|
+
* @param {string} params.migrationId - Migration unique ID.
|
|
1053
|
+
* @throws {AppwriteException}
|
|
1054
|
+
* @returns {Promise<Models.Migration>}
|
|
1055
|
+
*/
|
|
1056
|
+
get(params: { migrationId: string }): Promise<Models.Migration>;
|
|
538
1057
|
/**
|
|
539
1058
|
* Get a migration by its unique ID. This endpoint returns detailed information about a specific migration including its current status, progress, and any errors that occurred during the migration process.
|
|
540
1059
|
*
|
|
541
|
-
* @param {string} migrationId
|
|
1060
|
+
* @param {string} migrationId - Migration unique ID.
|
|
542
1061
|
* @throws {AppwriteException}
|
|
543
1062
|
* @returns {Promise<Models.Migration>}
|
|
1063
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
544
1064
|
*/
|
|
545
|
-
get(migrationId: string): Promise<Models.Migration
|
|
1065
|
+
get(migrationId: string): Promise<Models.Migration>;
|
|
1066
|
+
get(
|
|
1067
|
+
paramsOrFirst: { migrationId: string } | string
|
|
1068
|
+
): Promise<Models.Migration> {
|
|
1069
|
+
let params: { migrationId: string };
|
|
1070
|
+
|
|
1071
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1072
|
+
params = (paramsOrFirst || {}) as { migrationId: string };
|
|
1073
|
+
} else {
|
|
1074
|
+
params = {
|
|
1075
|
+
migrationId: paramsOrFirst as string
|
|
1076
|
+
};
|
|
1077
|
+
}
|
|
1078
|
+
|
|
1079
|
+
const migrationId = params.migrationId;
|
|
1080
|
+
|
|
546
1081
|
if (typeof migrationId === 'undefined') {
|
|
547
1082
|
throw new AppwriteException('Missing required parameter: "migrationId"');
|
|
548
1083
|
}
|
|
1084
|
+
|
|
549
1085
|
const apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
|
|
550
1086
|
const payload: Payload = {};
|
|
551
1087
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -560,17 +1096,43 @@ export class Migrations {
|
|
|
560
1096
|
payload
|
|
561
1097
|
);
|
|
562
1098
|
}
|
|
1099
|
+
|
|
1100
|
+
/**
|
|
1101
|
+
* Retry a failed migration. This endpoint allows you to retry a migration that has previously failed.
|
|
1102
|
+
*
|
|
1103
|
+
* @param {string} params.migrationId - Migration unique ID.
|
|
1104
|
+
* @throws {AppwriteException}
|
|
1105
|
+
* @returns {Promise<Models.Migration>}
|
|
1106
|
+
*/
|
|
1107
|
+
retry(params: { migrationId: string }): Promise<Models.Migration>;
|
|
563
1108
|
/**
|
|
564
1109
|
* Retry a failed migration. This endpoint allows you to retry a migration that has previously failed.
|
|
565
1110
|
*
|
|
566
|
-
* @param {string} migrationId
|
|
1111
|
+
* @param {string} migrationId - Migration unique ID.
|
|
567
1112
|
* @throws {AppwriteException}
|
|
568
1113
|
* @returns {Promise<Models.Migration>}
|
|
1114
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
569
1115
|
*/
|
|
570
|
-
retry(migrationId: string): Promise<Models.Migration
|
|
1116
|
+
retry(migrationId: string): Promise<Models.Migration>;
|
|
1117
|
+
retry(
|
|
1118
|
+
paramsOrFirst: { migrationId: string } | string
|
|
1119
|
+
): Promise<Models.Migration> {
|
|
1120
|
+
let params: { migrationId: string };
|
|
1121
|
+
|
|
1122
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1123
|
+
params = (paramsOrFirst || {}) as { migrationId: string };
|
|
1124
|
+
} else {
|
|
1125
|
+
params = {
|
|
1126
|
+
migrationId: paramsOrFirst as string
|
|
1127
|
+
};
|
|
1128
|
+
}
|
|
1129
|
+
|
|
1130
|
+
const migrationId = params.migrationId;
|
|
1131
|
+
|
|
571
1132
|
if (typeof migrationId === 'undefined') {
|
|
572
1133
|
throw new AppwriteException('Missing required parameter: "migrationId"');
|
|
573
1134
|
}
|
|
1135
|
+
|
|
574
1136
|
const apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
|
|
575
1137
|
const payload: Payload = {};
|
|
576
1138
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -586,17 +1148,43 @@ export class Migrations {
|
|
|
586
1148
|
payload
|
|
587
1149
|
);
|
|
588
1150
|
}
|
|
1151
|
+
|
|
1152
|
+
/**
|
|
1153
|
+
* Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project's migration history.
|
|
1154
|
+
*
|
|
1155
|
+
* @param {string} params.migrationId - Migration ID.
|
|
1156
|
+
* @throws {AppwriteException}
|
|
1157
|
+
* @returns {Promise<{}>}
|
|
1158
|
+
*/
|
|
1159
|
+
delete(params: { migrationId: string }): Promise<{}>;
|
|
589
1160
|
/**
|
|
590
|
-
* Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project
|
|
1161
|
+
* Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project's migration history.
|
|
591
1162
|
*
|
|
592
|
-
* @param {string} migrationId
|
|
1163
|
+
* @param {string} migrationId - Migration ID.
|
|
593
1164
|
* @throws {AppwriteException}
|
|
594
1165
|
* @returns {Promise<{}>}
|
|
1166
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
595
1167
|
*/
|
|
596
|
-
delete(migrationId: string): Promise<{}
|
|
1168
|
+
delete(migrationId: string): Promise<{}>;
|
|
1169
|
+
delete(
|
|
1170
|
+
paramsOrFirst: { migrationId: string } | string
|
|
1171
|
+
): Promise<{}> {
|
|
1172
|
+
let params: { migrationId: string };
|
|
1173
|
+
|
|
1174
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1175
|
+
params = (paramsOrFirst || {}) as { migrationId: string };
|
|
1176
|
+
} else {
|
|
1177
|
+
params = {
|
|
1178
|
+
migrationId: paramsOrFirst as string
|
|
1179
|
+
};
|
|
1180
|
+
}
|
|
1181
|
+
|
|
1182
|
+
const migrationId = params.migrationId;
|
|
1183
|
+
|
|
597
1184
|
if (typeof migrationId === 'undefined') {
|
|
598
1185
|
throw new AppwriteException('Missing required parameter: "migrationId"');
|
|
599
1186
|
}
|
|
1187
|
+
|
|
600
1188
|
const apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
|
|
601
1189
|
const payload: Payload = {};
|
|
602
1190
|
const uri = new URL(this.client.config.endpoint + apiPath);
|