@appwrite.io/console 1.10.0 → 2.1.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 +10 -0
- package/LICENSE +1 -1
- package/README.md +4 -4
- package/dist/cjs/sdk.js +15258 -6062
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +15256 -6063
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +15258 -6062
- 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 +15 -8
- package/docs/examples/databases/create-documents.md +6 -5
- 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 +3 -3
- 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 +4 -4
- 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 -6
- 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 +71 -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 +1692 -238
- package/src/operator.ts +308 -0
- package/src/query.ts +246 -2
- package/src/services/account.ts +2205 -223
- package/src/services/assistant.ts +29 -3
- package/src/services/avatars.ts +486 -33
- package/src/services/backups.ts +389 -42
- package/src/services/console.ts +492 -19
- package/src/services/databases.ts +3521 -431
- package/src/services/domains.ts +1684 -197
- package/src/services/functions.ts +1162 -149
- package/src/services/graphql.ts +55 -4
- package/src/services/health.ts +560 -41
- package/src/services/locale.ts +9 -0
- package/src/services/messaging.ts +3367 -380
- package/src/services/migrations.ts +641 -65
- package/src/services/organizations.ts +1323 -128
- package/src/services/project.ts +168 -17
- package/src/services/projects.ts +2742 -266
- package/src/services/proxy.ts +265 -26
- package/src/services/realtime.ts +437 -0
- package/src/services/sites.ts +1098 -140
- package/src/services/storage.ts +651 -82
- package/src/services/tables-db.ts +5439 -0
- package/src/services/teams.ts +512 -55
- package/src/services/tokens.ts +167 -16
- package/src/services/users.ts +1873 -181
- package/src/services/vcs.ts +359 -39
- package/types/client.d.ts +33 -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 +1664 -245
- package/types/operator.d.ts +180 -0
- package/types/query.d.ts +198 -2
- package/types/services/account.d.ts +985 -123
- package/types/services/assistant.d.ts +13 -2
- package/types/services/avatars.d.ts +244 -26
- package/types/services/backups.d.ts +190 -30
- package/types/services/console.d.ts +201 -14
- package/types/services/databases.d.ts +1731 -284
- package/types/services/domains.d.ts +904 -152
- package/types/services/functions.d.ts +616 -125
- package/types/services/graphql.d.ts +24 -2
- package/types/services/health.d.ts +245 -23
- package/types/services/messaging.d.ts +1660 -271
- package/types/services/migrations.d.ts +319 -53
- package/types/services/organizations.d.ts +635 -97
- 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 +577 -116
- package/types/services/storage.d.ts +354 -73
- package/types/services/tables-db.d.ts +2040 -0
- package/types/services/teams.d.ts +260 -44
- package/types/services/tokens.d.ts +80 -12
- package/types/services/users.d.ts +881 -124
- package/types/services/vcs.d.ts +179 -31
- 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
|
@@ -6,199 +6,476 @@ export declare class Domains {
|
|
|
6
6
|
/**
|
|
7
7
|
* List all domains registered for this project. This endpoint supports pagination.
|
|
8
8
|
*
|
|
9
|
-
* @param {string[]} queries
|
|
10
|
-
* @param {string} search
|
|
9
|
+
* @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 attributes such as domain name, teamInternalId, expiration, etc.
|
|
10
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
11
11
|
* @throws {AppwriteException}
|
|
12
12
|
* @returns {Promise<Models.DomainsList>}
|
|
13
13
|
*/
|
|
14
|
+
list(params?: {
|
|
15
|
+
queries?: string[];
|
|
16
|
+
search?: string;
|
|
17
|
+
}): Promise<Models.DomainsList>;
|
|
18
|
+
/**
|
|
19
|
+
* List all domains registered for this project. This endpoint supports pagination.
|
|
20
|
+
*
|
|
21
|
+
* @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 attributes such as domain name, teamInternalId, expiration, etc.
|
|
22
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
23
|
+
* @throws {AppwriteException}
|
|
24
|
+
* @returns {Promise<Models.DomainsList>}
|
|
25
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
26
|
+
*/
|
|
14
27
|
list(queries?: string[], search?: string): Promise<Models.DomainsList>;
|
|
15
28
|
/**
|
|
16
29
|
* Create a new domain. Before creating a domain, you need to ensure that your DNS provider is properly configured. After creating the domain, you can use the verification endpoint to check if the domain is ready to be used.
|
|
17
30
|
*
|
|
18
|
-
* @param {string} teamId
|
|
19
|
-
* @param {string} domain
|
|
31
|
+
* @param {string} params.teamId - Team unique ID.
|
|
32
|
+
* @param {string} params.domain - Domain name (e.g. "example.com").
|
|
20
33
|
* @throws {AppwriteException}
|
|
21
34
|
* @returns {Promise<Models.Domain>}
|
|
22
35
|
*/
|
|
36
|
+
create(params: {
|
|
37
|
+
teamId: string;
|
|
38
|
+
domain: string;
|
|
39
|
+
}): Promise<Models.Domain>;
|
|
40
|
+
/**
|
|
41
|
+
* Create a new domain. Before creating a domain, you need to ensure that your DNS provider is properly configured. After creating the domain, you can use the verification endpoint to check if the domain is ready to be used.
|
|
42
|
+
*
|
|
43
|
+
* @param {string} teamId - Team unique ID.
|
|
44
|
+
* @param {string} domain - Domain name (e.g. "example.com").
|
|
45
|
+
* @throws {AppwriteException}
|
|
46
|
+
* @returns {Promise<Models.Domain>}
|
|
47
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
48
|
+
*/
|
|
23
49
|
create(teamId: string, domain: string): Promise<Models.Domain>;
|
|
24
50
|
/**
|
|
25
51
|
* Get a domain by its unique ID.
|
|
26
52
|
*
|
|
27
|
-
* @param {string} domainId
|
|
53
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
54
|
+
* @throws {AppwriteException}
|
|
55
|
+
* @returns {Promise<Models.Domain>}
|
|
56
|
+
*/
|
|
57
|
+
get(params: {
|
|
58
|
+
domainId: string;
|
|
59
|
+
}): Promise<Models.Domain>;
|
|
60
|
+
/**
|
|
61
|
+
* Get a domain by its unique ID.
|
|
62
|
+
*
|
|
63
|
+
* @param {string} domainId - Domain unique ID.
|
|
28
64
|
* @throws {AppwriteException}
|
|
29
65
|
* @returns {Promise<Models.Domain>}
|
|
66
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
30
67
|
*/
|
|
31
68
|
get(domainId: string): Promise<Models.Domain>;
|
|
32
69
|
/**
|
|
33
70
|
* Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
|
|
34
71
|
* Once deleted, the domain will no longer be available for use and all associated resources will be removed.
|
|
35
72
|
*
|
|
36
|
-
* @param {string} domainId
|
|
73
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
37
74
|
* @throws {AppwriteException}
|
|
38
75
|
* @returns {Promise<{}>}
|
|
39
76
|
*/
|
|
77
|
+
delete(params: {
|
|
78
|
+
domainId: string;
|
|
79
|
+
}): Promise<{}>;
|
|
80
|
+
/**
|
|
81
|
+
* Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
|
|
82
|
+
* Once deleted, the domain will no longer be available for use and all associated resources will be removed.
|
|
83
|
+
*
|
|
84
|
+
* @param {string} domainId - Domain unique ID.
|
|
85
|
+
* @throws {AppwriteException}
|
|
86
|
+
* @returns {Promise<{}>}
|
|
87
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
88
|
+
*/
|
|
40
89
|
delete(domainId: string): Promise<{}>;
|
|
41
90
|
/**
|
|
42
|
-
* Verify which NS records are used and update the domain accordingly. This will check the domain
|
|
43
|
-
* nameservers and update the domain
|
|
91
|
+
* Verify which NS records are used and update the domain accordingly. This will check the domain's
|
|
92
|
+
* nameservers and update the domain's status based on whether the nameservers match the expected
|
|
93
|
+
* Appwrite nameservers.
|
|
94
|
+
*
|
|
95
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
96
|
+
* @throws {AppwriteException}
|
|
97
|
+
* @returns {Promise<Models.Domain>}
|
|
98
|
+
*/
|
|
99
|
+
updateNameservers(params: {
|
|
100
|
+
domainId: string;
|
|
101
|
+
}): Promise<Models.Domain>;
|
|
102
|
+
/**
|
|
103
|
+
* Verify which NS records are used and update the domain accordingly. This will check the domain's
|
|
104
|
+
* nameservers and update the domain's status based on whether the nameservers match the expected
|
|
44
105
|
* Appwrite nameservers.
|
|
45
106
|
*
|
|
46
|
-
* @param {string} domainId
|
|
107
|
+
* @param {string} domainId - Domain unique ID.
|
|
47
108
|
* @throws {AppwriteException}
|
|
48
109
|
* @returns {Promise<Models.Domain>}
|
|
110
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
49
111
|
*/
|
|
50
112
|
updateNameservers(domainId: string): Promise<Models.Domain>;
|
|
51
113
|
/**
|
|
52
114
|
* List Google Workspace DNS records.
|
|
53
115
|
*
|
|
54
|
-
* @param {string} domainId
|
|
116
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
55
117
|
* @throws {AppwriteException}
|
|
56
118
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
57
119
|
*/
|
|
120
|
+
getPresetGoogleWorkspace(params: {
|
|
121
|
+
domainId: string;
|
|
122
|
+
}): Promise<Models.DnsRecordsList>;
|
|
123
|
+
/**
|
|
124
|
+
* List Google Workspace DNS records.
|
|
125
|
+
*
|
|
126
|
+
* @param {string} domainId - Domain unique ID.
|
|
127
|
+
* @throws {AppwriteException}
|
|
128
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
129
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
130
|
+
*/
|
|
58
131
|
getPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
|
|
59
132
|
/**
|
|
60
133
|
* Add Google Workspace DNS records to the domain. This will create the required MX records
|
|
61
134
|
* for Google Workspace email hosting.
|
|
62
135
|
*
|
|
63
|
-
* @param {string} domainId
|
|
136
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
64
137
|
* @throws {AppwriteException}
|
|
65
138
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
66
139
|
*/
|
|
140
|
+
createPresetGoogleWorkspace(params: {
|
|
141
|
+
domainId: string;
|
|
142
|
+
}): Promise<Models.DnsRecordsList>;
|
|
143
|
+
/**
|
|
144
|
+
* Add Google Workspace DNS records to the domain. This will create the required MX records
|
|
145
|
+
* for Google Workspace email hosting.
|
|
146
|
+
*
|
|
147
|
+
* @param {string} domainId - Domain unique ID.
|
|
148
|
+
* @throws {AppwriteException}
|
|
149
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
150
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
151
|
+
*/
|
|
67
152
|
createPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
|
|
68
153
|
/**
|
|
69
154
|
* List iCloud DNS records.
|
|
70
155
|
*
|
|
71
|
-
* @param {string} domainId
|
|
156
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
157
|
+
* @throws {AppwriteException}
|
|
158
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
159
|
+
*/
|
|
160
|
+
getPresetICloud(params: {
|
|
161
|
+
domainId: string;
|
|
162
|
+
}): Promise<Models.DnsRecordsList>;
|
|
163
|
+
/**
|
|
164
|
+
* List iCloud DNS records.
|
|
165
|
+
*
|
|
166
|
+
* @param {string} domainId - Domain unique ID.
|
|
72
167
|
* @throws {AppwriteException}
|
|
73
168
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
169
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
74
170
|
*/
|
|
75
171
|
getPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
|
|
76
172
|
/**
|
|
77
173
|
* Add iCloud DNS records to the domain. This will create the required MX and SPF records
|
|
78
174
|
* for using iCloud email services with your domain.
|
|
79
175
|
*
|
|
80
|
-
* @param {string} domainId
|
|
176
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
177
|
+
* @throws {AppwriteException}
|
|
178
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
179
|
+
*/
|
|
180
|
+
createPresetICloud(params: {
|
|
181
|
+
domainId: string;
|
|
182
|
+
}): Promise<Models.DnsRecordsList>;
|
|
183
|
+
/**
|
|
184
|
+
* Add iCloud DNS records to the domain. This will create the required MX and SPF records
|
|
185
|
+
* for using iCloud email services with your domain.
|
|
186
|
+
*
|
|
187
|
+
* @param {string} domainId - Domain unique ID.
|
|
81
188
|
* @throws {AppwriteException}
|
|
82
189
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
190
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
83
191
|
*/
|
|
84
192
|
createPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
|
|
85
193
|
/**
|
|
86
194
|
* List Mailgun DNS records.
|
|
87
195
|
*
|
|
88
|
-
* @param {string} domainId
|
|
196
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
197
|
+
* @throws {AppwriteException}
|
|
198
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
199
|
+
*/
|
|
200
|
+
getPresetMailgun(params: {
|
|
201
|
+
domainId: string;
|
|
202
|
+
}): Promise<Models.DnsRecordsList>;
|
|
203
|
+
/**
|
|
204
|
+
* List Mailgun DNS records.
|
|
205
|
+
*
|
|
206
|
+
* @param {string} domainId - Domain unique ID.
|
|
89
207
|
* @throws {AppwriteException}
|
|
90
208
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
209
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
91
210
|
*/
|
|
92
211
|
getPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
|
|
93
212
|
/**
|
|
94
213
|
* Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
|
|
95
214
|
* for Mailgun in the specified domain.
|
|
96
215
|
*
|
|
97
|
-
* @param {string} domainId
|
|
216
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
217
|
+
* @throws {AppwriteException}
|
|
218
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
219
|
+
*/
|
|
220
|
+
createPresetMailgun(params: {
|
|
221
|
+
domainId: string;
|
|
222
|
+
}): Promise<Models.DnsRecordsList>;
|
|
223
|
+
/**
|
|
224
|
+
* Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
|
|
225
|
+
* for Mailgun in the specified domain.
|
|
226
|
+
*
|
|
227
|
+
* @param {string} domainId - Domain unique ID.
|
|
98
228
|
* @throws {AppwriteException}
|
|
99
229
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
230
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
100
231
|
*/
|
|
101
232
|
createPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
|
|
102
233
|
/**
|
|
103
234
|
* List Outlook DNS records.
|
|
104
235
|
*
|
|
105
|
-
* @param {string} domainId
|
|
236
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
237
|
+
* @throws {AppwriteException}
|
|
238
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
239
|
+
*/
|
|
240
|
+
getPresetOutlook(params: {
|
|
241
|
+
domainId: string;
|
|
242
|
+
}): Promise<Models.DnsRecordsList>;
|
|
243
|
+
/**
|
|
244
|
+
* List Outlook DNS records.
|
|
245
|
+
*
|
|
246
|
+
* @param {string} domainId - Domain unique ID.
|
|
106
247
|
* @throws {AppwriteException}
|
|
107
248
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
249
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
108
250
|
*/
|
|
109
251
|
getPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
|
|
110
252
|
/**
|
|
111
253
|
* Add Outlook DNS records to the domain. This will create the required MX records
|
|
112
254
|
* for setting up Outlook email hosting for your domain.
|
|
113
255
|
*
|
|
114
|
-
* @param {string} domainId
|
|
256
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
257
|
+
* @throws {AppwriteException}
|
|
258
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
259
|
+
*/
|
|
260
|
+
createPresetOutlook(params: {
|
|
261
|
+
domainId: string;
|
|
262
|
+
}): Promise<Models.DnsRecordsList>;
|
|
263
|
+
/**
|
|
264
|
+
* Add Outlook DNS records to the domain. This will create the required MX records
|
|
265
|
+
* for setting up Outlook email hosting for your domain.
|
|
266
|
+
*
|
|
267
|
+
* @param {string} domainId - Domain unique ID.
|
|
115
268
|
* @throws {AppwriteException}
|
|
116
269
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
270
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
117
271
|
*/
|
|
118
272
|
createPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
|
|
119
273
|
/**
|
|
120
274
|
* List ProtonMail DNS records.
|
|
121
275
|
*
|
|
122
|
-
* @param {string} domainId
|
|
276
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
123
277
|
* @throws {AppwriteException}
|
|
124
278
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
125
279
|
*/
|
|
280
|
+
getPresetProtonMail(params: {
|
|
281
|
+
domainId: string;
|
|
282
|
+
}): Promise<Models.DnsRecordsList>;
|
|
283
|
+
/**
|
|
284
|
+
* List ProtonMail DNS records.
|
|
285
|
+
*
|
|
286
|
+
* @param {string} domainId - Domain unique ID.
|
|
287
|
+
* @throws {AppwriteException}
|
|
288
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
289
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
290
|
+
*/
|
|
126
291
|
getPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
|
|
127
292
|
/**
|
|
128
293
|
* Add ProtonMail DNS records to the domain. This will create the required MX records
|
|
129
294
|
* for using ProtonMail with your custom domain.
|
|
130
295
|
*
|
|
131
|
-
* @param {string} domainId
|
|
296
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
132
297
|
* @throws {AppwriteException}
|
|
133
298
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
134
299
|
*/
|
|
300
|
+
createPresetProtonMail(params: {
|
|
301
|
+
domainId: string;
|
|
302
|
+
}): Promise<Models.DnsRecordsList>;
|
|
303
|
+
/**
|
|
304
|
+
* Add ProtonMail DNS records to the domain. This will create the required MX records
|
|
305
|
+
* for using ProtonMail with your custom domain.
|
|
306
|
+
*
|
|
307
|
+
* @param {string} domainId - Domain unique ID.
|
|
308
|
+
* @throws {AppwriteException}
|
|
309
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
310
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
311
|
+
*/
|
|
135
312
|
createPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
|
|
136
313
|
/**
|
|
137
314
|
* List Zoho DNS records.
|
|
138
315
|
*
|
|
139
|
-
* @param {string} domainId
|
|
316
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
317
|
+
* @throws {AppwriteException}
|
|
318
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
319
|
+
*/
|
|
320
|
+
getPresetZoho(params: {
|
|
321
|
+
domainId: string;
|
|
322
|
+
}): Promise<Models.DnsRecordsList>;
|
|
323
|
+
/**
|
|
324
|
+
* List Zoho DNS records.
|
|
325
|
+
*
|
|
326
|
+
* @param {string} domainId - Domain unique ID.
|
|
140
327
|
* @throws {AppwriteException}
|
|
141
328
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
329
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
142
330
|
*/
|
|
143
331
|
getPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
|
|
144
332
|
/**
|
|
145
333
|
* Add Zoho Mail DNS records to the domain. This will create the required MX records
|
|
146
334
|
* for setting up Zoho Mail on your domain.
|
|
147
335
|
*
|
|
148
|
-
* @param {string} domainId
|
|
336
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
149
337
|
* @throws {AppwriteException}
|
|
150
338
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
151
339
|
*/
|
|
340
|
+
createPresetZoho(params: {
|
|
341
|
+
domainId: string;
|
|
342
|
+
}): Promise<Models.DnsRecordsList>;
|
|
343
|
+
/**
|
|
344
|
+
* Add Zoho Mail DNS records to the domain. This will create the required MX records
|
|
345
|
+
* for setting up Zoho Mail on your domain.
|
|
346
|
+
*
|
|
347
|
+
* @param {string} domainId - Domain unique ID.
|
|
348
|
+
* @throws {AppwriteException}
|
|
349
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
350
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
351
|
+
*/
|
|
152
352
|
createPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
|
|
153
353
|
/**
|
|
154
354
|
* List DNS records for a given domain. You can use this endpoint to list all the DNS records
|
|
155
355
|
* associated with your domain.
|
|
156
356
|
*
|
|
157
|
-
* @param {string} domainId
|
|
158
|
-
* @param {string[]} queries
|
|
357
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
358
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. You may filter on attributes such as type, name, value, etc. Maximum of 100 queries are allowed, each 4096 characters long.
|
|
359
|
+
* @throws {AppwriteException}
|
|
360
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
361
|
+
*/
|
|
362
|
+
listRecords(params: {
|
|
363
|
+
domainId: string;
|
|
364
|
+
queries?: string[];
|
|
365
|
+
}): Promise<Models.DnsRecordsList>;
|
|
366
|
+
/**
|
|
367
|
+
* List DNS records for a given domain. You can use this endpoint to list all the DNS records
|
|
368
|
+
* associated with your domain.
|
|
369
|
+
*
|
|
370
|
+
* @param {string} domainId - Domain unique ID.
|
|
371
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. You may filter on attributes such as type, name, value, etc. Maximum of 100 queries are allowed, each 4096 characters long.
|
|
159
372
|
* @throws {AppwriteException}
|
|
160
373
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
374
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
161
375
|
*/
|
|
162
376
|
listRecords(domainId: string, queries?: string[]): Promise<Models.DnsRecordsList>;
|
|
163
377
|
/**
|
|
164
378
|
* Create a new A record for the given domain. A records are used to point a domain name
|
|
165
379
|
* to an IPv4 address. The record value should be a valid IPv4 address.
|
|
166
380
|
*
|
|
167
|
-
* @param {string} domainId
|
|
168
|
-
* @param {string} name
|
|
169
|
-
* @param {string} value
|
|
170
|
-
* @param {number} ttl
|
|
171
|
-
* @param {string} comment
|
|
381
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
382
|
+
* @param {string} params.name - Record name (subdomain).
|
|
383
|
+
* @param {string} params.value - IPv4 address for this A record.
|
|
384
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
385
|
+
* @param {string} params.comment - A comment explaining what this record is for.
|
|
172
386
|
* @throws {AppwriteException}
|
|
173
387
|
* @returns {Promise<Models.DnsRecord>}
|
|
174
388
|
*/
|
|
389
|
+
createRecordA(params: {
|
|
390
|
+
domainId: string;
|
|
391
|
+
name: string;
|
|
392
|
+
value: string;
|
|
393
|
+
ttl: number;
|
|
394
|
+
comment?: string;
|
|
395
|
+
}): Promise<Models.DnsRecord>;
|
|
396
|
+
/**
|
|
397
|
+
* Create a new A record for the given domain. A records are used to point a domain name
|
|
398
|
+
* to an IPv4 address. The record value should be a valid IPv4 address.
|
|
399
|
+
*
|
|
400
|
+
* @param {string} domainId - Domain unique ID.
|
|
401
|
+
* @param {string} name - Record name (subdomain).
|
|
402
|
+
* @param {string} value - IPv4 address for this A record.
|
|
403
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
404
|
+
* @param {string} comment - A comment explaining what this record is for.
|
|
405
|
+
* @throws {AppwriteException}
|
|
406
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
407
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
408
|
+
*/
|
|
175
409
|
createRecordA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
176
410
|
/**
|
|
177
411
|
* Update an existing A record for the given domain. This endpoint allows you to modify
|
|
178
412
|
* the properties of an A record including its name (subdomain), IPv4 address, TTL,
|
|
179
413
|
* and optional comment.
|
|
180
414
|
*
|
|
181
|
-
* @param {string} domainId
|
|
182
|
-
* @param {string} recordId
|
|
183
|
-
* @param {string} name
|
|
184
|
-
* @param {string} value
|
|
185
|
-
* @param {number} ttl
|
|
186
|
-
* @param {string} comment
|
|
415
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
416
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
417
|
+
* @param {string} params.name - Record name (subdomain).
|
|
418
|
+
* @param {string} params.value - IPv4 address for this A record.
|
|
419
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
420
|
+
* @param {string} params.comment - A comment explaining what this record is for.
|
|
421
|
+
* @throws {AppwriteException}
|
|
422
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
423
|
+
*/
|
|
424
|
+
updateRecordA(params: {
|
|
425
|
+
domainId: string;
|
|
426
|
+
recordId: string;
|
|
427
|
+
name: string;
|
|
428
|
+
value: string;
|
|
429
|
+
ttl: number;
|
|
430
|
+
comment?: string;
|
|
431
|
+
}): Promise<Models.DnsRecord>;
|
|
432
|
+
/**
|
|
433
|
+
* Update an existing A record for the given domain. This endpoint allows you to modify
|
|
434
|
+
* the properties of an A record including its name (subdomain), IPv4 address, TTL,
|
|
435
|
+
* and optional comment.
|
|
436
|
+
*
|
|
437
|
+
* @param {string} domainId - Domain unique ID.
|
|
438
|
+
* @param {string} recordId - DNS record unique ID.
|
|
439
|
+
* @param {string} name - Record name (subdomain).
|
|
440
|
+
* @param {string} value - IPv4 address for this A record.
|
|
441
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
442
|
+
* @param {string} comment - A comment explaining what this record is for.
|
|
187
443
|
* @throws {AppwriteException}
|
|
188
444
|
* @returns {Promise<Models.DnsRecord>}
|
|
445
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
189
446
|
*/
|
|
190
447
|
updateRecordA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
191
448
|
/**
|
|
192
449
|
* Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
|
|
193
450
|
* to your domain. The record will be used to point a hostname to an IPv6 address.
|
|
194
451
|
*
|
|
195
|
-
* @param {string} domainId
|
|
196
|
-
* @param {string} name
|
|
197
|
-
* @param {string} value
|
|
198
|
-
* @param {number} ttl
|
|
199
|
-
* @param {string} comment
|
|
452
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
453
|
+
* @param {string} params.name - Record name (subdomain).
|
|
454
|
+
* @param {string} params.value - IPv6 address for this AAAA record.
|
|
455
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
456
|
+
* @param {string} params.comment - A comment explaining what this record is for.
|
|
457
|
+
* @throws {AppwriteException}
|
|
458
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
459
|
+
*/
|
|
460
|
+
createRecordAAAA(params: {
|
|
461
|
+
domainId: string;
|
|
462
|
+
name: string;
|
|
463
|
+
value: string;
|
|
464
|
+
ttl: number;
|
|
465
|
+
comment?: string;
|
|
466
|
+
}): Promise<Models.DnsRecord>;
|
|
467
|
+
/**
|
|
468
|
+
* Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
|
|
469
|
+
* to your domain. The record will be used to point a hostname to an IPv6 address.
|
|
470
|
+
*
|
|
471
|
+
* @param {string} domainId - Domain unique ID.
|
|
472
|
+
* @param {string} name - Record name (subdomain).
|
|
473
|
+
* @param {string} value - IPv6 address for this AAAA record.
|
|
474
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
475
|
+
* @param {string} comment - A comment explaining what this record is for.
|
|
200
476
|
* @throws {AppwriteException}
|
|
201
477
|
* @returns {Promise<Models.DnsRecord>}
|
|
478
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
202
479
|
*/
|
|
203
480
|
createRecordAAAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
204
481
|
/**
|
|
@@ -206,14 +483,37 @@ export declare class Domains {
|
|
|
206
483
|
* the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
|
|
207
484
|
* TTL, and optional comment.
|
|
208
485
|
*
|
|
209
|
-
* @param {string} domainId
|
|
210
|
-
* @param {string} recordId
|
|
211
|
-
* @param {string} name
|
|
212
|
-
* @param {string} value
|
|
213
|
-
* @param {number} ttl
|
|
214
|
-
* @param {string} comment
|
|
486
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
487
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
488
|
+
* @param {string} params.name - Record name (subdomain).
|
|
489
|
+
* @param {string} params.value - IPv6 address for this AAAA record.
|
|
490
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
491
|
+
* @param {string} params.comment - A comment for this record.
|
|
492
|
+
* @throws {AppwriteException}
|
|
493
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
494
|
+
*/
|
|
495
|
+
updateRecordAAAA(params: {
|
|
496
|
+
domainId: string;
|
|
497
|
+
recordId: string;
|
|
498
|
+
name: string;
|
|
499
|
+
value: string;
|
|
500
|
+
ttl: number;
|
|
501
|
+
comment?: string;
|
|
502
|
+
}): Promise<Models.DnsRecord>;
|
|
503
|
+
/**
|
|
504
|
+
* Update an existing AAAA record for the given domain. This endpoint allows you to modify
|
|
505
|
+
* the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
|
|
506
|
+
* TTL, and optional comment.
|
|
507
|
+
*
|
|
508
|
+
* @param {string} domainId - Domain unique ID.
|
|
509
|
+
* @param {string} recordId - DNS record unique ID.
|
|
510
|
+
* @param {string} name - Record name (subdomain).
|
|
511
|
+
* @param {string} value - IPv6 address for this AAAA record.
|
|
512
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
513
|
+
* @param {string} comment - A comment for this record.
|
|
215
514
|
* @throws {AppwriteException}
|
|
216
515
|
* @returns {Promise<Models.DnsRecord>}
|
|
516
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
217
517
|
*/
|
|
218
518
|
updateRecordAAAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
219
519
|
/**
|
|
@@ -221,13 +521,34 @@ export declare class Domains {
|
|
|
221
521
|
* to another domain name that will serve as an alias. This is particularly useful when you want to
|
|
222
522
|
* map your domain to a target domain that may change its IP address.
|
|
223
523
|
*
|
|
224
|
-
* @param {string} domainId
|
|
225
|
-
* @param {string} name
|
|
226
|
-
* @param {string} value
|
|
227
|
-
* @param {number} ttl
|
|
228
|
-
* @param {string} comment
|
|
524
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
525
|
+
* @param {string} params.name - Record name.
|
|
526
|
+
* @param {string} params.value - Target domain for this ALIAS record.
|
|
527
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
528
|
+
* @param {string} params.comment - A comment for this record.
|
|
529
|
+
* @throws {AppwriteException}
|
|
530
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
531
|
+
*/
|
|
532
|
+
createRecordAlias(params: {
|
|
533
|
+
domainId: string;
|
|
534
|
+
name: string;
|
|
535
|
+
value: string;
|
|
536
|
+
ttl: number;
|
|
537
|
+
comment?: string;
|
|
538
|
+
}): Promise<Models.DnsRecord>;
|
|
539
|
+
/**
|
|
540
|
+
* Create a new ALIAS record for the given domain. This record type can be used to point your domain
|
|
541
|
+
* to another domain name that will serve as an alias. This is particularly useful when you want to
|
|
542
|
+
* map your domain to a target domain that may change its IP address.
|
|
543
|
+
*
|
|
544
|
+
* @param {string} domainId - Domain unique ID.
|
|
545
|
+
* @param {string} name - Record name.
|
|
546
|
+
* @param {string} value - Target domain for this ALIAS record.
|
|
547
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
548
|
+
* @param {string} comment - A comment for this record.
|
|
229
549
|
* @throws {AppwriteException}
|
|
230
550
|
* @returns {Promise<Models.DnsRecord>}
|
|
551
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
231
552
|
*/
|
|
232
553
|
createRecordAlias(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
233
554
|
/**
|
|
@@ -237,100 +558,255 @@ export declare class Domains {
|
|
|
237
558
|
* The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
|
|
238
559
|
* It provides a way to map one domain name to another.
|
|
239
560
|
*
|
|
240
|
-
* @param {string} domainId
|
|
241
|
-
* @param {string} recordId
|
|
242
|
-
* @param {string} name
|
|
243
|
-
* @param {string} value
|
|
244
|
-
* @param {number} ttl
|
|
245
|
-
* @param {string} comment
|
|
561
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
562
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
563
|
+
* @param {string} params.name - Record name.
|
|
564
|
+
* @param {string} params.value - Target domain for this ALIAS record.
|
|
565
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
566
|
+
* @param {string} params.comment - A comment for this record.
|
|
246
567
|
* @throws {AppwriteException}
|
|
247
568
|
* @returns {Promise<Models.DnsRecord>}
|
|
248
569
|
*/
|
|
570
|
+
updateRecordAlias(params: {
|
|
571
|
+
domainId: string;
|
|
572
|
+
recordId: string;
|
|
573
|
+
name: string;
|
|
574
|
+
value: string;
|
|
575
|
+
ttl: number;
|
|
576
|
+
comment?: string;
|
|
577
|
+
}): Promise<Models.DnsRecord>;
|
|
578
|
+
/**
|
|
579
|
+
* Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
|
|
580
|
+
* the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
|
|
581
|
+
*
|
|
582
|
+
* The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
|
|
583
|
+
* It provides a way to map one domain name to another.
|
|
584
|
+
*
|
|
585
|
+
* @param {string} domainId - Domain unique ID.
|
|
586
|
+
* @param {string} recordId - DNS record unique ID.
|
|
587
|
+
* @param {string} name - Record name.
|
|
588
|
+
* @param {string} value - Target domain for this ALIAS record.
|
|
589
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
590
|
+
* @param {string} comment - A comment for this record.
|
|
591
|
+
* @throws {AppwriteException}
|
|
592
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
593
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
594
|
+
*/
|
|
249
595
|
updateRecordAlias(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
250
596
|
/**
|
|
251
597
|
* Create a new CAA record for the given domain. CAA records are used to specify which
|
|
252
598
|
* Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
|
|
253
599
|
*
|
|
254
|
-
* @param {string} domainId
|
|
255
|
-
* @param {string} name
|
|
256
|
-
* @param {string} value
|
|
257
|
-
* @param {number} ttl
|
|
258
|
-
* @param {string} comment
|
|
600
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
601
|
+
* @param {string} params.name - Record name.
|
|
602
|
+
* @param {string} params.value - CAA value (e.g. issuer domain).
|
|
603
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
604
|
+
* @param {string} params.comment - A comment for this record.
|
|
259
605
|
* @throws {AppwriteException}
|
|
260
606
|
* @returns {Promise<Models.DnsRecord>}
|
|
261
607
|
*/
|
|
608
|
+
createRecordCAA(params: {
|
|
609
|
+
domainId: string;
|
|
610
|
+
name: string;
|
|
611
|
+
value: string;
|
|
612
|
+
ttl: number;
|
|
613
|
+
comment?: string;
|
|
614
|
+
}): Promise<Models.DnsRecord>;
|
|
615
|
+
/**
|
|
616
|
+
* Create a new CAA record for the given domain. CAA records are used to specify which
|
|
617
|
+
* Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
|
|
618
|
+
*
|
|
619
|
+
* @param {string} domainId - Domain unique ID.
|
|
620
|
+
* @param {string} name - Record name.
|
|
621
|
+
* @param {string} value - CAA value (e.g. issuer domain).
|
|
622
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
623
|
+
* @param {string} comment - A comment for this record.
|
|
624
|
+
* @throws {AppwriteException}
|
|
625
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
626
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
627
|
+
*/
|
|
262
628
|
createRecordCAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
263
629
|
/**
|
|
264
630
|
* Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
|
|
265
631
|
* record is used to specify which certificate authorities (CAs) are authorized to issue certificates
|
|
266
632
|
* for a domain.
|
|
267
633
|
*
|
|
268
|
-
* @param {string} domainId
|
|
269
|
-
* @param {string} recordId
|
|
270
|
-
* @param {string} name
|
|
271
|
-
* @param {string} value
|
|
272
|
-
* @param {number} ttl
|
|
273
|
-
* @param {string} comment
|
|
634
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
635
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
636
|
+
* @param {string} params.name - Record name.
|
|
637
|
+
* @param {string} params.value - CAA value (e.g. issuer domain).
|
|
638
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
639
|
+
* @param {string} params.comment - A comment for this record.
|
|
274
640
|
* @throws {AppwriteException}
|
|
275
641
|
* @returns {Promise<Models.DnsRecord>}
|
|
276
642
|
*/
|
|
643
|
+
updateRecordCAA(params: {
|
|
644
|
+
domainId: string;
|
|
645
|
+
recordId: string;
|
|
646
|
+
name: string;
|
|
647
|
+
value: string;
|
|
648
|
+
ttl: number;
|
|
649
|
+
comment?: string;
|
|
650
|
+
}): Promise<Models.DnsRecord>;
|
|
651
|
+
/**
|
|
652
|
+
* Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
|
|
653
|
+
* record is used to specify which certificate authorities (CAs) are authorized to issue certificates
|
|
654
|
+
* for a domain.
|
|
655
|
+
*
|
|
656
|
+
* @param {string} domainId - Domain unique ID.
|
|
657
|
+
* @param {string} recordId - DNS record unique ID.
|
|
658
|
+
* @param {string} name - Record name.
|
|
659
|
+
* @param {string} value - CAA value (e.g. issuer domain).
|
|
660
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
661
|
+
* @param {string} comment - A comment for this record.
|
|
662
|
+
* @throws {AppwriteException}
|
|
663
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
664
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
665
|
+
*/
|
|
277
666
|
updateRecordCAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
278
667
|
/**
|
|
279
668
|
* Create a new CNAME record for the given domain.
|
|
280
669
|
*
|
|
281
670
|
* A CNAME record maps a subdomain to another domain name, allowing you to create aliases
|
|
282
|
-
* for your domain. For example, you can create a CNAME record to point
|
|
283
|
-
* to
|
|
671
|
+
* for your domain. For example, you can create a CNAME record to point 'blog.example.com'
|
|
672
|
+
* to 'example.wordpress.com'.
|
|
284
673
|
*
|
|
285
|
-
* @param {string} domainId
|
|
286
|
-
* @param {string} name
|
|
287
|
-
* @param {string} value
|
|
288
|
-
* @param {number} ttl
|
|
289
|
-
* @param {string} comment
|
|
674
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
675
|
+
* @param {string} params.name - Record name (subdomain).
|
|
676
|
+
* @param {string} params.value - Canonical target for this CNAME record.
|
|
677
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
678
|
+
* @param {string} params.comment - A comment for this record.
|
|
290
679
|
* @throws {AppwriteException}
|
|
291
680
|
* @returns {Promise<Models.DnsRecord>}
|
|
292
681
|
*/
|
|
682
|
+
createRecordCNAME(params: {
|
|
683
|
+
domainId: string;
|
|
684
|
+
name: string;
|
|
685
|
+
value: string;
|
|
686
|
+
ttl: number;
|
|
687
|
+
comment?: string;
|
|
688
|
+
}): Promise<Models.DnsRecord>;
|
|
689
|
+
/**
|
|
690
|
+
* Create a new CNAME record for the given domain.
|
|
691
|
+
*
|
|
692
|
+
* A CNAME record maps a subdomain to another domain name, allowing you to create aliases
|
|
693
|
+
* for your domain. For example, you can create a CNAME record to point 'blog.example.com'
|
|
694
|
+
* to 'example.wordpress.com'.
|
|
695
|
+
*
|
|
696
|
+
* @param {string} domainId - Domain unique ID.
|
|
697
|
+
* @param {string} name - Record name (subdomain).
|
|
698
|
+
* @param {string} value - Canonical target for this CNAME record.
|
|
699
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
700
|
+
* @param {string} comment - A comment for this record.
|
|
701
|
+
* @throws {AppwriteException}
|
|
702
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
703
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
704
|
+
*/
|
|
293
705
|
createRecordCNAME(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
294
706
|
/**
|
|
295
707
|
* Update an existing CNAME record for the given domain.
|
|
296
708
|
*
|
|
297
|
-
* @param {string} domainId
|
|
298
|
-
* @param {string} recordId
|
|
299
|
-
* @param {string} name
|
|
300
|
-
* @param {string} value
|
|
301
|
-
* @param {number} ttl
|
|
302
|
-
* @param {string} comment
|
|
709
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
710
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
711
|
+
* @param {string} params.name - Record name (subdomain).
|
|
712
|
+
* @param {string} params.value - Canonical target for this CNAME record.
|
|
713
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
714
|
+
* @param {string} params.comment - A comment for this record.
|
|
715
|
+
* @throws {AppwriteException}
|
|
716
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
717
|
+
*/
|
|
718
|
+
updateRecordCNAME(params: {
|
|
719
|
+
domainId: string;
|
|
720
|
+
recordId: string;
|
|
721
|
+
name: string;
|
|
722
|
+
value: string;
|
|
723
|
+
ttl: number;
|
|
724
|
+
comment?: string;
|
|
725
|
+
}): Promise<Models.DnsRecord>;
|
|
726
|
+
/**
|
|
727
|
+
* Update an existing CNAME record for the given domain.
|
|
728
|
+
*
|
|
729
|
+
* @param {string} domainId - Domain unique ID.
|
|
730
|
+
* @param {string} recordId - DNS record unique ID.
|
|
731
|
+
* @param {string} name - Record name (subdomain).
|
|
732
|
+
* @param {string} value - Canonical target for this CNAME record.
|
|
733
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
734
|
+
* @param {string} comment - A comment for this record.
|
|
303
735
|
* @throws {AppwriteException}
|
|
304
736
|
* @returns {Promise<Models.DnsRecord>}
|
|
737
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
305
738
|
*/
|
|
306
739
|
updateRecordCNAME(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
307
740
|
/**
|
|
308
741
|
* Create a new HTTPS record for the given domain. This record is used to configure HTTPS
|
|
309
742
|
* settings for your domain, enabling secure communication over SSL/TLS.
|
|
310
743
|
*
|
|
311
|
-
* @param {string} domainId
|
|
312
|
-
* @param {string} name
|
|
313
|
-
* @param {string} value
|
|
314
|
-
* @param {number} ttl
|
|
315
|
-
* @param {string} comment
|
|
744
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
745
|
+
* @param {string} params.name - Record name (subdomain).
|
|
746
|
+
* @param {string} params.value - Target for the HTTPS record.
|
|
747
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
748
|
+
* @param {string} params.comment - A comment for this record.
|
|
316
749
|
* @throws {AppwriteException}
|
|
317
750
|
* @returns {Promise<Models.DnsRecord>}
|
|
318
751
|
*/
|
|
752
|
+
createRecordHTTPS(params: {
|
|
753
|
+
domainId: string;
|
|
754
|
+
name: string;
|
|
755
|
+
value: string;
|
|
756
|
+
ttl: number;
|
|
757
|
+
comment?: string;
|
|
758
|
+
}): Promise<Models.DnsRecord>;
|
|
759
|
+
/**
|
|
760
|
+
* Create a new HTTPS record for the given domain. This record is used to configure HTTPS
|
|
761
|
+
* settings for your domain, enabling secure communication over SSL/TLS.
|
|
762
|
+
*
|
|
763
|
+
* @param {string} domainId - Domain unique ID.
|
|
764
|
+
* @param {string} name - Record name (subdomain).
|
|
765
|
+
* @param {string} value - Target for the HTTPS record.
|
|
766
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
767
|
+
* @param {string} comment - A comment for this record.
|
|
768
|
+
* @throws {AppwriteException}
|
|
769
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
770
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
771
|
+
*/
|
|
319
772
|
createRecordHTTPS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
320
773
|
/**
|
|
321
774
|
* Update an existing HTTPS record for the given domain. This endpoint allows you to modify
|
|
322
775
|
* the properties of an HTTPS record associated with your domain, including the name (subdomain),
|
|
323
776
|
* target value, TTL, and optional comment.
|
|
324
777
|
*
|
|
325
|
-
* @param {string} domainId
|
|
326
|
-
* @param {string} recordId
|
|
327
|
-
* @param {string} name
|
|
328
|
-
* @param {string} value
|
|
329
|
-
* @param {number} ttl
|
|
330
|
-
* @param {string} comment
|
|
778
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
779
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
780
|
+
* @param {string} params.name - Record name (subdomain).
|
|
781
|
+
* @param {string} params.value - Target for the HTTPS record.
|
|
782
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
783
|
+
* @param {string} params.comment - A comment for this record.
|
|
331
784
|
* @throws {AppwriteException}
|
|
332
785
|
* @returns {Promise<Models.DnsRecord>}
|
|
333
786
|
*/
|
|
787
|
+
updateRecordHTTPS(params: {
|
|
788
|
+
domainId: string;
|
|
789
|
+
recordId: string;
|
|
790
|
+
name: string;
|
|
791
|
+
value: string;
|
|
792
|
+
ttl: number;
|
|
793
|
+
comment?: string;
|
|
794
|
+
}): Promise<Models.DnsRecord>;
|
|
795
|
+
/**
|
|
796
|
+
* Update an existing HTTPS record for the given domain. This endpoint allows you to modify
|
|
797
|
+
* the properties of an HTTPS record associated with your domain, including the name (subdomain),
|
|
798
|
+
* target value, TTL, and optional comment.
|
|
799
|
+
*
|
|
800
|
+
* @param {string} domainId - Domain unique ID.
|
|
801
|
+
* @param {string} recordId - DNS record unique ID.
|
|
802
|
+
* @param {string} name - Record name (subdomain).
|
|
803
|
+
* @param {string} value - Target for the HTTPS record.
|
|
804
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
805
|
+
* @param {string} comment - A comment for this record.
|
|
806
|
+
* @throws {AppwriteException}
|
|
807
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
808
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
809
|
+
*/
|
|
334
810
|
updateRecordHTTPS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
335
811
|
/**
|
|
336
812
|
* Create a new MX record for the given domain. MX records are used to define the mail servers responsible
|
|
@@ -338,42 +814,109 @@ export declare class Domains {
|
|
|
338
814
|
* The priority parameter determines the order in which mail servers are used, with lower values indicating
|
|
339
815
|
* higher priority.
|
|
340
816
|
*
|
|
341
|
-
* @param {string} domainId
|
|
342
|
-
* @param {string} name
|
|
343
|
-
* @param {string} value
|
|
344
|
-
* @param {number} ttl
|
|
345
|
-
* @param {number} priority
|
|
346
|
-
* @param {string} comment
|
|
817
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
818
|
+
* @param {string} params.name - Record name (subdomain).
|
|
819
|
+
* @param {string} params.value - Mail server domain for this MX record.
|
|
820
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
821
|
+
* @param {number} params.priority - MX priority.
|
|
822
|
+
* @param {string} params.comment - A comment for this record.
|
|
823
|
+
* @throws {AppwriteException}
|
|
824
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
825
|
+
*/
|
|
826
|
+
createRecordMX(params: {
|
|
827
|
+
domainId: string;
|
|
828
|
+
name: string;
|
|
829
|
+
value: string;
|
|
830
|
+
ttl: number;
|
|
831
|
+
priority: number;
|
|
832
|
+
comment?: string;
|
|
833
|
+
}): Promise<Models.DnsRecord>;
|
|
834
|
+
/**
|
|
835
|
+
* Create a new MX record for the given domain. MX records are used to define the mail servers responsible
|
|
836
|
+
* for accepting email messages for the domain. Multiple MX records can be created with different priorities.
|
|
837
|
+
* The priority parameter determines the order in which mail servers are used, with lower values indicating
|
|
838
|
+
* higher priority.
|
|
839
|
+
*
|
|
840
|
+
* @param {string} domainId - Domain unique ID.
|
|
841
|
+
* @param {string} name - Record name (subdomain).
|
|
842
|
+
* @param {string} value - Mail server domain for this MX record.
|
|
843
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
844
|
+
* @param {number} priority - MX priority.
|
|
845
|
+
* @param {string} comment - A comment for this record.
|
|
347
846
|
* @throws {AppwriteException}
|
|
348
847
|
* @returns {Promise<Models.DnsRecord>}
|
|
848
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
349
849
|
*/
|
|
350
850
|
createRecordMX(domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
|
|
351
851
|
/**
|
|
352
852
|
* Update an existing MX record for the given domain.
|
|
353
853
|
*
|
|
354
|
-
* @param {string} domainId
|
|
355
|
-
* @param {string} recordId
|
|
356
|
-
* @param {string} name
|
|
357
|
-
* @param {string} value
|
|
358
|
-
* @param {number} ttl
|
|
359
|
-
* @param {number} priority
|
|
360
|
-
* @param {string} comment
|
|
854
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
855
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
856
|
+
* @param {string} params.name - Record name (subdomain).
|
|
857
|
+
* @param {string} params.value - Mail server domain for this MX record.
|
|
858
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
859
|
+
* @param {number} params.priority - MX priority.
|
|
860
|
+
* @param {string} params.comment - A comment for this record.
|
|
861
|
+
* @throws {AppwriteException}
|
|
862
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
863
|
+
*/
|
|
864
|
+
updateRecordMX(params: {
|
|
865
|
+
domainId: string;
|
|
866
|
+
recordId: string;
|
|
867
|
+
name: string;
|
|
868
|
+
value: string;
|
|
869
|
+
ttl: number;
|
|
870
|
+
priority: number;
|
|
871
|
+
comment?: string;
|
|
872
|
+
}): Promise<Models.DnsRecord>;
|
|
873
|
+
/**
|
|
874
|
+
* Update an existing MX record for the given domain.
|
|
875
|
+
*
|
|
876
|
+
* @param {string} domainId - Domain unique ID.
|
|
877
|
+
* @param {string} recordId - DNS record unique ID.
|
|
878
|
+
* @param {string} name - Record name (subdomain).
|
|
879
|
+
* @param {string} value - Mail server domain for this MX record.
|
|
880
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
881
|
+
* @param {number} priority - MX priority.
|
|
882
|
+
* @param {string} comment - A comment for this record.
|
|
361
883
|
* @throws {AppwriteException}
|
|
362
884
|
* @returns {Promise<Models.DnsRecord>}
|
|
885
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
363
886
|
*/
|
|
364
887
|
updateRecordMX(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
|
|
365
888
|
/**
|
|
366
889
|
* Create a new NS record for the given domain. NS records specify the nameservers that are used
|
|
367
890
|
* to resolve the domain name to IP addresses. Each domain can have multiple NS records.
|
|
368
891
|
*
|
|
369
|
-
* @param {string} domainId
|
|
370
|
-
* @param {string} name
|
|
371
|
-
* @param {string} value
|
|
372
|
-
* @param {number} ttl
|
|
373
|
-
* @param {string} comment
|
|
892
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
893
|
+
* @param {string} params.name - Record name (subdomain).
|
|
894
|
+
* @param {string} params.value - Nameserver target for this NS record.
|
|
895
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
896
|
+
* @param {string} params.comment - A comment for this record.
|
|
374
897
|
* @throws {AppwriteException}
|
|
375
898
|
* @returns {Promise<Models.DnsRecord>}
|
|
376
899
|
*/
|
|
900
|
+
createRecordNS(params: {
|
|
901
|
+
domainId: string;
|
|
902
|
+
name: string;
|
|
903
|
+
value: string;
|
|
904
|
+
ttl: number;
|
|
905
|
+
comment?: string;
|
|
906
|
+
}): Promise<Models.DnsRecord>;
|
|
907
|
+
/**
|
|
908
|
+
* Create a new NS record for the given domain. NS records specify the nameservers that are used
|
|
909
|
+
* to resolve the domain name to IP addresses. Each domain can have multiple NS records.
|
|
910
|
+
*
|
|
911
|
+
* @param {string} domainId - Domain unique ID.
|
|
912
|
+
* @param {string} name - Record name (subdomain).
|
|
913
|
+
* @param {string} value - Nameserver target for this NS record.
|
|
914
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
915
|
+
* @param {string} comment - A comment for this record.
|
|
916
|
+
* @throws {AppwriteException}
|
|
917
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
918
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
919
|
+
*/
|
|
377
920
|
createRecordNS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
378
921
|
/**
|
|
379
922
|
* Update an existing NS record for the given domain. This endpoint allows you to modify
|
|
@@ -381,14 +924,38 @@ export declare class Domains {
|
|
|
381
924
|
* the record name (subdomain), target nameserver value, TTL, and add or modify comments
|
|
382
925
|
* for better record management.
|
|
383
926
|
*
|
|
384
|
-
* @param {string} domainId
|
|
385
|
-
* @param {string} recordId
|
|
386
|
-
* @param {string} name
|
|
387
|
-
* @param {string} value
|
|
388
|
-
* @param {number} ttl
|
|
389
|
-
* @param {string} comment
|
|
927
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
928
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
929
|
+
* @param {string} params.name - Record name (subdomain).
|
|
930
|
+
* @param {string} params.value - Nameserver target for this NS record.
|
|
931
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
932
|
+
* @param {string} params.comment - A comment for this record.
|
|
933
|
+
* @throws {AppwriteException}
|
|
934
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
935
|
+
*/
|
|
936
|
+
updateRecordNS(params: {
|
|
937
|
+
domainId: string;
|
|
938
|
+
recordId: string;
|
|
939
|
+
name: string;
|
|
940
|
+
value: string;
|
|
941
|
+
ttl: number;
|
|
942
|
+
comment?: string;
|
|
943
|
+
}): Promise<Models.DnsRecord>;
|
|
944
|
+
/**
|
|
945
|
+
* Update an existing NS record for the given domain. This endpoint allows you to modify
|
|
946
|
+
* the properties of an NS (nameserver) record associated with your domain. You can update
|
|
947
|
+
* the record name (subdomain), target nameserver value, TTL, and add or modify comments
|
|
948
|
+
* for better record management.
|
|
949
|
+
*
|
|
950
|
+
* @param {string} domainId - Domain unique ID.
|
|
951
|
+
* @param {string} recordId - DNS record unique ID.
|
|
952
|
+
* @param {string} name - Record name (subdomain).
|
|
953
|
+
* @param {string} value - Nameserver target for this NS record.
|
|
954
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
955
|
+
* @param {string} comment - A comment for this record.
|
|
390
956
|
* @throws {AppwriteException}
|
|
391
957
|
* @returns {Promise<Models.DnsRecord>}
|
|
958
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
392
959
|
*/
|
|
393
960
|
updateRecordNS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
394
961
|
/**
|
|
@@ -396,17 +963,44 @@ export declare class Domains {
|
|
|
396
963
|
* of servers for specific services. For example, they can be used to specify which server
|
|
397
964
|
* handles a specific service like SIP or XMPP for the domain.
|
|
398
965
|
*
|
|
399
|
-
* @param {string} domainId
|
|
400
|
-
* @param {string} name
|
|
401
|
-
* @param {string} value
|
|
402
|
-
* @param {number} ttl
|
|
403
|
-
* @param {number} priority
|
|
404
|
-
* @param {number} weight
|
|
405
|
-
* @param {number} port
|
|
406
|
-
* @param {string} comment
|
|
966
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
967
|
+
* @param {string} params.name - Record name (service name).
|
|
968
|
+
* @param {string} params.value - Target hostname for this SRV record.
|
|
969
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
970
|
+
* @param {number} params.priority - Record priority.
|
|
971
|
+
* @param {number} params.weight - Record weight.
|
|
972
|
+
* @param {number} params.port - Port number for the service.
|
|
973
|
+
* @param {string} params.comment - A comment for this record.
|
|
407
974
|
* @throws {AppwriteException}
|
|
408
975
|
* @returns {Promise<Models.DnsRecord>}
|
|
409
976
|
*/
|
|
977
|
+
createRecordSRV(params: {
|
|
978
|
+
domainId: string;
|
|
979
|
+
name: string;
|
|
980
|
+
value: string;
|
|
981
|
+
ttl: number;
|
|
982
|
+
priority: number;
|
|
983
|
+
weight: number;
|
|
984
|
+
port: number;
|
|
985
|
+
comment?: string;
|
|
986
|
+
}): Promise<Models.DnsRecord>;
|
|
987
|
+
/**
|
|
988
|
+
* Create a new SRV record for the given domain. SRV records are used to define the location
|
|
989
|
+
* of servers for specific services. For example, they can be used to specify which server
|
|
990
|
+
* handles a specific service like SIP or XMPP for the domain.
|
|
991
|
+
*
|
|
992
|
+
* @param {string} domainId - Domain unique ID.
|
|
993
|
+
* @param {string} name - Record name (service name).
|
|
994
|
+
* @param {string} value - Target hostname for this SRV record.
|
|
995
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
996
|
+
* @param {number} priority - Record priority.
|
|
997
|
+
* @param {number} weight - Record weight.
|
|
998
|
+
* @param {number} port - Port number for the service.
|
|
999
|
+
* @param {string} comment - A comment for this record.
|
|
1000
|
+
* @throws {AppwriteException}
|
|
1001
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1002
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1003
|
+
*/
|
|
410
1004
|
createRecordSRV(domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
|
|
411
1005
|
/**
|
|
412
1006
|
* Update an existing SRV record for the given domain.
|
|
@@ -424,17 +1018,57 @@ export declare class Domains {
|
|
|
424
1018
|
* Optional parameters:
|
|
425
1019
|
* - comment: A comment for this record
|
|
426
1020
|
*
|
|
427
|
-
* @param {string} domainId
|
|
428
|
-
* @param {string} recordId
|
|
429
|
-
* @param {string} name
|
|
430
|
-
* @param {string} value
|
|
431
|
-
* @param {number} ttl
|
|
432
|
-
* @param {number} priority
|
|
433
|
-
* @param {number} weight
|
|
434
|
-
* @param {number} port
|
|
435
|
-
* @param {string} comment
|
|
1021
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1022
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1023
|
+
* @param {string} params.name - Record name (service name).
|
|
1024
|
+
* @param {string} params.value - Target hostname for this SRV record.
|
|
1025
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1026
|
+
* @param {number} params.priority - Record priority.
|
|
1027
|
+
* @param {number} params.weight - Record weight.
|
|
1028
|
+
* @param {number} params.port - Port number for the service.
|
|
1029
|
+
* @param {string} params.comment - A comment for this record.
|
|
1030
|
+
* @throws {AppwriteException}
|
|
1031
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1032
|
+
*/
|
|
1033
|
+
updateRecordSRV(params: {
|
|
1034
|
+
domainId: string;
|
|
1035
|
+
recordId: string;
|
|
1036
|
+
name: string;
|
|
1037
|
+
value: string;
|
|
1038
|
+
ttl: number;
|
|
1039
|
+
priority: number;
|
|
1040
|
+
weight: number;
|
|
1041
|
+
port: number;
|
|
1042
|
+
comment?: string;
|
|
1043
|
+
}): Promise<Models.DnsRecord>;
|
|
1044
|
+
/**
|
|
1045
|
+
* Update an existing SRV record for the given domain.
|
|
1046
|
+
*
|
|
1047
|
+
* Required parameters:
|
|
1048
|
+
* - domainId: Domain unique ID
|
|
1049
|
+
* - recordId: DNS record unique ID
|
|
1050
|
+
* - name: Record name (service name)
|
|
1051
|
+
* - value: Target hostname for this SRV record
|
|
1052
|
+
* - ttl: Time to live, in seconds
|
|
1053
|
+
* - priority: Record priority
|
|
1054
|
+
* - weight: Record weight
|
|
1055
|
+
* - port: Port number for the service
|
|
1056
|
+
*
|
|
1057
|
+
* Optional parameters:
|
|
1058
|
+
* - comment: A comment for this record
|
|
1059
|
+
*
|
|
1060
|
+
* @param {string} domainId - Domain unique ID.
|
|
1061
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1062
|
+
* @param {string} name - Record name (service name).
|
|
1063
|
+
* @param {string} value - Target hostname for this SRV record.
|
|
1064
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1065
|
+
* @param {number} priority - Record priority.
|
|
1066
|
+
* @param {number} weight - Record weight.
|
|
1067
|
+
* @param {number} port - Port number for the service.
|
|
1068
|
+
* @param {string} comment - A comment for this record.
|
|
436
1069
|
* @throws {AppwriteException}
|
|
437
1070
|
* @returns {Promise<Models.DnsRecord>}
|
|
1071
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
438
1072
|
*/
|
|
439
1073
|
updateRecordSRV(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
|
|
440
1074
|
/**
|
|
@@ -442,13 +1076,34 @@ export declare class Domains {
|
|
|
442
1076
|
* to provide additional information about your domain, such as domain
|
|
443
1077
|
* verification records, SPF records, or DKIM records.
|
|
444
1078
|
*
|
|
445
|
-
* @param {string} domainId
|
|
446
|
-
* @param {string} name
|
|
447
|
-
* @param {number} ttl
|
|
448
|
-
* @param {string} value
|
|
449
|
-
* @param {string} comment
|
|
1079
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1080
|
+
* @param {string} params.name - Record name (subdomain) for the TXT record.
|
|
1081
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1082
|
+
* @param {string} params.value - TXT record value.
|
|
1083
|
+
* @param {string} params.comment - A comment for this record.
|
|
1084
|
+
* @throws {AppwriteException}
|
|
1085
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1086
|
+
*/
|
|
1087
|
+
createRecordTXT(params: {
|
|
1088
|
+
domainId: string;
|
|
1089
|
+
name: string;
|
|
1090
|
+
ttl: number;
|
|
1091
|
+
value?: string;
|
|
1092
|
+
comment?: string;
|
|
1093
|
+
}): Promise<Models.DnsRecord>;
|
|
1094
|
+
/**
|
|
1095
|
+
* Create a new TXT record for the given domain. TXT records can be used
|
|
1096
|
+
* to provide additional information about your domain, such as domain
|
|
1097
|
+
* verification records, SPF records, or DKIM records.
|
|
1098
|
+
*
|
|
1099
|
+
* @param {string} domainId - Domain unique ID.
|
|
1100
|
+
* @param {string} name - Record name (subdomain) for the TXT record.
|
|
1101
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1102
|
+
* @param {string} value - TXT record value.
|
|
1103
|
+
* @param {string} comment - A comment for this record.
|
|
450
1104
|
* @throws {AppwriteException}
|
|
451
1105
|
* @returns {Promise<Models.DnsRecord>}
|
|
1106
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
452
1107
|
*/
|
|
453
1108
|
createRecordTXT(domainId: string, name: string, ttl: number, value?: string, comment?: string): Promise<Models.DnsRecord>;
|
|
454
1109
|
/**
|
|
@@ -457,14 +1112,38 @@ export declare class Domains {
|
|
|
457
1112
|
* Update the TXT record details for a specific domain by providing the domain ID,
|
|
458
1113
|
* record ID, and the new record configuration including name, value, TTL, and an optional comment.
|
|
459
1114
|
*
|
|
460
|
-
* @param {string} domainId
|
|
461
|
-
* @param {string} recordId
|
|
462
|
-
* @param {string} name
|
|
463
|
-
* @param {string} value
|
|
464
|
-
* @param {number} ttl
|
|
465
|
-
* @param {string} comment
|
|
1115
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1116
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1117
|
+
* @param {string} params.name - Record name (subdomain) for the TXT record.
|
|
1118
|
+
* @param {string} params.value - TXT record value.
|
|
1119
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1120
|
+
* @param {string} params.comment - A comment for this record.
|
|
1121
|
+
* @throws {AppwriteException}
|
|
1122
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1123
|
+
*/
|
|
1124
|
+
updateRecordTXT(params: {
|
|
1125
|
+
domainId: string;
|
|
1126
|
+
recordId: string;
|
|
1127
|
+
name: string;
|
|
1128
|
+
value: string;
|
|
1129
|
+
ttl: number;
|
|
1130
|
+
comment?: string;
|
|
1131
|
+
}): Promise<Models.DnsRecord>;
|
|
1132
|
+
/**
|
|
1133
|
+
* Update an existing TXT record for the given domain.
|
|
1134
|
+
*
|
|
1135
|
+
* Update the TXT record details for a specific domain by providing the domain ID,
|
|
1136
|
+
* record ID, and the new record configuration including name, value, TTL, and an optional comment.
|
|
1137
|
+
*
|
|
1138
|
+
* @param {string} domainId - Domain unique ID.
|
|
1139
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1140
|
+
* @param {string} name - Record name (subdomain) for the TXT record.
|
|
1141
|
+
* @param {string} value - TXT record value.
|
|
1142
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1143
|
+
* @param {string} comment - A comment for this record.
|
|
466
1144
|
* @throws {AppwriteException}
|
|
467
1145
|
* @returns {Promise<Models.DnsRecord>}
|
|
1146
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
468
1147
|
*/
|
|
469
1148
|
updateRecordTXT(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
470
1149
|
/**
|
|
@@ -474,21 +1153,52 @@ export declare class Domains {
|
|
|
474
1153
|
* using its unique identifier. The record contains information about the DNS configuration
|
|
475
1154
|
* such as type, value, and TTL settings.
|
|
476
1155
|
*
|
|
477
|
-
* @param {string} domainId
|
|
478
|
-
* @param {string} recordId
|
|
1156
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1157
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
479
1158
|
* @throws {AppwriteException}
|
|
480
1159
|
* @returns {Promise<Models.DnsRecord>}
|
|
481
1160
|
*/
|
|
1161
|
+
getRecord(params: {
|
|
1162
|
+
domainId: string;
|
|
1163
|
+
recordId: string;
|
|
1164
|
+
}): Promise<Models.DnsRecord>;
|
|
1165
|
+
/**
|
|
1166
|
+
* Get a single DNS record for a given domain by record ID.
|
|
1167
|
+
*
|
|
1168
|
+
* This endpoint allows you to retrieve a specific DNS record associated with a domain
|
|
1169
|
+
* using its unique identifier. The record contains information about the DNS configuration
|
|
1170
|
+
* such as type, value, and TTL settings.
|
|
1171
|
+
*
|
|
1172
|
+
* @param {string} domainId - Domain unique ID.
|
|
1173
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1174
|
+
* @throws {AppwriteException}
|
|
1175
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1176
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1177
|
+
*/
|
|
482
1178
|
getRecord(domainId: string, recordId: string): Promise<Models.DnsRecord>;
|
|
483
1179
|
/**
|
|
484
1180
|
* Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
|
|
485
1181
|
* from a specific domain.
|
|
486
1182
|
*
|
|
487
|
-
* @param {string} domainId
|
|
488
|
-
* @param {string} recordId
|
|
1183
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1184
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
489
1185
|
* @throws {AppwriteException}
|
|
490
1186
|
* @returns {Promise<{}>}
|
|
491
1187
|
*/
|
|
1188
|
+
deleteRecord(params: {
|
|
1189
|
+
domainId: string;
|
|
1190
|
+
recordId: string;
|
|
1191
|
+
}): Promise<{}>;
|
|
1192
|
+
/**
|
|
1193
|
+
* Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
|
|
1194
|
+
* from a specific domain.
|
|
1195
|
+
*
|
|
1196
|
+
* @param {string} domainId - Domain unique ID.
|
|
1197
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1198
|
+
* @throws {AppwriteException}
|
|
1199
|
+
* @returns {Promise<{}>}
|
|
1200
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1201
|
+
*/
|
|
492
1202
|
deleteRecord(domainId: string, recordId: string): Promise<{}>;
|
|
493
1203
|
/**
|
|
494
1204
|
* Update the team ID for a specific domain. This endpoint requires admin access.
|
|
@@ -496,29 +1206,71 @@ export declare class Domains {
|
|
|
496
1206
|
* Updating the team ID will transfer ownership and access control of the domain
|
|
497
1207
|
* and all its DNS records to the new team.
|
|
498
1208
|
*
|
|
499
|
-
* @param {string} domainId
|
|
500
|
-
* @param {string} teamId
|
|
1209
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1210
|
+
* @param {string} params.teamId - New team unique ID.
|
|
1211
|
+
* @throws {AppwriteException}
|
|
1212
|
+
* @returns {Promise<Models.Domain>}
|
|
1213
|
+
*/
|
|
1214
|
+
updateTeam(params: {
|
|
1215
|
+
domainId: string;
|
|
1216
|
+
teamId: string;
|
|
1217
|
+
}): Promise<Models.Domain>;
|
|
1218
|
+
/**
|
|
1219
|
+
* Update the team ID for a specific domain. This endpoint requires admin access.
|
|
1220
|
+
*
|
|
1221
|
+
* Updating the team ID will transfer ownership and access control of the domain
|
|
1222
|
+
* and all its DNS records to the new team.
|
|
1223
|
+
*
|
|
1224
|
+
* @param {string} domainId - Domain unique ID.
|
|
1225
|
+
* @param {string} teamId - New team unique ID.
|
|
501
1226
|
* @throws {AppwriteException}
|
|
502
1227
|
* @returns {Promise<Models.Domain>}
|
|
1228
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
503
1229
|
*/
|
|
504
1230
|
updateTeam(domainId: string, teamId: string): Promise<Models.Domain>;
|
|
505
1231
|
/**
|
|
506
1232
|
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
507
1233
|
* zone file in a standardized format that can be used to configure DNS servers.
|
|
508
1234
|
*
|
|
509
|
-
* @param {string} domainId
|
|
1235
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1236
|
+
* @throws {AppwriteException}
|
|
1237
|
+
* @returns {Promise<{}>}
|
|
1238
|
+
*/
|
|
1239
|
+
getZone(params: {
|
|
1240
|
+
domainId: string;
|
|
1241
|
+
}): Promise<{}>;
|
|
1242
|
+
/**
|
|
1243
|
+
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
1244
|
+
* zone file in a standardized format that can be used to configure DNS servers.
|
|
1245
|
+
*
|
|
1246
|
+
* @param {string} domainId - Domain unique ID.
|
|
510
1247
|
* @throws {AppwriteException}
|
|
511
1248
|
* @returns {Promise<{}>}
|
|
1249
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
512
1250
|
*/
|
|
513
1251
|
getZone(domainId: string): Promise<{}>;
|
|
514
1252
|
/**
|
|
515
1253
|
* Update the DNS zone for the given domain using the provided zone file content.
|
|
516
1254
|
* All parsed records are imported and then the main domain document is returned.
|
|
517
1255
|
*
|
|
518
|
-
* @param {string} domainId
|
|
519
|
-
* @param {string} content
|
|
1256
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1257
|
+
* @param {string} params.content - DNS zone file content as a string.
|
|
1258
|
+
* @throws {AppwriteException}
|
|
1259
|
+
* @returns {Promise<Models.Domain>}
|
|
1260
|
+
*/
|
|
1261
|
+
updateZone(params: {
|
|
1262
|
+
domainId: string;
|
|
1263
|
+
content: string;
|
|
1264
|
+
}): Promise<Models.Domain>;
|
|
1265
|
+
/**
|
|
1266
|
+
* Update the DNS zone for the given domain using the provided zone file content.
|
|
1267
|
+
* All parsed records are imported and then the main domain document is returned.
|
|
1268
|
+
*
|
|
1269
|
+
* @param {string} domainId - Domain unique ID.
|
|
1270
|
+
* @param {string} content - DNS zone file content as a string.
|
|
520
1271
|
* @throws {AppwriteException}
|
|
521
1272
|
* @returns {Promise<Models.Domain>}
|
|
1273
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
522
1274
|
*/
|
|
523
1275
|
updateZone(domainId: string, content: string): Promise<Models.Domain>;
|
|
524
1276
|
}
|