@appwrite.io/console 1.9.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yml +9 -8
- package/CHANGELOG.md +51 -6
- package/LICENSE +1 -1
- package/README.md +84 -4
- package/dist/cjs/sdk.js +15258 -6036
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +15256 -6037
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +15258 -6036
- package/docs/examples/account/create-billing-address.md +8 -8
- package/docs/examples/account/create-email-password-session.md +4 -4
- package/docs/examples/account/create-email-token.md +5 -5
- package/docs/examples/account/{update-magic-u-r-l-session.md → create-email-verification.md} +3 -4
- package/docs/examples/account/{update-m-f-a.md → create-jwt.md} +3 -3
- package/docs/examples/account/{create-magic-u-r-l-token.md → create-magic-url-token.md} +6 -6
- package/docs/examples/account/create-mfa-authenticator.md +3 -3
- package/docs/examples/account/create-mfa-challenge.md +3 -3
- package/docs/examples/account/create-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-o-auth2token.md → create-o-auth-2-session.md} +6 -6
- package/docs/examples/account/{create-o-auth2session.md → create-o-auth-2-token.md} +6 -6
- package/docs/examples/account/create-phone-token.md +4 -4
- package/docs/examples/account/create-push-target.md +5 -5
- package/docs/examples/account/create-recovery.md +4 -4
- package/docs/examples/account/create-session.md +4 -4
- package/docs/examples/account/create-verification.md +3 -3
- package/docs/examples/account/create.md +6 -6
- package/docs/examples/account/delete-billing-address.md +3 -3
- package/docs/examples/account/delete-identity.md +3 -3
- package/docs/examples/account/delete-mfa-authenticator.md +3 -3
- package/docs/examples/account/delete-payment-method.md +3 -3
- package/docs/examples/account/delete-push-target.md +3 -3
- package/docs/examples/account/delete-session.md +3 -3
- package/docs/examples/account/get-billing-address.md +3 -3
- package/docs/examples/account/get-coupon.md +3 -3
- package/docs/examples/account/get-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/get-payment-method.md +3 -3
- package/docs/examples/account/get-session.md +3 -3
- package/docs/examples/account/list-billing-addresses.md +3 -3
- package/docs/examples/account/list-identities.md +4 -3
- package/docs/examples/account/list-invoices.md +3 -3
- package/docs/examples/account/list-logs.md +4 -3
- package/docs/examples/account/list-mfa-factors.md +1 -1
- package/docs/examples/account/list-payment-methods.md +3 -3
- package/docs/examples/account/update-billing-address.md +9 -9
- package/docs/examples/account/update-email-verification.md +14 -0
- package/docs/examples/account/update-email.md +4 -4
- package/docs/examples/account/update-magic-url-session.md +14 -0
- package/docs/examples/account/update-mfa-authenticator.md +4 -4
- package/docs/examples/account/update-mfa-challenge.md +4 -4
- package/docs/examples/account/update-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-j-w-t.md → update-mfa.md} +3 -1
- package/docs/examples/account/update-name.md +3 -3
- package/docs/examples/account/update-password.md +4 -4
- package/docs/examples/account/update-payment-method-mandate-options.md +3 -3
- package/docs/examples/account/update-payment-method-provider.md +6 -5
- package/docs/examples/account/update-payment-method.md +6 -5
- package/docs/examples/account/update-phone-session.md +4 -4
- package/docs/examples/account/update-phone-verification.md +4 -4
- package/docs/examples/account/update-phone.md +4 -4
- package/docs/examples/account/update-prefs.md +7 -3
- package/docs/examples/account/update-push-target.md +4 -4
- package/docs/examples/account/update-recovery.md +5 -5
- package/docs/examples/account/update-session.md +3 -3
- package/docs/examples/account/update-verification.md +4 -4
- package/docs/examples/assistant/chat.md +3 -3
- package/docs/examples/avatars/get-browser.md +6 -6
- package/docs/examples/avatars/get-credit-card.md +6 -6
- package/docs/examples/avatars/get-favicon.md +3 -3
- package/docs/examples/avatars/get-flag.md +6 -6
- package/docs/examples/avatars/get-image.md +5 -5
- package/docs/examples/avatars/get-initials.md +6 -6
- package/docs/examples/avatars/{get-q-r.md → get-qr.md} +6 -6
- package/docs/examples/avatars/get-screenshot.md +35 -0
- package/docs/examples/backups/create-archive.md +4 -4
- package/docs/examples/backups/create-policy.md +9 -9
- package/docs/examples/backups/create-restoration.md +6 -6
- package/docs/examples/backups/delete-archive.md +3 -3
- package/docs/examples/backups/delete-policy.md +3 -3
- package/docs/examples/backups/get-archive.md +3 -3
- package/docs/examples/backups/get-policy.md +3 -3
- package/docs/examples/backups/get-restoration.md +3 -3
- package/docs/examples/backups/list-archives.md +3 -3
- package/docs/examples/backups/list-policies.md +3 -3
- package/docs/examples/backups/list-restorations.md +3 -3
- package/docs/examples/backups/update-policy.md +7 -7
- package/docs/examples/console/create-program-membership.md +3 -3
- package/docs/examples/console/create-source.md +7 -7
- package/docs/examples/console/get-campaign.md +3 -3
- package/docs/examples/console/get-coupon.md +3 -3
- package/docs/examples/console/{plans.md → get-plan.md} +3 -1
- package/docs/examples/console/get-plans.md +13 -0
- package/docs/examples/console/{regions.md → get-program.md} +3 -1
- package/docs/examples/console/get-regions.md +13 -0
- package/docs/examples/console/get-resource.md +4 -4
- package/docs/examples/console/suggest-columns.md +17 -0
- package/docs/examples/console/suggest-indexes.md +16 -0
- package/docs/examples/databases/create-boolean-attribute.md +8 -8
- package/docs/examples/databases/create-collection.md +11 -9
- package/docs/examples/databases/create-datetime-attribute.md +8 -8
- package/docs/examples/databases/create-document.md +16 -11
- package/docs/examples/databases/create-documents.md +7 -6
- package/docs/examples/databases/create-email-attribute.md +8 -8
- package/docs/examples/databases/create-enum-attribute.md +9 -9
- package/docs/examples/databases/create-float-attribute.md +10 -10
- package/docs/examples/databases/create-index.md +9 -9
- package/docs/examples/databases/create-integer-attribute.md +10 -10
- package/docs/examples/databases/create-ip-attribute.md +8 -8
- package/docs/examples/databases/create-line-attribute.md +17 -0
- package/docs/examples/databases/create-operations.md +24 -0
- package/docs/examples/databases/create-point-attribute.md +17 -0
- package/docs/examples/databases/create-polygon-attribute.md +17 -0
- package/docs/examples/databases/create-relationship-attribute.md +10 -10
- package/docs/examples/databases/create-string-attribute.md +10 -10
- package/docs/examples/databases/create-transaction.md +13 -0
- package/docs/examples/databases/create-url-attribute.md +8 -8
- package/docs/examples/databases/create.md +5 -5
- package/docs/examples/databases/decrement-document-attribute.md +9 -8
- package/docs/examples/databases/delete-attribute.md +5 -5
- package/docs/examples/databases/delete-collection.md +4 -4
- package/docs/examples/databases/delete-document.md +6 -5
- package/docs/examples/databases/delete-documents.md +6 -5
- package/docs/examples/databases/delete-index.md +5 -5
- package/docs/examples/databases/{get-database-usage.md → delete-transaction.md} +4 -5
- package/docs/examples/databases/delete.md +3 -3
- package/docs/examples/databases/get-attribute.md +5 -5
- package/docs/examples/databases/get-collection-usage.md +6 -6
- package/docs/examples/databases/get-collection.md +4 -4
- package/docs/examples/databases/get-document.md +7 -6
- package/docs/examples/databases/get-index.md +5 -5
- package/docs/examples/databases/get-transaction.md +13 -0
- package/docs/examples/databases/get-usage.md +5 -4
- package/docs/examples/databases/get.md +3 -3
- package/docs/examples/databases/increment-document-attribute.md +9 -8
- package/docs/examples/databases/list-attributes.md +6 -5
- package/docs/examples/databases/list-collection-logs.md +5 -5
- package/docs/examples/databases/list-collections.md +6 -5
- package/docs/examples/databases/list-document-logs.md +6 -6
- package/docs/examples/databases/list-documents.md +7 -5
- package/docs/examples/databases/list-indexes.md +6 -5
- package/docs/examples/databases/list-logs.md +4 -4
- package/docs/examples/databases/list-transactions.md +13 -0
- package/docs/examples/databases/list-usage.md +13 -0
- package/docs/examples/databases/list.md +5 -4
- package/docs/examples/databases/update-boolean-attribute.md +8 -8
- package/docs/examples/databases/update-collection.md +9 -9
- package/docs/examples/databases/update-datetime-attribute.md +8 -8
- package/docs/examples/databases/update-document.md +15 -8
- package/docs/examples/databases/update-documents.md +13 -6
- package/docs/examples/databases/update-email-attribute.md +8 -8
- package/docs/examples/databases/update-enum-attribute.md +9 -9
- package/docs/examples/databases/update-float-attribute.md +10 -10
- package/docs/examples/databases/update-integer-attribute.md +10 -10
- package/docs/examples/databases/update-ip-attribute.md +8 -8
- package/docs/examples/databases/update-line-attribute.md +18 -0
- package/docs/examples/databases/update-point-attribute.md +18 -0
- package/docs/examples/databases/update-polygon-attribute.md +18 -0
- package/docs/examples/databases/update-relationship-attribute.md +7 -7
- package/docs/examples/databases/update-string-attribute.md +9 -9
- package/docs/examples/databases/update-transaction.md +15 -0
- package/docs/examples/databases/update-url-attribute.md +8 -8
- package/docs/examples/databases/update.md +5 -5
- package/docs/examples/databases/upsert-document.md +15 -8
- package/docs/examples/databases/upsert-documents.md +6 -5
- package/docs/examples/domains/create-preset-google-workspace.md +3 -3
- package/docs/examples/domains/create-preset-i-cloud.md +3 -3
- package/docs/examples/domains/create-preset-mailgun.md +3 -3
- package/docs/examples/domains/create-preset-outlook.md +3 -3
- package/docs/examples/domains/create-preset-proton-mail.md +3 -3
- package/docs/examples/domains/create-preset-zoho.md +3 -3
- package/docs/examples/domains/create-record-a.md +7 -7
- package/docs/examples/domains/{create-record-a-a-a-a.md → create-record-aaaa.md} +7 -7
- package/docs/examples/domains/create-record-alias.md +7 -7
- package/docs/examples/domains/{create-record-n-s.md → create-record-caa.md} +7 -7
- package/docs/examples/domains/{create-record-c-a-a.md → create-record-cname.md} +7 -7
- package/docs/examples/domains/{create-record-h-t-t-p-s.md → create-record-https.md} +7 -7
- package/docs/examples/domains/create-record-mx.md +18 -0
- package/docs/examples/domains/create-record-ns.md +17 -0
- package/docs/examples/domains/create-record-srv.md +20 -0
- package/docs/examples/domains/{create-record-c-n-a-m-e.md → create-record-txt.md} +7 -7
- package/docs/examples/domains/create.md +4 -4
- package/docs/examples/domains/delete-record.md +4 -4
- package/docs/examples/domains/delete.md +3 -3
- package/docs/examples/domains/get-preset-google-workspace.md +3 -3
- package/docs/examples/domains/get-preset-i-cloud.md +3 -3
- package/docs/examples/domains/get-preset-mailgun.md +3 -3
- package/docs/examples/domains/get-preset-outlook.md +3 -3
- package/docs/examples/domains/get-preset-proton-mail.md +3 -3
- package/docs/examples/domains/get-preset-zoho.md +3 -3
- package/docs/examples/domains/get-record.md +4 -4
- package/docs/examples/domains/get-zone.md +3 -3
- package/docs/examples/domains/get.md +3 -3
- package/docs/examples/domains/list-records.md +4 -4
- package/docs/examples/domains/list.md +4 -4
- package/docs/examples/domains/update-nameservers.md +3 -3
- package/docs/examples/domains/update-record-a.md +8 -8
- package/docs/examples/domains/update-record-aaaa.md +18 -0
- package/docs/examples/domains/update-record-alias.md +8 -8
- package/docs/examples/domains/update-record-caa.md +18 -0
- package/docs/examples/domains/update-record-cname.md +18 -0
- package/docs/examples/domains/update-record-https.md +18 -0
- package/docs/examples/domains/update-record-mx.md +19 -0
- package/docs/examples/domains/update-record-ns.md +18 -0
- package/docs/examples/domains/update-record-srv.md +21 -0
- package/docs/examples/domains/update-record-txt.md +18 -0
- package/docs/examples/domains/update-team.md +4 -4
- package/docs/examples/domains/update-zone.md +4 -4
- package/docs/examples/functions/create-deployment.md +7 -7
- package/docs/examples/functions/create-duplicate-deployment.md +5 -5
- package/docs/examples/functions/create-execution.md +9 -9
- package/docs/examples/functions/create-template-deployment.md +10 -9
- package/docs/examples/functions/create-variable.md +6 -6
- package/docs/examples/functions/create-vcs-deployment.md +7 -7
- package/docs/examples/functions/create.md +21 -21
- package/docs/examples/functions/delete-deployment.md +4 -4
- package/docs/examples/functions/delete-execution.md +4 -4
- package/docs/examples/functions/delete-variable.md +4 -4
- package/docs/examples/functions/delete.md +3 -3
- package/docs/examples/functions/get-deployment-download.md +5 -5
- package/docs/examples/functions/get-deployment.md +4 -4
- package/docs/examples/functions/get-execution.md +4 -4
- package/docs/examples/functions/get-template.md +3 -3
- package/docs/examples/functions/get-usage.md +5 -5
- package/docs/examples/functions/get-variable.md +4 -4
- package/docs/examples/functions/get.md +3 -3
- package/docs/examples/functions/list-deployments.md +6 -5
- package/docs/examples/functions/list-executions.md +5 -4
- package/docs/examples/functions/list-templates.md +7 -6
- package/docs/examples/functions/list-usage.md +4 -4
- package/docs/examples/functions/list-variables.md +3 -3
- package/docs/examples/functions/list.md +5 -4
- package/docs/examples/functions/update-deployment-status.md +4 -4
- package/docs/examples/functions/update-function-deployment.md +4 -4
- package/docs/examples/functions/update-variable.md +7 -7
- package/docs/examples/functions/update.md +21 -21
- package/docs/examples/graphql/mutation.md +3 -3
- package/docs/examples/graphql/query.md +3 -3
- package/docs/examples/health/get-certificate.md +3 -3
- package/docs/examples/health/get-failed-jobs.md +5 -5
- package/docs/examples/health/get-queue-billing-project-aggregation.md +3 -3
- package/docs/examples/health/get-queue-billing-team-aggregation.md +3 -3
- package/docs/examples/health/get-queue-builds.md +3 -3
- package/docs/examples/health/get-queue-certificates.md +3 -3
- package/docs/examples/health/get-queue-databases.md +4 -4
- package/docs/examples/health/get-queue-deletes.md +3 -3
- package/docs/examples/health/get-queue-functions.md +3 -3
- package/docs/examples/health/get-queue-logs.md +3 -3
- package/docs/examples/health/get-queue-mails.md +3 -3
- package/docs/examples/health/get-queue-messaging.md +3 -3
- package/docs/examples/health/get-queue-migrations.md +3 -3
- package/docs/examples/health/get-queue-priority-builds.md +3 -3
- package/docs/examples/health/get-queue-region-manager.md +3 -3
- package/docs/examples/health/get-queue-stats-resources.md +3 -3
- package/docs/examples/health/get-queue-threats.md +13 -0
- package/docs/examples/health/get-queue-usage.md +3 -3
- package/docs/examples/health/get-queue-webhooks.md +3 -3
- package/docs/examples/messaging/create-apns-provider.md +10 -10
- package/docs/examples/messaging/create-email.md +14 -14
- package/docs/examples/messaging/create-fcm-provider.md +6 -6
- package/docs/examples/messaging/create-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{create-msg91provider.md → create-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/create-push.md +21 -21
- package/docs/examples/messaging/create-resend-provider.md +20 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/create-sms.md +9 -9
- package/docs/examples/messaging/create-smtp-provider.md +16 -16
- package/docs/examples/messaging/create-subscriber.md +5 -5
- package/docs/examples/messaging/create-telesign-provider.md +8 -8
- package/docs/examples/messaging/create-textmagic-provider.md +8 -8
- package/docs/examples/messaging/create-topic.md +5 -5
- package/docs/examples/messaging/create-twilio-provider.md +8 -8
- package/docs/examples/messaging/create-vonage-provider.md +8 -8
- package/docs/examples/messaging/delete-provider.md +3 -3
- package/docs/examples/messaging/delete-subscriber.md +4 -4
- package/docs/examples/messaging/delete-topic.md +3 -3
- package/docs/examples/messaging/delete.md +3 -3
- package/docs/examples/messaging/get-message.md +3 -3
- package/docs/examples/messaging/get-provider.md +3 -3
- package/docs/examples/messaging/get-subscriber.md +4 -4
- package/docs/examples/messaging/get-topic.md +3 -3
- package/docs/examples/messaging/list-message-logs.md +5 -4
- package/docs/examples/messaging/list-messages.md +5 -4
- package/docs/examples/messaging/list-provider-logs.md +5 -4
- package/docs/examples/messaging/list-providers.md +5 -4
- package/docs/examples/messaging/list-subscriber-logs.md +5 -4
- package/docs/examples/messaging/list-subscribers.md +6 -5
- package/docs/examples/messaging/list-targets.md +5 -4
- package/docs/examples/messaging/list-topic-logs.md +5 -4
- package/docs/examples/messaging/list-topics.md +5 -4
- package/docs/examples/messaging/update-apns-provider.md +10 -10
- package/docs/examples/messaging/update-email.md +14 -14
- package/docs/examples/messaging/update-fcm-provider.md +6 -6
- package/docs/examples/messaging/update-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{update-msg91provider.md → update-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/update-push.md +21 -21
- package/docs/examples/messaging/update-resend-provider.md +20 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/update-sms.md +9 -9
- package/docs/examples/messaging/update-smtp-provider.md +16 -16
- package/docs/examples/messaging/update-telesign-provider.md +8 -8
- package/docs/examples/messaging/update-textmagic-provider.md +8 -8
- package/docs/examples/messaging/update-topic.md +5 -5
- package/docs/examples/messaging/update-twilio-provider.md +8 -8
- package/docs/examples/messaging/update-vonage-provider.md +8 -8
- package/docs/examples/migrations/create-appwrite-migration.md +6 -6
- package/docs/examples/migrations/create-csv-export.md +21 -0
- package/docs/examples/migrations/{create-csv-migration.md → create-csv-import.md} +6 -5
- package/docs/examples/migrations/create-firebase-migration.md +4 -4
- package/docs/examples/migrations/create-n-host-migration.md +10 -10
- package/docs/examples/migrations/create-supabase-migration.md +9 -9
- package/docs/examples/migrations/delete.md +3 -3
- package/docs/examples/migrations/get-appwrite-report.md +6 -6
- package/docs/examples/migrations/get-firebase-report.md +4 -4
- package/docs/examples/migrations/get-n-host-report.md +10 -10
- package/docs/examples/migrations/get-supabase-report.md +9 -9
- package/docs/examples/migrations/get.md +3 -3
- package/docs/examples/migrations/list.md +5 -4
- package/docs/examples/migrations/retry.md +3 -3
- package/docs/examples/organizations/add-credit.md +4 -4
- package/docs/examples/organizations/cancel-downgrade.md +3 -3
- package/docs/examples/organizations/create-downgrade-feedback.md +17 -0
- package/docs/examples/organizations/create-invoice-payment.md +5 -5
- package/docs/examples/organizations/create.md +13 -12
- package/docs/examples/organizations/delete-backup-payment-method.md +3 -3
- package/docs/examples/organizations/delete-billing-address.md +3 -3
- package/docs/examples/organizations/delete-default-payment-method.md +3 -3
- package/docs/examples/organizations/delete.md +3 -3
- package/docs/examples/organizations/estimation-create-organization.md +8 -7
- package/docs/examples/organizations/estimation-delete-organization.md +3 -3
- package/docs/examples/organizations/estimation-update-plan.md +7 -7
- package/docs/examples/organizations/get-aggregation.md +6 -4
- package/docs/examples/organizations/get-available-credits.md +13 -0
- package/docs/examples/organizations/get-billing-address.md +4 -4
- package/docs/examples/organizations/get-credit.md +4 -4
- package/docs/examples/organizations/get-invoice-download.md +4 -4
- package/docs/examples/organizations/get-invoice-view.md +4 -4
- package/docs/examples/organizations/get-invoice.md +4 -4
- package/docs/examples/organizations/get-payment-method.md +4 -4
- package/docs/examples/organizations/get-plan.md +3 -3
- package/docs/examples/organizations/get-scopes.md +3 -3
- package/docs/examples/organizations/get-usage.md +5 -5
- package/docs/examples/organizations/list-aggregations.md +4 -4
- package/docs/examples/organizations/list-credits.md +4 -4
- package/docs/examples/organizations/list-invoices.md +4 -4
- package/docs/examples/organizations/list.md +4 -4
- package/docs/examples/organizations/set-backup-payment-method.md +4 -4
- package/docs/examples/organizations/set-billing-address.md +4 -4
- package/docs/examples/organizations/set-billing-email.md +4 -4
- package/docs/examples/organizations/set-billing-tax-id.md +4 -4
- package/docs/examples/organizations/set-default-payment-method.md +4 -4
- package/docs/examples/organizations/update-budget.md +5 -5
- package/docs/examples/organizations/update-plan.md +11 -11
- package/docs/examples/organizations/update-projects.md +14 -0
- package/docs/examples/organizations/validate-invoice.md +4 -4
- package/docs/examples/organizations/validate-payment.md +4 -4
- package/docs/examples/project/create-variable.md +5 -5
- package/docs/examples/project/delete-variable.md +3 -3
- package/docs/examples/project/get-usage.md +5 -5
- package/docs/examples/project/get-variable.md +3 -3
- package/docs/examples/project/update-variable.md +6 -6
- package/docs/examples/projects/create-dev-key.md +5 -5
- package/docs/examples/projects/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/projects/create-key.md +6 -6
- package/docs/examples/projects/create-platform.md +8 -8
- package/docs/examples/projects/create-smtp-test.md +12 -12
- package/docs/examples/projects/create-webhook.md +10 -10
- package/docs/examples/projects/create.md +16 -16
- package/docs/examples/projects/delete-dev-key.md +4 -4
- package/docs/examples/projects/delete-email-template.md +5 -5
- package/docs/examples/projects/delete-key.md +4 -4
- package/docs/examples/projects/delete-platform.md +4 -4
- package/docs/examples/projects/delete-sms-template.md +5 -5
- package/docs/examples/projects/delete-webhook.md +4 -4
- package/docs/examples/projects/delete.md +3 -3
- package/docs/examples/projects/get-dev-key.md +4 -4
- package/docs/examples/projects/get-email-template.md +5 -5
- package/docs/examples/projects/get-key.md +4 -4
- package/docs/examples/projects/get-platform.md +4 -4
- package/docs/examples/projects/get-sms-template.md +5 -5
- package/docs/examples/projects/get-webhook.md +4 -4
- package/docs/examples/projects/get.md +3 -3
- package/docs/examples/projects/list-dev-keys.md +4 -4
- package/docs/examples/projects/list-keys.md +4 -3
- package/docs/examples/projects/list-platforms.md +4 -3
- package/docs/examples/projects/list-webhooks.md +4 -3
- package/docs/examples/projects/list.md +5 -4
- package/docs/examples/projects/update-api-status-all.md +4 -4
- package/docs/examples/projects/update-api-status.md +6 -6
- package/docs/examples/projects/update-auth-duration.md +4 -4
- package/docs/examples/projects/update-auth-limit.md +4 -4
- package/docs/examples/projects/update-auth-password-dictionary.md +4 -4
- package/docs/examples/projects/update-auth-password-history.md +4 -4
- package/docs/examples/projects/update-auth-sessions-limit.md +4 -4
- package/docs/examples/projects/update-auth-status.md +5 -5
- package/docs/examples/projects/update-dev-key.md +6 -6
- package/docs/examples/projects/update-email-template.md +10 -10
- package/docs/examples/projects/update-key.md +7 -7
- package/docs/examples/projects/update-memberships-privacy.md +6 -6
- package/docs/examples/projects/update-mock-numbers.md +4 -4
- package/docs/examples/projects/{update-o-auth2.md → update-o-auth-2.md} +7 -7
- package/docs/examples/projects/update-personal-data-check.md +4 -4
- package/docs/examples/projects/update-platform.md +8 -8
- package/docs/examples/projects/update-service-status-all.md +4 -4
- package/docs/examples/projects/update-service-status.md +5 -5
- package/docs/examples/projects/update-session-alerts.md +4 -4
- package/docs/examples/projects/update-session-invalidation.md +14 -0
- package/docs/examples/projects/update-sms-template.md +6 -6
- package/docs/examples/projects/update-smtp.md +12 -12
- package/docs/examples/projects/update-status.md +14 -0
- package/docs/examples/projects/update-team.md +4 -4
- package/docs/examples/projects/update-webhook-signature.md +4 -4
- package/docs/examples/projects/update-webhook.md +11 -11
- package/docs/examples/projects/update.md +13 -13
- package/docs/examples/proxy/{create-a-p-i-rule.md → create-api-rule.md} +3 -3
- package/docs/examples/proxy/create-function-rule.md +5 -5
- package/docs/examples/proxy/create-redirect-rule.md +8 -8
- package/docs/examples/proxy/create-site-rule.md +5 -5
- package/docs/examples/proxy/delete-rule.md +3 -3
- package/docs/examples/proxy/get-rule.md +3 -3
- package/docs/examples/proxy/list-rules.md +5 -4
- package/docs/examples/proxy/update-rule-verification.md +3 -3
- package/docs/examples/sites/create-deployment.md +8 -8
- package/docs/examples/sites/create-duplicate-deployment.md +4 -4
- package/docs/examples/sites/create-template-deployment.md +10 -9
- package/docs/examples/sites/create-variable.md +6 -6
- package/docs/examples/sites/create-vcs-deployment.md +7 -7
- package/docs/examples/sites/create.md +21 -21
- package/docs/examples/sites/delete-deployment.md +4 -4
- package/docs/examples/sites/delete-log.md +4 -4
- package/docs/examples/sites/delete-variable.md +4 -4
- package/docs/examples/sites/delete.md +3 -3
- package/docs/examples/sites/get-deployment-download.md +5 -5
- package/docs/examples/sites/get-deployment.md +4 -4
- package/docs/examples/sites/get-log.md +4 -4
- package/docs/examples/sites/get-template.md +3 -3
- package/docs/examples/sites/get-usage.md +5 -5
- package/docs/examples/sites/get-variable.md +4 -4
- package/docs/examples/sites/get.md +3 -3
- package/docs/examples/sites/list-deployments.md +6 -5
- package/docs/examples/sites/list-logs.md +5 -4
- package/docs/examples/sites/list-templates.md +6 -6
- package/docs/examples/sites/list-usage.md +4 -4
- package/docs/examples/sites/list-variables.md +3 -3
- package/docs/examples/sites/list.md +5 -4
- package/docs/examples/sites/update-deployment-status.md +4 -4
- package/docs/examples/sites/update-site-deployment.md +4 -4
- package/docs/examples/sites/update-variable.md +7 -7
- package/docs/examples/sites/update.md +21 -21
- package/docs/examples/storage/create-bucket.md +14 -13
- package/docs/examples/storage/create-file.md +7 -7
- package/docs/examples/storage/delete-bucket.md +3 -3
- package/docs/examples/storage/delete-file.md +4 -4
- package/docs/examples/storage/get-bucket-usage.md +5 -5
- package/docs/examples/storage/get-bucket.md +3 -3
- package/docs/examples/storage/get-file-download.md +5 -5
- package/docs/examples/storage/get-file-preview.md +16 -16
- package/docs/examples/storage/get-file-view.md +5 -5
- package/docs/examples/storage/get-file.md +4 -4
- package/docs/examples/storage/get-usage.md +4 -4
- package/docs/examples/storage/list-buckets.md +5 -4
- package/docs/examples/storage/list-files.md +6 -5
- package/docs/examples/storage/update-bucket.md +14 -13
- package/docs/examples/storage/update-file.md +7 -7
- package/docs/examples/tablesdb/create-boolean-column.md +18 -0
- package/docs/examples/tablesdb/create-datetime-column.md +18 -0
- package/docs/examples/tablesdb/create-email-column.md +18 -0
- package/docs/examples/tablesdb/create-enum-column.md +19 -0
- package/docs/examples/tablesdb/create-float-column.md +20 -0
- package/docs/examples/tablesdb/create-index.md +19 -0
- package/docs/examples/tablesdb/create-integer-column.md +20 -0
- package/docs/examples/tablesdb/create-ip-column.md +18 -0
- package/docs/examples/tablesdb/create-line-column.md +17 -0
- package/docs/examples/tablesdb/create-operations.md +24 -0
- package/docs/examples/tablesdb/create-point-column.md +17 -0
- package/docs/examples/tablesdb/create-polygon-column.md +17 -0
- package/docs/examples/tablesdb/create-relationship-column.md +20 -0
- package/docs/examples/tablesdb/create-row.md +24 -0
- package/docs/examples/tablesdb/create-rows.md +16 -0
- package/docs/examples/tablesdb/create-string-column.md +20 -0
- package/docs/examples/tablesdb/create-table.md +20 -0
- package/docs/examples/tablesdb/create-transaction.md +13 -0
- package/docs/examples/tablesdb/create-url-column.md +18 -0
- package/docs/examples/tablesdb/create.md +15 -0
- package/docs/examples/tablesdb/decrement-row-column.md +19 -0
- package/docs/examples/tablesdb/delete-column.md +15 -0
- package/docs/examples/tablesdb/delete-index.md +15 -0
- package/docs/examples/tablesdb/delete-row.md +16 -0
- package/docs/examples/tablesdb/delete-rows.md +16 -0
- package/docs/examples/tablesdb/delete-table.md +14 -0
- package/docs/examples/tablesdb/delete-transaction.md +13 -0
- package/docs/examples/tablesdb/delete.md +13 -0
- package/docs/examples/tablesdb/get-column.md +15 -0
- package/docs/examples/tablesdb/get-index.md +15 -0
- package/docs/examples/tablesdb/get-row.md +17 -0
- package/docs/examples/tablesdb/get-table-usage.md +15 -0
- package/docs/examples/tablesdb/get-table.md +14 -0
- package/docs/examples/tablesdb/get-transaction.md +13 -0
- package/docs/examples/tablesdb/get-usage.md +14 -0
- package/docs/examples/tablesdb/get.md +13 -0
- package/docs/examples/tablesdb/increment-row-column.md +19 -0
- package/docs/examples/tablesdb/list-columns.md +16 -0
- package/docs/examples/tablesdb/list-indexes.md +16 -0
- package/docs/examples/tablesdb/list-row-logs.md +16 -0
- package/docs/examples/tablesdb/list-rows.md +17 -0
- package/docs/examples/tablesdb/list-table-logs.md +15 -0
- package/docs/examples/tablesdb/list-tables.md +16 -0
- package/docs/examples/tablesdb/list-transactions.md +13 -0
- package/docs/examples/tablesdb/list-usage.md +13 -0
- package/docs/examples/tablesdb/list.md +15 -0
- package/docs/examples/tablesdb/update-boolean-column.md +18 -0
- package/docs/examples/tablesdb/update-datetime-column.md +18 -0
- package/docs/examples/tablesdb/update-email-column.md +18 -0
- package/docs/examples/tablesdb/update-enum-column.md +19 -0
- package/docs/examples/tablesdb/update-float-column.md +20 -0
- package/docs/examples/tablesdb/update-integer-column.md +20 -0
- package/docs/examples/tablesdb/update-ip-column.md +18 -0
- package/docs/examples/tablesdb/update-line-column.md +18 -0
- package/docs/examples/tablesdb/update-point-column.md +18 -0
- package/docs/examples/tablesdb/update-polygon-column.md +18 -0
- package/docs/examples/tablesdb/update-relationship-column.md +17 -0
- package/docs/examples/tablesdb/update-row.md +24 -0
- package/docs/examples/tablesdb/update-rows.md +23 -0
- package/docs/examples/tablesdb/update-string-column.md +19 -0
- package/docs/examples/tablesdb/update-table.md +18 -0
- package/docs/examples/tablesdb/update-transaction.md +15 -0
- package/docs/examples/tablesdb/update-url-column.md +18 -0
- package/docs/examples/tablesdb/update.md +15 -0
- package/docs/examples/tablesdb/upsert-row.md +24 -0
- package/docs/examples/tablesdb/upsert-rows.md +16 -0
- package/docs/examples/teams/create-membership.md +9 -9
- package/docs/examples/teams/create.md +5 -5
- package/docs/examples/teams/delete-membership.md +4 -4
- package/docs/examples/teams/delete.md +3 -3
- package/docs/examples/teams/get-membership.md +4 -4
- package/docs/examples/teams/get-prefs.md +3 -3
- package/docs/examples/teams/get.md +3 -3
- package/docs/examples/teams/list-logs.md +5 -4
- package/docs/examples/teams/list-memberships.md +6 -5
- package/docs/examples/teams/list.md +5 -4
- package/docs/examples/teams/update-membership-status.md +6 -6
- package/docs/examples/teams/update-membership.md +5 -5
- package/docs/examples/teams/update-name.md +4 -4
- package/docs/examples/teams/update-prefs.md +4 -4
- package/docs/examples/tokens/create-file-token.md +5 -5
- package/docs/examples/tokens/delete.md +3 -3
- package/docs/examples/tokens/get.md +3 -3
- package/docs/examples/tokens/list.md +6 -5
- package/docs/examples/tokens/update.md +4 -4
- package/docs/examples/users/{create-m-d5user.md → create-argon-2-user.md} +6 -6
- package/docs/examples/users/create-bcrypt-user.md +6 -6
- package/docs/examples/users/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/users/{create-argon2user.md → create-md-5-user.md} +6 -6
- package/docs/examples/users/create-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/{create-p-h-pass-user.md → create-ph-pass-user.md} +6 -6
- package/docs/examples/users/create-scrypt-modified-user.md +9 -9
- package/docs/examples/users/create-scrypt-user.md +11 -11
- package/docs/examples/users/create-session.md +3 -3
- package/docs/examples/users/{create-s-h-a-user.md → create-sha-user.md} +7 -7
- package/docs/examples/users/create-target.md +8 -8
- package/docs/examples/users/create-token.md +5 -5
- package/docs/examples/users/create.md +7 -7
- package/docs/examples/users/delete-identity.md +3 -3
- package/docs/examples/users/delete-mfa-authenticator.md +4 -4
- package/docs/examples/users/delete-session.md +4 -4
- package/docs/examples/users/delete-sessions.md +3 -3
- package/docs/examples/users/delete-target.md +4 -4
- package/docs/examples/users/delete.md +3 -3
- package/docs/examples/users/get-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/get-prefs.md +3 -3
- package/docs/examples/users/get-target.md +4 -4
- package/docs/examples/users/get-usage.md +4 -4
- package/docs/examples/users/get.md +3 -3
- package/docs/examples/users/list-identities.md +5 -4
- package/docs/examples/users/list-logs.md +5 -4
- package/docs/examples/users/list-memberships.md +6 -5
- package/docs/examples/users/list-mfa-factors.md +3 -3
- package/docs/examples/users/list-sessions.md +4 -3
- package/docs/examples/users/list-targets.md +5 -4
- package/docs/examples/users/list.md +5 -4
- package/docs/examples/users/update-email-verification.md +4 -4
- package/docs/examples/users/update-email.md +4 -4
- package/docs/examples/users/update-labels.md +4 -4
- package/docs/examples/users/update-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/update-mfa.md +4 -4
- package/docs/examples/users/update-name.md +4 -4
- package/docs/examples/users/update-password.md +4 -4
- package/docs/examples/users/update-phone-verification.md +4 -4
- package/docs/examples/users/update-phone.md +4 -4
- package/docs/examples/users/update-prefs.md +4 -4
- package/docs/examples/users/update-status.md +4 -4
- package/docs/examples/users/update-target.md +7 -7
- package/docs/examples/vcs/create-repository-detection.md +6 -6
- package/docs/examples/vcs/create-repository.md +5 -5
- package/docs/examples/vcs/delete-installation.md +3 -3
- package/docs/examples/vcs/get-installation.md +3 -3
- package/docs/examples/vcs/get-repository-contents.md +6 -5
- package/docs/examples/vcs/get-repository.md +4 -4
- package/docs/examples/vcs/list-installations.md +5 -4
- package/docs/examples/vcs/list-repositories.md +6 -5
- package/docs/examples/vcs/list-repository-branches.md +4 -4
- package/docs/examples/vcs/update-external-deployments.md +5 -5
- package/package.json +4 -4
- package/src/client.ts +42 -7
- package/src/enums/api-service.ts +1 -0
- package/src/enums/attribute-status.ts +7 -0
- package/src/enums/billing-plan-group.ts +5 -0
- package/src/enums/build-runtime.ts +2 -0
- package/src/enums/column-status.ts +7 -0
- package/src/enums/credit-card.ts +1 -1
- package/src/enums/database-type.ts +4 -0
- package/src/enums/deployment-status.ts +7 -0
- package/src/enums/execution-method.ts +1 -0
- package/src/enums/execution-status.ts +7 -0
- package/src/enums/execution-trigger.ts +5 -0
- package/src/enums/framework.ts +1 -0
- package/src/enums/health-antivirus-status.ts +5 -0
- package/src/enums/health-check-status.ts +4 -0
- package/src/enums/index-status.ts +7 -0
- package/src/enums/index-type.ts +1 -0
- package/src/enums/message-status.ts +7 -0
- package/src/enums/o-auth-provider.ts +3 -0
- package/src/enums/platform.ts +4 -0
- package/src/enums/proxy-rule-deployment-resource-type.ts +4 -0
- package/src/enums/proxy-rule-status.ts +6 -0
- package/src/enums/region.ts +3 -0
- package/src/enums/runtime.ts +2 -0
- package/src/enums/status.ts +4 -0
- package/src/enums/template-reference-type.ts +5 -0
- package/src/enums/theme.ts +4 -0
- package/src/enums/timezone.ts +421 -0
- package/src/enums/{user-usage-range.ts → usage-range.ts} +1 -1
- package/src/enums/{v-c-s-deployment-type.ts → vcs-reference-type.ts} +1 -1
- package/src/index.ts +27 -11
- package/src/models.ts +1925 -239
- package/src/operator.ts +308 -0
- package/src/query.ts +246 -2
- package/src/services/account.ts +2278 -235
- package/src/services/assistant.ts +29 -3
- package/src/services/avatars.ts +511 -52
- package/src/services/backups.ts +400 -42
- package/src/services/console.ts +499 -19
- package/src/services/databases.ts +3584 -430
- package/src/services/domains.ts +1795 -266
- package/src/services/functions.ts +1197 -155
- package/src/services/graphql.ts +56 -4
- package/src/services/health.ts +586 -42
- package/src/services/locale.ts +18 -2
- package/src/services/messaging.ts +3418 -386
- package/src/services/migrations.ts +653 -65
- package/src/services/organizations.ts +1411 -126
- package/src/services/project.ts +173 -17
- package/src/services/projects.ts +2808 -282
- package/src/services/proxy.ts +272 -26
- package/src/services/realtime.ts +437 -0
- package/src/services/sites.ts +1129 -143
- package/src/services/storage.ts +672 -89
- package/src/services/tables-db.ts +5439 -0
- package/src/services/teams.ts +535 -65
- package/src/services/tokens.ts +171 -16
- package/src/services/users.ts +1916 -182
- package/src/services/vcs.ts +373 -41
- package/types/client.d.ts +14 -5
- package/types/enums/api-service.d.ts +1 -0
- package/types/enums/attribute-status.d.ts +7 -0
- package/types/enums/billing-plan-group.d.ts +5 -0
- package/types/enums/build-runtime.d.ts +3 -1
- package/types/enums/column-status.d.ts +7 -0
- package/types/enums/credit-card.d.ts +1 -1
- package/types/enums/database-type.d.ts +4 -0
- package/types/enums/deployment-status.d.ts +7 -0
- package/types/enums/execution-method.d.ts +2 -1
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/framework.d.ts +1 -0
- package/types/enums/health-antivirus-status.d.ts +5 -0
- package/types/enums/health-check-status.d.ts +4 -0
- package/types/enums/index-status.d.ts +7 -0
- package/types/enums/index-type.d.ts +2 -1
- package/types/enums/message-status.d.ts +7 -0
- package/types/enums/o-auth-provider.d.ts +4 -1
- package/types/enums/platform.d.ts +4 -0
- package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
- package/types/enums/proxy-rule-status.d.ts +6 -0
- package/types/enums/region.d.ts +4 -1
- package/types/enums/runtime.d.ts +3 -1
- package/types/enums/status.d.ts +4 -0
- package/types/enums/template-reference-type.d.ts +5 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +421 -0
- package/types/enums/{site-usage-range.d.ts → usage-range.d.ts} +1 -1
- package/types/enums/{v-c-s-deployment-type.d.ts → vcs-reference-type.d.ts} +1 -1
- package/types/index.d.ts +27 -11
- package/types/models.d.ts +1877 -422
- package/types/operator.d.ts +180 -0
- package/types/query.d.ts +198 -2
- package/types/services/account.d.ts +1020 -158
- package/types/services/assistant.d.ts +13 -2
- package/types/services/avatars.d.ts +263 -45
- package/types/services/backups.d.ts +190 -30
- package/types/services/console.d.ts +202 -15
- package/types/services/databases.d.ts +1756 -299
- package/types/services/domains.d.ts +971 -219
- package/types/services/functions.d.ts +622 -131
- package/types/services/graphql.d.ts +24 -2
- package/types/services/health.d.ts +246 -24
- package/types/services/locale.d.ts +2 -2
- package/types/services/messaging.d.ts +1670 -281
- package/types/services/migrations.d.ts +319 -53
- package/types/services/organizations.d.ts +664 -109
- package/types/services/project.d.ts +81 -12
- package/types/services/projects.d.ts +1308 -202
- package/types/services/proxy.d.ts +128 -19
- package/types/services/realtime.d.ts +118 -0
- package/types/services/sites.d.ts +580 -119
- package/types/services/storage.d.ts +362 -81
- package/types/services/tables-db.d.ts +2040 -0
- package/types/services/teams.d.ts +277 -61
- package/types/services/tokens.d.ts +80 -12
- package/types/services/users.d.ts +906 -149
- package/types/services/vcs.d.ts +182 -34
- package/docs/examples/domains/create-record-m-x.md +0 -18
- package/docs/examples/domains/create-record-s-r-v.md +0 -20
- package/docs/examples/domains/create-record-t-x-t.md +0 -17
- package/docs/examples/domains/update-record-a-a-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-n-a-m-e.md +0 -18
- package/docs/examples/domains/update-record-h-t-t-p-s.md +0 -18
- package/docs/examples/domains/update-record-m-x.md +0 -19
- package/docs/examples/domains/update-record-n-s.md +0 -18
- package/docs/examples/domains/update-record-s-r-v.md +0 -21
- package/docs/examples/domains/update-record-t-x-t.md +0 -18
- package/src/enums/billing-plan.ts +0 -5
- package/src/enums/database-usage-range.ts +0 -5
- package/src/enums/function-usage-range.ts +0 -5
- package/src/enums/site-usage-range.ts +0 -5
- package/src/enums/storage-usage-range.ts +0 -5
- package/types/enums/billing-plan.d.ts +0 -5
- package/types/enums/database-usage-range.d.ts +0 -5
- package/types/enums/function-usage-range.d.ts +0 -5
- package/types/enums/storage-usage-range.d.ts +0 -5
- package/types/enums/user-usage-range.d.ts +0 -5
- /package/docs/examples/health/{get-d-b.md → get-db.md} +0 -0
- /package/docs/examples/locale/{list-countries-e-u.md → list-countries-eu.md} +0 -0
- /package/src/enums/{s-m-t-p-secure.ts → smtp-secure.ts} +0 -0
- /package/src/enums/{v-c-s-detection-type.ts → vcs-detection-type.ts} +0 -0
- /package/types/enums/{s-m-t-p-secure.d.ts → smtp-secure.d.ts} +0 -0
- /package/types/enums/{v-c-s-detection-type.d.ts → vcs-detection-type.d.ts} +0 -0
package/src/services/domains.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { Service } from '../service';
|
|
|
2
2
|
import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
|
|
3
3
|
import type { Models } from '../models';
|
|
4
4
|
|
|
5
|
+
|
|
5
6
|
export class Domains {
|
|
6
7
|
client: Client;
|
|
7
8
|
|
|
@@ -12,12 +13,41 @@ export class Domains {
|
|
|
12
13
|
/**
|
|
13
14
|
* List all domains registered for this project. This endpoint supports pagination.
|
|
14
15
|
*
|
|
15
|
-
* @param {string[]} queries
|
|
16
|
-
* @param {string} search
|
|
16
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as domain name, teamInternalId, expiration, etc.
|
|
17
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
18
|
+
* @throws {AppwriteException}
|
|
19
|
+
* @returns {Promise<Models.DomainsList>}
|
|
20
|
+
*/
|
|
21
|
+
list(params?: { queries?: string[], search?: string }): Promise<Models.DomainsList>;
|
|
22
|
+
/**
|
|
23
|
+
* List all domains registered for this project. This endpoint supports pagination.
|
|
24
|
+
*
|
|
25
|
+
* @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.
|
|
26
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
17
27
|
* @throws {AppwriteException}
|
|
18
28
|
* @returns {Promise<Models.DomainsList>}
|
|
29
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
19
30
|
*/
|
|
20
|
-
list(queries?: string[], search?: string): Promise<Models.DomainsList
|
|
31
|
+
list(queries?: string[], search?: string): Promise<Models.DomainsList>;
|
|
32
|
+
list(
|
|
33
|
+
paramsOrFirst?: { queries?: string[], search?: string } | string[],
|
|
34
|
+
...rest: [(string)?]
|
|
35
|
+
): Promise<Models.DomainsList> {
|
|
36
|
+
let params: { queries?: string[], search?: string };
|
|
37
|
+
|
|
38
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
39
|
+
params = (paramsOrFirst || {}) as { queries?: string[], search?: string };
|
|
40
|
+
} else {
|
|
41
|
+
params = {
|
|
42
|
+
queries: paramsOrFirst as string[],
|
|
43
|
+
search: rest[0] as string
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
const queries = params.queries;
|
|
48
|
+
const search = params.search;
|
|
49
|
+
|
|
50
|
+
|
|
21
51
|
const apiPath = '/domains';
|
|
22
52
|
const payload: Payload = {};
|
|
23
53
|
if (typeof queries !== 'undefined') {
|
|
@@ -38,21 +68,51 @@ export class Domains {
|
|
|
38
68
|
payload
|
|
39
69
|
);
|
|
40
70
|
}
|
|
71
|
+
|
|
41
72
|
/**
|
|
42
73
|
* 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.
|
|
43
74
|
*
|
|
44
|
-
* @param {string} teamId
|
|
45
|
-
* @param {string} domain
|
|
75
|
+
* @param {string} params.teamId - Team unique ID.
|
|
76
|
+
* @param {string} params.domain - Domain name (e.g. "example.com").
|
|
46
77
|
* @throws {AppwriteException}
|
|
47
78
|
* @returns {Promise<Models.Domain>}
|
|
48
79
|
*/
|
|
49
|
-
create(teamId: string, domain: string): Promise<Models.Domain
|
|
80
|
+
create(params: { teamId: string, domain: string }): Promise<Models.Domain>;
|
|
81
|
+
/**
|
|
82
|
+
* 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.
|
|
83
|
+
*
|
|
84
|
+
* @param {string} teamId - Team unique ID.
|
|
85
|
+
* @param {string} domain - Domain name (e.g. "example.com").
|
|
86
|
+
* @throws {AppwriteException}
|
|
87
|
+
* @returns {Promise<Models.Domain>}
|
|
88
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
89
|
+
*/
|
|
90
|
+
create(teamId: string, domain: string): Promise<Models.Domain>;
|
|
91
|
+
create(
|
|
92
|
+
paramsOrFirst: { teamId: string, domain: string } | string,
|
|
93
|
+
...rest: [(string)?]
|
|
94
|
+
): Promise<Models.Domain> {
|
|
95
|
+
let params: { teamId: string, domain: string };
|
|
96
|
+
|
|
97
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
98
|
+
params = (paramsOrFirst || {}) as { teamId: string, domain: string };
|
|
99
|
+
} else {
|
|
100
|
+
params = {
|
|
101
|
+
teamId: paramsOrFirst as string,
|
|
102
|
+
domain: rest[0] as string
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
const teamId = params.teamId;
|
|
107
|
+
const domain = params.domain;
|
|
108
|
+
|
|
50
109
|
if (typeof teamId === 'undefined') {
|
|
51
110
|
throw new AppwriteException('Missing required parameter: "teamId"');
|
|
52
111
|
}
|
|
53
112
|
if (typeof domain === 'undefined') {
|
|
54
113
|
throw new AppwriteException('Missing required parameter: "domain"');
|
|
55
114
|
}
|
|
115
|
+
|
|
56
116
|
const apiPath = '/domains';
|
|
57
117
|
const payload: Payload = {};
|
|
58
118
|
if (typeof teamId !== 'undefined') {
|
|
@@ -74,17 +134,43 @@ export class Domains {
|
|
|
74
134
|
payload
|
|
75
135
|
);
|
|
76
136
|
}
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* Get a domain by its unique ID.
|
|
140
|
+
*
|
|
141
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
142
|
+
* @throws {AppwriteException}
|
|
143
|
+
* @returns {Promise<Models.Domain>}
|
|
144
|
+
*/
|
|
145
|
+
get(params: { domainId: string }): Promise<Models.Domain>;
|
|
77
146
|
/**
|
|
78
147
|
* Get a domain by its unique ID.
|
|
79
148
|
*
|
|
80
|
-
* @param {string} domainId
|
|
149
|
+
* @param {string} domainId - Domain unique ID.
|
|
81
150
|
* @throws {AppwriteException}
|
|
82
151
|
* @returns {Promise<Models.Domain>}
|
|
152
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
83
153
|
*/
|
|
84
|
-
get(domainId: string): Promise<Models.Domain
|
|
154
|
+
get(domainId: string): Promise<Models.Domain>;
|
|
155
|
+
get(
|
|
156
|
+
paramsOrFirst: { domainId: string } | string
|
|
157
|
+
): Promise<Models.Domain> {
|
|
158
|
+
let params: { domainId: string };
|
|
159
|
+
|
|
160
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
161
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
162
|
+
} else {
|
|
163
|
+
params = {
|
|
164
|
+
domainId: paramsOrFirst as string
|
|
165
|
+
};
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
const domainId = params.domainId;
|
|
169
|
+
|
|
85
170
|
if (typeof domainId === 'undefined') {
|
|
86
171
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
87
172
|
}
|
|
173
|
+
|
|
88
174
|
const apiPath = '/domains/{domainId}'.replace('{domainId}', domainId);
|
|
89
175
|
const payload: Payload = {};
|
|
90
176
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -99,18 +185,45 @@ export class Domains {
|
|
|
99
185
|
payload
|
|
100
186
|
);
|
|
101
187
|
}
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
|
|
191
|
+
* Once deleted, the domain will no longer be available for use and all associated resources will be removed.
|
|
192
|
+
*
|
|
193
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
194
|
+
* @throws {AppwriteException}
|
|
195
|
+
* @returns {Promise<{}>}
|
|
196
|
+
*/
|
|
197
|
+
delete(params: { domainId: string }): Promise<{}>;
|
|
102
198
|
/**
|
|
103
199
|
* Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
|
|
104
|
-
Once deleted, the domain will no longer be available for use and all associated resources will be removed.
|
|
200
|
+
* Once deleted, the domain will no longer be available for use and all associated resources will be removed.
|
|
105
201
|
*
|
|
106
|
-
* @param {string} domainId
|
|
202
|
+
* @param {string} domainId - Domain unique ID.
|
|
107
203
|
* @throws {AppwriteException}
|
|
108
204
|
* @returns {Promise<{}>}
|
|
205
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
109
206
|
*/
|
|
110
|
-
delete(domainId: string): Promise<{}
|
|
207
|
+
delete(domainId: string): Promise<{}>;
|
|
208
|
+
delete(
|
|
209
|
+
paramsOrFirst: { domainId: string } | string
|
|
210
|
+
): Promise<{}> {
|
|
211
|
+
let params: { domainId: string };
|
|
212
|
+
|
|
213
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
214
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
215
|
+
} else {
|
|
216
|
+
params = {
|
|
217
|
+
domainId: paramsOrFirst as string
|
|
218
|
+
};
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
const domainId = params.domainId;
|
|
222
|
+
|
|
111
223
|
if (typeof domainId === 'undefined') {
|
|
112
224
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
113
225
|
}
|
|
226
|
+
|
|
114
227
|
const apiPath = '/domains/{domainId}'.replace('{domainId}', domainId);
|
|
115
228
|
const payload: Payload = {};
|
|
116
229
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -126,19 +239,47 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
126
239
|
payload
|
|
127
240
|
);
|
|
128
241
|
}
|
|
242
|
+
|
|
129
243
|
/**
|
|
130
|
-
* Verify which NS records are used and update the domain accordingly. This will check the domain
|
|
131
|
-
|
|
132
|
-
|
|
244
|
+
* Verify which NS records are used and update the domain accordingly. This will check the domain's
|
|
245
|
+
* nameservers and update the domain's status based on whether the nameservers match the expected
|
|
246
|
+
* Appwrite nameservers.
|
|
133
247
|
*
|
|
134
|
-
* @param {string} domainId
|
|
248
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
135
249
|
* @throws {AppwriteException}
|
|
136
250
|
* @returns {Promise<Models.Domain>}
|
|
137
251
|
*/
|
|
138
|
-
updateNameservers(domainId: string): Promise<Models.Domain
|
|
252
|
+
updateNameservers(params: { domainId: string }): Promise<Models.Domain>;
|
|
253
|
+
/**
|
|
254
|
+
* Verify which NS records are used and update the domain accordingly. This will check the domain's
|
|
255
|
+
* nameservers and update the domain's status based on whether the nameservers match the expected
|
|
256
|
+
* Appwrite nameservers.
|
|
257
|
+
*
|
|
258
|
+
* @param {string} domainId - Domain unique ID.
|
|
259
|
+
* @throws {AppwriteException}
|
|
260
|
+
* @returns {Promise<Models.Domain>}
|
|
261
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
262
|
+
*/
|
|
263
|
+
updateNameservers(domainId: string): Promise<Models.Domain>;
|
|
264
|
+
updateNameservers(
|
|
265
|
+
paramsOrFirst: { domainId: string } | string
|
|
266
|
+
): Promise<Models.Domain> {
|
|
267
|
+
let params: { domainId: string };
|
|
268
|
+
|
|
269
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
270
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
271
|
+
} else {
|
|
272
|
+
params = {
|
|
273
|
+
domainId: paramsOrFirst as string
|
|
274
|
+
};
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
const domainId = params.domainId;
|
|
278
|
+
|
|
139
279
|
if (typeof domainId === 'undefined') {
|
|
140
280
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
141
281
|
}
|
|
282
|
+
|
|
142
283
|
const apiPath = '/domains/{domainId}/nameservers'.replace('{domainId}', domainId);
|
|
143
284
|
const payload: Payload = {};
|
|
144
285
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -154,17 +295,43 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
154
295
|
payload
|
|
155
296
|
);
|
|
156
297
|
}
|
|
298
|
+
|
|
157
299
|
/**
|
|
158
300
|
* List Google Workspace DNS records.
|
|
159
301
|
*
|
|
160
|
-
* @param {string} domainId
|
|
302
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
161
303
|
* @throws {AppwriteException}
|
|
162
304
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
163
305
|
*/
|
|
164
|
-
getPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList
|
|
306
|
+
getPresetGoogleWorkspace(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
307
|
+
/**
|
|
308
|
+
* List Google Workspace DNS records.
|
|
309
|
+
*
|
|
310
|
+
* @param {string} domainId - Domain unique ID.
|
|
311
|
+
* @throws {AppwriteException}
|
|
312
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
313
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
314
|
+
*/
|
|
315
|
+
getPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
|
|
316
|
+
getPresetGoogleWorkspace(
|
|
317
|
+
paramsOrFirst: { domainId: string } | string
|
|
318
|
+
): Promise<Models.DnsRecordsList> {
|
|
319
|
+
let params: { domainId: string };
|
|
320
|
+
|
|
321
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
322
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
323
|
+
} else {
|
|
324
|
+
params = {
|
|
325
|
+
domainId: paramsOrFirst as string
|
|
326
|
+
};
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
const domainId = params.domainId;
|
|
330
|
+
|
|
165
331
|
if (typeof domainId === 'undefined') {
|
|
166
332
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
167
333
|
}
|
|
334
|
+
|
|
168
335
|
const apiPath = '/domains/{domainId}/presets/google-workspace'.replace('{domainId}', domainId);
|
|
169
336
|
const payload: Payload = {};
|
|
170
337
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -179,18 +346,45 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
179
346
|
payload
|
|
180
347
|
);
|
|
181
348
|
}
|
|
349
|
+
|
|
350
|
+
/**
|
|
351
|
+
* Add Google Workspace DNS records to the domain. This will create the required MX records
|
|
352
|
+
* for Google Workspace email hosting.
|
|
353
|
+
*
|
|
354
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
355
|
+
* @throws {AppwriteException}
|
|
356
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
357
|
+
*/
|
|
358
|
+
createPresetGoogleWorkspace(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
182
359
|
/**
|
|
183
360
|
* Add Google Workspace DNS records to the domain. This will create the required MX records
|
|
184
|
-
|
|
361
|
+
* for Google Workspace email hosting.
|
|
185
362
|
*
|
|
186
|
-
* @param {string} domainId
|
|
363
|
+
* @param {string} domainId - Domain unique ID.
|
|
187
364
|
* @throws {AppwriteException}
|
|
188
365
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
366
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
189
367
|
*/
|
|
190
|
-
createPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList
|
|
368
|
+
createPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
|
|
369
|
+
createPresetGoogleWorkspace(
|
|
370
|
+
paramsOrFirst: { domainId: string } | string
|
|
371
|
+
): Promise<Models.DnsRecordsList> {
|
|
372
|
+
let params: { domainId: string };
|
|
373
|
+
|
|
374
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
375
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
376
|
+
} else {
|
|
377
|
+
params = {
|
|
378
|
+
domainId: paramsOrFirst as string
|
|
379
|
+
};
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
const domainId = params.domainId;
|
|
383
|
+
|
|
191
384
|
if (typeof domainId === 'undefined') {
|
|
192
385
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
193
386
|
}
|
|
387
|
+
|
|
194
388
|
const apiPath = '/domains/{domainId}/presets/google-workspace'.replace('{domainId}', domainId);
|
|
195
389
|
const payload: Payload = {};
|
|
196
390
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -206,17 +400,43 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
206
400
|
payload
|
|
207
401
|
);
|
|
208
402
|
}
|
|
403
|
+
|
|
404
|
+
/**
|
|
405
|
+
* List iCloud DNS records.
|
|
406
|
+
*
|
|
407
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
408
|
+
* @throws {AppwriteException}
|
|
409
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
410
|
+
*/
|
|
411
|
+
getPresetICloud(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
209
412
|
/**
|
|
210
413
|
* List iCloud DNS records.
|
|
211
414
|
*
|
|
212
|
-
* @param {string} domainId
|
|
415
|
+
* @param {string} domainId - Domain unique ID.
|
|
213
416
|
* @throws {AppwriteException}
|
|
214
417
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
418
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
215
419
|
*/
|
|
216
|
-
getPresetICloud(domainId: string): Promise<Models.DnsRecordsList
|
|
420
|
+
getPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
|
|
421
|
+
getPresetICloud(
|
|
422
|
+
paramsOrFirst: { domainId: string } | string
|
|
423
|
+
): Promise<Models.DnsRecordsList> {
|
|
424
|
+
let params: { domainId: string };
|
|
425
|
+
|
|
426
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
427
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
428
|
+
} else {
|
|
429
|
+
params = {
|
|
430
|
+
domainId: paramsOrFirst as string
|
|
431
|
+
};
|
|
432
|
+
}
|
|
433
|
+
|
|
434
|
+
const domainId = params.domainId;
|
|
435
|
+
|
|
217
436
|
if (typeof domainId === 'undefined') {
|
|
218
437
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
219
438
|
}
|
|
439
|
+
|
|
220
440
|
const apiPath = '/domains/{domainId}/presets/icloud'.replace('{domainId}', domainId);
|
|
221
441
|
const payload: Payload = {};
|
|
222
442
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -231,18 +451,45 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
231
451
|
payload
|
|
232
452
|
);
|
|
233
453
|
}
|
|
454
|
+
|
|
455
|
+
/**
|
|
456
|
+
* Add iCloud DNS records to the domain. This will create the required MX and SPF records
|
|
457
|
+
* for using iCloud email services with your domain.
|
|
458
|
+
*
|
|
459
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
460
|
+
* @throws {AppwriteException}
|
|
461
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
462
|
+
*/
|
|
463
|
+
createPresetICloud(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
234
464
|
/**
|
|
235
465
|
* Add iCloud DNS records to the domain. This will create the required MX and SPF records
|
|
236
|
-
|
|
466
|
+
* for using iCloud email services with your domain.
|
|
237
467
|
*
|
|
238
|
-
* @param {string} domainId
|
|
468
|
+
* @param {string} domainId - Domain unique ID.
|
|
239
469
|
* @throws {AppwriteException}
|
|
240
470
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
471
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
241
472
|
*/
|
|
242
|
-
createPresetICloud(domainId: string): Promise<Models.DnsRecordsList
|
|
473
|
+
createPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
|
|
474
|
+
createPresetICloud(
|
|
475
|
+
paramsOrFirst: { domainId: string } | string
|
|
476
|
+
): Promise<Models.DnsRecordsList> {
|
|
477
|
+
let params: { domainId: string };
|
|
478
|
+
|
|
479
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
480
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
481
|
+
} else {
|
|
482
|
+
params = {
|
|
483
|
+
domainId: paramsOrFirst as string
|
|
484
|
+
};
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
const domainId = params.domainId;
|
|
488
|
+
|
|
243
489
|
if (typeof domainId === 'undefined') {
|
|
244
490
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
245
491
|
}
|
|
492
|
+
|
|
246
493
|
const apiPath = '/domains/{domainId}/presets/icloud'.replace('{domainId}', domainId);
|
|
247
494
|
const payload: Payload = {};
|
|
248
495
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -258,17 +505,43 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
258
505
|
payload
|
|
259
506
|
);
|
|
260
507
|
}
|
|
508
|
+
|
|
509
|
+
/**
|
|
510
|
+
* List Mailgun DNS records.
|
|
511
|
+
*
|
|
512
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
513
|
+
* @throws {AppwriteException}
|
|
514
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
515
|
+
*/
|
|
516
|
+
getPresetMailgun(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
261
517
|
/**
|
|
262
518
|
* List Mailgun DNS records.
|
|
263
519
|
*
|
|
264
|
-
* @param {string} domainId
|
|
520
|
+
* @param {string} domainId - Domain unique ID.
|
|
265
521
|
* @throws {AppwriteException}
|
|
266
522
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
523
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
267
524
|
*/
|
|
268
|
-
getPresetMailgun(domainId: string): Promise<Models.DnsRecordsList
|
|
525
|
+
getPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
|
|
526
|
+
getPresetMailgun(
|
|
527
|
+
paramsOrFirst: { domainId: string } | string
|
|
528
|
+
): Promise<Models.DnsRecordsList> {
|
|
529
|
+
let params: { domainId: string };
|
|
530
|
+
|
|
531
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
532
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
533
|
+
} else {
|
|
534
|
+
params = {
|
|
535
|
+
domainId: paramsOrFirst as string
|
|
536
|
+
};
|
|
537
|
+
}
|
|
538
|
+
|
|
539
|
+
const domainId = params.domainId;
|
|
540
|
+
|
|
269
541
|
if (typeof domainId === 'undefined') {
|
|
270
542
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
271
543
|
}
|
|
544
|
+
|
|
272
545
|
const apiPath = '/domains/{domainId}/presets/mailgun'.replace('{domainId}', domainId);
|
|
273
546
|
const payload: Payload = {};
|
|
274
547
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -283,18 +556,45 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
283
556
|
payload
|
|
284
557
|
);
|
|
285
558
|
}
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
|
|
562
|
+
* for Mailgun in the specified domain.
|
|
563
|
+
*
|
|
564
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
565
|
+
* @throws {AppwriteException}
|
|
566
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
567
|
+
*/
|
|
568
|
+
createPresetMailgun(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
286
569
|
/**
|
|
287
570
|
* Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
|
|
288
|
-
|
|
571
|
+
* for Mailgun in the specified domain.
|
|
289
572
|
*
|
|
290
|
-
* @param {string} domainId
|
|
573
|
+
* @param {string} domainId - Domain unique ID.
|
|
291
574
|
* @throws {AppwriteException}
|
|
292
575
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
576
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
293
577
|
*/
|
|
294
|
-
createPresetMailgun(domainId: string): Promise<Models.DnsRecordsList
|
|
578
|
+
createPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
|
|
579
|
+
createPresetMailgun(
|
|
580
|
+
paramsOrFirst: { domainId: string } | string
|
|
581
|
+
): Promise<Models.DnsRecordsList> {
|
|
582
|
+
let params: { domainId: string };
|
|
583
|
+
|
|
584
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
585
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
586
|
+
} else {
|
|
587
|
+
params = {
|
|
588
|
+
domainId: paramsOrFirst as string
|
|
589
|
+
};
|
|
590
|
+
}
|
|
591
|
+
|
|
592
|
+
const domainId = params.domainId;
|
|
593
|
+
|
|
295
594
|
if (typeof domainId === 'undefined') {
|
|
296
595
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
297
596
|
}
|
|
597
|
+
|
|
298
598
|
const apiPath = '/domains/{domainId}/presets/mailgun'.replace('{domainId}', domainId);
|
|
299
599
|
const payload: Payload = {};
|
|
300
600
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -310,17 +610,43 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
310
610
|
payload
|
|
311
611
|
);
|
|
312
612
|
}
|
|
613
|
+
|
|
313
614
|
/**
|
|
314
615
|
* List Outlook DNS records.
|
|
315
616
|
*
|
|
316
|
-
* @param {string} domainId
|
|
617
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
317
618
|
* @throws {AppwriteException}
|
|
318
619
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
319
620
|
*/
|
|
320
|
-
getPresetOutlook(domainId: string): Promise<Models.DnsRecordsList
|
|
621
|
+
getPresetOutlook(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
622
|
+
/**
|
|
623
|
+
* List Outlook DNS records.
|
|
624
|
+
*
|
|
625
|
+
* @param {string} domainId - Domain unique ID.
|
|
626
|
+
* @throws {AppwriteException}
|
|
627
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
628
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
629
|
+
*/
|
|
630
|
+
getPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
|
|
631
|
+
getPresetOutlook(
|
|
632
|
+
paramsOrFirst: { domainId: string } | string
|
|
633
|
+
): Promise<Models.DnsRecordsList> {
|
|
634
|
+
let params: { domainId: string };
|
|
635
|
+
|
|
636
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
637
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
638
|
+
} else {
|
|
639
|
+
params = {
|
|
640
|
+
domainId: paramsOrFirst as string
|
|
641
|
+
};
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
const domainId = params.domainId;
|
|
645
|
+
|
|
321
646
|
if (typeof domainId === 'undefined') {
|
|
322
647
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
323
648
|
}
|
|
649
|
+
|
|
324
650
|
const apiPath = '/domains/{domainId}/presets/outlook'.replace('{domainId}', domainId);
|
|
325
651
|
const payload: Payload = {};
|
|
326
652
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -335,18 +661,45 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
335
661
|
payload
|
|
336
662
|
);
|
|
337
663
|
}
|
|
664
|
+
|
|
338
665
|
/**
|
|
339
666
|
* Add Outlook DNS records to the domain. This will create the required MX records
|
|
340
|
-
|
|
667
|
+
* for setting up Outlook email hosting for your domain.
|
|
341
668
|
*
|
|
342
|
-
* @param {string} domainId
|
|
669
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
343
670
|
* @throws {AppwriteException}
|
|
344
671
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
345
672
|
*/
|
|
346
|
-
createPresetOutlook(domainId: string): Promise<Models.DnsRecordsList
|
|
673
|
+
createPresetOutlook(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
674
|
+
/**
|
|
675
|
+
* Add Outlook DNS records to the domain. This will create the required MX records
|
|
676
|
+
* for setting up Outlook email hosting for your domain.
|
|
677
|
+
*
|
|
678
|
+
* @param {string} domainId - Domain unique ID.
|
|
679
|
+
* @throws {AppwriteException}
|
|
680
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
681
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
682
|
+
*/
|
|
683
|
+
createPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
|
|
684
|
+
createPresetOutlook(
|
|
685
|
+
paramsOrFirst: { domainId: string } | string
|
|
686
|
+
): Promise<Models.DnsRecordsList> {
|
|
687
|
+
let params: { domainId: string };
|
|
688
|
+
|
|
689
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
690
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
691
|
+
} else {
|
|
692
|
+
params = {
|
|
693
|
+
domainId: paramsOrFirst as string
|
|
694
|
+
};
|
|
695
|
+
}
|
|
696
|
+
|
|
697
|
+
const domainId = params.domainId;
|
|
698
|
+
|
|
347
699
|
if (typeof domainId === 'undefined') {
|
|
348
700
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
349
701
|
}
|
|
702
|
+
|
|
350
703
|
const apiPath = '/domains/{domainId}/presets/outlook'.replace('{domainId}', domainId);
|
|
351
704
|
const payload: Payload = {};
|
|
352
705
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -362,17 +715,43 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
362
715
|
payload
|
|
363
716
|
);
|
|
364
717
|
}
|
|
718
|
+
|
|
365
719
|
/**
|
|
366
720
|
* List ProtonMail DNS records.
|
|
367
721
|
*
|
|
368
|
-
* @param {string} domainId
|
|
722
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
369
723
|
* @throws {AppwriteException}
|
|
370
724
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
371
725
|
*/
|
|
372
|
-
getPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList
|
|
726
|
+
getPresetProtonMail(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
727
|
+
/**
|
|
728
|
+
* List ProtonMail DNS records.
|
|
729
|
+
*
|
|
730
|
+
* @param {string} domainId - Domain unique ID.
|
|
731
|
+
* @throws {AppwriteException}
|
|
732
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
733
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
734
|
+
*/
|
|
735
|
+
getPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
|
|
736
|
+
getPresetProtonMail(
|
|
737
|
+
paramsOrFirst: { domainId: string } | string
|
|
738
|
+
): Promise<Models.DnsRecordsList> {
|
|
739
|
+
let params: { domainId: string };
|
|
740
|
+
|
|
741
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
742
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
743
|
+
} else {
|
|
744
|
+
params = {
|
|
745
|
+
domainId: paramsOrFirst as string
|
|
746
|
+
};
|
|
747
|
+
}
|
|
748
|
+
|
|
749
|
+
const domainId = params.domainId;
|
|
750
|
+
|
|
373
751
|
if (typeof domainId === 'undefined') {
|
|
374
752
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
375
753
|
}
|
|
754
|
+
|
|
376
755
|
const apiPath = '/domains/{domainId}/presets/proton-mail'.replace('{domainId}', domainId);
|
|
377
756
|
const payload: Payload = {};
|
|
378
757
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -387,18 +766,45 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
387
766
|
payload
|
|
388
767
|
);
|
|
389
768
|
}
|
|
769
|
+
|
|
770
|
+
/**
|
|
771
|
+
* Add ProtonMail DNS records to the domain. This will create the required MX records
|
|
772
|
+
* for using ProtonMail with your custom domain.
|
|
773
|
+
*
|
|
774
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
775
|
+
* @throws {AppwriteException}
|
|
776
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
777
|
+
*/
|
|
778
|
+
createPresetProtonMail(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
390
779
|
/**
|
|
391
780
|
* Add ProtonMail DNS records to the domain. This will create the required MX records
|
|
392
|
-
|
|
781
|
+
* for using ProtonMail with your custom domain.
|
|
393
782
|
*
|
|
394
|
-
* @param {string} domainId
|
|
783
|
+
* @param {string} domainId - Domain unique ID.
|
|
395
784
|
* @throws {AppwriteException}
|
|
396
785
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
786
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
397
787
|
*/
|
|
398
|
-
createPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList
|
|
788
|
+
createPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
|
|
789
|
+
createPresetProtonMail(
|
|
790
|
+
paramsOrFirst: { domainId: string } | string
|
|
791
|
+
): Promise<Models.DnsRecordsList> {
|
|
792
|
+
let params: { domainId: string };
|
|
793
|
+
|
|
794
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
795
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
796
|
+
} else {
|
|
797
|
+
params = {
|
|
798
|
+
domainId: paramsOrFirst as string
|
|
799
|
+
};
|
|
800
|
+
}
|
|
801
|
+
|
|
802
|
+
const domainId = params.domainId;
|
|
803
|
+
|
|
399
804
|
if (typeof domainId === 'undefined') {
|
|
400
805
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
401
806
|
}
|
|
807
|
+
|
|
402
808
|
const apiPath = '/domains/{domainId}/presets/proton-mail'.replace('{domainId}', domainId);
|
|
403
809
|
const payload: Payload = {};
|
|
404
810
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -414,17 +820,43 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
414
820
|
payload
|
|
415
821
|
);
|
|
416
822
|
}
|
|
823
|
+
|
|
824
|
+
/**
|
|
825
|
+
* List Zoho DNS records.
|
|
826
|
+
*
|
|
827
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
828
|
+
* @throws {AppwriteException}
|
|
829
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
830
|
+
*/
|
|
831
|
+
getPresetZoho(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
417
832
|
/**
|
|
418
833
|
* List Zoho DNS records.
|
|
419
834
|
*
|
|
420
|
-
* @param {string} domainId
|
|
835
|
+
* @param {string} domainId - Domain unique ID.
|
|
421
836
|
* @throws {AppwriteException}
|
|
422
837
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
838
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
423
839
|
*/
|
|
424
|
-
getPresetZoho(domainId: string): Promise<Models.DnsRecordsList
|
|
840
|
+
getPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
|
|
841
|
+
getPresetZoho(
|
|
842
|
+
paramsOrFirst: { domainId: string } | string
|
|
843
|
+
): Promise<Models.DnsRecordsList> {
|
|
844
|
+
let params: { domainId: string };
|
|
845
|
+
|
|
846
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
847
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
848
|
+
} else {
|
|
849
|
+
params = {
|
|
850
|
+
domainId: paramsOrFirst as string
|
|
851
|
+
};
|
|
852
|
+
}
|
|
853
|
+
|
|
854
|
+
const domainId = params.domainId;
|
|
855
|
+
|
|
425
856
|
if (typeof domainId === 'undefined') {
|
|
426
857
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
427
858
|
}
|
|
859
|
+
|
|
428
860
|
const apiPath = '/domains/{domainId}/presets/zoho'.replace('{domainId}', domainId);
|
|
429
861
|
const payload: Payload = {};
|
|
430
862
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -439,18 +871,45 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
439
871
|
payload
|
|
440
872
|
);
|
|
441
873
|
}
|
|
874
|
+
|
|
442
875
|
/**
|
|
443
876
|
* Add Zoho Mail DNS records to the domain. This will create the required MX records
|
|
444
|
-
|
|
877
|
+
* for setting up Zoho Mail on your domain.
|
|
445
878
|
*
|
|
446
|
-
* @param {string} domainId
|
|
879
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
447
880
|
* @throws {AppwriteException}
|
|
448
881
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
449
882
|
*/
|
|
450
|
-
createPresetZoho(domainId: string): Promise<Models.DnsRecordsList
|
|
883
|
+
createPresetZoho(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
884
|
+
/**
|
|
885
|
+
* Add Zoho Mail DNS records to the domain. This will create the required MX records
|
|
886
|
+
* for setting up Zoho Mail on your domain.
|
|
887
|
+
*
|
|
888
|
+
* @param {string} domainId - Domain unique ID.
|
|
889
|
+
* @throws {AppwriteException}
|
|
890
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
891
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
892
|
+
*/
|
|
893
|
+
createPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
|
|
894
|
+
createPresetZoho(
|
|
895
|
+
paramsOrFirst: { domainId: string } | string
|
|
896
|
+
): Promise<Models.DnsRecordsList> {
|
|
897
|
+
let params: { domainId: string };
|
|
898
|
+
|
|
899
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
900
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
901
|
+
} else {
|
|
902
|
+
params = {
|
|
903
|
+
domainId: paramsOrFirst as string
|
|
904
|
+
};
|
|
905
|
+
}
|
|
906
|
+
|
|
907
|
+
const domainId = params.domainId;
|
|
908
|
+
|
|
451
909
|
if (typeof domainId === 'undefined') {
|
|
452
910
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
453
911
|
}
|
|
912
|
+
|
|
454
913
|
const apiPath = '/domains/{domainId}/presets/zoho'.replace('{domainId}', domainId);
|
|
455
914
|
const payload: Payload = {};
|
|
456
915
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -466,19 +925,50 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
466
925
|
payload
|
|
467
926
|
);
|
|
468
927
|
}
|
|
928
|
+
|
|
929
|
+
/**
|
|
930
|
+
* List DNS records for a given domain. You can use this endpoint to list all the DNS records
|
|
931
|
+
* associated with your domain.
|
|
932
|
+
*
|
|
933
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
934
|
+
* @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.
|
|
935
|
+
* @throws {AppwriteException}
|
|
936
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
937
|
+
*/
|
|
938
|
+
listRecords(params: { domainId: string, queries?: string[] }): Promise<Models.DnsRecordsList>;
|
|
469
939
|
/**
|
|
470
940
|
* List DNS records for a given domain. You can use this endpoint to list all the DNS records
|
|
471
|
-
|
|
941
|
+
* associated with your domain.
|
|
472
942
|
*
|
|
473
|
-
* @param {string} domainId
|
|
474
|
-
* @param {string[]} queries
|
|
943
|
+
* @param {string} domainId - Domain unique ID.
|
|
944
|
+
* @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.
|
|
475
945
|
* @throws {AppwriteException}
|
|
476
946
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
947
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
477
948
|
*/
|
|
478
|
-
listRecords(domainId: string, queries?: string[]): Promise<Models.DnsRecordsList
|
|
949
|
+
listRecords(domainId: string, queries?: string[]): Promise<Models.DnsRecordsList>;
|
|
950
|
+
listRecords(
|
|
951
|
+
paramsOrFirst: { domainId: string, queries?: string[] } | string,
|
|
952
|
+
...rest: [(string[])?]
|
|
953
|
+
): Promise<Models.DnsRecordsList> {
|
|
954
|
+
let params: { domainId: string, queries?: string[] };
|
|
955
|
+
|
|
956
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
957
|
+
params = (paramsOrFirst || {}) as { domainId: string, queries?: string[] };
|
|
958
|
+
} else {
|
|
959
|
+
params = {
|
|
960
|
+
domainId: paramsOrFirst as string,
|
|
961
|
+
queries: rest[0] as string[]
|
|
962
|
+
};
|
|
963
|
+
}
|
|
964
|
+
|
|
965
|
+
const domainId = params.domainId;
|
|
966
|
+
const queries = params.queries;
|
|
967
|
+
|
|
479
968
|
if (typeof domainId === 'undefined') {
|
|
480
969
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
481
970
|
}
|
|
971
|
+
|
|
482
972
|
const apiPath = '/domains/{domainId}/records'.replace('{domainId}', domainId);
|
|
483
973
|
const payload: Payload = {};
|
|
484
974
|
if (typeof queries !== 'undefined') {
|
|
@@ -496,19 +986,58 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
496
986
|
payload
|
|
497
987
|
);
|
|
498
988
|
}
|
|
989
|
+
|
|
990
|
+
/**
|
|
991
|
+
* Create a new A record for the given domain. A records are used to point a domain name
|
|
992
|
+
* to an IPv4 address. The record value should be a valid IPv4 address.
|
|
993
|
+
*
|
|
994
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
995
|
+
* @param {string} params.name - Record name (subdomain).
|
|
996
|
+
* @param {string} params.value - IPv4 address for this A record.
|
|
997
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
998
|
+
* @param {string} params.comment - A comment explaining what this record is for.
|
|
999
|
+
* @throws {AppwriteException}
|
|
1000
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1001
|
+
*/
|
|
1002
|
+
createRecordA(params: { domainId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
499
1003
|
/**
|
|
500
1004
|
* Create a new A record for the given domain. A records are used to point a domain name
|
|
501
|
-
to an IPv4 address. The record value should be a valid IPv4 address.
|
|
1005
|
+
* to an IPv4 address. The record value should be a valid IPv4 address.
|
|
502
1006
|
*
|
|
503
|
-
* @param {string} domainId
|
|
504
|
-
* @param {string} name
|
|
505
|
-
* @param {string} value
|
|
506
|
-
* @param {number} ttl
|
|
507
|
-
* @param {string} comment
|
|
1007
|
+
* @param {string} domainId - Domain unique ID.
|
|
1008
|
+
* @param {string} name - Record name (subdomain).
|
|
1009
|
+
* @param {string} value - IPv4 address for this A record.
|
|
1010
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1011
|
+
* @param {string} comment - A comment explaining what this record is for.
|
|
508
1012
|
* @throws {AppwriteException}
|
|
509
1013
|
* @returns {Promise<Models.DnsRecord>}
|
|
1014
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
510
1015
|
*/
|
|
511
|
-
createRecordA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1016
|
+
createRecordA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1017
|
+
createRecordA(
|
|
1018
|
+
paramsOrFirst: { domainId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
1019
|
+
...rest: [(string)?, (string)?, (number)?, (string)?]
|
|
1020
|
+
): Promise<Models.DnsRecord> {
|
|
1021
|
+
let params: { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1022
|
+
|
|
1023
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1024
|
+
params = (paramsOrFirst || {}) as { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1025
|
+
} else {
|
|
1026
|
+
params = {
|
|
1027
|
+
domainId: paramsOrFirst as string,
|
|
1028
|
+
name: rest[0] as string,
|
|
1029
|
+
value: rest[1] as string,
|
|
1030
|
+
ttl: rest[2] as number,
|
|
1031
|
+
comment: rest[3] as string
|
|
1032
|
+
};
|
|
1033
|
+
}
|
|
1034
|
+
|
|
1035
|
+
const domainId = params.domainId;
|
|
1036
|
+
const name = params.name;
|
|
1037
|
+
const value = params.value;
|
|
1038
|
+
const ttl = params.ttl;
|
|
1039
|
+
const comment = params.comment;
|
|
1040
|
+
|
|
512
1041
|
if (typeof domainId === 'undefined') {
|
|
513
1042
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
514
1043
|
}
|
|
@@ -521,6 +1050,7 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
521
1050
|
if (typeof ttl === 'undefined') {
|
|
522
1051
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
523
1052
|
}
|
|
1053
|
+
|
|
524
1054
|
const apiPath = '/domains/{domainId}/records/a'.replace('{domainId}', domainId);
|
|
525
1055
|
const payload: Payload = {};
|
|
526
1056
|
if (typeof name !== 'undefined') {
|
|
@@ -548,21 +1078,64 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
548
1078
|
payload
|
|
549
1079
|
);
|
|
550
1080
|
}
|
|
1081
|
+
|
|
1082
|
+
/**
|
|
1083
|
+
* Update an existing A record for the given domain. This endpoint allows you to modify
|
|
1084
|
+
* the properties of an A record including its name (subdomain), IPv4 address, TTL,
|
|
1085
|
+
* and optional comment.
|
|
1086
|
+
*
|
|
1087
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1088
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1089
|
+
* @param {string} params.name - Record name (subdomain).
|
|
1090
|
+
* @param {string} params.value - IPv4 address for this A record.
|
|
1091
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1092
|
+
* @param {string} params.comment - A comment explaining what this record is for.
|
|
1093
|
+
* @throws {AppwriteException}
|
|
1094
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1095
|
+
*/
|
|
1096
|
+
updateRecordA(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
551
1097
|
/**
|
|
552
1098
|
* Update an existing A record for the given domain. This endpoint allows you to modify
|
|
553
|
-
|
|
554
|
-
|
|
1099
|
+
* the properties of an A record including its name (subdomain), IPv4 address, TTL,
|
|
1100
|
+
* and optional comment.
|
|
555
1101
|
*
|
|
556
|
-
* @param {string} domainId
|
|
557
|
-
* @param {string} recordId
|
|
558
|
-
* @param {string} name
|
|
559
|
-
* @param {string} value
|
|
560
|
-
* @param {number} ttl
|
|
561
|
-
* @param {string} comment
|
|
1102
|
+
* @param {string} domainId - Domain unique ID.
|
|
1103
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1104
|
+
* @param {string} name - Record name (subdomain).
|
|
1105
|
+
* @param {string} value - IPv4 address for this A record.
|
|
1106
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1107
|
+
* @param {string} comment - A comment explaining what this record is for.
|
|
562
1108
|
* @throws {AppwriteException}
|
|
563
1109
|
* @returns {Promise<Models.DnsRecord>}
|
|
1110
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
564
1111
|
*/
|
|
565
|
-
updateRecordA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1112
|
+
updateRecordA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1113
|
+
updateRecordA(
|
|
1114
|
+
paramsOrFirst: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
1115
|
+
...rest: [(string)?, (string)?, (string)?, (number)?, (string)?]
|
|
1116
|
+
): Promise<Models.DnsRecord> {
|
|
1117
|
+
let params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1118
|
+
|
|
1119
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1120
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1121
|
+
} else {
|
|
1122
|
+
params = {
|
|
1123
|
+
domainId: paramsOrFirst as string,
|
|
1124
|
+
recordId: rest[0] as string,
|
|
1125
|
+
name: rest[1] as string,
|
|
1126
|
+
value: rest[2] as string,
|
|
1127
|
+
ttl: rest[3] as number,
|
|
1128
|
+
comment: rest[4] as string
|
|
1129
|
+
};
|
|
1130
|
+
}
|
|
1131
|
+
|
|
1132
|
+
const domainId = params.domainId;
|
|
1133
|
+
const recordId = params.recordId;
|
|
1134
|
+
const name = params.name;
|
|
1135
|
+
const value = params.value;
|
|
1136
|
+
const ttl = params.ttl;
|
|
1137
|
+
const comment = params.comment;
|
|
1138
|
+
|
|
566
1139
|
if (typeof domainId === 'undefined') {
|
|
567
1140
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
568
1141
|
}
|
|
@@ -578,6 +1151,7 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
578
1151
|
if (typeof ttl === 'undefined') {
|
|
579
1152
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
580
1153
|
}
|
|
1154
|
+
|
|
581
1155
|
const apiPath = '/domains/{domainId}/records/a/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
582
1156
|
const payload: Payload = {};
|
|
583
1157
|
if (typeof name !== 'undefined') {
|
|
@@ -605,19 +1179,58 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
605
1179
|
payload
|
|
606
1180
|
);
|
|
607
1181
|
}
|
|
1182
|
+
|
|
1183
|
+
/**
|
|
1184
|
+
* Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
|
|
1185
|
+
* to your domain. The record will be used to point a hostname to an IPv6 address.
|
|
1186
|
+
*
|
|
1187
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1188
|
+
* @param {string} params.name - Record name (subdomain).
|
|
1189
|
+
* @param {string} params.value - IPv6 address for this AAAA record.
|
|
1190
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1191
|
+
* @param {string} params.comment - A comment explaining what this record is for.
|
|
1192
|
+
* @throws {AppwriteException}
|
|
1193
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1194
|
+
*/
|
|
1195
|
+
createRecordAAAA(params: { domainId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
608
1196
|
/**
|
|
609
1197
|
* Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
|
|
610
|
-
|
|
1198
|
+
* to your domain. The record will be used to point a hostname to an IPv6 address.
|
|
611
1199
|
*
|
|
612
|
-
* @param {string} domainId
|
|
613
|
-
* @param {string} name
|
|
614
|
-
* @param {string} value
|
|
615
|
-
* @param {number} ttl
|
|
616
|
-
* @param {string} comment
|
|
1200
|
+
* @param {string} domainId - Domain unique ID.
|
|
1201
|
+
* @param {string} name - Record name (subdomain).
|
|
1202
|
+
* @param {string} value - IPv6 address for this AAAA record.
|
|
1203
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1204
|
+
* @param {string} comment - A comment explaining what this record is for.
|
|
617
1205
|
* @throws {AppwriteException}
|
|
618
1206
|
* @returns {Promise<Models.DnsRecord>}
|
|
1207
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
619
1208
|
*/
|
|
620
|
-
createRecordAAAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1209
|
+
createRecordAAAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1210
|
+
createRecordAAAA(
|
|
1211
|
+
paramsOrFirst: { domainId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
1212
|
+
...rest: [(string)?, (string)?, (number)?, (string)?]
|
|
1213
|
+
): Promise<Models.DnsRecord> {
|
|
1214
|
+
let params: { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1215
|
+
|
|
1216
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1217
|
+
params = (paramsOrFirst || {}) as { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1218
|
+
} else {
|
|
1219
|
+
params = {
|
|
1220
|
+
domainId: paramsOrFirst as string,
|
|
1221
|
+
name: rest[0] as string,
|
|
1222
|
+
value: rest[1] as string,
|
|
1223
|
+
ttl: rest[2] as number,
|
|
1224
|
+
comment: rest[3] as string
|
|
1225
|
+
};
|
|
1226
|
+
}
|
|
1227
|
+
|
|
1228
|
+
const domainId = params.domainId;
|
|
1229
|
+
const name = params.name;
|
|
1230
|
+
const value = params.value;
|
|
1231
|
+
const ttl = params.ttl;
|
|
1232
|
+
const comment = params.comment;
|
|
1233
|
+
|
|
621
1234
|
if (typeof domainId === 'undefined') {
|
|
622
1235
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
623
1236
|
}
|
|
@@ -630,6 +1243,7 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
630
1243
|
if (typeof ttl === 'undefined') {
|
|
631
1244
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
632
1245
|
}
|
|
1246
|
+
|
|
633
1247
|
const apiPath = '/domains/{domainId}/records/aaaa'.replace('{domainId}', domainId);
|
|
634
1248
|
const payload: Payload = {};
|
|
635
1249
|
if (typeof name !== 'undefined') {
|
|
@@ -657,21 +1271,64 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
657
1271
|
payload
|
|
658
1272
|
);
|
|
659
1273
|
}
|
|
1274
|
+
|
|
660
1275
|
/**
|
|
661
1276
|
* Update an existing AAAA record for the given domain. This endpoint allows you to modify
|
|
662
|
-
|
|
663
|
-
|
|
1277
|
+
* the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
|
|
1278
|
+
* TTL, and optional comment.
|
|
664
1279
|
*
|
|
665
|
-
* @param {string} domainId
|
|
666
|
-
* @param {string} recordId
|
|
667
|
-
* @param {string} name
|
|
668
|
-
* @param {string} value
|
|
669
|
-
* @param {number} ttl
|
|
670
|
-
* @param {string} comment
|
|
1280
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1281
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1282
|
+
* @param {string} params.name - Record name (subdomain).
|
|
1283
|
+
* @param {string} params.value - IPv6 address for this AAAA record.
|
|
1284
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1285
|
+
* @param {string} params.comment - A comment for this record.
|
|
671
1286
|
* @throws {AppwriteException}
|
|
672
1287
|
* @returns {Promise<Models.DnsRecord>}
|
|
673
1288
|
*/
|
|
674
|
-
updateRecordAAAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1289
|
+
updateRecordAAAA(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1290
|
+
/**
|
|
1291
|
+
* Update an existing AAAA record for the given domain. This endpoint allows you to modify
|
|
1292
|
+
* the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
|
|
1293
|
+
* TTL, and optional comment.
|
|
1294
|
+
*
|
|
1295
|
+
* @param {string} domainId - Domain unique ID.
|
|
1296
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1297
|
+
* @param {string} name - Record name (subdomain).
|
|
1298
|
+
* @param {string} value - IPv6 address for this AAAA record.
|
|
1299
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1300
|
+
* @param {string} comment - A comment for this record.
|
|
1301
|
+
* @throws {AppwriteException}
|
|
1302
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1303
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1304
|
+
*/
|
|
1305
|
+
updateRecordAAAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1306
|
+
updateRecordAAAA(
|
|
1307
|
+
paramsOrFirst: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
1308
|
+
...rest: [(string)?, (string)?, (string)?, (number)?, (string)?]
|
|
1309
|
+
): Promise<Models.DnsRecord> {
|
|
1310
|
+
let params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1311
|
+
|
|
1312
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1313
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1314
|
+
} else {
|
|
1315
|
+
params = {
|
|
1316
|
+
domainId: paramsOrFirst as string,
|
|
1317
|
+
recordId: rest[0] as string,
|
|
1318
|
+
name: rest[1] as string,
|
|
1319
|
+
value: rest[2] as string,
|
|
1320
|
+
ttl: rest[3] as number,
|
|
1321
|
+
comment: rest[4] as string
|
|
1322
|
+
};
|
|
1323
|
+
}
|
|
1324
|
+
|
|
1325
|
+
const domainId = params.domainId;
|
|
1326
|
+
const recordId = params.recordId;
|
|
1327
|
+
const name = params.name;
|
|
1328
|
+
const value = params.value;
|
|
1329
|
+
const ttl = params.ttl;
|
|
1330
|
+
const comment = params.comment;
|
|
1331
|
+
|
|
675
1332
|
if (typeof domainId === 'undefined') {
|
|
676
1333
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
677
1334
|
}
|
|
@@ -687,6 +1344,7 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
687
1344
|
if (typeof ttl === 'undefined') {
|
|
688
1345
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
689
1346
|
}
|
|
1347
|
+
|
|
690
1348
|
const apiPath = '/domains/{domainId}/records/aaaa/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
691
1349
|
const payload: Payload = {};
|
|
692
1350
|
if (typeof name !== 'undefined') {
|
|
@@ -714,20 +1372,60 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
714
1372
|
payload
|
|
715
1373
|
);
|
|
716
1374
|
}
|
|
1375
|
+
|
|
717
1376
|
/**
|
|
718
1377
|
* Create a new ALIAS record for the given domain. This record type can be used to point your domain
|
|
719
|
-
|
|
720
|
-
|
|
1378
|
+
* to another domain name that will serve as an alias. This is particularly useful when you want to
|
|
1379
|
+
* map your domain to a target domain that may change its IP address.
|
|
721
1380
|
*
|
|
722
|
-
* @param {string} domainId
|
|
723
|
-
* @param {string} name
|
|
724
|
-
* @param {string} value
|
|
725
|
-
* @param {number} ttl
|
|
726
|
-
* @param {string} comment
|
|
1381
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1382
|
+
* @param {string} params.name - Record name.
|
|
1383
|
+
* @param {string} params.value - Target domain for this ALIAS record.
|
|
1384
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1385
|
+
* @param {string} params.comment - A comment for this record.
|
|
727
1386
|
* @throws {AppwriteException}
|
|
728
1387
|
* @returns {Promise<Models.DnsRecord>}
|
|
729
1388
|
*/
|
|
730
|
-
createRecordAlias(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1389
|
+
createRecordAlias(params: { domainId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1390
|
+
/**
|
|
1391
|
+
* Create a new ALIAS record for the given domain. This record type can be used to point your domain
|
|
1392
|
+
* to another domain name that will serve as an alias. This is particularly useful when you want to
|
|
1393
|
+
* map your domain to a target domain that may change its IP address.
|
|
1394
|
+
*
|
|
1395
|
+
* @param {string} domainId - Domain unique ID.
|
|
1396
|
+
* @param {string} name - Record name.
|
|
1397
|
+
* @param {string} value - Target domain for this ALIAS record.
|
|
1398
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1399
|
+
* @param {string} comment - A comment for this record.
|
|
1400
|
+
* @throws {AppwriteException}
|
|
1401
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1402
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1403
|
+
*/
|
|
1404
|
+
createRecordAlias(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1405
|
+
createRecordAlias(
|
|
1406
|
+
paramsOrFirst: { domainId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
1407
|
+
...rest: [(string)?, (string)?, (number)?, (string)?]
|
|
1408
|
+
): Promise<Models.DnsRecord> {
|
|
1409
|
+
let params: { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1410
|
+
|
|
1411
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1412
|
+
params = (paramsOrFirst || {}) as { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1413
|
+
} else {
|
|
1414
|
+
params = {
|
|
1415
|
+
domainId: paramsOrFirst as string,
|
|
1416
|
+
name: rest[0] as string,
|
|
1417
|
+
value: rest[1] as string,
|
|
1418
|
+
ttl: rest[2] as number,
|
|
1419
|
+
comment: rest[3] as string
|
|
1420
|
+
};
|
|
1421
|
+
}
|
|
1422
|
+
|
|
1423
|
+
const domainId = params.domainId;
|
|
1424
|
+
const name = params.name;
|
|
1425
|
+
const value = params.value;
|
|
1426
|
+
const ttl = params.ttl;
|
|
1427
|
+
const comment = params.comment;
|
|
1428
|
+
|
|
731
1429
|
if (typeof domainId === 'undefined') {
|
|
732
1430
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
733
1431
|
}
|
|
@@ -740,6 +1438,7 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
740
1438
|
if (typeof ttl === 'undefined') {
|
|
741
1439
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
742
1440
|
}
|
|
1441
|
+
|
|
743
1442
|
const apiPath = '/domains/{domainId}/records/alias'.replace('{domainId}', domainId);
|
|
744
1443
|
const payload: Payload = {};
|
|
745
1444
|
if (typeof name !== 'undefined') {
|
|
@@ -767,23 +1466,68 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
767
1466
|
payload
|
|
768
1467
|
);
|
|
769
1468
|
}
|
|
1469
|
+
|
|
770
1470
|
/**
|
|
771
1471
|
* Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
*
|
|
777
|
-
* @param {string} domainId
|
|
778
|
-
* @param {string} recordId
|
|
779
|
-
* @param {string} name
|
|
780
|
-
* @param {string} value
|
|
781
|
-
* @param {number} ttl
|
|
782
|
-
* @param {string} comment
|
|
1472
|
+
* the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
|
|
1473
|
+
*
|
|
1474
|
+
* The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
|
|
1475
|
+
* It provides a way to map one domain name to another.
|
|
1476
|
+
*
|
|
1477
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1478
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1479
|
+
* @param {string} params.name - Record name.
|
|
1480
|
+
* @param {string} params.value - Target domain for this ALIAS record.
|
|
1481
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1482
|
+
* @param {string} params.comment - A comment for this record.
|
|
1483
|
+
* @throws {AppwriteException}
|
|
1484
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1485
|
+
*/
|
|
1486
|
+
updateRecordAlias(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1487
|
+
/**
|
|
1488
|
+
* Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
|
|
1489
|
+
* the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
|
|
1490
|
+
*
|
|
1491
|
+
* The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
|
|
1492
|
+
* It provides a way to map one domain name to another.
|
|
1493
|
+
*
|
|
1494
|
+
* @param {string} domainId - Domain unique ID.
|
|
1495
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1496
|
+
* @param {string} name - Record name.
|
|
1497
|
+
* @param {string} value - Target domain for this ALIAS record.
|
|
1498
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1499
|
+
* @param {string} comment - A comment for this record.
|
|
783
1500
|
* @throws {AppwriteException}
|
|
784
1501
|
* @returns {Promise<Models.DnsRecord>}
|
|
1502
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
785
1503
|
*/
|
|
786
|
-
updateRecordAlias(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1504
|
+
updateRecordAlias(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1505
|
+
updateRecordAlias(
|
|
1506
|
+
paramsOrFirst: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
1507
|
+
...rest: [(string)?, (string)?, (string)?, (number)?, (string)?]
|
|
1508
|
+
): Promise<Models.DnsRecord> {
|
|
1509
|
+
let params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1510
|
+
|
|
1511
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1512
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1513
|
+
} else {
|
|
1514
|
+
params = {
|
|
1515
|
+
domainId: paramsOrFirst as string,
|
|
1516
|
+
recordId: rest[0] as string,
|
|
1517
|
+
name: rest[1] as string,
|
|
1518
|
+
value: rest[2] as string,
|
|
1519
|
+
ttl: rest[3] as number,
|
|
1520
|
+
comment: rest[4] as string
|
|
1521
|
+
};
|
|
1522
|
+
}
|
|
1523
|
+
|
|
1524
|
+
const domainId = params.domainId;
|
|
1525
|
+
const recordId = params.recordId;
|
|
1526
|
+
const name = params.name;
|
|
1527
|
+
const value = params.value;
|
|
1528
|
+
const ttl = params.ttl;
|
|
1529
|
+
const comment = params.comment;
|
|
1530
|
+
|
|
787
1531
|
if (typeof domainId === 'undefined') {
|
|
788
1532
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
789
1533
|
}
|
|
@@ -799,6 +1543,7 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
799
1543
|
if (typeof ttl === 'undefined') {
|
|
800
1544
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
801
1545
|
}
|
|
1546
|
+
|
|
802
1547
|
const apiPath = '/domains/{domainId}/records/alias/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
803
1548
|
const payload: Payload = {};
|
|
804
1549
|
if (typeof name !== 'undefined') {
|
|
@@ -826,19 +1571,58 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
826
1571
|
payload
|
|
827
1572
|
);
|
|
828
1573
|
}
|
|
1574
|
+
|
|
829
1575
|
/**
|
|
830
1576
|
* Create a new CAA record for the given domain. CAA records are used to specify which
|
|
831
|
-
Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
|
|
1577
|
+
* Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
|
|
832
1578
|
*
|
|
833
|
-
* @param {string} domainId
|
|
834
|
-
* @param {string} name
|
|
835
|
-
* @param {string} value
|
|
836
|
-
* @param {number} ttl
|
|
837
|
-
* @param {string} comment
|
|
1579
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1580
|
+
* @param {string} params.name - Record name.
|
|
1581
|
+
* @param {string} params.value - CAA value (e.g. issuer domain).
|
|
1582
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1583
|
+
* @param {string} params.comment - A comment for this record.
|
|
838
1584
|
* @throws {AppwriteException}
|
|
839
1585
|
* @returns {Promise<Models.DnsRecord>}
|
|
840
1586
|
*/
|
|
841
|
-
createRecordCAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1587
|
+
createRecordCAA(params: { domainId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1588
|
+
/**
|
|
1589
|
+
* Create a new CAA record for the given domain. CAA records are used to specify which
|
|
1590
|
+
* Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
|
|
1591
|
+
*
|
|
1592
|
+
* @param {string} domainId - Domain unique ID.
|
|
1593
|
+
* @param {string} name - Record name.
|
|
1594
|
+
* @param {string} value - CAA value (e.g. issuer domain).
|
|
1595
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1596
|
+
* @param {string} comment - A comment for this record.
|
|
1597
|
+
* @throws {AppwriteException}
|
|
1598
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1599
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1600
|
+
*/
|
|
1601
|
+
createRecordCAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1602
|
+
createRecordCAA(
|
|
1603
|
+
paramsOrFirst: { domainId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
1604
|
+
...rest: [(string)?, (string)?, (number)?, (string)?]
|
|
1605
|
+
): Promise<Models.DnsRecord> {
|
|
1606
|
+
let params: { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1607
|
+
|
|
1608
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1609
|
+
params = (paramsOrFirst || {}) as { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1610
|
+
} else {
|
|
1611
|
+
params = {
|
|
1612
|
+
domainId: paramsOrFirst as string,
|
|
1613
|
+
name: rest[0] as string,
|
|
1614
|
+
value: rest[1] as string,
|
|
1615
|
+
ttl: rest[2] as number,
|
|
1616
|
+
comment: rest[3] as string
|
|
1617
|
+
};
|
|
1618
|
+
}
|
|
1619
|
+
|
|
1620
|
+
const domainId = params.domainId;
|
|
1621
|
+
const name = params.name;
|
|
1622
|
+
const value = params.value;
|
|
1623
|
+
const ttl = params.ttl;
|
|
1624
|
+
const comment = params.comment;
|
|
1625
|
+
|
|
842
1626
|
if (typeof domainId === 'undefined') {
|
|
843
1627
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
844
1628
|
}
|
|
@@ -851,6 +1635,7 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
851
1635
|
if (typeof ttl === 'undefined') {
|
|
852
1636
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
853
1637
|
}
|
|
1638
|
+
|
|
854
1639
|
const apiPath = '/domains/{domainId}/records/caa'.replace('{domainId}', domainId);
|
|
855
1640
|
const payload: Payload = {};
|
|
856
1641
|
if (typeof name !== 'undefined') {
|
|
@@ -878,21 +1663,64 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
878
1663
|
payload
|
|
879
1664
|
);
|
|
880
1665
|
}
|
|
1666
|
+
|
|
1667
|
+
/**
|
|
1668
|
+
* Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
|
|
1669
|
+
* record is used to specify which certificate authorities (CAs) are authorized to issue certificates
|
|
1670
|
+
* for a domain.
|
|
1671
|
+
*
|
|
1672
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1673
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1674
|
+
* @param {string} params.name - Record name.
|
|
1675
|
+
* @param {string} params.value - CAA value (e.g. issuer domain).
|
|
1676
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1677
|
+
* @param {string} params.comment - A comment for this record.
|
|
1678
|
+
* @throws {AppwriteException}
|
|
1679
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1680
|
+
*/
|
|
1681
|
+
updateRecordCAA(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
881
1682
|
/**
|
|
882
1683
|
* Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
|
|
883
|
-
|
|
884
|
-
|
|
1684
|
+
* record is used to specify which certificate authorities (CAs) are authorized to issue certificates
|
|
1685
|
+
* for a domain.
|
|
885
1686
|
*
|
|
886
|
-
* @param {string} domainId
|
|
887
|
-
* @param {string} recordId
|
|
888
|
-
* @param {string} name
|
|
889
|
-
* @param {string} value
|
|
890
|
-
* @param {number} ttl
|
|
891
|
-
* @param {string} comment
|
|
1687
|
+
* @param {string} domainId - Domain unique ID.
|
|
1688
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1689
|
+
* @param {string} name - Record name.
|
|
1690
|
+
* @param {string} value - CAA value (e.g. issuer domain).
|
|
1691
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1692
|
+
* @param {string} comment - A comment for this record.
|
|
892
1693
|
* @throws {AppwriteException}
|
|
893
1694
|
* @returns {Promise<Models.DnsRecord>}
|
|
1695
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
894
1696
|
*/
|
|
895
|
-
updateRecordCAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1697
|
+
updateRecordCAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1698
|
+
updateRecordCAA(
|
|
1699
|
+
paramsOrFirst: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
1700
|
+
...rest: [(string)?, (string)?, (string)?, (number)?, (string)?]
|
|
1701
|
+
): Promise<Models.DnsRecord> {
|
|
1702
|
+
let params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1703
|
+
|
|
1704
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1705
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1706
|
+
} else {
|
|
1707
|
+
params = {
|
|
1708
|
+
domainId: paramsOrFirst as string,
|
|
1709
|
+
recordId: rest[0] as string,
|
|
1710
|
+
name: rest[1] as string,
|
|
1711
|
+
value: rest[2] as string,
|
|
1712
|
+
ttl: rest[3] as number,
|
|
1713
|
+
comment: rest[4] as string
|
|
1714
|
+
};
|
|
1715
|
+
}
|
|
1716
|
+
|
|
1717
|
+
const domainId = params.domainId;
|
|
1718
|
+
const recordId = params.recordId;
|
|
1719
|
+
const name = params.name;
|
|
1720
|
+
const value = params.value;
|
|
1721
|
+
const ttl = params.ttl;
|
|
1722
|
+
const comment = params.comment;
|
|
1723
|
+
|
|
896
1724
|
if (typeof domainId === 'undefined') {
|
|
897
1725
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
898
1726
|
}
|
|
@@ -908,6 +1736,7 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
908
1736
|
if (typeof ttl === 'undefined') {
|
|
909
1737
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
910
1738
|
}
|
|
1739
|
+
|
|
911
1740
|
const apiPath = '/domains/{domainId}/records/caa/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
912
1741
|
const payload: Payload = {};
|
|
913
1742
|
if (typeof name !== 'undefined') {
|
|
@@ -935,22 +1764,64 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
935
1764
|
payload
|
|
936
1765
|
);
|
|
937
1766
|
}
|
|
1767
|
+
|
|
1768
|
+
/**
|
|
1769
|
+
* Create a new CNAME record for the given domain.
|
|
1770
|
+
*
|
|
1771
|
+
* A CNAME record maps a subdomain to another domain name, allowing you to create aliases
|
|
1772
|
+
* for your domain. For example, you can create a CNAME record to point 'blog.example.com'
|
|
1773
|
+
* to 'example.wordpress.com'.
|
|
1774
|
+
*
|
|
1775
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1776
|
+
* @param {string} params.name - Record name (subdomain).
|
|
1777
|
+
* @param {string} params.value - Canonical target for this CNAME record.
|
|
1778
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1779
|
+
* @param {string} params.comment - A comment for this record.
|
|
1780
|
+
* @throws {AppwriteException}
|
|
1781
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1782
|
+
*/
|
|
1783
|
+
createRecordCNAME(params: { domainId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
938
1784
|
/**
|
|
939
1785
|
* Create a new CNAME record for the given domain.
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
1786
|
+
*
|
|
1787
|
+
* A CNAME record maps a subdomain to another domain name, allowing you to create aliases
|
|
1788
|
+
* for your domain. For example, you can create a CNAME record to point 'blog.example.com'
|
|
1789
|
+
* to 'example.wordpress.com'.
|
|
944
1790
|
*
|
|
945
|
-
* @param {string} domainId
|
|
946
|
-
* @param {string} name
|
|
947
|
-
* @param {string} value
|
|
948
|
-
* @param {number} ttl
|
|
949
|
-
* @param {string} comment
|
|
1791
|
+
* @param {string} domainId - Domain unique ID.
|
|
1792
|
+
* @param {string} name - Record name (subdomain).
|
|
1793
|
+
* @param {string} value - Canonical target for this CNAME record.
|
|
1794
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1795
|
+
* @param {string} comment - A comment for this record.
|
|
950
1796
|
* @throws {AppwriteException}
|
|
951
1797
|
* @returns {Promise<Models.DnsRecord>}
|
|
1798
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
952
1799
|
*/
|
|
953
|
-
createRecordCNAME(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1800
|
+
createRecordCNAME(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1801
|
+
createRecordCNAME(
|
|
1802
|
+
paramsOrFirst: { domainId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
1803
|
+
...rest: [(string)?, (string)?, (number)?, (string)?]
|
|
1804
|
+
): Promise<Models.DnsRecord> {
|
|
1805
|
+
let params: { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1806
|
+
|
|
1807
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1808
|
+
params = (paramsOrFirst || {}) as { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1809
|
+
} else {
|
|
1810
|
+
params = {
|
|
1811
|
+
domainId: paramsOrFirst as string,
|
|
1812
|
+
name: rest[0] as string,
|
|
1813
|
+
value: rest[1] as string,
|
|
1814
|
+
ttl: rest[2] as number,
|
|
1815
|
+
comment: rest[3] as string
|
|
1816
|
+
};
|
|
1817
|
+
}
|
|
1818
|
+
|
|
1819
|
+
const domainId = params.domainId;
|
|
1820
|
+
const name = params.name;
|
|
1821
|
+
const value = params.value;
|
|
1822
|
+
const ttl = params.ttl;
|
|
1823
|
+
const comment = params.comment;
|
|
1824
|
+
|
|
954
1825
|
if (typeof domainId === 'undefined') {
|
|
955
1826
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
956
1827
|
}
|
|
@@ -963,6 +1834,7 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
963
1834
|
if (typeof ttl === 'undefined') {
|
|
964
1835
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
965
1836
|
}
|
|
1837
|
+
|
|
966
1838
|
const apiPath = '/domains/{domainId}/records/cname'.replace('{domainId}', domainId);
|
|
967
1839
|
const payload: Payload = {};
|
|
968
1840
|
if (typeof name !== 'undefined') {
|
|
@@ -990,19 +1862,60 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
990
1862
|
payload
|
|
991
1863
|
);
|
|
992
1864
|
}
|
|
1865
|
+
|
|
1866
|
+
/**
|
|
1867
|
+
* Update an existing CNAME record for the given domain.
|
|
1868
|
+
*
|
|
1869
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1870
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1871
|
+
* @param {string} params.name - Record name (subdomain).
|
|
1872
|
+
* @param {string} params.value - Canonical target for this CNAME record.
|
|
1873
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1874
|
+
* @param {string} params.comment - A comment for this record.
|
|
1875
|
+
* @throws {AppwriteException}
|
|
1876
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1877
|
+
*/
|
|
1878
|
+
updateRecordCNAME(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
993
1879
|
/**
|
|
994
1880
|
* Update an existing CNAME record for the given domain.
|
|
995
1881
|
*
|
|
996
|
-
* @param {string} domainId
|
|
997
|
-
* @param {string} recordId
|
|
998
|
-
* @param {string} name
|
|
999
|
-
* @param {string} value
|
|
1000
|
-
* @param {number} ttl
|
|
1001
|
-
* @param {string} comment
|
|
1882
|
+
* @param {string} domainId - Domain unique ID.
|
|
1883
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1884
|
+
* @param {string} name - Record name (subdomain).
|
|
1885
|
+
* @param {string} value - Canonical target for this CNAME record.
|
|
1886
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1887
|
+
* @param {string} comment - A comment for this record.
|
|
1002
1888
|
* @throws {AppwriteException}
|
|
1003
1889
|
* @returns {Promise<Models.DnsRecord>}
|
|
1890
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1004
1891
|
*/
|
|
1005
|
-
updateRecordCNAME(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1892
|
+
updateRecordCNAME(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1893
|
+
updateRecordCNAME(
|
|
1894
|
+
paramsOrFirst: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
1895
|
+
...rest: [(string)?, (string)?, (string)?, (number)?, (string)?]
|
|
1896
|
+
): Promise<Models.DnsRecord> {
|
|
1897
|
+
let params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1898
|
+
|
|
1899
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1900
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1901
|
+
} else {
|
|
1902
|
+
params = {
|
|
1903
|
+
domainId: paramsOrFirst as string,
|
|
1904
|
+
recordId: rest[0] as string,
|
|
1905
|
+
name: rest[1] as string,
|
|
1906
|
+
value: rest[2] as string,
|
|
1907
|
+
ttl: rest[3] as number,
|
|
1908
|
+
comment: rest[4] as string
|
|
1909
|
+
};
|
|
1910
|
+
}
|
|
1911
|
+
|
|
1912
|
+
const domainId = params.domainId;
|
|
1913
|
+
const recordId = params.recordId;
|
|
1914
|
+
const name = params.name;
|
|
1915
|
+
const value = params.value;
|
|
1916
|
+
const ttl = params.ttl;
|
|
1917
|
+
const comment = params.comment;
|
|
1918
|
+
|
|
1006
1919
|
if (typeof domainId === 'undefined') {
|
|
1007
1920
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1008
1921
|
}
|
|
@@ -1018,6 +1931,7 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
1018
1931
|
if (typeof ttl === 'undefined') {
|
|
1019
1932
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1020
1933
|
}
|
|
1934
|
+
|
|
1021
1935
|
const apiPath = '/domains/{domainId}/records/cname/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1022
1936
|
const payload: Payload = {};
|
|
1023
1937
|
if (typeof name !== 'undefined') {
|
|
@@ -1045,19 +1959,58 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
1045
1959
|
payload
|
|
1046
1960
|
);
|
|
1047
1961
|
}
|
|
1962
|
+
|
|
1963
|
+
/**
|
|
1964
|
+
* Create a new HTTPS record for the given domain. This record is used to configure HTTPS
|
|
1965
|
+
* settings for your domain, enabling secure communication over SSL/TLS.
|
|
1966
|
+
*
|
|
1967
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1968
|
+
* @param {string} params.name - Record name (subdomain).
|
|
1969
|
+
* @param {string} params.value - Target for the HTTPS record.
|
|
1970
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1971
|
+
* @param {string} params.comment - A comment for this record.
|
|
1972
|
+
* @throws {AppwriteException}
|
|
1973
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1974
|
+
*/
|
|
1975
|
+
createRecordHTTPS(params: { domainId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1048
1976
|
/**
|
|
1049
1977
|
* Create a new HTTPS record for the given domain. This record is used to configure HTTPS
|
|
1050
|
-
|
|
1978
|
+
* settings for your domain, enabling secure communication over SSL/TLS.
|
|
1051
1979
|
*
|
|
1052
|
-
* @param {string} domainId
|
|
1053
|
-
* @param {string} name
|
|
1054
|
-
* @param {string} value
|
|
1055
|
-
* @param {number} ttl
|
|
1056
|
-
* @param {string} comment
|
|
1980
|
+
* @param {string} domainId - Domain unique ID.
|
|
1981
|
+
* @param {string} name - Record name (subdomain).
|
|
1982
|
+
* @param {string} value - Target for the HTTPS record.
|
|
1983
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1984
|
+
* @param {string} comment - A comment for this record.
|
|
1057
1985
|
* @throws {AppwriteException}
|
|
1058
1986
|
* @returns {Promise<Models.DnsRecord>}
|
|
1987
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1059
1988
|
*/
|
|
1060
|
-
createRecordHTTPS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1989
|
+
createRecordHTTPS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1990
|
+
createRecordHTTPS(
|
|
1991
|
+
paramsOrFirst: { domainId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
1992
|
+
...rest: [(string)?, (string)?, (number)?, (string)?]
|
|
1993
|
+
): Promise<Models.DnsRecord> {
|
|
1994
|
+
let params: { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1995
|
+
|
|
1996
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1997
|
+
params = (paramsOrFirst || {}) as { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
1998
|
+
} else {
|
|
1999
|
+
params = {
|
|
2000
|
+
domainId: paramsOrFirst as string,
|
|
2001
|
+
name: rest[0] as string,
|
|
2002
|
+
value: rest[1] as string,
|
|
2003
|
+
ttl: rest[2] as number,
|
|
2004
|
+
comment: rest[3] as string
|
|
2005
|
+
};
|
|
2006
|
+
}
|
|
2007
|
+
|
|
2008
|
+
const domainId = params.domainId;
|
|
2009
|
+
const name = params.name;
|
|
2010
|
+
const value = params.value;
|
|
2011
|
+
const ttl = params.ttl;
|
|
2012
|
+
const comment = params.comment;
|
|
2013
|
+
|
|
1061
2014
|
if (typeof domainId === 'undefined') {
|
|
1062
2015
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1063
2016
|
}
|
|
@@ -1070,6 +2023,7 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
1070
2023
|
if (typeof ttl === 'undefined') {
|
|
1071
2024
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1072
2025
|
}
|
|
2026
|
+
|
|
1073
2027
|
const apiPath = '/domains/{domainId}/records/https'.replace('{domainId}', domainId);
|
|
1074
2028
|
const payload: Payload = {};
|
|
1075
2029
|
if (typeof name !== 'undefined') {
|
|
@@ -1097,21 +2051,64 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
1097
2051
|
payload
|
|
1098
2052
|
);
|
|
1099
2053
|
}
|
|
2054
|
+
|
|
2055
|
+
/**
|
|
2056
|
+
* Update an existing HTTPS record for the given domain. This endpoint allows you to modify
|
|
2057
|
+
* the properties of an HTTPS record associated with your domain, including the name (subdomain),
|
|
2058
|
+
* target value, TTL, and optional comment.
|
|
2059
|
+
*
|
|
2060
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
2061
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
2062
|
+
* @param {string} params.name - Record name (subdomain).
|
|
2063
|
+
* @param {string} params.value - Target for the HTTPS record.
|
|
2064
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
2065
|
+
* @param {string} params.comment - A comment for this record.
|
|
2066
|
+
* @throws {AppwriteException}
|
|
2067
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2068
|
+
*/
|
|
2069
|
+
updateRecordHTTPS(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1100
2070
|
/**
|
|
1101
2071
|
* Update an existing HTTPS record for the given domain. This endpoint allows you to modify
|
|
1102
|
-
the properties of an HTTPS record associated with your domain, including the name (subdomain),
|
|
1103
|
-
target value, TTL, and optional comment.
|
|
2072
|
+
* the properties of an HTTPS record associated with your domain, including the name (subdomain),
|
|
2073
|
+
* target value, TTL, and optional comment.
|
|
1104
2074
|
*
|
|
1105
|
-
* @param {string} domainId
|
|
1106
|
-
* @param {string} recordId
|
|
1107
|
-
* @param {string} name
|
|
1108
|
-
* @param {string} value
|
|
1109
|
-
* @param {number} ttl
|
|
1110
|
-
* @param {string} comment
|
|
2075
|
+
* @param {string} domainId - Domain unique ID.
|
|
2076
|
+
* @param {string} recordId - DNS record unique ID.
|
|
2077
|
+
* @param {string} name - Record name (subdomain).
|
|
2078
|
+
* @param {string} value - Target for the HTTPS record.
|
|
2079
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
2080
|
+
* @param {string} comment - A comment for this record.
|
|
1111
2081
|
* @throws {AppwriteException}
|
|
1112
2082
|
* @returns {Promise<Models.DnsRecord>}
|
|
2083
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1113
2084
|
*/
|
|
1114
|
-
updateRecordHTTPS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
2085
|
+
updateRecordHTTPS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
2086
|
+
updateRecordHTTPS(
|
|
2087
|
+
paramsOrFirst: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
2088
|
+
...rest: [(string)?, (string)?, (string)?, (number)?, (string)?]
|
|
2089
|
+
): Promise<Models.DnsRecord> {
|
|
2090
|
+
let params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
2091
|
+
|
|
2092
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2093
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
2094
|
+
} else {
|
|
2095
|
+
params = {
|
|
2096
|
+
domainId: paramsOrFirst as string,
|
|
2097
|
+
recordId: rest[0] as string,
|
|
2098
|
+
name: rest[1] as string,
|
|
2099
|
+
value: rest[2] as string,
|
|
2100
|
+
ttl: rest[3] as number,
|
|
2101
|
+
comment: rest[4] as string
|
|
2102
|
+
};
|
|
2103
|
+
}
|
|
2104
|
+
|
|
2105
|
+
const domainId = params.domainId;
|
|
2106
|
+
const recordId = params.recordId;
|
|
2107
|
+
const name = params.name;
|
|
2108
|
+
const value = params.value;
|
|
2109
|
+
const ttl = params.ttl;
|
|
2110
|
+
const comment = params.comment;
|
|
2111
|
+
|
|
1115
2112
|
if (typeof domainId === 'undefined') {
|
|
1116
2113
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1117
2114
|
}
|
|
@@ -1127,6 +2124,7 @@ target value, TTL, and optional comment.
|
|
|
1127
2124
|
if (typeof ttl === 'undefined') {
|
|
1128
2125
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1129
2126
|
}
|
|
2127
|
+
|
|
1130
2128
|
const apiPath = '/domains/{domainId}/records/https/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1131
2129
|
const payload: Payload = {};
|
|
1132
2130
|
if (typeof name !== 'undefined') {
|
|
@@ -1154,22 +2152,66 @@ target value, TTL, and optional comment.
|
|
|
1154
2152
|
payload
|
|
1155
2153
|
);
|
|
1156
2154
|
}
|
|
2155
|
+
|
|
2156
|
+
/**
|
|
2157
|
+
* Create a new MX record for the given domain. MX records are used to define the mail servers responsible
|
|
2158
|
+
* for accepting email messages for the domain. Multiple MX records can be created with different priorities.
|
|
2159
|
+
* The priority parameter determines the order in which mail servers are used, with lower values indicating
|
|
2160
|
+
* higher priority.
|
|
2161
|
+
*
|
|
2162
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
2163
|
+
* @param {string} params.name - Record name (subdomain).
|
|
2164
|
+
* @param {string} params.value - Mail server domain for this MX record.
|
|
2165
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
2166
|
+
* @param {number} params.priority - MX priority.
|
|
2167
|
+
* @param {string} params.comment - A comment for this record.
|
|
2168
|
+
* @throws {AppwriteException}
|
|
2169
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2170
|
+
*/
|
|
2171
|
+
createRecordMX(params: { domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1157
2172
|
/**
|
|
1158
2173
|
* Create a new MX record for the given domain. MX records are used to define the mail servers responsible
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
|
|
2174
|
+
* for accepting email messages for the domain. Multiple MX records can be created with different priorities.
|
|
2175
|
+
* The priority parameter determines the order in which mail servers are used, with lower values indicating
|
|
2176
|
+
* higher priority.
|
|
1162
2177
|
*
|
|
1163
|
-
* @param {string} domainId
|
|
1164
|
-
* @param {string} name
|
|
1165
|
-
* @param {string} value
|
|
1166
|
-
* @param {number} ttl
|
|
1167
|
-
* @param {number} priority
|
|
1168
|
-
* @param {string} comment
|
|
2178
|
+
* @param {string} domainId - Domain unique ID.
|
|
2179
|
+
* @param {string} name - Record name (subdomain).
|
|
2180
|
+
* @param {string} value - Mail server domain for this MX record.
|
|
2181
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
2182
|
+
* @param {number} priority - MX priority.
|
|
2183
|
+
* @param {string} comment - A comment for this record.
|
|
1169
2184
|
* @throws {AppwriteException}
|
|
1170
2185
|
* @returns {Promise<Models.DnsRecord>}
|
|
2186
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1171
2187
|
*/
|
|
1172
|
-
createRecordMX(domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord
|
|
2188
|
+
createRecordMX(domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
|
|
2189
|
+
createRecordMX(
|
|
2190
|
+
paramsOrFirst: { domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string } | string,
|
|
2191
|
+
...rest: [(string)?, (string)?, (number)?, (number)?, (string)?]
|
|
2192
|
+
): Promise<Models.DnsRecord> {
|
|
2193
|
+
let params: { domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string };
|
|
2194
|
+
|
|
2195
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2196
|
+
params = (paramsOrFirst || {}) as { domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string };
|
|
2197
|
+
} else {
|
|
2198
|
+
params = {
|
|
2199
|
+
domainId: paramsOrFirst as string,
|
|
2200
|
+
name: rest[0] as string,
|
|
2201
|
+
value: rest[1] as string,
|
|
2202
|
+
ttl: rest[2] as number,
|
|
2203
|
+
priority: rest[3] as number,
|
|
2204
|
+
comment: rest[4] as string
|
|
2205
|
+
};
|
|
2206
|
+
}
|
|
2207
|
+
|
|
2208
|
+
const domainId = params.domainId;
|
|
2209
|
+
const name = params.name;
|
|
2210
|
+
const value = params.value;
|
|
2211
|
+
const ttl = params.ttl;
|
|
2212
|
+
const priority = params.priority;
|
|
2213
|
+
const comment = params.comment;
|
|
2214
|
+
|
|
1173
2215
|
if (typeof domainId === 'undefined') {
|
|
1174
2216
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1175
2217
|
}
|
|
@@ -1185,6 +2227,7 @@ target value, TTL, and optional comment.
|
|
|
1185
2227
|
if (typeof priority === 'undefined') {
|
|
1186
2228
|
throw new AppwriteException('Missing required parameter: "priority"');
|
|
1187
2229
|
}
|
|
2230
|
+
|
|
1188
2231
|
const apiPath = '/domains/{domainId}/records/mx'.replace('{domainId}', domainId);
|
|
1189
2232
|
const payload: Payload = {};
|
|
1190
2233
|
if (typeof name !== 'undefined') {
|
|
@@ -1215,20 +2258,64 @@ target value, TTL, and optional comment.
|
|
|
1215
2258
|
payload
|
|
1216
2259
|
);
|
|
1217
2260
|
}
|
|
2261
|
+
|
|
2262
|
+
/**
|
|
2263
|
+
* Update an existing MX record for the given domain.
|
|
2264
|
+
*
|
|
2265
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
2266
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
2267
|
+
* @param {string} params.name - Record name (subdomain).
|
|
2268
|
+
* @param {string} params.value - Mail server domain for this MX record.
|
|
2269
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
2270
|
+
* @param {number} params.priority - MX priority.
|
|
2271
|
+
* @param {string} params.comment - A comment for this record.
|
|
2272
|
+
* @throws {AppwriteException}
|
|
2273
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2274
|
+
*/
|
|
2275
|
+
updateRecordMX(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1218
2276
|
/**
|
|
1219
2277
|
* Update an existing MX record for the given domain.
|
|
1220
2278
|
*
|
|
1221
|
-
* @param {string} domainId
|
|
1222
|
-
* @param {string} recordId
|
|
1223
|
-
* @param {string} name
|
|
1224
|
-
* @param {string} value
|
|
1225
|
-
* @param {number} ttl
|
|
1226
|
-
* @param {number} priority
|
|
1227
|
-
* @param {string} comment
|
|
2279
|
+
* @param {string} domainId - Domain unique ID.
|
|
2280
|
+
* @param {string} recordId - DNS record unique ID.
|
|
2281
|
+
* @param {string} name - Record name (subdomain).
|
|
2282
|
+
* @param {string} value - Mail server domain for this MX record.
|
|
2283
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
2284
|
+
* @param {number} priority - MX priority.
|
|
2285
|
+
* @param {string} comment - A comment for this record.
|
|
1228
2286
|
* @throws {AppwriteException}
|
|
1229
2287
|
* @returns {Promise<Models.DnsRecord>}
|
|
2288
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1230
2289
|
*/
|
|
1231
|
-
updateRecordMX(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord
|
|
2290
|
+
updateRecordMX(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
|
|
2291
|
+
updateRecordMX(
|
|
2292
|
+
paramsOrFirst: { domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string } | string,
|
|
2293
|
+
...rest: [(string)?, (string)?, (string)?, (number)?, (number)?, (string)?]
|
|
2294
|
+
): Promise<Models.DnsRecord> {
|
|
2295
|
+
let params: { domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string };
|
|
2296
|
+
|
|
2297
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2298
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string };
|
|
2299
|
+
} else {
|
|
2300
|
+
params = {
|
|
2301
|
+
domainId: paramsOrFirst as string,
|
|
2302
|
+
recordId: rest[0] as string,
|
|
2303
|
+
name: rest[1] as string,
|
|
2304
|
+
value: rest[2] as string,
|
|
2305
|
+
ttl: rest[3] as number,
|
|
2306
|
+
priority: rest[4] as number,
|
|
2307
|
+
comment: rest[5] as string
|
|
2308
|
+
};
|
|
2309
|
+
}
|
|
2310
|
+
|
|
2311
|
+
const domainId = params.domainId;
|
|
2312
|
+
const recordId = params.recordId;
|
|
2313
|
+
const name = params.name;
|
|
2314
|
+
const value = params.value;
|
|
2315
|
+
const ttl = params.ttl;
|
|
2316
|
+
const priority = params.priority;
|
|
2317
|
+
const comment = params.comment;
|
|
2318
|
+
|
|
1232
2319
|
if (typeof domainId === 'undefined') {
|
|
1233
2320
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1234
2321
|
}
|
|
@@ -1247,6 +2334,7 @@ target value, TTL, and optional comment.
|
|
|
1247
2334
|
if (typeof priority === 'undefined') {
|
|
1248
2335
|
throw new AppwriteException('Missing required parameter: "priority"');
|
|
1249
2336
|
}
|
|
2337
|
+
|
|
1250
2338
|
const apiPath = '/domains/{domainId}/records/mx/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1251
2339
|
const payload: Payload = {};
|
|
1252
2340
|
if (typeof name !== 'undefined') {
|
|
@@ -1277,19 +2365,58 @@ target value, TTL, and optional comment.
|
|
|
1277
2365
|
payload
|
|
1278
2366
|
);
|
|
1279
2367
|
}
|
|
2368
|
+
|
|
1280
2369
|
/**
|
|
1281
2370
|
* Create a new NS record for the given domain. NS records specify the nameservers that are used
|
|
1282
|
-
|
|
2371
|
+
* to resolve the domain name to IP addresses. Each domain can have multiple NS records.
|
|
1283
2372
|
*
|
|
1284
|
-
* @param {string} domainId
|
|
1285
|
-
* @param {string} name
|
|
1286
|
-
* @param {string} value
|
|
1287
|
-
* @param {number} ttl
|
|
1288
|
-
* @param {string} comment
|
|
2373
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
2374
|
+
* @param {string} params.name - Record name (subdomain).
|
|
2375
|
+
* @param {string} params.value - Nameserver target for this NS record.
|
|
2376
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
2377
|
+
* @param {string} params.comment - A comment for this record.
|
|
1289
2378
|
* @throws {AppwriteException}
|
|
1290
2379
|
* @returns {Promise<Models.DnsRecord>}
|
|
1291
2380
|
*/
|
|
1292
|
-
createRecordNS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
2381
|
+
createRecordNS(params: { domainId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
2382
|
+
/**
|
|
2383
|
+
* Create a new NS record for the given domain. NS records specify the nameservers that are used
|
|
2384
|
+
* to resolve the domain name to IP addresses. Each domain can have multiple NS records.
|
|
2385
|
+
*
|
|
2386
|
+
* @param {string} domainId - Domain unique ID.
|
|
2387
|
+
* @param {string} name - Record name (subdomain).
|
|
2388
|
+
* @param {string} value - Nameserver target for this NS record.
|
|
2389
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
2390
|
+
* @param {string} comment - A comment for this record.
|
|
2391
|
+
* @throws {AppwriteException}
|
|
2392
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2393
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2394
|
+
*/
|
|
2395
|
+
createRecordNS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
2396
|
+
createRecordNS(
|
|
2397
|
+
paramsOrFirst: { domainId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
2398
|
+
...rest: [(string)?, (string)?, (number)?, (string)?]
|
|
2399
|
+
): Promise<Models.DnsRecord> {
|
|
2400
|
+
let params: { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
2401
|
+
|
|
2402
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2403
|
+
params = (paramsOrFirst || {}) as { domainId: string, name: string, value: string, ttl: number, comment?: string };
|
|
2404
|
+
} else {
|
|
2405
|
+
params = {
|
|
2406
|
+
domainId: paramsOrFirst as string,
|
|
2407
|
+
name: rest[0] as string,
|
|
2408
|
+
value: rest[1] as string,
|
|
2409
|
+
ttl: rest[2] as number,
|
|
2410
|
+
comment: rest[3] as string
|
|
2411
|
+
};
|
|
2412
|
+
}
|
|
2413
|
+
|
|
2414
|
+
const domainId = params.domainId;
|
|
2415
|
+
const name = params.name;
|
|
2416
|
+
const value = params.value;
|
|
2417
|
+
const ttl = params.ttl;
|
|
2418
|
+
const comment = params.comment;
|
|
2419
|
+
|
|
1293
2420
|
if (typeof domainId === 'undefined') {
|
|
1294
2421
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1295
2422
|
}
|
|
@@ -1302,6 +2429,7 @@ target value, TTL, and optional comment.
|
|
|
1302
2429
|
if (typeof ttl === 'undefined') {
|
|
1303
2430
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1304
2431
|
}
|
|
2432
|
+
|
|
1305
2433
|
const apiPath = '/domains/{domainId}/records/ns'.replace('{domainId}', domainId);
|
|
1306
2434
|
const payload: Payload = {};
|
|
1307
2435
|
if (typeof name !== 'undefined') {
|
|
@@ -1329,22 +2457,66 @@ target value, TTL, and optional comment.
|
|
|
1329
2457
|
payload
|
|
1330
2458
|
);
|
|
1331
2459
|
}
|
|
2460
|
+
|
|
2461
|
+
/**
|
|
2462
|
+
* Update an existing NS record for the given domain. This endpoint allows you to modify
|
|
2463
|
+
* the properties of an NS (nameserver) record associated with your domain. You can update
|
|
2464
|
+
* the record name (subdomain), target nameserver value, TTL, and add or modify comments
|
|
2465
|
+
* for better record management.
|
|
2466
|
+
*
|
|
2467
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
2468
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
2469
|
+
* @param {string} params.name - Record name (subdomain).
|
|
2470
|
+
* @param {string} params.value - Nameserver target for this NS record.
|
|
2471
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
2472
|
+
* @param {string} params.comment - A comment for this record.
|
|
2473
|
+
* @throws {AppwriteException}
|
|
2474
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2475
|
+
*/
|
|
2476
|
+
updateRecordNS(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1332
2477
|
/**
|
|
1333
2478
|
* Update an existing NS record for the given domain. This endpoint allows you to modify
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
2479
|
+
* the properties of an NS (nameserver) record associated with your domain. You can update
|
|
2480
|
+
* the record name (subdomain), target nameserver value, TTL, and add or modify comments
|
|
2481
|
+
* for better record management.
|
|
1337
2482
|
*
|
|
1338
|
-
* @param {string} domainId
|
|
1339
|
-
* @param {string} recordId
|
|
1340
|
-
* @param {string} name
|
|
1341
|
-
* @param {string} value
|
|
1342
|
-
* @param {number} ttl
|
|
1343
|
-
* @param {string} comment
|
|
2483
|
+
* @param {string} domainId - Domain unique ID.
|
|
2484
|
+
* @param {string} recordId - DNS record unique ID.
|
|
2485
|
+
* @param {string} name - Record name (subdomain).
|
|
2486
|
+
* @param {string} value - Nameserver target for this NS record.
|
|
2487
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
2488
|
+
* @param {string} comment - A comment for this record.
|
|
1344
2489
|
* @throws {AppwriteException}
|
|
1345
2490
|
* @returns {Promise<Models.DnsRecord>}
|
|
2491
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1346
2492
|
*/
|
|
1347
|
-
updateRecordNS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
2493
|
+
updateRecordNS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
2494
|
+
updateRecordNS(
|
|
2495
|
+
paramsOrFirst: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
2496
|
+
...rest: [(string)?, (string)?, (string)?, (number)?, (string)?]
|
|
2497
|
+
): Promise<Models.DnsRecord> {
|
|
2498
|
+
let params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
2499
|
+
|
|
2500
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2501
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
2502
|
+
} else {
|
|
2503
|
+
params = {
|
|
2504
|
+
domainId: paramsOrFirst as string,
|
|
2505
|
+
recordId: rest[0] as string,
|
|
2506
|
+
name: rest[1] as string,
|
|
2507
|
+
value: rest[2] as string,
|
|
2508
|
+
ttl: rest[3] as number,
|
|
2509
|
+
comment: rest[4] as string
|
|
2510
|
+
};
|
|
2511
|
+
}
|
|
2512
|
+
|
|
2513
|
+
const domainId = params.domainId;
|
|
2514
|
+
const recordId = params.recordId;
|
|
2515
|
+
const name = params.name;
|
|
2516
|
+
const value = params.value;
|
|
2517
|
+
const ttl = params.ttl;
|
|
2518
|
+
const comment = params.comment;
|
|
2519
|
+
|
|
1348
2520
|
if (typeof domainId === 'undefined') {
|
|
1349
2521
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1350
2522
|
}
|
|
@@ -1360,6 +2532,7 @@ target value, TTL, and optional comment.
|
|
|
1360
2532
|
if (typeof ttl === 'undefined') {
|
|
1361
2533
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1362
2534
|
}
|
|
2535
|
+
|
|
1363
2536
|
const apiPath = '/domains/{domainId}/records/ns/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1364
2537
|
const payload: Payload = {};
|
|
1365
2538
|
if (typeof name !== 'undefined') {
|
|
@@ -1387,23 +2560,72 @@ target value, TTL, and optional comment.
|
|
|
1387
2560
|
payload
|
|
1388
2561
|
);
|
|
1389
2562
|
}
|
|
2563
|
+
|
|
2564
|
+
/**
|
|
2565
|
+
* Create a new SRV record for the given domain. SRV records are used to define the location
|
|
2566
|
+
* of servers for specific services. For example, they can be used to specify which server
|
|
2567
|
+
* handles a specific service like SIP or XMPP for the domain.
|
|
2568
|
+
*
|
|
2569
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
2570
|
+
* @param {string} params.name - Record name (service name).
|
|
2571
|
+
* @param {string} params.value - Target hostname for this SRV record.
|
|
2572
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
2573
|
+
* @param {number} params.priority - Record priority.
|
|
2574
|
+
* @param {number} params.weight - Record weight.
|
|
2575
|
+
* @param {number} params.port - Port number for the service.
|
|
2576
|
+
* @param {string} params.comment - A comment for this record.
|
|
2577
|
+
* @throws {AppwriteException}
|
|
2578
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2579
|
+
*/
|
|
2580
|
+
createRecordSRV(params: { domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1390
2581
|
/**
|
|
1391
2582
|
* Create a new SRV record for the given domain. SRV records are used to define the location
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
*
|
|
1395
|
-
* @param {string} domainId
|
|
1396
|
-
* @param {string} name
|
|
1397
|
-
* @param {string} value
|
|
1398
|
-
* @param {number} ttl
|
|
1399
|
-
* @param {number} priority
|
|
1400
|
-
* @param {number} weight
|
|
1401
|
-
* @param {number} port
|
|
1402
|
-
* @param {string} comment
|
|
2583
|
+
* of servers for specific services. For example, they can be used to specify which server
|
|
2584
|
+
* handles a specific service like SIP or XMPP for the domain.
|
|
2585
|
+
*
|
|
2586
|
+
* @param {string} domainId - Domain unique ID.
|
|
2587
|
+
* @param {string} name - Record name (service name).
|
|
2588
|
+
* @param {string} value - Target hostname for this SRV record.
|
|
2589
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
2590
|
+
* @param {number} priority - Record priority.
|
|
2591
|
+
* @param {number} weight - Record weight.
|
|
2592
|
+
* @param {number} port - Port number for the service.
|
|
2593
|
+
* @param {string} comment - A comment for this record.
|
|
1403
2594
|
* @throws {AppwriteException}
|
|
1404
2595
|
* @returns {Promise<Models.DnsRecord>}
|
|
2596
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1405
2597
|
*/
|
|
1406
|
-
createRecordSRV(domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord
|
|
2598
|
+
createRecordSRV(domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
|
|
2599
|
+
createRecordSRV(
|
|
2600
|
+
paramsOrFirst: { domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string } | string,
|
|
2601
|
+
...rest: [(string)?, (string)?, (number)?, (number)?, (number)?, (number)?, (string)?]
|
|
2602
|
+
): Promise<Models.DnsRecord> {
|
|
2603
|
+
let params: { domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string };
|
|
2604
|
+
|
|
2605
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2606
|
+
params = (paramsOrFirst || {}) as { domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string };
|
|
2607
|
+
} else {
|
|
2608
|
+
params = {
|
|
2609
|
+
domainId: paramsOrFirst as string,
|
|
2610
|
+
name: rest[0] as string,
|
|
2611
|
+
value: rest[1] as string,
|
|
2612
|
+
ttl: rest[2] as number,
|
|
2613
|
+
priority: rest[3] as number,
|
|
2614
|
+
weight: rest[4] as number,
|
|
2615
|
+
port: rest[5] as number,
|
|
2616
|
+
comment: rest[6] as string
|
|
2617
|
+
};
|
|
2618
|
+
}
|
|
2619
|
+
|
|
2620
|
+
const domainId = params.domainId;
|
|
2621
|
+
const name = params.name;
|
|
2622
|
+
const value = params.value;
|
|
2623
|
+
const ttl = params.ttl;
|
|
2624
|
+
const priority = params.priority;
|
|
2625
|
+
const weight = params.weight;
|
|
2626
|
+
const port = params.port;
|
|
2627
|
+
const comment = params.comment;
|
|
2628
|
+
|
|
1407
2629
|
if (typeof domainId === 'undefined') {
|
|
1408
2630
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1409
2631
|
}
|
|
@@ -1425,6 +2647,7 @@ target value, TTL, and optional comment.
|
|
|
1425
2647
|
if (typeof port === 'undefined') {
|
|
1426
2648
|
throw new AppwriteException('Missing required parameter: "port"');
|
|
1427
2649
|
}
|
|
2650
|
+
|
|
1428
2651
|
const apiPath = '/domains/{domainId}/records/srv'.replace('{domainId}', domainId);
|
|
1429
2652
|
const payload: Payload = {};
|
|
1430
2653
|
if (typeof name !== 'undefined') {
|
|
@@ -1461,35 +2684,98 @@ target value, TTL, and optional comment.
|
|
|
1461
2684
|
payload
|
|
1462
2685
|
);
|
|
1463
2686
|
}
|
|
2687
|
+
|
|
2688
|
+
/**
|
|
2689
|
+
* Update an existing SRV record for the given domain.
|
|
2690
|
+
*
|
|
2691
|
+
* Required parameters:
|
|
2692
|
+
* - domainId: Domain unique ID
|
|
2693
|
+
* - recordId: DNS record unique ID
|
|
2694
|
+
* - name: Record name (service name)
|
|
2695
|
+
* - value: Target hostname for this SRV record
|
|
2696
|
+
* - ttl: Time to live, in seconds
|
|
2697
|
+
* - priority: Record priority
|
|
2698
|
+
* - weight: Record weight
|
|
2699
|
+
* - port: Port number for the service
|
|
2700
|
+
*
|
|
2701
|
+
* Optional parameters:
|
|
2702
|
+
* - comment: A comment for this record
|
|
2703
|
+
*
|
|
2704
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
2705
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
2706
|
+
* @param {string} params.name - Record name (service name).
|
|
2707
|
+
* @param {string} params.value - Target hostname for this SRV record.
|
|
2708
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
2709
|
+
* @param {number} params.priority - Record priority.
|
|
2710
|
+
* @param {number} params.weight - Record weight.
|
|
2711
|
+
* @param {number} params.port - Port number for the service.
|
|
2712
|
+
* @param {string} params.comment - A comment for this record.
|
|
2713
|
+
* @throws {AppwriteException}
|
|
2714
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2715
|
+
*/
|
|
2716
|
+
updateRecordSRV(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1464
2717
|
/**
|
|
1465
2718
|
* Update an existing SRV record for the given domain.
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
*
|
|
1480
|
-
* @param {string} domainId
|
|
1481
|
-
* @param {string} recordId
|
|
1482
|
-
* @param {string} name
|
|
1483
|
-
* @param {string} value
|
|
1484
|
-
* @param {number} ttl
|
|
1485
|
-
* @param {number} priority
|
|
1486
|
-
* @param {number} weight
|
|
1487
|
-
* @param {number} port
|
|
1488
|
-
* @param {string} comment
|
|
2719
|
+
*
|
|
2720
|
+
* Required parameters:
|
|
2721
|
+
* - domainId: Domain unique ID
|
|
2722
|
+
* - recordId: DNS record unique ID
|
|
2723
|
+
* - name: Record name (service name)
|
|
2724
|
+
* - value: Target hostname for this SRV record
|
|
2725
|
+
* - ttl: Time to live, in seconds
|
|
2726
|
+
* - priority: Record priority
|
|
2727
|
+
* - weight: Record weight
|
|
2728
|
+
* - port: Port number for the service
|
|
2729
|
+
*
|
|
2730
|
+
* Optional parameters:
|
|
2731
|
+
* - comment: A comment for this record
|
|
2732
|
+
*
|
|
2733
|
+
* @param {string} domainId - Domain unique ID.
|
|
2734
|
+
* @param {string} recordId - DNS record unique ID.
|
|
2735
|
+
* @param {string} name - Record name (service name).
|
|
2736
|
+
* @param {string} value - Target hostname for this SRV record.
|
|
2737
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
2738
|
+
* @param {number} priority - Record priority.
|
|
2739
|
+
* @param {number} weight - Record weight.
|
|
2740
|
+
* @param {number} port - Port number for the service.
|
|
2741
|
+
* @param {string} comment - A comment for this record.
|
|
1489
2742
|
* @throws {AppwriteException}
|
|
1490
2743
|
* @returns {Promise<Models.DnsRecord>}
|
|
2744
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1491
2745
|
*/
|
|
1492
|
-
updateRecordSRV(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord
|
|
2746
|
+
updateRecordSRV(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
|
|
2747
|
+
updateRecordSRV(
|
|
2748
|
+
paramsOrFirst: { domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string } | string,
|
|
2749
|
+
...rest: [(string)?, (string)?, (string)?, (number)?, (number)?, (number)?, (number)?, (string)?]
|
|
2750
|
+
): Promise<Models.DnsRecord> {
|
|
2751
|
+
let params: { domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string };
|
|
2752
|
+
|
|
2753
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2754
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string };
|
|
2755
|
+
} else {
|
|
2756
|
+
params = {
|
|
2757
|
+
domainId: paramsOrFirst as string,
|
|
2758
|
+
recordId: rest[0] as string,
|
|
2759
|
+
name: rest[1] as string,
|
|
2760
|
+
value: rest[2] as string,
|
|
2761
|
+
ttl: rest[3] as number,
|
|
2762
|
+
priority: rest[4] as number,
|
|
2763
|
+
weight: rest[5] as number,
|
|
2764
|
+
port: rest[6] as number,
|
|
2765
|
+
comment: rest[7] as string
|
|
2766
|
+
};
|
|
2767
|
+
}
|
|
2768
|
+
|
|
2769
|
+
const domainId = params.domainId;
|
|
2770
|
+
const recordId = params.recordId;
|
|
2771
|
+
const name = params.name;
|
|
2772
|
+
const value = params.value;
|
|
2773
|
+
const ttl = params.ttl;
|
|
2774
|
+
const priority = params.priority;
|
|
2775
|
+
const weight = params.weight;
|
|
2776
|
+
const port = params.port;
|
|
2777
|
+
const comment = params.comment;
|
|
2778
|
+
|
|
1493
2779
|
if (typeof domainId === 'undefined') {
|
|
1494
2780
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1495
2781
|
}
|
|
@@ -1514,6 +2800,7 @@ target value, TTL, and optional comment.
|
|
|
1514
2800
|
if (typeof port === 'undefined') {
|
|
1515
2801
|
throw new AppwriteException('Missing required parameter: "port"');
|
|
1516
2802
|
}
|
|
2803
|
+
|
|
1517
2804
|
const apiPath = '/domains/{domainId}/records/srv/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1518
2805
|
const payload: Payload = {};
|
|
1519
2806
|
if (typeof name !== 'undefined') {
|
|
@@ -1550,20 +2837,60 @@ target value, TTL, and optional comment.
|
|
|
1550
2837
|
payload
|
|
1551
2838
|
);
|
|
1552
2839
|
}
|
|
2840
|
+
|
|
1553
2841
|
/**
|
|
1554
2842
|
* Create a new TXT record for the given domain. TXT records can be used
|
|
1555
|
-
|
|
1556
|
-
|
|
2843
|
+
* to provide additional information about your domain, such as domain
|
|
2844
|
+
* verification records, SPF records, or DKIM records.
|
|
1557
2845
|
*
|
|
1558
|
-
* @param {string} domainId
|
|
1559
|
-
* @param {string} name
|
|
1560
|
-
* @param {number} ttl
|
|
1561
|
-
* @param {string} value
|
|
1562
|
-
* @param {string} comment
|
|
2846
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
2847
|
+
* @param {string} params.name - Record name (subdomain) for the TXT record.
|
|
2848
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
2849
|
+
* @param {string} params.value - TXT record value.
|
|
2850
|
+
* @param {string} params.comment - A comment for this record.
|
|
1563
2851
|
* @throws {AppwriteException}
|
|
1564
2852
|
* @returns {Promise<Models.DnsRecord>}
|
|
1565
2853
|
*/
|
|
1566
|
-
createRecordTXT(domainId: string, name: string, ttl: number, value?: string, comment?: string): Promise<Models.DnsRecord
|
|
2854
|
+
createRecordTXT(params: { domainId: string, name: string, ttl: number, value?: string, comment?: string }): Promise<Models.DnsRecord>;
|
|
2855
|
+
/**
|
|
2856
|
+
* Create a new TXT record for the given domain. TXT records can be used
|
|
2857
|
+
* to provide additional information about your domain, such as domain
|
|
2858
|
+
* verification records, SPF records, or DKIM records.
|
|
2859
|
+
*
|
|
2860
|
+
* @param {string} domainId - Domain unique ID.
|
|
2861
|
+
* @param {string} name - Record name (subdomain) for the TXT record.
|
|
2862
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
2863
|
+
* @param {string} value - TXT record value.
|
|
2864
|
+
* @param {string} comment - A comment for this record.
|
|
2865
|
+
* @throws {AppwriteException}
|
|
2866
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2867
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2868
|
+
*/
|
|
2869
|
+
createRecordTXT(domainId: string, name: string, ttl: number, value?: string, comment?: string): Promise<Models.DnsRecord>;
|
|
2870
|
+
createRecordTXT(
|
|
2871
|
+
paramsOrFirst: { domainId: string, name: string, ttl: number, value?: string, comment?: string } | string,
|
|
2872
|
+
...rest: [(string)?, (number)?, (string)?, (string)?]
|
|
2873
|
+
): Promise<Models.DnsRecord> {
|
|
2874
|
+
let params: { domainId: string, name: string, ttl: number, value?: string, comment?: string };
|
|
2875
|
+
|
|
2876
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2877
|
+
params = (paramsOrFirst || {}) as { domainId: string, name: string, ttl: number, value?: string, comment?: string };
|
|
2878
|
+
} else {
|
|
2879
|
+
params = {
|
|
2880
|
+
domainId: paramsOrFirst as string,
|
|
2881
|
+
name: rest[0] as string,
|
|
2882
|
+
ttl: rest[1] as number,
|
|
2883
|
+
value: rest[2] as string,
|
|
2884
|
+
comment: rest[3] as string
|
|
2885
|
+
};
|
|
2886
|
+
}
|
|
2887
|
+
|
|
2888
|
+
const domainId = params.domainId;
|
|
2889
|
+
const name = params.name;
|
|
2890
|
+
const ttl = params.ttl;
|
|
2891
|
+
const value = params.value;
|
|
2892
|
+
const comment = params.comment;
|
|
2893
|
+
|
|
1567
2894
|
if (typeof domainId === 'undefined') {
|
|
1568
2895
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1569
2896
|
}
|
|
@@ -1573,6 +2900,7 @@ target value, TTL, and optional comment.
|
|
|
1573
2900
|
if (typeof ttl === 'undefined') {
|
|
1574
2901
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1575
2902
|
}
|
|
2903
|
+
|
|
1576
2904
|
const apiPath = '/domains/{domainId}/records/txt'.replace('{domainId}', domainId);
|
|
1577
2905
|
const payload: Payload = {};
|
|
1578
2906
|
if (typeof name !== 'undefined') {
|
|
@@ -1600,22 +2928,66 @@ target value, TTL, and optional comment.
|
|
|
1600
2928
|
payload
|
|
1601
2929
|
);
|
|
1602
2930
|
}
|
|
2931
|
+
|
|
2932
|
+
/**
|
|
2933
|
+
* Update an existing TXT record for the given domain.
|
|
2934
|
+
*
|
|
2935
|
+
* Update the TXT record details for a specific domain by providing the domain ID,
|
|
2936
|
+
* record ID, and the new record configuration including name, value, TTL, and an optional comment.
|
|
2937
|
+
*
|
|
2938
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
2939
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
2940
|
+
* @param {string} params.name - Record name (subdomain) for the TXT record.
|
|
2941
|
+
* @param {string} params.value - TXT record value.
|
|
2942
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
2943
|
+
* @param {string} params.comment - A comment for this record.
|
|
2944
|
+
* @throws {AppwriteException}
|
|
2945
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2946
|
+
*/
|
|
2947
|
+
updateRecordTXT(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1603
2948
|
/**
|
|
1604
2949
|
* Update an existing TXT record for the given domain.
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
2950
|
+
*
|
|
2951
|
+
* Update the TXT record details for a specific domain by providing the domain ID,
|
|
2952
|
+
* record ID, and the new record configuration including name, value, TTL, and an optional comment.
|
|
1608
2953
|
*
|
|
1609
|
-
* @param {string} domainId
|
|
1610
|
-
* @param {string} recordId
|
|
1611
|
-
* @param {string} name
|
|
1612
|
-
* @param {string} value
|
|
1613
|
-
* @param {number} ttl
|
|
1614
|
-
* @param {string} comment
|
|
2954
|
+
* @param {string} domainId - Domain unique ID.
|
|
2955
|
+
* @param {string} recordId - DNS record unique ID.
|
|
2956
|
+
* @param {string} name - Record name (subdomain) for the TXT record.
|
|
2957
|
+
* @param {string} value - TXT record value.
|
|
2958
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
2959
|
+
* @param {string} comment - A comment for this record.
|
|
1615
2960
|
* @throws {AppwriteException}
|
|
1616
2961
|
* @returns {Promise<Models.DnsRecord>}
|
|
2962
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1617
2963
|
*/
|
|
1618
|
-
updateRecordTXT(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
2964
|
+
updateRecordTXT(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
2965
|
+
updateRecordTXT(
|
|
2966
|
+
paramsOrFirst: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string } | string,
|
|
2967
|
+
...rest: [(string)?, (string)?, (string)?, (number)?, (string)?]
|
|
2968
|
+
): Promise<Models.DnsRecord> {
|
|
2969
|
+
let params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
2970
|
+
|
|
2971
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2972
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string };
|
|
2973
|
+
} else {
|
|
2974
|
+
params = {
|
|
2975
|
+
domainId: paramsOrFirst as string,
|
|
2976
|
+
recordId: rest[0] as string,
|
|
2977
|
+
name: rest[1] as string,
|
|
2978
|
+
value: rest[2] as string,
|
|
2979
|
+
ttl: rest[3] as number,
|
|
2980
|
+
comment: rest[4] as string
|
|
2981
|
+
};
|
|
2982
|
+
}
|
|
2983
|
+
|
|
2984
|
+
const domainId = params.domainId;
|
|
2985
|
+
const recordId = params.recordId;
|
|
2986
|
+
const name = params.name;
|
|
2987
|
+
const value = params.value;
|
|
2988
|
+
const ttl = params.ttl;
|
|
2989
|
+
const comment = params.comment;
|
|
2990
|
+
|
|
1619
2991
|
if (typeof domainId === 'undefined') {
|
|
1620
2992
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1621
2993
|
}
|
|
@@ -1631,6 +3003,7 @@ target value, TTL, and optional comment.
|
|
|
1631
3003
|
if (typeof ttl === 'undefined') {
|
|
1632
3004
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1633
3005
|
}
|
|
3006
|
+
|
|
1634
3007
|
const apiPath = '/domains/{domainId}/records/txt/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1635
3008
|
const payload: Payload = {};
|
|
1636
3009
|
if (typeof name !== 'undefined') {
|
|
@@ -1658,25 +3031,59 @@ target value, TTL, and optional comment.
|
|
|
1658
3031
|
payload
|
|
1659
3032
|
);
|
|
1660
3033
|
}
|
|
3034
|
+
|
|
3035
|
+
/**
|
|
3036
|
+
* Get a single DNS record for a given domain by record ID.
|
|
3037
|
+
*
|
|
3038
|
+
* This endpoint allows you to retrieve a specific DNS record associated with a domain
|
|
3039
|
+
* using its unique identifier. The record contains information about the DNS configuration
|
|
3040
|
+
* such as type, value, and TTL settings.
|
|
3041
|
+
*
|
|
3042
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
3043
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
3044
|
+
* @throws {AppwriteException}
|
|
3045
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
3046
|
+
*/
|
|
3047
|
+
getRecord(params: { domainId: string, recordId: string }): Promise<Models.DnsRecord>;
|
|
1661
3048
|
/**
|
|
1662
3049
|
* Get a single DNS record for a given domain by record ID.
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
|
|
3050
|
+
*
|
|
3051
|
+
* This endpoint allows you to retrieve a specific DNS record associated with a domain
|
|
3052
|
+
* using its unique identifier. The record contains information about the DNS configuration
|
|
3053
|
+
* such as type, value, and TTL settings.
|
|
1667
3054
|
*
|
|
1668
|
-
* @param {string} domainId
|
|
1669
|
-
* @param {string} recordId
|
|
3055
|
+
* @param {string} domainId - Domain unique ID.
|
|
3056
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1670
3057
|
* @throws {AppwriteException}
|
|
1671
3058
|
* @returns {Promise<Models.DnsRecord>}
|
|
3059
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1672
3060
|
*/
|
|
1673
|
-
getRecord(domainId: string, recordId: string): Promise<Models.DnsRecord
|
|
3061
|
+
getRecord(domainId: string, recordId: string): Promise<Models.DnsRecord>;
|
|
3062
|
+
getRecord(
|
|
3063
|
+
paramsOrFirst: { domainId: string, recordId: string } | string,
|
|
3064
|
+
...rest: [(string)?]
|
|
3065
|
+
): Promise<Models.DnsRecord> {
|
|
3066
|
+
let params: { domainId: string, recordId: string };
|
|
3067
|
+
|
|
3068
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
3069
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string };
|
|
3070
|
+
} else {
|
|
3071
|
+
params = {
|
|
3072
|
+
domainId: paramsOrFirst as string,
|
|
3073
|
+
recordId: rest[0] as string
|
|
3074
|
+
};
|
|
3075
|
+
}
|
|
3076
|
+
|
|
3077
|
+
const domainId = params.domainId;
|
|
3078
|
+
const recordId = params.recordId;
|
|
3079
|
+
|
|
1674
3080
|
if (typeof domainId === 'undefined') {
|
|
1675
3081
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1676
3082
|
}
|
|
1677
3083
|
if (typeof recordId === 'undefined') {
|
|
1678
3084
|
throw new AppwriteException('Missing required parameter: "recordId"');
|
|
1679
3085
|
}
|
|
3086
|
+
|
|
1680
3087
|
const apiPath = '/domains/{domainId}/records/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1681
3088
|
const payload: Payload = {};
|
|
1682
3089
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -1691,22 +3098,53 @@ target value, TTL, and optional comment.
|
|
|
1691
3098
|
payload
|
|
1692
3099
|
);
|
|
1693
3100
|
}
|
|
3101
|
+
|
|
3102
|
+
/**
|
|
3103
|
+
* Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
|
|
3104
|
+
* from a specific domain.
|
|
3105
|
+
*
|
|
3106
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
3107
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
3108
|
+
* @throws {AppwriteException}
|
|
3109
|
+
* @returns {Promise<{}>}
|
|
3110
|
+
*/
|
|
3111
|
+
deleteRecord(params: { domainId: string, recordId: string }): Promise<{}>;
|
|
1694
3112
|
/**
|
|
1695
3113
|
* Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
|
|
1696
|
-
|
|
3114
|
+
* from a specific domain.
|
|
1697
3115
|
*
|
|
1698
|
-
* @param {string} domainId
|
|
1699
|
-
* @param {string} recordId
|
|
3116
|
+
* @param {string} domainId - Domain unique ID.
|
|
3117
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1700
3118
|
* @throws {AppwriteException}
|
|
1701
3119
|
* @returns {Promise<{}>}
|
|
3120
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1702
3121
|
*/
|
|
1703
|
-
deleteRecord(domainId: string, recordId: string): Promise<{}
|
|
3122
|
+
deleteRecord(domainId: string, recordId: string): Promise<{}>;
|
|
3123
|
+
deleteRecord(
|
|
3124
|
+
paramsOrFirst: { domainId: string, recordId: string } | string,
|
|
3125
|
+
...rest: [(string)?]
|
|
3126
|
+
): Promise<{}> {
|
|
3127
|
+
let params: { domainId: string, recordId: string };
|
|
3128
|
+
|
|
3129
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
3130
|
+
params = (paramsOrFirst || {}) as { domainId: string, recordId: string };
|
|
3131
|
+
} else {
|
|
3132
|
+
params = {
|
|
3133
|
+
domainId: paramsOrFirst as string,
|
|
3134
|
+
recordId: rest[0] as string
|
|
3135
|
+
};
|
|
3136
|
+
}
|
|
3137
|
+
|
|
3138
|
+
const domainId = params.domainId;
|
|
3139
|
+
const recordId = params.recordId;
|
|
3140
|
+
|
|
1704
3141
|
if (typeof domainId === 'undefined') {
|
|
1705
3142
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1706
3143
|
}
|
|
1707
3144
|
if (typeof recordId === 'undefined') {
|
|
1708
3145
|
throw new AppwriteException('Missing required parameter: "recordId"');
|
|
1709
3146
|
}
|
|
3147
|
+
|
|
1710
3148
|
const apiPath = '/domains/{domainId}/records/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1711
3149
|
const payload: Payload = {};
|
|
1712
3150
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -1722,24 +3160,57 @@ target value, TTL, and optional comment.
|
|
|
1722
3160
|
payload
|
|
1723
3161
|
);
|
|
1724
3162
|
}
|
|
3163
|
+
|
|
1725
3164
|
/**
|
|
1726
3165
|
* Update the team ID for a specific domain. This endpoint requires admin access.
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
3166
|
+
*
|
|
3167
|
+
* Updating the team ID will transfer ownership and access control of the domain
|
|
3168
|
+
* and all its DNS records to the new team.
|
|
1730
3169
|
*
|
|
1731
|
-
* @param {string} domainId
|
|
1732
|
-
* @param {string} teamId
|
|
3170
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
3171
|
+
* @param {string} params.teamId - New team unique ID.
|
|
1733
3172
|
* @throws {AppwriteException}
|
|
1734
3173
|
* @returns {Promise<Models.Domain>}
|
|
1735
3174
|
*/
|
|
1736
|
-
updateTeam(domainId: string, teamId: string): Promise<Models.Domain
|
|
3175
|
+
updateTeam(params: { domainId: string, teamId: string }): Promise<Models.Domain>;
|
|
3176
|
+
/**
|
|
3177
|
+
* Update the team ID for a specific domain. This endpoint requires admin access.
|
|
3178
|
+
*
|
|
3179
|
+
* Updating the team ID will transfer ownership and access control of the domain
|
|
3180
|
+
* and all its DNS records to the new team.
|
|
3181
|
+
*
|
|
3182
|
+
* @param {string} domainId - Domain unique ID.
|
|
3183
|
+
* @param {string} teamId - New team unique ID.
|
|
3184
|
+
* @throws {AppwriteException}
|
|
3185
|
+
* @returns {Promise<Models.Domain>}
|
|
3186
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
3187
|
+
*/
|
|
3188
|
+
updateTeam(domainId: string, teamId: string): Promise<Models.Domain>;
|
|
3189
|
+
updateTeam(
|
|
3190
|
+
paramsOrFirst: { domainId: string, teamId: string } | string,
|
|
3191
|
+
...rest: [(string)?]
|
|
3192
|
+
): Promise<Models.Domain> {
|
|
3193
|
+
let params: { domainId: string, teamId: string };
|
|
3194
|
+
|
|
3195
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
3196
|
+
params = (paramsOrFirst || {}) as { domainId: string, teamId: string };
|
|
3197
|
+
} else {
|
|
3198
|
+
params = {
|
|
3199
|
+
domainId: paramsOrFirst as string,
|
|
3200
|
+
teamId: rest[0] as string
|
|
3201
|
+
};
|
|
3202
|
+
}
|
|
3203
|
+
|
|
3204
|
+
const domainId = params.domainId;
|
|
3205
|
+
const teamId = params.teamId;
|
|
3206
|
+
|
|
1737
3207
|
if (typeof domainId === 'undefined') {
|
|
1738
3208
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1739
3209
|
}
|
|
1740
3210
|
if (typeof teamId === 'undefined') {
|
|
1741
3211
|
throw new AppwriteException('Missing required parameter: "teamId"');
|
|
1742
3212
|
}
|
|
3213
|
+
|
|
1743
3214
|
const apiPath = '/domains/{domainId}/team'.replace('{domainId}', domainId);
|
|
1744
3215
|
const payload: Payload = {};
|
|
1745
3216
|
if (typeof teamId !== 'undefined') {
|
|
@@ -1758,18 +3229,45 @@ target value, TTL, and optional comment.
|
|
|
1758
3229
|
payload
|
|
1759
3230
|
);
|
|
1760
3231
|
}
|
|
3232
|
+
|
|
3233
|
+
/**
|
|
3234
|
+
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
3235
|
+
* zone file in a standardized format that can be used to configure DNS servers.
|
|
3236
|
+
*
|
|
3237
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
3238
|
+
* @throws {AppwriteException}
|
|
3239
|
+
* @returns {Promise<{}>}
|
|
3240
|
+
*/
|
|
3241
|
+
getZone(params: { domainId: string }): Promise<{}>;
|
|
1761
3242
|
/**
|
|
1762
|
-
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
1763
|
-
|
|
3243
|
+
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
3244
|
+
* zone file in a standardized format that can be used to configure DNS servers.
|
|
1764
3245
|
*
|
|
1765
|
-
* @param {string} domainId
|
|
3246
|
+
* @param {string} domainId - Domain unique ID.
|
|
1766
3247
|
* @throws {AppwriteException}
|
|
1767
3248
|
* @returns {Promise<{}>}
|
|
3249
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1768
3250
|
*/
|
|
1769
|
-
getZone(domainId: string): Promise<{}
|
|
3251
|
+
getZone(domainId: string): Promise<{}>;
|
|
3252
|
+
getZone(
|
|
3253
|
+
paramsOrFirst: { domainId: string } | string
|
|
3254
|
+
): Promise<{}> {
|
|
3255
|
+
let params: { domainId: string };
|
|
3256
|
+
|
|
3257
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
3258
|
+
params = (paramsOrFirst || {}) as { domainId: string };
|
|
3259
|
+
} else {
|
|
3260
|
+
params = {
|
|
3261
|
+
domainId: paramsOrFirst as string
|
|
3262
|
+
};
|
|
3263
|
+
}
|
|
3264
|
+
|
|
3265
|
+
const domainId = params.domainId;
|
|
3266
|
+
|
|
1770
3267
|
if (typeof domainId === 'undefined') {
|
|
1771
3268
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1772
3269
|
}
|
|
3270
|
+
|
|
1773
3271
|
const apiPath = '/domains/{domainId}/zone'.replace('{domainId}', domainId);
|
|
1774
3272
|
const payload: Payload = {};
|
|
1775
3273
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -1784,22 +3282,53 @@ target value, TTL, and optional comment.
|
|
|
1784
3282
|
payload
|
|
1785
3283
|
);
|
|
1786
3284
|
}
|
|
3285
|
+
|
|
3286
|
+
/**
|
|
3287
|
+
* Update the DNS zone for the given domain using the provided zone file content.
|
|
3288
|
+
* All parsed records are imported and then the main domain document is returned.
|
|
3289
|
+
*
|
|
3290
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
3291
|
+
* @param {string} params.content - DNS zone file content as a string.
|
|
3292
|
+
* @throws {AppwriteException}
|
|
3293
|
+
* @returns {Promise<Models.Domain>}
|
|
3294
|
+
*/
|
|
3295
|
+
updateZone(params: { domainId: string, content: string }): Promise<Models.Domain>;
|
|
1787
3296
|
/**
|
|
1788
|
-
* Update the DNS zone for the given domain using the provided zone file content.
|
|
1789
|
-
All parsed records are imported and then the main domain document is returned.
|
|
3297
|
+
* Update the DNS zone for the given domain using the provided zone file content.
|
|
3298
|
+
* All parsed records are imported and then the main domain document is returned.
|
|
1790
3299
|
*
|
|
1791
|
-
* @param {string} domainId
|
|
1792
|
-
* @param {string} content
|
|
3300
|
+
* @param {string} domainId - Domain unique ID.
|
|
3301
|
+
* @param {string} content - DNS zone file content as a string.
|
|
1793
3302
|
* @throws {AppwriteException}
|
|
1794
3303
|
* @returns {Promise<Models.Domain>}
|
|
3304
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1795
3305
|
*/
|
|
1796
|
-
updateZone(domainId: string, content: string): Promise<Models.Domain
|
|
3306
|
+
updateZone(domainId: string, content: string): Promise<Models.Domain>;
|
|
3307
|
+
updateZone(
|
|
3308
|
+
paramsOrFirst: { domainId: string, content: string } | string,
|
|
3309
|
+
...rest: [(string)?]
|
|
3310
|
+
): Promise<Models.Domain> {
|
|
3311
|
+
let params: { domainId: string, content: string };
|
|
3312
|
+
|
|
3313
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
3314
|
+
params = (paramsOrFirst || {}) as { domainId: string, content: string };
|
|
3315
|
+
} else {
|
|
3316
|
+
params = {
|
|
3317
|
+
domainId: paramsOrFirst as string,
|
|
3318
|
+
content: rest[0] as string
|
|
3319
|
+
};
|
|
3320
|
+
}
|
|
3321
|
+
|
|
3322
|
+
const domainId = params.domainId;
|
|
3323
|
+
const content = params.content;
|
|
3324
|
+
|
|
1797
3325
|
if (typeof domainId === 'undefined') {
|
|
1798
3326
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1799
3327
|
}
|
|
1800
3328
|
if (typeof content === 'undefined') {
|
|
1801
3329
|
throw new AppwriteException('Missing required parameter: "content"');
|
|
1802
3330
|
}
|
|
3331
|
+
|
|
1803
3332
|
const apiPath = '/domains/{domainId}/zone'.replace('{domainId}', domainId);
|
|
1804
3333
|
const payload: Payload = {};
|
|
1805
3334
|
if (typeof content !== 'undefined') {
|