@appwrite.io/console 1.10.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 +6 -0
- package/LICENSE +1 -1
- package/README.md +4 -4
- package/dist/cjs/sdk.js +15239 -6070
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +15237 -6071
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +15239 -6070
- package/docs/examples/account/create-billing-address.md +8 -8
- package/docs/examples/account/create-email-password-session.md +4 -4
- package/docs/examples/account/create-email-token.md +5 -5
- package/docs/examples/account/{update-magic-u-r-l-session.md → create-email-verification.md} +3 -4
- package/docs/examples/account/{update-m-f-a.md → create-jwt.md} +3 -3
- package/docs/examples/account/{create-magic-u-r-l-token.md → create-magic-url-token.md} +6 -6
- package/docs/examples/account/create-mfa-authenticator.md +3 -3
- package/docs/examples/account/create-mfa-challenge.md +3 -3
- package/docs/examples/account/create-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-o-auth2token.md → create-o-auth-2-session.md} +6 -6
- package/docs/examples/account/{create-o-auth2session.md → create-o-auth-2-token.md} +6 -6
- package/docs/examples/account/create-phone-token.md +4 -4
- package/docs/examples/account/create-push-target.md +5 -5
- package/docs/examples/account/create-recovery.md +4 -4
- package/docs/examples/account/create-session.md +4 -4
- package/docs/examples/account/create-verification.md +3 -3
- package/docs/examples/account/create.md +6 -6
- package/docs/examples/account/delete-billing-address.md +3 -3
- package/docs/examples/account/delete-identity.md +3 -3
- package/docs/examples/account/delete-mfa-authenticator.md +3 -3
- package/docs/examples/account/delete-payment-method.md +3 -3
- package/docs/examples/account/delete-push-target.md +3 -3
- package/docs/examples/account/delete-session.md +3 -3
- package/docs/examples/account/get-billing-address.md +3 -3
- package/docs/examples/account/get-coupon.md +3 -3
- package/docs/examples/account/get-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/get-payment-method.md +3 -3
- package/docs/examples/account/get-session.md +3 -3
- package/docs/examples/account/list-billing-addresses.md +3 -3
- package/docs/examples/account/list-identities.md +4 -3
- package/docs/examples/account/list-invoices.md +3 -3
- package/docs/examples/account/list-logs.md +4 -3
- package/docs/examples/account/list-mfa-factors.md +1 -1
- package/docs/examples/account/list-payment-methods.md +3 -3
- package/docs/examples/account/update-billing-address.md +9 -9
- package/docs/examples/account/update-email-verification.md +14 -0
- package/docs/examples/account/update-email.md +4 -4
- package/docs/examples/account/update-magic-url-session.md +14 -0
- package/docs/examples/account/update-mfa-authenticator.md +4 -4
- package/docs/examples/account/update-mfa-challenge.md +4 -4
- package/docs/examples/account/update-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-j-w-t.md → update-mfa.md} +3 -1
- package/docs/examples/account/update-name.md +3 -3
- package/docs/examples/account/update-password.md +4 -4
- package/docs/examples/account/update-payment-method-mandate-options.md +3 -3
- package/docs/examples/account/update-payment-method-provider.md +6 -5
- package/docs/examples/account/update-payment-method.md +6 -5
- package/docs/examples/account/update-phone-session.md +4 -4
- package/docs/examples/account/update-phone-verification.md +4 -4
- package/docs/examples/account/update-phone.md +4 -4
- package/docs/examples/account/update-prefs.md +7 -3
- package/docs/examples/account/update-push-target.md +4 -4
- package/docs/examples/account/update-recovery.md +5 -5
- package/docs/examples/account/update-session.md +3 -3
- package/docs/examples/account/update-verification.md +4 -4
- package/docs/examples/assistant/chat.md +3 -3
- package/docs/examples/avatars/get-browser.md +6 -6
- package/docs/examples/avatars/get-credit-card.md +6 -6
- package/docs/examples/avatars/get-favicon.md +3 -3
- package/docs/examples/avatars/get-flag.md +6 -6
- package/docs/examples/avatars/get-image.md +5 -5
- package/docs/examples/avatars/get-initials.md +6 -6
- package/docs/examples/avatars/{get-q-r.md → get-qr.md} +6 -6
- package/docs/examples/avatars/get-screenshot.md +35 -0
- package/docs/examples/backups/create-archive.md +4 -4
- package/docs/examples/backups/create-policy.md +9 -9
- package/docs/examples/backups/create-restoration.md +6 -6
- package/docs/examples/backups/delete-archive.md +3 -3
- package/docs/examples/backups/delete-policy.md +3 -3
- package/docs/examples/backups/get-archive.md +3 -3
- package/docs/examples/backups/get-policy.md +3 -3
- package/docs/examples/backups/get-restoration.md +3 -3
- package/docs/examples/backups/list-archives.md +3 -3
- package/docs/examples/backups/list-policies.md +3 -3
- package/docs/examples/backups/list-restorations.md +3 -3
- package/docs/examples/backups/update-policy.md +7 -7
- package/docs/examples/console/create-program-membership.md +3 -3
- package/docs/examples/console/create-source.md +7 -7
- package/docs/examples/console/get-campaign.md +3 -3
- package/docs/examples/console/get-coupon.md +3 -3
- package/docs/examples/console/{plans.md → get-plan.md} +3 -1
- package/docs/examples/console/get-plans.md +13 -0
- package/docs/examples/console/{regions.md → get-program.md} +3 -1
- package/docs/examples/console/get-regions.md +13 -0
- package/docs/examples/console/get-resource.md +4 -4
- package/docs/examples/console/suggest-columns.md +17 -0
- package/docs/examples/console/suggest-indexes.md +16 -0
- package/docs/examples/databases/create-boolean-attribute.md +8 -8
- package/docs/examples/databases/create-collection.md +11 -9
- package/docs/examples/databases/create-datetime-attribute.md +8 -8
- package/docs/examples/databases/create-document.md +15 -8
- package/docs/examples/databases/create-documents.md +6 -5
- package/docs/examples/databases/create-email-attribute.md +8 -8
- package/docs/examples/databases/create-enum-attribute.md +9 -9
- package/docs/examples/databases/create-float-attribute.md +10 -10
- package/docs/examples/databases/create-index.md +9 -9
- package/docs/examples/databases/create-integer-attribute.md +10 -10
- package/docs/examples/databases/create-ip-attribute.md +8 -8
- package/docs/examples/databases/create-line-attribute.md +17 -0
- package/docs/examples/databases/create-operations.md +24 -0
- package/docs/examples/databases/create-point-attribute.md +17 -0
- package/docs/examples/databases/create-polygon-attribute.md +17 -0
- package/docs/examples/databases/create-relationship-attribute.md +10 -10
- package/docs/examples/databases/create-string-attribute.md +10 -10
- package/docs/examples/databases/create-transaction.md +13 -0
- package/docs/examples/databases/create-url-attribute.md +8 -8
- package/docs/examples/databases/create.md +5 -5
- package/docs/examples/databases/decrement-document-attribute.md +9 -8
- package/docs/examples/databases/delete-attribute.md +5 -5
- package/docs/examples/databases/delete-collection.md +4 -4
- package/docs/examples/databases/delete-document.md +6 -5
- package/docs/examples/databases/delete-documents.md +6 -5
- package/docs/examples/databases/delete-index.md +5 -5
- package/docs/examples/databases/{get-database-usage.md → delete-transaction.md} +4 -5
- package/docs/examples/databases/delete.md +3 -3
- package/docs/examples/databases/get-attribute.md +5 -5
- package/docs/examples/databases/get-collection-usage.md +6 -6
- package/docs/examples/databases/get-collection.md +4 -4
- package/docs/examples/databases/get-document.md +7 -6
- package/docs/examples/databases/get-index.md +5 -5
- package/docs/examples/databases/get-transaction.md +13 -0
- package/docs/examples/databases/get-usage.md +5 -4
- package/docs/examples/databases/get.md +3 -3
- package/docs/examples/databases/increment-document-attribute.md +9 -8
- package/docs/examples/databases/list-attributes.md +6 -5
- package/docs/examples/databases/list-collection-logs.md +5 -5
- package/docs/examples/databases/list-collections.md +6 -5
- package/docs/examples/databases/list-document-logs.md +6 -6
- package/docs/examples/databases/list-documents.md +7 -5
- package/docs/examples/databases/list-indexes.md +6 -5
- package/docs/examples/databases/list-logs.md +4 -4
- package/docs/examples/databases/list-transactions.md +13 -0
- package/docs/examples/databases/list-usage.md +13 -0
- package/docs/examples/databases/list.md +5 -4
- package/docs/examples/databases/update-boolean-attribute.md +8 -8
- package/docs/examples/databases/update-collection.md +9 -9
- package/docs/examples/databases/update-datetime-attribute.md +8 -8
- package/docs/examples/databases/update-document.md +15 -8
- package/docs/examples/databases/update-documents.md +13 -6
- package/docs/examples/databases/update-email-attribute.md +8 -8
- package/docs/examples/databases/update-enum-attribute.md +9 -9
- package/docs/examples/databases/update-float-attribute.md +10 -10
- package/docs/examples/databases/update-integer-attribute.md +10 -10
- package/docs/examples/databases/update-ip-attribute.md +8 -8
- package/docs/examples/databases/update-line-attribute.md +18 -0
- package/docs/examples/databases/update-point-attribute.md +18 -0
- package/docs/examples/databases/update-polygon-attribute.md +18 -0
- package/docs/examples/databases/update-relationship-attribute.md +7 -7
- package/docs/examples/databases/update-string-attribute.md +9 -9
- package/docs/examples/databases/update-transaction.md +15 -0
- package/docs/examples/databases/update-url-attribute.md +8 -8
- package/docs/examples/databases/update.md +5 -5
- package/docs/examples/databases/upsert-document.md +15 -8
- package/docs/examples/databases/upsert-documents.md +6 -5
- package/docs/examples/domains/create-preset-google-workspace.md +3 -3
- package/docs/examples/domains/create-preset-i-cloud.md +3 -3
- package/docs/examples/domains/create-preset-mailgun.md +3 -3
- package/docs/examples/domains/create-preset-outlook.md +3 -3
- package/docs/examples/domains/create-preset-proton-mail.md +3 -3
- package/docs/examples/domains/create-preset-zoho.md +3 -3
- package/docs/examples/domains/create-record-a.md +7 -7
- package/docs/examples/domains/{create-record-a-a-a-a.md → create-record-aaaa.md} +7 -7
- package/docs/examples/domains/create-record-alias.md +7 -7
- package/docs/examples/domains/{create-record-n-s.md → create-record-caa.md} +7 -7
- package/docs/examples/domains/{create-record-c-a-a.md → create-record-cname.md} +7 -7
- package/docs/examples/domains/{create-record-h-t-t-p-s.md → create-record-https.md} +7 -7
- package/docs/examples/domains/create-record-mx.md +18 -0
- package/docs/examples/domains/create-record-ns.md +17 -0
- package/docs/examples/domains/create-record-srv.md +20 -0
- package/docs/examples/domains/{create-record-c-n-a-m-e.md → create-record-txt.md} +7 -7
- package/docs/examples/domains/create.md +4 -4
- package/docs/examples/domains/delete-record.md +4 -4
- package/docs/examples/domains/delete.md +3 -3
- package/docs/examples/domains/get-preset-google-workspace.md +3 -3
- package/docs/examples/domains/get-preset-i-cloud.md +3 -3
- package/docs/examples/domains/get-preset-mailgun.md +3 -3
- package/docs/examples/domains/get-preset-outlook.md +3 -3
- package/docs/examples/domains/get-preset-proton-mail.md +3 -3
- package/docs/examples/domains/get-preset-zoho.md +3 -3
- package/docs/examples/domains/get-record.md +4 -4
- package/docs/examples/domains/get-zone.md +3 -3
- package/docs/examples/domains/get.md +3 -3
- package/docs/examples/domains/list-records.md +4 -4
- package/docs/examples/domains/list.md +4 -4
- package/docs/examples/domains/update-nameservers.md +3 -3
- package/docs/examples/domains/update-record-a.md +8 -8
- package/docs/examples/domains/update-record-aaaa.md +18 -0
- package/docs/examples/domains/update-record-alias.md +8 -8
- package/docs/examples/domains/update-record-caa.md +18 -0
- package/docs/examples/domains/update-record-cname.md +18 -0
- package/docs/examples/domains/update-record-https.md +18 -0
- package/docs/examples/domains/update-record-mx.md +19 -0
- package/docs/examples/domains/update-record-ns.md +18 -0
- package/docs/examples/domains/update-record-srv.md +21 -0
- package/docs/examples/domains/update-record-txt.md +18 -0
- package/docs/examples/domains/update-team.md +4 -4
- package/docs/examples/domains/update-zone.md +4 -4
- package/docs/examples/functions/create-deployment.md +7 -7
- package/docs/examples/functions/create-duplicate-deployment.md +5 -5
- package/docs/examples/functions/create-execution.md +9 -9
- package/docs/examples/functions/create-template-deployment.md +10 -9
- package/docs/examples/functions/create-variable.md +6 -6
- package/docs/examples/functions/create-vcs-deployment.md +7 -7
- package/docs/examples/functions/create.md +21 -21
- package/docs/examples/functions/delete-deployment.md +4 -4
- package/docs/examples/functions/delete-execution.md +4 -4
- package/docs/examples/functions/delete-variable.md +4 -4
- package/docs/examples/functions/delete.md +3 -3
- package/docs/examples/functions/get-deployment-download.md +5 -5
- package/docs/examples/functions/get-deployment.md +4 -4
- package/docs/examples/functions/get-execution.md +4 -4
- package/docs/examples/functions/get-template.md +3 -3
- package/docs/examples/functions/get-usage.md +5 -5
- package/docs/examples/functions/get-variable.md +4 -4
- package/docs/examples/functions/get.md +3 -3
- package/docs/examples/functions/list-deployments.md +6 -5
- package/docs/examples/functions/list-executions.md +5 -4
- package/docs/examples/functions/list-templates.md +7 -6
- package/docs/examples/functions/list-usage.md +4 -4
- package/docs/examples/functions/list-variables.md +3 -3
- package/docs/examples/functions/list.md +5 -4
- package/docs/examples/functions/update-deployment-status.md +4 -4
- package/docs/examples/functions/update-function-deployment.md +4 -4
- package/docs/examples/functions/update-variable.md +7 -7
- package/docs/examples/functions/update.md +21 -21
- package/docs/examples/graphql/mutation.md +3 -3
- package/docs/examples/graphql/query.md +3 -3
- package/docs/examples/health/get-certificate.md +3 -3
- package/docs/examples/health/get-failed-jobs.md +5 -5
- package/docs/examples/health/get-queue-billing-project-aggregation.md +3 -3
- package/docs/examples/health/get-queue-billing-team-aggregation.md +3 -3
- package/docs/examples/health/get-queue-builds.md +3 -3
- package/docs/examples/health/get-queue-certificates.md +3 -3
- package/docs/examples/health/get-queue-databases.md +4 -4
- package/docs/examples/health/get-queue-deletes.md +3 -3
- package/docs/examples/health/get-queue-functions.md +3 -3
- package/docs/examples/health/get-queue-logs.md +3 -3
- package/docs/examples/health/get-queue-mails.md +3 -3
- package/docs/examples/health/get-queue-messaging.md +3 -3
- package/docs/examples/health/get-queue-migrations.md +3 -3
- package/docs/examples/health/get-queue-priority-builds.md +3 -3
- package/docs/examples/health/get-queue-region-manager.md +3 -3
- package/docs/examples/health/get-queue-stats-resources.md +3 -3
- package/docs/examples/health/get-queue-threats.md +13 -0
- package/docs/examples/health/get-queue-usage.md +3 -3
- package/docs/examples/health/get-queue-webhooks.md +3 -3
- package/docs/examples/messaging/create-apns-provider.md +10 -10
- package/docs/examples/messaging/create-email.md +14 -14
- package/docs/examples/messaging/create-fcm-provider.md +6 -6
- package/docs/examples/messaging/create-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{create-msg91provider.md → create-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/create-push.md +21 -21
- package/docs/examples/messaging/create-resend-provider.md +20 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/create-sms.md +9 -9
- package/docs/examples/messaging/create-smtp-provider.md +16 -16
- package/docs/examples/messaging/create-subscriber.md +5 -5
- package/docs/examples/messaging/create-telesign-provider.md +8 -8
- package/docs/examples/messaging/create-textmagic-provider.md +8 -8
- package/docs/examples/messaging/create-topic.md +5 -5
- package/docs/examples/messaging/create-twilio-provider.md +8 -8
- package/docs/examples/messaging/create-vonage-provider.md +8 -8
- package/docs/examples/messaging/delete-provider.md +3 -3
- package/docs/examples/messaging/delete-subscriber.md +4 -4
- package/docs/examples/messaging/delete-topic.md +3 -3
- package/docs/examples/messaging/delete.md +3 -3
- package/docs/examples/messaging/get-message.md +3 -3
- package/docs/examples/messaging/get-provider.md +3 -3
- package/docs/examples/messaging/get-subscriber.md +4 -4
- package/docs/examples/messaging/get-topic.md +3 -3
- package/docs/examples/messaging/list-message-logs.md +5 -4
- package/docs/examples/messaging/list-messages.md +5 -4
- package/docs/examples/messaging/list-provider-logs.md +5 -4
- package/docs/examples/messaging/list-providers.md +5 -4
- package/docs/examples/messaging/list-subscriber-logs.md +5 -4
- package/docs/examples/messaging/list-subscribers.md +6 -5
- package/docs/examples/messaging/list-targets.md +5 -4
- package/docs/examples/messaging/list-topic-logs.md +5 -4
- package/docs/examples/messaging/list-topics.md +5 -4
- package/docs/examples/messaging/update-apns-provider.md +10 -10
- package/docs/examples/messaging/update-email.md +14 -14
- package/docs/examples/messaging/update-fcm-provider.md +6 -6
- package/docs/examples/messaging/update-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{update-msg91provider.md → update-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/update-push.md +21 -21
- package/docs/examples/messaging/update-resend-provider.md +20 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/update-sms.md +9 -9
- package/docs/examples/messaging/update-smtp-provider.md +16 -16
- package/docs/examples/messaging/update-telesign-provider.md +8 -8
- package/docs/examples/messaging/update-textmagic-provider.md +8 -8
- package/docs/examples/messaging/update-topic.md +5 -5
- package/docs/examples/messaging/update-twilio-provider.md +8 -8
- package/docs/examples/messaging/update-vonage-provider.md +8 -8
- package/docs/examples/migrations/create-appwrite-migration.md +6 -6
- package/docs/examples/migrations/create-csv-export.md +21 -0
- package/docs/examples/migrations/{create-csv-migration.md → create-csv-import.md} +6 -5
- package/docs/examples/migrations/create-firebase-migration.md +4 -4
- package/docs/examples/migrations/create-n-host-migration.md +10 -10
- package/docs/examples/migrations/create-supabase-migration.md +9 -9
- package/docs/examples/migrations/delete.md +3 -3
- package/docs/examples/migrations/get-appwrite-report.md +6 -6
- package/docs/examples/migrations/get-firebase-report.md +4 -4
- package/docs/examples/migrations/get-n-host-report.md +10 -10
- package/docs/examples/migrations/get-supabase-report.md +9 -9
- package/docs/examples/migrations/get.md +3 -3
- package/docs/examples/migrations/list.md +5 -4
- package/docs/examples/migrations/retry.md +3 -3
- package/docs/examples/organizations/add-credit.md +4 -4
- package/docs/examples/organizations/cancel-downgrade.md +3 -3
- package/docs/examples/organizations/create-downgrade-feedback.md +17 -0
- package/docs/examples/organizations/create-invoice-payment.md +5 -5
- package/docs/examples/organizations/create.md +13 -12
- package/docs/examples/organizations/delete-backup-payment-method.md +3 -3
- package/docs/examples/organizations/delete-billing-address.md +3 -3
- package/docs/examples/organizations/delete-default-payment-method.md +3 -3
- package/docs/examples/organizations/delete.md +3 -3
- package/docs/examples/organizations/estimation-create-organization.md +8 -7
- package/docs/examples/organizations/estimation-delete-organization.md +3 -3
- package/docs/examples/organizations/estimation-update-plan.md +7 -7
- package/docs/examples/organizations/get-aggregation.md +6 -4
- package/docs/examples/organizations/get-available-credits.md +3 -3
- package/docs/examples/organizations/get-billing-address.md +4 -4
- package/docs/examples/organizations/get-credit.md +4 -4
- package/docs/examples/organizations/get-invoice-download.md +4 -4
- package/docs/examples/organizations/get-invoice-view.md +4 -4
- package/docs/examples/organizations/get-invoice.md +4 -4
- package/docs/examples/organizations/get-payment-method.md +4 -4
- package/docs/examples/organizations/get-plan.md +3 -3
- package/docs/examples/organizations/get-scopes.md +3 -3
- package/docs/examples/organizations/get-usage.md +5 -5
- package/docs/examples/organizations/list-aggregations.md +4 -4
- package/docs/examples/organizations/list-credits.md +4 -4
- package/docs/examples/organizations/list-invoices.md +4 -4
- package/docs/examples/organizations/list.md +4 -4
- package/docs/examples/organizations/set-backup-payment-method.md +4 -4
- package/docs/examples/organizations/set-billing-address.md +4 -4
- package/docs/examples/organizations/set-billing-email.md +4 -4
- package/docs/examples/organizations/set-billing-tax-id.md +4 -4
- package/docs/examples/organizations/set-default-payment-method.md +4 -4
- package/docs/examples/organizations/update-budget.md +5 -5
- package/docs/examples/organizations/update-plan.md +11 -11
- package/docs/examples/organizations/update-projects.md +4 -4
- package/docs/examples/organizations/validate-invoice.md +4 -4
- package/docs/examples/organizations/validate-payment.md +4 -4
- package/docs/examples/project/create-variable.md +5 -5
- package/docs/examples/project/delete-variable.md +3 -3
- package/docs/examples/project/get-usage.md +5 -5
- package/docs/examples/project/get-variable.md +3 -3
- package/docs/examples/project/update-variable.md +6 -6
- package/docs/examples/projects/create-dev-key.md +5 -5
- package/docs/examples/projects/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/projects/create-key.md +6 -6
- package/docs/examples/projects/create-platform.md +8 -8
- package/docs/examples/projects/create-smtp-test.md +12 -12
- package/docs/examples/projects/create-webhook.md +10 -10
- package/docs/examples/projects/create.md +16 -16
- package/docs/examples/projects/delete-dev-key.md +4 -4
- package/docs/examples/projects/delete-email-template.md +5 -5
- package/docs/examples/projects/delete-key.md +4 -4
- package/docs/examples/projects/delete-platform.md +4 -4
- package/docs/examples/projects/delete-sms-template.md +5 -5
- package/docs/examples/projects/delete-webhook.md +4 -4
- package/docs/examples/projects/delete.md +3 -3
- package/docs/examples/projects/get-dev-key.md +4 -4
- package/docs/examples/projects/get-email-template.md +5 -5
- package/docs/examples/projects/get-key.md +4 -4
- package/docs/examples/projects/get-platform.md +4 -4
- package/docs/examples/projects/get-sms-template.md +5 -5
- package/docs/examples/projects/get-webhook.md +4 -4
- package/docs/examples/projects/get.md +3 -3
- package/docs/examples/projects/list-dev-keys.md +4 -4
- package/docs/examples/projects/list-keys.md +4 -3
- package/docs/examples/projects/list-platforms.md +4 -3
- package/docs/examples/projects/list-webhooks.md +4 -3
- package/docs/examples/projects/list.md +5 -4
- package/docs/examples/projects/update-api-status-all.md +4 -4
- package/docs/examples/projects/update-api-status.md +6 -6
- package/docs/examples/projects/update-auth-duration.md +4 -4
- package/docs/examples/projects/update-auth-limit.md +4 -4
- package/docs/examples/projects/update-auth-password-dictionary.md +4 -4
- package/docs/examples/projects/update-auth-password-history.md +4 -4
- package/docs/examples/projects/update-auth-sessions-limit.md +4 -4
- package/docs/examples/projects/update-auth-status.md +5 -5
- package/docs/examples/projects/update-dev-key.md +6 -6
- package/docs/examples/projects/update-email-template.md +10 -10
- package/docs/examples/projects/update-key.md +7 -7
- package/docs/examples/projects/update-memberships-privacy.md +6 -6
- package/docs/examples/projects/update-mock-numbers.md +4 -4
- package/docs/examples/projects/{update-o-auth2.md → update-o-auth-2.md} +7 -7
- package/docs/examples/projects/update-personal-data-check.md +4 -4
- package/docs/examples/projects/update-platform.md +8 -8
- package/docs/examples/projects/update-service-status-all.md +4 -4
- package/docs/examples/projects/update-service-status.md +5 -5
- package/docs/examples/projects/update-session-alerts.md +4 -4
- package/docs/examples/projects/update-session-invalidation.md +14 -0
- package/docs/examples/projects/update-sms-template.md +6 -6
- package/docs/examples/projects/update-smtp.md +12 -12
- package/docs/examples/projects/update-status.md +14 -0
- package/docs/examples/projects/update-team.md +4 -4
- package/docs/examples/projects/update-webhook-signature.md +4 -4
- package/docs/examples/projects/update-webhook.md +11 -11
- package/docs/examples/projects/update.md +13 -13
- package/docs/examples/proxy/{create-a-p-i-rule.md → create-api-rule.md} +3 -3
- package/docs/examples/proxy/create-function-rule.md +5 -5
- package/docs/examples/proxy/create-redirect-rule.md +8 -8
- package/docs/examples/proxy/create-site-rule.md +5 -5
- package/docs/examples/proxy/delete-rule.md +3 -3
- package/docs/examples/proxy/get-rule.md +3 -3
- package/docs/examples/proxy/list-rules.md +5 -4
- package/docs/examples/proxy/update-rule-verification.md +3 -3
- package/docs/examples/sites/create-deployment.md +8 -8
- package/docs/examples/sites/create-duplicate-deployment.md +4 -4
- package/docs/examples/sites/create-template-deployment.md +10 -9
- package/docs/examples/sites/create-variable.md +6 -6
- package/docs/examples/sites/create-vcs-deployment.md +7 -7
- package/docs/examples/sites/create.md +21 -21
- package/docs/examples/sites/delete-deployment.md +4 -4
- package/docs/examples/sites/delete-log.md +4 -4
- package/docs/examples/sites/delete-variable.md +4 -4
- package/docs/examples/sites/delete.md +3 -3
- package/docs/examples/sites/get-deployment-download.md +5 -5
- package/docs/examples/sites/get-deployment.md +4 -4
- package/docs/examples/sites/get-log.md +4 -4
- package/docs/examples/sites/get-template.md +3 -3
- package/docs/examples/sites/get-usage.md +5 -5
- package/docs/examples/sites/get-variable.md +4 -4
- package/docs/examples/sites/get.md +3 -3
- package/docs/examples/sites/list-deployments.md +6 -5
- package/docs/examples/sites/list-logs.md +5 -4
- package/docs/examples/sites/list-templates.md +6 -6
- package/docs/examples/sites/list-usage.md +4 -4
- package/docs/examples/sites/list-variables.md +3 -3
- package/docs/examples/sites/list.md +5 -4
- package/docs/examples/sites/update-deployment-status.md +4 -4
- package/docs/examples/sites/update-site-deployment.md +4 -4
- package/docs/examples/sites/update-variable.md +7 -7
- package/docs/examples/sites/update.md +21 -21
- package/docs/examples/storage/create-bucket.md +14 -13
- package/docs/examples/storage/create-file.md +7 -7
- package/docs/examples/storage/delete-bucket.md +3 -3
- package/docs/examples/storage/delete-file.md +4 -4
- package/docs/examples/storage/get-bucket-usage.md +5 -5
- package/docs/examples/storage/get-bucket.md +3 -3
- package/docs/examples/storage/get-file-download.md +5 -5
- package/docs/examples/storage/get-file-preview.md +16 -16
- package/docs/examples/storage/get-file-view.md +5 -5
- package/docs/examples/storage/get-file.md +4 -4
- package/docs/examples/storage/get-usage.md +4 -4
- package/docs/examples/storage/list-buckets.md +5 -4
- package/docs/examples/storage/list-files.md +6 -5
- package/docs/examples/storage/update-bucket.md +14 -13
- package/docs/examples/storage/update-file.md +7 -7
- package/docs/examples/tablesdb/create-boolean-column.md +18 -0
- package/docs/examples/tablesdb/create-datetime-column.md +18 -0
- package/docs/examples/tablesdb/create-email-column.md +18 -0
- package/docs/examples/tablesdb/create-enum-column.md +19 -0
- package/docs/examples/tablesdb/create-float-column.md +20 -0
- package/docs/examples/tablesdb/create-index.md +19 -0
- package/docs/examples/tablesdb/create-integer-column.md +20 -0
- package/docs/examples/tablesdb/create-ip-column.md +18 -0
- package/docs/examples/tablesdb/create-line-column.md +17 -0
- package/docs/examples/tablesdb/create-operations.md +24 -0
- package/docs/examples/tablesdb/create-point-column.md +17 -0
- package/docs/examples/tablesdb/create-polygon-column.md +17 -0
- package/docs/examples/tablesdb/create-relationship-column.md +20 -0
- package/docs/examples/tablesdb/create-row.md +24 -0
- package/docs/examples/tablesdb/create-rows.md +16 -0
- package/docs/examples/tablesdb/create-string-column.md +20 -0
- package/docs/examples/tablesdb/create-table.md +20 -0
- package/docs/examples/tablesdb/create-transaction.md +13 -0
- package/docs/examples/tablesdb/create-url-column.md +18 -0
- package/docs/examples/tablesdb/create.md +15 -0
- package/docs/examples/tablesdb/decrement-row-column.md +19 -0
- package/docs/examples/tablesdb/delete-column.md +15 -0
- package/docs/examples/tablesdb/delete-index.md +15 -0
- package/docs/examples/tablesdb/delete-row.md +16 -0
- package/docs/examples/tablesdb/delete-rows.md +16 -0
- package/docs/examples/tablesdb/delete-table.md +14 -0
- package/docs/examples/tablesdb/delete-transaction.md +13 -0
- package/docs/examples/tablesdb/delete.md +13 -0
- package/docs/examples/tablesdb/get-column.md +15 -0
- package/docs/examples/tablesdb/get-index.md +15 -0
- package/docs/examples/tablesdb/get-row.md +17 -0
- package/docs/examples/tablesdb/get-table-usage.md +15 -0
- package/docs/examples/tablesdb/get-table.md +14 -0
- package/docs/examples/tablesdb/get-transaction.md +13 -0
- package/docs/examples/tablesdb/get-usage.md +14 -0
- package/docs/examples/tablesdb/get.md +13 -0
- package/docs/examples/tablesdb/increment-row-column.md +19 -0
- package/docs/examples/tablesdb/list-columns.md +16 -0
- package/docs/examples/tablesdb/list-indexes.md +16 -0
- package/docs/examples/tablesdb/list-row-logs.md +16 -0
- package/docs/examples/tablesdb/list-rows.md +17 -0
- package/docs/examples/tablesdb/list-table-logs.md +15 -0
- package/docs/examples/tablesdb/list-tables.md +16 -0
- package/docs/examples/tablesdb/list-transactions.md +13 -0
- package/docs/examples/tablesdb/list-usage.md +13 -0
- package/docs/examples/tablesdb/list.md +15 -0
- package/docs/examples/tablesdb/update-boolean-column.md +18 -0
- package/docs/examples/tablesdb/update-datetime-column.md +18 -0
- package/docs/examples/tablesdb/update-email-column.md +18 -0
- package/docs/examples/tablesdb/update-enum-column.md +19 -0
- package/docs/examples/tablesdb/update-float-column.md +20 -0
- package/docs/examples/tablesdb/update-integer-column.md +20 -0
- package/docs/examples/tablesdb/update-ip-column.md +18 -0
- package/docs/examples/tablesdb/update-line-column.md +18 -0
- package/docs/examples/tablesdb/update-point-column.md +18 -0
- package/docs/examples/tablesdb/update-polygon-column.md +18 -0
- package/docs/examples/tablesdb/update-relationship-column.md +17 -0
- package/docs/examples/tablesdb/update-row.md +24 -0
- package/docs/examples/tablesdb/update-rows.md +23 -0
- package/docs/examples/tablesdb/update-string-column.md +19 -0
- package/docs/examples/tablesdb/update-table.md +18 -0
- package/docs/examples/tablesdb/update-transaction.md +15 -0
- package/docs/examples/tablesdb/update-url-column.md +18 -0
- package/docs/examples/tablesdb/update.md +15 -0
- package/docs/examples/tablesdb/upsert-row.md +24 -0
- package/docs/examples/tablesdb/upsert-rows.md +16 -0
- package/docs/examples/teams/create-membership.md +9 -9
- package/docs/examples/teams/create.md +5 -5
- package/docs/examples/teams/delete-membership.md +4 -4
- package/docs/examples/teams/delete.md +3 -3
- package/docs/examples/teams/get-membership.md +4 -4
- package/docs/examples/teams/get-prefs.md +3 -3
- package/docs/examples/teams/get.md +3 -3
- package/docs/examples/teams/list-logs.md +5 -4
- package/docs/examples/teams/list-memberships.md +6 -5
- package/docs/examples/teams/list.md +5 -4
- package/docs/examples/teams/update-membership-status.md +6 -6
- package/docs/examples/teams/update-membership.md +5 -5
- package/docs/examples/teams/update-name.md +4 -4
- package/docs/examples/teams/update-prefs.md +4 -4
- package/docs/examples/tokens/create-file-token.md +5 -5
- package/docs/examples/tokens/delete.md +3 -3
- package/docs/examples/tokens/get.md +3 -3
- package/docs/examples/tokens/list.md +6 -5
- package/docs/examples/tokens/update.md +4 -4
- package/docs/examples/users/{create-m-d5user.md → create-argon-2-user.md} +6 -6
- package/docs/examples/users/create-bcrypt-user.md +6 -6
- package/docs/examples/users/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/users/{create-argon2user.md → create-md-5-user.md} +6 -6
- package/docs/examples/users/create-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/{create-p-h-pass-user.md → create-ph-pass-user.md} +6 -6
- package/docs/examples/users/create-scrypt-modified-user.md +9 -9
- package/docs/examples/users/create-scrypt-user.md +11 -11
- package/docs/examples/users/create-session.md +3 -3
- package/docs/examples/users/{create-s-h-a-user.md → create-sha-user.md} +7 -7
- package/docs/examples/users/create-target.md +8 -8
- package/docs/examples/users/create-token.md +5 -5
- package/docs/examples/users/create.md +7 -7
- package/docs/examples/users/delete-identity.md +3 -3
- package/docs/examples/users/delete-mfa-authenticator.md +4 -4
- package/docs/examples/users/delete-session.md +4 -4
- package/docs/examples/users/delete-sessions.md +3 -3
- package/docs/examples/users/delete-target.md +4 -4
- package/docs/examples/users/delete.md +3 -3
- package/docs/examples/users/get-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/get-prefs.md +3 -3
- package/docs/examples/users/get-target.md +4 -4
- package/docs/examples/users/get-usage.md +4 -4
- package/docs/examples/users/get.md +3 -3
- package/docs/examples/users/list-identities.md +5 -4
- package/docs/examples/users/list-logs.md +5 -4
- package/docs/examples/users/list-memberships.md +6 -5
- package/docs/examples/users/list-mfa-factors.md +3 -3
- package/docs/examples/users/list-sessions.md +4 -3
- package/docs/examples/users/list-targets.md +5 -4
- package/docs/examples/users/list.md +5 -4
- package/docs/examples/users/update-email-verification.md +4 -4
- package/docs/examples/users/update-email.md +4 -4
- package/docs/examples/users/update-labels.md +4 -4
- package/docs/examples/users/update-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/update-mfa.md +4 -4
- package/docs/examples/users/update-name.md +4 -4
- package/docs/examples/users/update-password.md +4 -4
- package/docs/examples/users/update-phone-verification.md +4 -4
- package/docs/examples/users/update-phone.md +4 -4
- package/docs/examples/users/update-prefs.md +4 -4
- package/docs/examples/users/update-status.md +4 -4
- package/docs/examples/users/update-target.md +7 -7
- package/docs/examples/vcs/create-repository-detection.md +6 -6
- package/docs/examples/vcs/create-repository.md +5 -5
- package/docs/examples/vcs/delete-installation.md +3 -3
- package/docs/examples/vcs/get-installation.md +3 -3
- package/docs/examples/vcs/get-repository-contents.md +6 -6
- package/docs/examples/vcs/get-repository.md +4 -4
- package/docs/examples/vcs/list-installations.md +5 -4
- package/docs/examples/vcs/list-repositories.md +6 -5
- package/docs/examples/vcs/list-repository-branches.md +4 -4
- package/docs/examples/vcs/update-external-deployments.md +5 -5
- package/package.json +4 -4
- package/src/client.ts +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 +1692 -238
- package/src/operator.ts +308 -0
- package/src/query.ts +246 -2
- package/src/services/account.ts +2205 -223
- package/src/services/assistant.ts +29 -3
- package/src/services/avatars.ts +486 -33
- package/src/services/backups.ts +389 -42
- package/src/services/console.ts +492 -19
- package/src/services/databases.ts +3521 -431
- package/src/services/domains.ts +1684 -197
- package/src/services/functions.ts +1162 -149
- package/src/services/graphql.ts +55 -4
- package/src/services/health.ts +560 -41
- package/src/services/locale.ts +9 -0
- package/src/services/messaging.ts +3367 -380
- package/src/services/migrations.ts +641 -65
- package/src/services/organizations.ts +1323 -128
- package/src/services/project.ts +168 -17
- package/src/services/projects.ts +2742 -266
- package/src/services/proxy.ts +265 -26
- package/src/services/realtime.ts +437 -0
- package/src/services/sites.ts +1098 -140
- package/src/services/storage.ts +651 -82
- package/src/services/tables-db.ts +5439 -0
- package/src/services/teams.ts +512 -55
- package/src/services/tokens.ts +167 -16
- package/src/services/users.ts +1873 -181
- package/src/services/vcs.ts +359 -39
- package/types/client.d.ts +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 +1664 -245
- package/types/operator.d.ts +180 -0
- package/types/query.d.ts +198 -2
- package/types/services/account.d.ts +985 -123
- package/types/services/assistant.d.ts +13 -2
- package/types/services/avatars.d.ts +244 -26
- package/types/services/backups.d.ts +190 -30
- package/types/services/console.d.ts +201 -14
- package/types/services/databases.d.ts +1731 -284
- package/types/services/domains.d.ts +904 -152
- package/types/services/functions.d.ts +616 -125
- package/types/services/graphql.d.ts +24 -2
- package/types/services/health.d.ts +245 -23
- package/types/services/messaging.d.ts +1660 -271
- package/types/services/migrations.d.ts +319 -53
- package/types/services/organizations.d.ts +635 -97
- package/types/services/project.d.ts +81 -12
- package/types/services/projects.d.ts +1308 -202
- package/types/services/proxy.d.ts +128 -19
- package/types/services/realtime.d.ts +118 -0
- package/types/services/sites.d.ts +577 -116
- package/types/services/storage.d.ts +354 -73
- package/types/services/tables-db.d.ts +2040 -0
- package/types/services/teams.d.ts +260 -44
- package/types/services/tokens.d.ts +80 -12
- package/types/services/users.d.ts +881 -124
- package/types/services/vcs.d.ts +179 -31
- package/docs/examples/domains/create-record-m-x.md +0 -18
- package/docs/examples/domains/create-record-s-r-v.md +0 -20
- package/docs/examples/domains/create-record-t-x-t.md +0 -17
- package/docs/examples/domains/update-record-a-a-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-n-a-m-e.md +0 -18
- package/docs/examples/domains/update-record-h-t-t-p-s.md +0 -18
- package/docs/examples/domains/update-record-m-x.md +0 -19
- package/docs/examples/domains/update-record-n-s.md +0 -18
- package/docs/examples/domains/update-record-s-r-v.md +0 -21
- package/docs/examples/domains/update-record-t-x-t.md +0 -18
- package/src/enums/billing-plan.ts +0 -5
- package/src/enums/database-usage-range.ts +0 -5
- package/src/enums/function-usage-range.ts +0 -5
- package/src/enums/site-usage-range.ts +0 -5
- package/src/enums/storage-usage-range.ts +0 -5
- package/types/enums/billing-plan.d.ts +0 -5
- package/types/enums/database-usage-range.d.ts +0 -5
- package/types/enums/function-usage-range.d.ts +0 -5
- package/types/enums/storage-usage-range.d.ts +0 -5
- package/types/enums/user-usage-range.d.ts +0 -5
- /package/docs/examples/health/{get-d-b.md → get-db.md} +0 -0
- /package/docs/examples/locale/{list-countries-e-u.md → list-countries-eu.md} +0 -0
- /package/src/enums/{s-m-t-p-secure.ts → smtp-secure.ts} +0 -0
- /package/src/enums/{v-c-s-detection-type.ts → vcs-detection-type.ts} +0 -0
- /package/types/enums/{s-m-t-p-secure.d.ts → smtp-secure.d.ts} +0 -0
- /package/types/enums/{v-c-s-detection-type.d.ts → vcs-detection-type.d.ts} +0 -0
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') {
|
|
@@ -42,18 +72,47 @@ export class Domains {
|
|
|
42
72
|
/**
|
|
43
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.
|
|
44
74
|
*
|
|
45
|
-
* @param {string} teamId
|
|
46
|
-
* @param {string} domain
|
|
75
|
+
* @param {string} params.teamId - Team unique ID.
|
|
76
|
+
* @param {string} params.domain - Domain name (e.g. "example.com").
|
|
77
|
+
* @throws {AppwriteException}
|
|
78
|
+
* @returns {Promise<Models.Domain>}
|
|
79
|
+
*/
|
|
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").
|
|
47
86
|
* @throws {AppwriteException}
|
|
48
87
|
* @returns {Promise<Models.Domain>}
|
|
88
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
49
89
|
*/
|
|
50
|
-
create(teamId: string, domain: string): Promise<Models.Domain
|
|
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
|
+
|
|
51
109
|
if (typeof teamId === 'undefined') {
|
|
52
110
|
throw new AppwriteException('Missing required parameter: "teamId"');
|
|
53
111
|
}
|
|
54
112
|
if (typeof domain === 'undefined') {
|
|
55
113
|
throw new AppwriteException('Missing required parameter: "domain"');
|
|
56
114
|
}
|
|
115
|
+
|
|
57
116
|
const apiPath = '/domains';
|
|
58
117
|
const payload: Payload = {};
|
|
59
118
|
if (typeof teamId !== 'undefined') {
|
|
@@ -79,14 +138,39 @@ export class Domains {
|
|
|
79
138
|
/**
|
|
80
139
|
* Get a domain by its unique ID.
|
|
81
140
|
*
|
|
82
|
-
* @param {string} domainId
|
|
141
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
83
142
|
* @throws {AppwriteException}
|
|
84
143
|
* @returns {Promise<Models.Domain>}
|
|
85
144
|
*/
|
|
86
|
-
get(domainId: string): Promise<Models.Domain
|
|
145
|
+
get(params: { domainId: string }): Promise<Models.Domain>;
|
|
146
|
+
/**
|
|
147
|
+
* Get a domain by its unique ID.
|
|
148
|
+
*
|
|
149
|
+
* @param {string} domainId - Domain unique ID.
|
|
150
|
+
* @throws {AppwriteException}
|
|
151
|
+
* @returns {Promise<Models.Domain>}
|
|
152
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
153
|
+
*/
|
|
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
|
+
|
|
87
170
|
if (typeof domainId === 'undefined') {
|
|
88
171
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
89
172
|
}
|
|
173
|
+
|
|
90
174
|
const apiPath = '/domains/{domainId}'.replace('{domainId}', domainId);
|
|
91
175
|
const payload: Payload = {};
|
|
92
176
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -106,14 +190,40 @@ export class Domains {
|
|
|
106
190
|
* Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
|
|
107
191
|
* Once deleted, the domain will no longer be available for use and all associated resources will be removed.
|
|
108
192
|
*
|
|
109
|
-
* @param {string} domainId
|
|
193
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
110
194
|
* @throws {AppwriteException}
|
|
111
195
|
* @returns {Promise<{}>}
|
|
112
196
|
*/
|
|
113
|
-
delete(domainId: string): Promise<{}
|
|
197
|
+
delete(params: { domainId: string }): Promise<{}>;
|
|
198
|
+
/**
|
|
199
|
+
* Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
|
|
200
|
+
* Once deleted, the domain will no longer be available for use and all associated resources will be removed.
|
|
201
|
+
*
|
|
202
|
+
* @param {string} domainId - Domain unique ID.
|
|
203
|
+
* @throws {AppwriteException}
|
|
204
|
+
* @returns {Promise<{}>}
|
|
205
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
206
|
+
*/
|
|
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
|
+
|
|
114
223
|
if (typeof domainId === 'undefined') {
|
|
115
224
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
116
225
|
}
|
|
226
|
+
|
|
117
227
|
const apiPath = '/domains/{domainId}'.replace('{domainId}', domainId);
|
|
118
228
|
const payload: Payload = {};
|
|
119
229
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -131,18 +241,45 @@ export class Domains {
|
|
|
131
241
|
}
|
|
132
242
|
|
|
133
243
|
/**
|
|
134
|
-
* Verify which NS records are used and update the domain accordingly. This will check the domain
|
|
135
|
-
* nameservers and update the domain
|
|
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
|
|
136
246
|
* Appwrite nameservers.
|
|
137
247
|
*
|
|
138
|
-
* @param {string} domainId
|
|
248
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
139
249
|
* @throws {AppwriteException}
|
|
140
250
|
* @returns {Promise<Models.Domain>}
|
|
141
251
|
*/
|
|
142
|
-
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
|
+
|
|
143
279
|
if (typeof domainId === 'undefined') {
|
|
144
280
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
145
281
|
}
|
|
282
|
+
|
|
146
283
|
const apiPath = '/domains/{domainId}/nameservers'.replace('{domainId}', domainId);
|
|
147
284
|
const payload: Payload = {};
|
|
148
285
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -162,14 +299,39 @@ export class Domains {
|
|
|
162
299
|
/**
|
|
163
300
|
* List Google Workspace DNS records.
|
|
164
301
|
*
|
|
165
|
-
* @param {string} domainId
|
|
302
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
303
|
+
* @throws {AppwriteException}
|
|
304
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
305
|
+
*/
|
|
306
|
+
getPresetGoogleWorkspace(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
307
|
+
/**
|
|
308
|
+
* List Google Workspace DNS records.
|
|
309
|
+
*
|
|
310
|
+
* @param {string} domainId - Domain unique ID.
|
|
166
311
|
* @throws {AppwriteException}
|
|
167
312
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
313
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
168
314
|
*/
|
|
169
|
-
getPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList
|
|
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
|
+
|
|
170
331
|
if (typeof domainId === 'undefined') {
|
|
171
332
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
172
333
|
}
|
|
334
|
+
|
|
173
335
|
const apiPath = '/domains/{domainId}/presets/google-workspace'.replace('{domainId}', domainId);
|
|
174
336
|
const payload: Payload = {};
|
|
175
337
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -189,14 +351,40 @@ export class Domains {
|
|
|
189
351
|
* Add Google Workspace DNS records to the domain. This will create the required MX records
|
|
190
352
|
* for Google Workspace email hosting.
|
|
191
353
|
*
|
|
192
|
-
* @param {string} domainId
|
|
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>;
|
|
359
|
+
/**
|
|
360
|
+
* Add Google Workspace DNS records to the domain. This will create the required MX records
|
|
361
|
+
* for Google Workspace email hosting.
|
|
362
|
+
*
|
|
363
|
+
* @param {string} domainId - Domain unique ID.
|
|
193
364
|
* @throws {AppwriteException}
|
|
194
365
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
366
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
195
367
|
*/
|
|
196
|
-
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
|
+
|
|
197
384
|
if (typeof domainId === 'undefined') {
|
|
198
385
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
199
386
|
}
|
|
387
|
+
|
|
200
388
|
const apiPath = '/domains/{domainId}/presets/google-workspace'.replace('{domainId}', domainId);
|
|
201
389
|
const payload: Payload = {};
|
|
202
390
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -216,14 +404,39 @@ export class Domains {
|
|
|
216
404
|
/**
|
|
217
405
|
* List iCloud DNS records.
|
|
218
406
|
*
|
|
219
|
-
* @param {string} domainId
|
|
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>;
|
|
412
|
+
/**
|
|
413
|
+
* List iCloud DNS records.
|
|
414
|
+
*
|
|
415
|
+
* @param {string} domainId - Domain unique ID.
|
|
220
416
|
* @throws {AppwriteException}
|
|
221
417
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
418
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
222
419
|
*/
|
|
223
|
-
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
|
+
|
|
224
436
|
if (typeof domainId === 'undefined') {
|
|
225
437
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
226
438
|
}
|
|
439
|
+
|
|
227
440
|
const apiPath = '/domains/{domainId}/presets/icloud'.replace('{domainId}', domainId);
|
|
228
441
|
const payload: Payload = {};
|
|
229
442
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -243,14 +456,40 @@ export class Domains {
|
|
|
243
456
|
* Add iCloud DNS records to the domain. This will create the required MX and SPF records
|
|
244
457
|
* for using iCloud email services with your domain.
|
|
245
458
|
*
|
|
246
|
-
* @param {string} domainId
|
|
459
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
247
460
|
* @throws {AppwriteException}
|
|
248
461
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
249
462
|
*/
|
|
250
|
-
createPresetICloud(domainId: string): Promise<Models.DnsRecordsList
|
|
463
|
+
createPresetICloud(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
464
|
+
/**
|
|
465
|
+
* Add iCloud DNS records to the domain. This will create the required MX and SPF records
|
|
466
|
+
* for using iCloud email services with your domain.
|
|
467
|
+
*
|
|
468
|
+
* @param {string} domainId - Domain unique ID.
|
|
469
|
+
* @throws {AppwriteException}
|
|
470
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
471
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
472
|
+
*/
|
|
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
|
+
|
|
251
489
|
if (typeof domainId === 'undefined') {
|
|
252
490
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
253
491
|
}
|
|
492
|
+
|
|
254
493
|
const apiPath = '/domains/{domainId}/presets/icloud'.replace('{domainId}', domainId);
|
|
255
494
|
const payload: Payload = {};
|
|
256
495
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -270,14 +509,39 @@ export class Domains {
|
|
|
270
509
|
/**
|
|
271
510
|
* List Mailgun DNS records.
|
|
272
511
|
*
|
|
273
|
-
* @param {string} domainId
|
|
512
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
274
513
|
* @throws {AppwriteException}
|
|
275
514
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
276
515
|
*/
|
|
277
|
-
getPresetMailgun(domainId: string): Promise<Models.DnsRecordsList
|
|
516
|
+
getPresetMailgun(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
517
|
+
/**
|
|
518
|
+
* List Mailgun DNS records.
|
|
519
|
+
*
|
|
520
|
+
* @param {string} domainId - Domain unique ID.
|
|
521
|
+
* @throws {AppwriteException}
|
|
522
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
523
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
524
|
+
*/
|
|
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
|
+
|
|
278
541
|
if (typeof domainId === 'undefined') {
|
|
279
542
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
280
543
|
}
|
|
544
|
+
|
|
281
545
|
const apiPath = '/domains/{domainId}/presets/mailgun'.replace('{domainId}', domainId);
|
|
282
546
|
const payload: Payload = {};
|
|
283
547
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -297,14 +561,40 @@ export class Domains {
|
|
|
297
561
|
* Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
|
|
298
562
|
* for Mailgun in the specified domain.
|
|
299
563
|
*
|
|
300
|
-
* @param {string} domainId
|
|
564
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
301
565
|
* @throws {AppwriteException}
|
|
302
566
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
303
567
|
*/
|
|
304
|
-
createPresetMailgun(domainId: string): Promise<Models.DnsRecordsList
|
|
568
|
+
createPresetMailgun(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
569
|
+
/**
|
|
570
|
+
* Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
|
|
571
|
+
* for Mailgun in the specified domain.
|
|
572
|
+
*
|
|
573
|
+
* @param {string} domainId - Domain unique ID.
|
|
574
|
+
* @throws {AppwriteException}
|
|
575
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
576
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
577
|
+
*/
|
|
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
|
+
|
|
305
594
|
if (typeof domainId === 'undefined') {
|
|
306
595
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
307
596
|
}
|
|
597
|
+
|
|
308
598
|
const apiPath = '/domains/{domainId}/presets/mailgun'.replace('{domainId}', domainId);
|
|
309
599
|
const payload: Payload = {};
|
|
310
600
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -324,14 +614,39 @@ export class Domains {
|
|
|
324
614
|
/**
|
|
325
615
|
* List Outlook DNS records.
|
|
326
616
|
*
|
|
327
|
-
* @param {string} domainId
|
|
617
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
618
|
+
* @throws {AppwriteException}
|
|
619
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
620
|
+
*/
|
|
621
|
+
getPresetOutlook(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
622
|
+
/**
|
|
623
|
+
* List Outlook DNS records.
|
|
624
|
+
*
|
|
625
|
+
* @param {string} domainId - Domain unique ID.
|
|
328
626
|
* @throws {AppwriteException}
|
|
329
627
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
628
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
330
629
|
*/
|
|
331
|
-
getPresetOutlook(domainId: string): Promise<Models.DnsRecordsList
|
|
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
|
+
|
|
332
646
|
if (typeof domainId === 'undefined') {
|
|
333
647
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
334
648
|
}
|
|
649
|
+
|
|
335
650
|
const apiPath = '/domains/{domainId}/presets/outlook'.replace('{domainId}', domainId);
|
|
336
651
|
const payload: Payload = {};
|
|
337
652
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -351,14 +666,40 @@ export class Domains {
|
|
|
351
666
|
* Add Outlook DNS records to the domain. This will create the required MX records
|
|
352
667
|
* for setting up Outlook email hosting for your domain.
|
|
353
668
|
*
|
|
354
|
-
* @param {string} domainId
|
|
669
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
670
|
+
* @throws {AppwriteException}
|
|
671
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
672
|
+
*/
|
|
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.
|
|
355
679
|
* @throws {AppwriteException}
|
|
356
680
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
681
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
357
682
|
*/
|
|
358
|
-
createPresetOutlook(domainId: string): Promise<Models.DnsRecordsList
|
|
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
|
+
|
|
359
699
|
if (typeof domainId === 'undefined') {
|
|
360
700
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
361
701
|
}
|
|
702
|
+
|
|
362
703
|
const apiPath = '/domains/{domainId}/presets/outlook'.replace('{domainId}', domainId);
|
|
363
704
|
const payload: Payload = {};
|
|
364
705
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -378,14 +719,39 @@ export class Domains {
|
|
|
378
719
|
/**
|
|
379
720
|
* List ProtonMail DNS records.
|
|
380
721
|
*
|
|
381
|
-
* @param {string} domainId
|
|
722
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
723
|
+
* @throws {AppwriteException}
|
|
724
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
725
|
+
*/
|
|
726
|
+
getPresetProtonMail(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
727
|
+
/**
|
|
728
|
+
* List ProtonMail DNS records.
|
|
729
|
+
*
|
|
730
|
+
* @param {string} domainId - Domain unique ID.
|
|
382
731
|
* @throws {AppwriteException}
|
|
383
732
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
733
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
384
734
|
*/
|
|
385
|
-
getPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList
|
|
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
|
+
|
|
386
751
|
if (typeof domainId === 'undefined') {
|
|
387
752
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
388
753
|
}
|
|
754
|
+
|
|
389
755
|
const apiPath = '/domains/{domainId}/presets/proton-mail'.replace('{domainId}', domainId);
|
|
390
756
|
const payload: Payload = {};
|
|
391
757
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -405,14 +771,40 @@ export class Domains {
|
|
|
405
771
|
* Add ProtonMail DNS records to the domain. This will create the required MX records
|
|
406
772
|
* for using ProtonMail with your custom domain.
|
|
407
773
|
*
|
|
408
|
-
* @param {string} domainId
|
|
774
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
409
775
|
* @throws {AppwriteException}
|
|
410
776
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
411
777
|
*/
|
|
412
|
-
createPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList
|
|
778
|
+
createPresetProtonMail(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
779
|
+
/**
|
|
780
|
+
* Add ProtonMail DNS records to the domain. This will create the required MX records
|
|
781
|
+
* for using ProtonMail with your custom domain.
|
|
782
|
+
*
|
|
783
|
+
* @param {string} domainId - Domain unique ID.
|
|
784
|
+
* @throws {AppwriteException}
|
|
785
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
786
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
787
|
+
*/
|
|
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
|
+
|
|
413
804
|
if (typeof domainId === 'undefined') {
|
|
414
805
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
415
806
|
}
|
|
807
|
+
|
|
416
808
|
const apiPath = '/domains/{domainId}/presets/proton-mail'.replace('{domainId}', domainId);
|
|
417
809
|
const payload: Payload = {};
|
|
418
810
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -432,14 +824,39 @@ export class Domains {
|
|
|
432
824
|
/**
|
|
433
825
|
* List Zoho DNS records.
|
|
434
826
|
*
|
|
435
|
-
* @param {string} domainId
|
|
827
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
436
828
|
* @throws {AppwriteException}
|
|
437
829
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
438
830
|
*/
|
|
439
|
-
getPresetZoho(domainId: string): Promise<Models.DnsRecordsList
|
|
831
|
+
getPresetZoho(params: { domainId: string }): Promise<Models.DnsRecordsList>;
|
|
832
|
+
/**
|
|
833
|
+
* List Zoho DNS records.
|
|
834
|
+
*
|
|
835
|
+
* @param {string} domainId - Domain unique ID.
|
|
836
|
+
* @throws {AppwriteException}
|
|
837
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
838
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
839
|
+
*/
|
|
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
|
+
|
|
440
856
|
if (typeof domainId === 'undefined') {
|
|
441
857
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
442
858
|
}
|
|
859
|
+
|
|
443
860
|
const apiPath = '/domains/{domainId}/presets/zoho'.replace('{domainId}', domainId);
|
|
444
861
|
const payload: Payload = {};
|
|
445
862
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -459,14 +876,40 @@ export class Domains {
|
|
|
459
876
|
* Add Zoho Mail DNS records to the domain. This will create the required MX records
|
|
460
877
|
* for setting up Zoho Mail on your domain.
|
|
461
878
|
*
|
|
462
|
-
* @param {string} domainId
|
|
879
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
463
880
|
* @throws {AppwriteException}
|
|
464
881
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
465
882
|
*/
|
|
466
|
-
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
|
+
|
|
467
909
|
if (typeof domainId === 'undefined') {
|
|
468
910
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
469
911
|
}
|
|
912
|
+
|
|
470
913
|
const apiPath = '/domains/{domainId}/presets/zoho'.replace('{domainId}', domainId);
|
|
471
914
|
const payload: Payload = {};
|
|
472
915
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -487,15 +930,45 @@ export class Domains {
|
|
|
487
930
|
* List DNS records for a given domain. You can use this endpoint to list all the DNS records
|
|
488
931
|
* associated with your domain.
|
|
489
932
|
*
|
|
490
|
-
* @param {string} domainId
|
|
491
|
-
* @param {string[]} queries
|
|
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>;
|
|
939
|
+
/**
|
|
940
|
+
* List DNS records for a given domain. You can use this endpoint to list all the DNS records
|
|
941
|
+
* associated with your domain.
|
|
942
|
+
*
|
|
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.
|
|
492
945
|
* @throws {AppwriteException}
|
|
493
946
|
* @returns {Promise<Models.DnsRecordsList>}
|
|
947
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
494
948
|
*/
|
|
495
|
-
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
|
+
|
|
496
968
|
if (typeof domainId === 'undefined') {
|
|
497
969
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
498
970
|
}
|
|
971
|
+
|
|
499
972
|
const apiPath = '/domains/{domainId}/records'.replace('{domainId}', domainId);
|
|
500
973
|
const payload: Payload = {};
|
|
501
974
|
if (typeof queries !== 'undefined') {
|
|
@@ -518,15 +991,53 @@ export class Domains {
|
|
|
518
991
|
* Create a new A record for the given domain. A records are used to point a domain name
|
|
519
992
|
* to an IPv4 address. The record value should be a valid IPv4 address.
|
|
520
993
|
*
|
|
521
|
-
* @param {string} domainId
|
|
522
|
-
* @param {string} name
|
|
523
|
-
* @param {string} value
|
|
524
|
-
* @param {number} ttl
|
|
525
|
-
* @param {string} comment
|
|
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.
|
|
526
999
|
* @throws {AppwriteException}
|
|
527
1000
|
* @returns {Promise<Models.DnsRecord>}
|
|
528
1001
|
*/
|
|
529
|
-
createRecordA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1002
|
+
createRecordA(params: { domainId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1003
|
+
/**
|
|
1004
|
+
* Create a new A record for the given domain. A records are used to point a domain name
|
|
1005
|
+
* to an IPv4 address. The record value should be a valid IPv4 address.
|
|
1006
|
+
*
|
|
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.
|
|
1012
|
+
* @throws {AppwriteException}
|
|
1013
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1014
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1015
|
+
*/
|
|
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
|
+
|
|
530
1041
|
if (typeof domainId === 'undefined') {
|
|
531
1042
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
532
1043
|
}
|
|
@@ -539,6 +1050,7 @@ export class Domains {
|
|
|
539
1050
|
if (typeof ttl === 'undefined') {
|
|
540
1051
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
541
1052
|
}
|
|
1053
|
+
|
|
542
1054
|
const apiPath = '/domains/{domainId}/records/a'.replace('{domainId}', domainId);
|
|
543
1055
|
const payload: Payload = {};
|
|
544
1056
|
if (typeof name !== 'undefined') {
|
|
@@ -572,16 +1084,58 @@ export class Domains {
|
|
|
572
1084
|
* the properties of an A record including its name (subdomain), IPv4 address, TTL,
|
|
573
1085
|
* and optional comment.
|
|
574
1086
|
*
|
|
575
|
-
* @param {string} domainId
|
|
576
|
-
* @param {string} recordId
|
|
577
|
-
* @param {string} name
|
|
578
|
-
* @param {string} value
|
|
579
|
-
* @param {number} ttl
|
|
580
|
-
* @param {string} comment
|
|
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>;
|
|
1097
|
+
/**
|
|
1098
|
+
* Update an existing A record for the given domain. This endpoint allows you to modify
|
|
1099
|
+
* the properties of an A record including its name (subdomain), IPv4 address, TTL,
|
|
1100
|
+
* and optional comment.
|
|
1101
|
+
*
|
|
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.
|
|
581
1108
|
* @throws {AppwriteException}
|
|
582
1109
|
* @returns {Promise<Models.DnsRecord>}
|
|
1110
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
583
1111
|
*/
|
|
584
|
-
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
|
+
|
|
585
1139
|
if (typeof domainId === 'undefined') {
|
|
586
1140
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
587
1141
|
}
|
|
@@ -597,6 +1151,7 @@ export class Domains {
|
|
|
597
1151
|
if (typeof ttl === 'undefined') {
|
|
598
1152
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
599
1153
|
}
|
|
1154
|
+
|
|
600
1155
|
const apiPath = '/domains/{domainId}/records/a/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
601
1156
|
const payload: Payload = {};
|
|
602
1157
|
if (typeof name !== 'undefined') {
|
|
@@ -629,15 +1184,53 @@ export class Domains {
|
|
|
629
1184
|
* Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
|
|
630
1185
|
* to your domain. The record will be used to point a hostname to an IPv6 address.
|
|
631
1186
|
*
|
|
632
|
-
* @param {string} domainId
|
|
633
|
-
* @param {string} name
|
|
634
|
-
* @param {string} value
|
|
635
|
-
* @param {number} ttl
|
|
636
|
-
* @param {string} comment
|
|
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>;
|
|
1196
|
+
/**
|
|
1197
|
+
* Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
|
|
1198
|
+
* to your domain. The record will be used to point a hostname to an IPv6 address.
|
|
1199
|
+
*
|
|
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.
|
|
637
1205
|
* @throws {AppwriteException}
|
|
638
1206
|
* @returns {Promise<Models.DnsRecord>}
|
|
1207
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
639
1208
|
*/
|
|
640
|
-
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
|
+
|
|
641
1234
|
if (typeof domainId === 'undefined') {
|
|
642
1235
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
643
1236
|
}
|
|
@@ -650,6 +1243,7 @@ export class Domains {
|
|
|
650
1243
|
if (typeof ttl === 'undefined') {
|
|
651
1244
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
652
1245
|
}
|
|
1246
|
+
|
|
653
1247
|
const apiPath = '/domains/{domainId}/records/aaaa'.replace('{domainId}', domainId);
|
|
654
1248
|
const payload: Payload = {};
|
|
655
1249
|
if (typeof name !== 'undefined') {
|
|
@@ -683,16 +1277,58 @@ export class Domains {
|
|
|
683
1277
|
* the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
|
|
684
1278
|
* TTL, and optional comment.
|
|
685
1279
|
*
|
|
686
|
-
* @param {string} domainId
|
|
687
|
-
* @param {string} recordId
|
|
688
|
-
* @param {string} name
|
|
689
|
-
* @param {string} value
|
|
690
|
-
* @param {number} ttl
|
|
691
|
-
* @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.
|
|
692
1286
|
* @throws {AppwriteException}
|
|
693
1287
|
* @returns {Promise<Models.DnsRecord>}
|
|
694
1288
|
*/
|
|
695
|
-
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
|
+
|
|
696
1332
|
if (typeof domainId === 'undefined') {
|
|
697
1333
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
698
1334
|
}
|
|
@@ -708,6 +1344,7 @@ export class Domains {
|
|
|
708
1344
|
if (typeof ttl === 'undefined') {
|
|
709
1345
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
710
1346
|
}
|
|
1347
|
+
|
|
711
1348
|
const apiPath = '/domains/{domainId}/records/aaaa/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
712
1349
|
const payload: Payload = {};
|
|
713
1350
|
if (typeof name !== 'undefined') {
|
|
@@ -741,15 +1378,54 @@ export class Domains {
|
|
|
741
1378
|
* to another domain name that will serve as an alias. This is particularly useful when you want to
|
|
742
1379
|
* map your domain to a target domain that may change its IP address.
|
|
743
1380
|
*
|
|
744
|
-
* @param {string} domainId
|
|
745
|
-
* @param {string} name
|
|
746
|
-
* @param {string} value
|
|
747
|
-
* @param {number} ttl
|
|
748
|
-
* @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.
|
|
749
1386
|
* @throws {AppwriteException}
|
|
750
1387
|
* @returns {Promise<Models.DnsRecord>}
|
|
751
1388
|
*/
|
|
752
|
-
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
|
+
|
|
753
1429
|
if (typeof domainId === 'undefined') {
|
|
754
1430
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
755
1431
|
}
|
|
@@ -762,6 +1438,7 @@ export class Domains {
|
|
|
762
1438
|
if (typeof ttl === 'undefined') {
|
|
763
1439
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
764
1440
|
}
|
|
1441
|
+
|
|
765
1442
|
const apiPath = '/domains/{domainId}/records/alias'.replace('{domainId}', domainId);
|
|
766
1443
|
const payload: Payload = {};
|
|
767
1444
|
if (typeof name !== 'undefined') {
|
|
@@ -797,16 +1474,60 @@ export class Domains {
|
|
|
797
1474
|
* The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
|
|
798
1475
|
* It provides a way to map one domain name to another.
|
|
799
1476
|
*
|
|
800
|
-
* @param {string} domainId
|
|
801
|
-
* @param {string} recordId
|
|
802
|
-
* @param {string} name
|
|
803
|
-
* @param {string} value
|
|
804
|
-
* @param {number} ttl
|
|
805
|
-
* @param {string} comment
|
|
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.
|
|
806
1500
|
* @throws {AppwriteException}
|
|
807
1501
|
* @returns {Promise<Models.DnsRecord>}
|
|
1502
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
808
1503
|
*/
|
|
809
|
-
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
|
+
|
|
810
1531
|
if (typeof domainId === 'undefined') {
|
|
811
1532
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
812
1533
|
}
|
|
@@ -822,6 +1543,7 @@ export class Domains {
|
|
|
822
1543
|
if (typeof ttl === 'undefined') {
|
|
823
1544
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
824
1545
|
}
|
|
1546
|
+
|
|
825
1547
|
const apiPath = '/domains/{domainId}/records/alias/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
826
1548
|
const payload: Payload = {};
|
|
827
1549
|
if (typeof name !== 'undefined') {
|
|
@@ -854,15 +1576,53 @@ export class Domains {
|
|
|
854
1576
|
* Create a new CAA record for the given domain. CAA records are used to specify which
|
|
855
1577
|
* Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
|
|
856
1578
|
*
|
|
857
|
-
* @param {string} domainId
|
|
858
|
-
* @param {string} name
|
|
859
|
-
* @param {string} value
|
|
860
|
-
* @param {number} ttl
|
|
861
|
-
* @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.
|
|
1584
|
+
* @throws {AppwriteException}
|
|
1585
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1586
|
+
*/
|
|
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.
|
|
862
1597
|
* @throws {AppwriteException}
|
|
863
1598
|
* @returns {Promise<Models.DnsRecord>}
|
|
1599
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
864
1600
|
*/
|
|
865
|
-
createRecordCAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
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
|
+
|
|
866
1626
|
if (typeof domainId === 'undefined') {
|
|
867
1627
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
868
1628
|
}
|
|
@@ -875,6 +1635,7 @@ export class Domains {
|
|
|
875
1635
|
if (typeof ttl === 'undefined') {
|
|
876
1636
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
877
1637
|
}
|
|
1638
|
+
|
|
878
1639
|
const apiPath = '/domains/{domainId}/records/caa'.replace('{domainId}', domainId);
|
|
879
1640
|
const payload: Payload = {};
|
|
880
1641
|
if (typeof name !== 'undefined') {
|
|
@@ -908,16 +1669,58 @@ export class Domains {
|
|
|
908
1669
|
* record is used to specify which certificate authorities (CAs) are authorized to issue certificates
|
|
909
1670
|
* for a domain.
|
|
910
1671
|
*
|
|
911
|
-
* @param {string} domainId
|
|
912
|
-
* @param {string} recordId
|
|
913
|
-
* @param {string} name
|
|
914
|
-
* @param {string} value
|
|
915
|
-
* @param {number} ttl
|
|
916
|
-
* @param {string} comment
|
|
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>;
|
|
1682
|
+
/**
|
|
1683
|
+
* Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
|
|
1684
|
+
* record is used to specify which certificate authorities (CAs) are authorized to issue certificates
|
|
1685
|
+
* for a domain.
|
|
1686
|
+
*
|
|
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.
|
|
917
1693
|
* @throws {AppwriteException}
|
|
918
1694
|
* @returns {Promise<Models.DnsRecord>}
|
|
1695
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
919
1696
|
*/
|
|
920
|
-
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
|
+
|
|
921
1724
|
if (typeof domainId === 'undefined') {
|
|
922
1725
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
923
1726
|
}
|
|
@@ -933,6 +1736,7 @@ export class Domains {
|
|
|
933
1736
|
if (typeof ttl === 'undefined') {
|
|
934
1737
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
935
1738
|
}
|
|
1739
|
+
|
|
936
1740
|
const apiPath = '/domains/{domainId}/records/caa/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
937
1741
|
const payload: Payload = {};
|
|
938
1742
|
if (typeof name !== 'undefined') {
|
|
@@ -965,18 +1769,59 @@ export class Domains {
|
|
|
965
1769
|
* Create a new CNAME record for the given domain.
|
|
966
1770
|
*
|
|
967
1771
|
* A CNAME record maps a subdomain to another domain name, allowing you to create aliases
|
|
968
|
-
* for your domain. For example, you can create a CNAME record to point
|
|
969
|
-
* to
|
|
1772
|
+
* for your domain. For example, you can create a CNAME record to point 'blog.example.com'
|
|
1773
|
+
* to 'example.wordpress.com'.
|
|
970
1774
|
*
|
|
971
|
-
* @param {string} domainId
|
|
972
|
-
* @param {string} name
|
|
973
|
-
* @param {string} value
|
|
974
|
-
* @param {number} ttl
|
|
975
|
-
* @param {string} comment
|
|
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.
|
|
976
1780
|
* @throws {AppwriteException}
|
|
977
1781
|
* @returns {Promise<Models.DnsRecord>}
|
|
978
1782
|
*/
|
|
979
|
-
createRecordCNAME(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1783
|
+
createRecordCNAME(params: { domainId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1784
|
+
/**
|
|
1785
|
+
* Create a new CNAME record for the given domain.
|
|
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'.
|
|
1790
|
+
*
|
|
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.
|
|
1796
|
+
* @throws {AppwriteException}
|
|
1797
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1798
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1799
|
+
*/
|
|
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
|
+
|
|
980
1825
|
if (typeof domainId === 'undefined') {
|
|
981
1826
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
982
1827
|
}
|
|
@@ -989,6 +1834,7 @@ export class Domains {
|
|
|
989
1834
|
if (typeof ttl === 'undefined') {
|
|
990
1835
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
991
1836
|
}
|
|
1837
|
+
|
|
992
1838
|
const apiPath = '/domains/{domainId}/records/cname'.replace('{domainId}', domainId);
|
|
993
1839
|
const payload: Payload = {};
|
|
994
1840
|
if (typeof name !== 'undefined') {
|
|
@@ -1020,16 +1866,56 @@ export class Domains {
|
|
|
1020
1866
|
/**
|
|
1021
1867
|
* Update an existing CNAME record for the given domain.
|
|
1022
1868
|
*
|
|
1023
|
-
* @param {string} domainId
|
|
1024
|
-
* @param {string} recordId
|
|
1025
|
-
* @param {string} name
|
|
1026
|
-
* @param {string} value
|
|
1027
|
-
* @param {number} ttl
|
|
1028
|
-
* @param {string} comment
|
|
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.
|
|
1029
1875
|
* @throws {AppwriteException}
|
|
1030
1876
|
* @returns {Promise<Models.DnsRecord>}
|
|
1031
1877
|
*/
|
|
1032
|
-
updateRecordCNAME(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
1878
|
+
updateRecordCNAME(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
1879
|
+
/**
|
|
1880
|
+
* Update an existing CNAME record for the given domain.
|
|
1881
|
+
*
|
|
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.
|
|
1888
|
+
* @throws {AppwriteException}
|
|
1889
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1890
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1891
|
+
*/
|
|
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
|
+
|
|
1033
1919
|
if (typeof domainId === 'undefined') {
|
|
1034
1920
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1035
1921
|
}
|
|
@@ -1045,6 +1931,7 @@ export class Domains {
|
|
|
1045
1931
|
if (typeof ttl === 'undefined') {
|
|
1046
1932
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1047
1933
|
}
|
|
1934
|
+
|
|
1048
1935
|
const apiPath = '/domains/{domainId}/records/cname/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1049
1936
|
const payload: Payload = {};
|
|
1050
1937
|
if (typeof name !== 'undefined') {
|
|
@@ -1077,15 +1964,53 @@ export class Domains {
|
|
|
1077
1964
|
* Create a new HTTPS record for the given domain. This record is used to configure HTTPS
|
|
1078
1965
|
* settings for your domain, enabling secure communication over SSL/TLS.
|
|
1079
1966
|
*
|
|
1080
|
-
* @param {string} domainId
|
|
1081
|
-
* @param {string} name
|
|
1082
|
-
* @param {string} value
|
|
1083
|
-
* @param {number} ttl
|
|
1084
|
-
* @param {string} comment
|
|
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>;
|
|
1976
|
+
/**
|
|
1977
|
+
* Create a new HTTPS record for the given domain. This record is used to configure HTTPS
|
|
1978
|
+
* settings for your domain, enabling secure communication over SSL/TLS.
|
|
1979
|
+
*
|
|
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.
|
|
1085
1985
|
* @throws {AppwriteException}
|
|
1086
1986
|
* @returns {Promise<Models.DnsRecord>}
|
|
1987
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1087
1988
|
*/
|
|
1088
|
-
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
|
+
|
|
1089
2014
|
if (typeof domainId === 'undefined') {
|
|
1090
2015
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1091
2016
|
}
|
|
@@ -1098,6 +2023,7 @@ export class Domains {
|
|
|
1098
2023
|
if (typeof ttl === 'undefined') {
|
|
1099
2024
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1100
2025
|
}
|
|
2026
|
+
|
|
1101
2027
|
const apiPath = '/domains/{domainId}/records/https'.replace('{domainId}', domainId);
|
|
1102
2028
|
const payload: Payload = {};
|
|
1103
2029
|
if (typeof name !== 'undefined') {
|
|
@@ -1131,16 +2057,58 @@ export class Domains {
|
|
|
1131
2057
|
* the properties of an HTTPS record associated with your domain, including the name (subdomain),
|
|
1132
2058
|
* target value, TTL, and optional comment.
|
|
1133
2059
|
*
|
|
1134
|
-
* @param {string} domainId
|
|
1135
|
-
* @param {string} recordId
|
|
1136
|
-
* @param {string} name
|
|
1137
|
-
* @param {string} value
|
|
1138
|
-
* @param {number} ttl
|
|
1139
|
-
* @param {string} comment
|
|
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.
|
|
1140
2066
|
* @throws {AppwriteException}
|
|
1141
2067
|
* @returns {Promise<Models.DnsRecord>}
|
|
1142
2068
|
*/
|
|
1143
|
-
updateRecordHTTPS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord
|
|
2069
|
+
updateRecordHTTPS(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
2070
|
+
/**
|
|
2071
|
+
* Update an existing HTTPS record for the given domain. This endpoint allows you to modify
|
|
2072
|
+
* the properties of an HTTPS record associated with your domain, including the name (subdomain),
|
|
2073
|
+
* target value, TTL, and optional comment.
|
|
2074
|
+
*
|
|
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.
|
|
2081
|
+
* @throws {AppwriteException}
|
|
2082
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2083
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2084
|
+
*/
|
|
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
|
+
|
|
1144
2112
|
if (typeof domainId === 'undefined') {
|
|
1145
2113
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1146
2114
|
}
|
|
@@ -1156,6 +2124,7 @@ export class Domains {
|
|
|
1156
2124
|
if (typeof ttl === 'undefined') {
|
|
1157
2125
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1158
2126
|
}
|
|
2127
|
+
|
|
1159
2128
|
const apiPath = '/domains/{domainId}/records/https/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1160
2129
|
const payload: Payload = {};
|
|
1161
2130
|
if (typeof name !== 'undefined') {
|
|
@@ -1190,16 +2159,59 @@ export class Domains {
|
|
|
1190
2159
|
* The priority parameter determines the order in which mail servers are used, with lower values indicating
|
|
1191
2160
|
* higher priority.
|
|
1192
2161
|
*
|
|
1193
|
-
* @param {string} domainId
|
|
1194
|
-
* @param {string} name
|
|
1195
|
-
* @param {string} value
|
|
1196
|
-
* @param {number} ttl
|
|
1197
|
-
* @param {number} priority
|
|
1198
|
-
* @param {string} comment
|
|
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.
|
|
1199
2168
|
* @throws {AppwriteException}
|
|
1200
2169
|
* @returns {Promise<Models.DnsRecord>}
|
|
1201
2170
|
*/
|
|
1202
|
-
createRecordMX(domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord
|
|
2171
|
+
createRecordMX(params: { domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
2172
|
+
/**
|
|
2173
|
+
* Create a new MX record for the given domain. MX records are used to define the mail servers responsible
|
|
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.
|
|
2177
|
+
*
|
|
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.
|
|
2184
|
+
* @throws {AppwriteException}
|
|
2185
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2186
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2187
|
+
*/
|
|
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
|
+
|
|
1203
2215
|
if (typeof domainId === 'undefined') {
|
|
1204
2216
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1205
2217
|
}
|
|
@@ -1215,6 +2227,7 @@ export class Domains {
|
|
|
1215
2227
|
if (typeof priority === 'undefined') {
|
|
1216
2228
|
throw new AppwriteException('Missing required parameter: "priority"');
|
|
1217
2229
|
}
|
|
2230
|
+
|
|
1218
2231
|
const apiPath = '/domains/{domainId}/records/mx'.replace('{domainId}', domainId);
|
|
1219
2232
|
const payload: Payload = {};
|
|
1220
2233
|
if (typeof name !== 'undefined') {
|
|
@@ -1249,17 +2262,60 @@ export class Domains {
|
|
|
1249
2262
|
/**
|
|
1250
2263
|
* Update an existing MX record for the given domain.
|
|
1251
2264
|
*
|
|
1252
|
-
* @param {string} domainId
|
|
1253
|
-
* @param {string} recordId
|
|
1254
|
-
* @param {string} name
|
|
1255
|
-
* @param {string} value
|
|
1256
|
-
* @param {number} ttl
|
|
1257
|
-
* @param {number} priority
|
|
1258
|
-
* @param {string} comment
|
|
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.
|
|
1259
2272
|
* @throws {AppwriteException}
|
|
1260
2273
|
* @returns {Promise<Models.DnsRecord>}
|
|
1261
2274
|
*/
|
|
1262
|
-
updateRecordMX(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord
|
|
2275
|
+
updateRecordMX(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
2276
|
+
/**
|
|
2277
|
+
* Update an existing MX record for the given domain.
|
|
2278
|
+
*
|
|
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.
|
|
2286
|
+
* @throws {AppwriteException}
|
|
2287
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2288
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2289
|
+
*/
|
|
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
|
+
|
|
1263
2319
|
if (typeof domainId === 'undefined') {
|
|
1264
2320
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1265
2321
|
}
|
|
@@ -1278,6 +2334,7 @@ export class Domains {
|
|
|
1278
2334
|
if (typeof priority === 'undefined') {
|
|
1279
2335
|
throw new AppwriteException('Missing required parameter: "priority"');
|
|
1280
2336
|
}
|
|
2337
|
+
|
|
1281
2338
|
const apiPath = '/domains/{domainId}/records/mx/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1282
2339
|
const payload: Payload = {};
|
|
1283
2340
|
if (typeof name !== 'undefined') {
|
|
@@ -1313,15 +2370,53 @@ export class Domains {
|
|
|
1313
2370
|
* Create a new NS record for the given domain. NS records specify the nameservers that are used
|
|
1314
2371
|
* to resolve the domain name to IP addresses. Each domain can have multiple NS records.
|
|
1315
2372
|
*
|
|
1316
|
-
* @param {string} domainId
|
|
1317
|
-
* @param {string} name
|
|
1318
|
-
* @param {string} value
|
|
1319
|
-
* @param {number} ttl
|
|
1320
|
-
* @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.
|
|
1321
2378
|
* @throws {AppwriteException}
|
|
1322
2379
|
* @returns {Promise<Models.DnsRecord>}
|
|
1323
2380
|
*/
|
|
1324
|
-
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
|
+
|
|
1325
2420
|
if (typeof domainId === 'undefined') {
|
|
1326
2421
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1327
2422
|
}
|
|
@@ -1334,6 +2429,7 @@ export class Domains {
|
|
|
1334
2429
|
if (typeof ttl === 'undefined') {
|
|
1335
2430
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1336
2431
|
}
|
|
2432
|
+
|
|
1337
2433
|
const apiPath = '/domains/{domainId}/records/ns'.replace('{domainId}', domainId);
|
|
1338
2434
|
const payload: Payload = {};
|
|
1339
2435
|
if (typeof name !== 'undefined') {
|
|
@@ -1368,16 +2464,59 @@ export class Domains {
|
|
|
1368
2464
|
* the record name (subdomain), target nameserver value, TTL, and add or modify comments
|
|
1369
2465
|
* for better record management.
|
|
1370
2466
|
*
|
|
1371
|
-
* @param {string} domainId
|
|
1372
|
-
* @param {string} recordId
|
|
1373
|
-
* @param {string} name
|
|
1374
|
-
* @param {string} value
|
|
1375
|
-
* @param {number} ttl
|
|
1376
|
-
* @param {string} comment
|
|
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>;
|
|
2477
|
+
/**
|
|
2478
|
+
* Update an existing NS record for the given domain. This endpoint allows you to modify
|
|
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.
|
|
2482
|
+
*
|
|
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.
|
|
1377
2489
|
* @throws {AppwriteException}
|
|
1378
2490
|
* @returns {Promise<Models.DnsRecord>}
|
|
2491
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1379
2492
|
*/
|
|
1380
|
-
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
|
+
|
|
1381
2520
|
if (typeof domainId === 'undefined') {
|
|
1382
2521
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1383
2522
|
}
|
|
@@ -1393,6 +2532,7 @@ export class Domains {
|
|
|
1393
2532
|
if (typeof ttl === 'undefined') {
|
|
1394
2533
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1395
2534
|
}
|
|
2535
|
+
|
|
1396
2536
|
const apiPath = '/domains/{domainId}/records/ns/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1397
2537
|
const payload: Payload = {};
|
|
1398
2538
|
if (typeof name !== 'undefined') {
|
|
@@ -1426,18 +2566,66 @@ export class Domains {
|
|
|
1426
2566
|
* of servers for specific services. For example, they can be used to specify which server
|
|
1427
2567
|
* handles a specific service like SIP or XMPP for the domain.
|
|
1428
2568
|
*
|
|
1429
|
-
* @param {string} domainId
|
|
1430
|
-
* @param {string} name
|
|
1431
|
-
* @param {string} value
|
|
1432
|
-
* @param {number} ttl
|
|
1433
|
-
* @param {number} priority
|
|
1434
|
-
* @param {number} weight
|
|
1435
|
-
* @param {number} port
|
|
1436
|
-
* @param {string} comment
|
|
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.
|
|
1437
2577
|
* @throws {AppwriteException}
|
|
1438
2578
|
* @returns {Promise<Models.DnsRecord>}
|
|
1439
2579
|
*/
|
|
1440
|
-
createRecordSRV(domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord
|
|
2580
|
+
createRecordSRV(params: { domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
2581
|
+
/**
|
|
2582
|
+
* Create a new SRV record for the given domain. SRV records are used to define the location
|
|
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.
|
|
2594
|
+
* @throws {AppwriteException}
|
|
2595
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2596
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2597
|
+
*/
|
|
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
|
+
|
|
1441
2629
|
if (typeof domainId === 'undefined') {
|
|
1442
2630
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1443
2631
|
}
|
|
@@ -1459,6 +2647,7 @@ export class Domains {
|
|
|
1459
2647
|
if (typeof port === 'undefined') {
|
|
1460
2648
|
throw new AppwriteException('Missing required parameter: "port"');
|
|
1461
2649
|
}
|
|
2650
|
+
|
|
1462
2651
|
const apiPath = '/domains/{domainId}/records/srv'.replace('{domainId}', domainId);
|
|
1463
2652
|
const payload: Payload = {};
|
|
1464
2653
|
if (typeof name !== 'undefined') {
|
|
@@ -1512,19 +2701,81 @@ export class Domains {
|
|
|
1512
2701
|
* Optional parameters:
|
|
1513
2702
|
* - comment: A comment for this record
|
|
1514
2703
|
*
|
|
1515
|
-
* @param {string} domainId
|
|
1516
|
-
* @param {string} recordId
|
|
1517
|
-
* @param {string} name
|
|
1518
|
-
* @param {string} value
|
|
1519
|
-
* @param {number} ttl
|
|
1520
|
-
* @param {number} priority
|
|
1521
|
-
* @param {number} weight
|
|
1522
|
-
* @param {number} port
|
|
1523
|
-
* @param {string} comment
|
|
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.
|
|
1524
2713
|
* @throws {AppwriteException}
|
|
1525
2714
|
* @returns {Promise<Models.DnsRecord>}
|
|
1526
2715
|
*/
|
|
1527
|
-
updateRecordSRV(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord
|
|
2716
|
+
updateRecordSRV(params: { domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string }): Promise<Models.DnsRecord>;
|
|
2717
|
+
/**
|
|
2718
|
+
* Update an existing SRV record for the given domain.
|
|
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.
|
|
2742
|
+
* @throws {AppwriteException}
|
|
2743
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
2744
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2745
|
+
*/
|
|
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
|
+
|
|
1528
2779
|
if (typeof domainId === 'undefined') {
|
|
1529
2780
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1530
2781
|
}
|
|
@@ -1549,6 +2800,7 @@ export class Domains {
|
|
|
1549
2800
|
if (typeof port === 'undefined') {
|
|
1550
2801
|
throw new AppwriteException('Missing required parameter: "port"');
|
|
1551
2802
|
}
|
|
2803
|
+
|
|
1552
2804
|
const apiPath = '/domains/{domainId}/records/srv/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1553
2805
|
const payload: Payload = {};
|
|
1554
2806
|
if (typeof name !== 'undefined') {
|
|
@@ -1591,15 +2843,54 @@ export class Domains {
|
|
|
1591
2843
|
* to provide additional information about your domain, such as domain
|
|
1592
2844
|
* verification records, SPF records, or DKIM records.
|
|
1593
2845
|
*
|
|
1594
|
-
* @param {string} domainId
|
|
1595
|
-
* @param {string} name
|
|
1596
|
-
* @param {number} ttl
|
|
1597
|
-
* @param {string} value
|
|
1598
|
-
* @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.
|
|
1599
2851
|
* @throws {AppwriteException}
|
|
1600
2852
|
* @returns {Promise<Models.DnsRecord>}
|
|
1601
2853
|
*/
|
|
1602
|
-
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
|
+
|
|
1603
2894
|
if (typeof domainId === 'undefined') {
|
|
1604
2895
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1605
2896
|
}
|
|
@@ -1609,6 +2900,7 @@ export class Domains {
|
|
|
1609
2900
|
if (typeof ttl === 'undefined') {
|
|
1610
2901
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1611
2902
|
}
|
|
2903
|
+
|
|
1612
2904
|
const apiPath = '/domains/{domainId}/records/txt'.replace('{domainId}', domainId);
|
|
1613
2905
|
const payload: Payload = {};
|
|
1614
2906
|
if (typeof name !== 'undefined') {
|
|
@@ -1643,16 +2935,59 @@ export class Domains {
|
|
|
1643
2935
|
* Update the TXT record details for a specific domain by providing the domain ID,
|
|
1644
2936
|
* record ID, and the new record configuration including name, value, TTL, and an optional comment.
|
|
1645
2937
|
*
|
|
1646
|
-
* @param {string} domainId
|
|
1647
|
-
* @param {string} recordId
|
|
1648
|
-
* @param {string} name
|
|
1649
|
-
* @param {string} value
|
|
1650
|
-
* @param {number} ttl
|
|
1651
|
-
* @param {string} comment
|
|
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>;
|
|
2948
|
+
/**
|
|
2949
|
+
* Update an existing TXT record for the given domain.
|
|
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.
|
|
2953
|
+
*
|
|
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.
|
|
1652
2960
|
* @throws {AppwriteException}
|
|
1653
2961
|
* @returns {Promise<Models.DnsRecord>}
|
|
2962
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1654
2963
|
*/
|
|
1655
|
-
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
|
+
|
|
1656
2991
|
if (typeof domainId === 'undefined') {
|
|
1657
2992
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1658
2993
|
}
|
|
@@ -1668,6 +3003,7 @@ export class Domains {
|
|
|
1668
3003
|
if (typeof ttl === 'undefined') {
|
|
1669
3004
|
throw new AppwriteException('Missing required parameter: "ttl"');
|
|
1670
3005
|
}
|
|
3006
|
+
|
|
1671
3007
|
const apiPath = '/domains/{domainId}/records/txt/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1672
3008
|
const payload: Payload = {};
|
|
1673
3009
|
if (typeof name !== 'undefined') {
|
|
@@ -1703,18 +3039,51 @@ export class Domains {
|
|
|
1703
3039
|
* using its unique identifier. The record contains information about the DNS configuration
|
|
1704
3040
|
* such as type, value, and TTL settings.
|
|
1705
3041
|
*
|
|
1706
|
-
* @param {string} domainId
|
|
1707
|
-
* @param {string} recordId
|
|
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>;
|
|
3048
|
+
/**
|
|
3049
|
+
* Get a single DNS record for a given domain by record ID.
|
|
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.
|
|
3054
|
+
*
|
|
3055
|
+
* @param {string} domainId - Domain unique ID.
|
|
3056
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1708
3057
|
* @throws {AppwriteException}
|
|
1709
3058
|
* @returns {Promise<Models.DnsRecord>}
|
|
3059
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1710
3060
|
*/
|
|
1711
|
-
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
|
+
|
|
1712
3080
|
if (typeof domainId === 'undefined') {
|
|
1713
3081
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1714
3082
|
}
|
|
1715
3083
|
if (typeof recordId === 'undefined') {
|
|
1716
3084
|
throw new AppwriteException('Missing required parameter: "recordId"');
|
|
1717
3085
|
}
|
|
3086
|
+
|
|
1718
3087
|
const apiPath = '/domains/{domainId}/records/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1719
3088
|
const payload: Payload = {};
|
|
1720
3089
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -1734,18 +3103,48 @@ export class Domains {
|
|
|
1734
3103
|
* Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
|
|
1735
3104
|
* from a specific domain.
|
|
1736
3105
|
*
|
|
1737
|
-
* @param {string} domainId
|
|
1738
|
-
* @param {string} recordId
|
|
3106
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
3107
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1739
3108
|
* @throws {AppwriteException}
|
|
1740
3109
|
* @returns {Promise<{}>}
|
|
1741
3110
|
*/
|
|
1742
|
-
deleteRecord(domainId: string, recordId: string): Promise<{}
|
|
3111
|
+
deleteRecord(params: { domainId: string, recordId: string }): Promise<{}>;
|
|
3112
|
+
/**
|
|
3113
|
+
* Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
|
|
3114
|
+
* from a specific domain.
|
|
3115
|
+
*
|
|
3116
|
+
* @param {string} domainId - Domain unique ID.
|
|
3117
|
+
* @param {string} recordId - DNS record unique ID.
|
|
3118
|
+
* @throws {AppwriteException}
|
|
3119
|
+
* @returns {Promise<{}>}
|
|
3120
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
3121
|
+
*/
|
|
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
|
+
|
|
1743
3141
|
if (typeof domainId === 'undefined') {
|
|
1744
3142
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1745
3143
|
}
|
|
1746
3144
|
if (typeof recordId === 'undefined') {
|
|
1747
3145
|
throw new AppwriteException('Missing required parameter: "recordId"');
|
|
1748
3146
|
}
|
|
3147
|
+
|
|
1749
3148
|
const apiPath = '/domains/{domainId}/records/{recordId}'.replace('{domainId}', domainId).replace('{recordId}', recordId);
|
|
1750
3149
|
const payload: Payload = {};
|
|
1751
3150
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -1768,18 +3167,50 @@ export class Domains {
|
|
|
1768
3167
|
* Updating the team ID will transfer ownership and access control of the domain
|
|
1769
3168
|
* and all its DNS records to the new team.
|
|
1770
3169
|
*
|
|
1771
|
-
* @param {string} domainId
|
|
1772
|
-
* @param {string} teamId
|
|
3170
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
3171
|
+
* @param {string} params.teamId - New team unique ID.
|
|
1773
3172
|
* @throws {AppwriteException}
|
|
1774
3173
|
* @returns {Promise<Models.Domain>}
|
|
1775
3174
|
*/
|
|
1776
|
-
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
|
+
|
|
1777
3207
|
if (typeof domainId === 'undefined') {
|
|
1778
3208
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1779
3209
|
}
|
|
1780
3210
|
if (typeof teamId === 'undefined') {
|
|
1781
3211
|
throw new AppwriteException('Missing required parameter: "teamId"');
|
|
1782
3212
|
}
|
|
3213
|
+
|
|
1783
3214
|
const apiPath = '/domains/{domainId}/team'.replace('{domainId}', domainId);
|
|
1784
3215
|
const payload: Payload = {};
|
|
1785
3216
|
if (typeof teamId !== 'undefined') {
|
|
@@ -1800,17 +3231,43 @@ export class Domains {
|
|
|
1800
3231
|
}
|
|
1801
3232
|
|
|
1802
3233
|
/**
|
|
1803
|
-
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
3234
|
+
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
1804
3235
|
* zone file in a standardized format that can be used to configure DNS servers.
|
|
1805
3236
|
*
|
|
1806
|
-
* @param {string} domainId
|
|
3237
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1807
3238
|
* @throws {AppwriteException}
|
|
1808
3239
|
* @returns {Promise<{}>}
|
|
1809
3240
|
*/
|
|
1810
|
-
getZone(domainId: string): Promise<{}
|
|
3241
|
+
getZone(params: { domainId: string }): Promise<{}>;
|
|
3242
|
+
/**
|
|
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.
|
|
3245
|
+
*
|
|
3246
|
+
* @param {string} domainId - Domain unique ID.
|
|
3247
|
+
* @throws {AppwriteException}
|
|
3248
|
+
* @returns {Promise<{}>}
|
|
3249
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
3250
|
+
*/
|
|
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
|
+
|
|
1811
3267
|
if (typeof domainId === 'undefined') {
|
|
1812
3268
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1813
3269
|
}
|
|
3270
|
+
|
|
1814
3271
|
const apiPath = '/domains/{domainId}/zone'.replace('{domainId}', domainId);
|
|
1815
3272
|
const payload: Payload = {};
|
|
1816
3273
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -1827,21 +3284,51 @@ export class Domains {
|
|
|
1827
3284
|
}
|
|
1828
3285
|
|
|
1829
3286
|
/**
|
|
1830
|
-
* Update the DNS zone for the given domain using the provided zone file content.
|
|
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>;
|
|
3296
|
+
/**
|
|
3297
|
+
* Update the DNS zone for the given domain using the provided zone file content.
|
|
1831
3298
|
* All parsed records are imported and then the main domain document is returned.
|
|
1832
3299
|
*
|
|
1833
|
-
* @param {string} domainId
|
|
1834
|
-
* @param {string} content
|
|
3300
|
+
* @param {string} domainId - Domain unique ID.
|
|
3301
|
+
* @param {string} content - DNS zone file content as a string.
|
|
1835
3302
|
* @throws {AppwriteException}
|
|
1836
3303
|
* @returns {Promise<Models.Domain>}
|
|
3304
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1837
3305
|
*/
|
|
1838
|
-
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
|
+
|
|
1839
3325
|
if (typeof domainId === 'undefined') {
|
|
1840
3326
|
throw new AppwriteException('Missing required parameter: "domainId"');
|
|
1841
3327
|
}
|
|
1842
3328
|
if (typeof content === 'undefined') {
|
|
1843
3329
|
throw new AppwriteException('Missing required parameter: "content"');
|
|
1844
3330
|
}
|
|
3331
|
+
|
|
1845
3332
|
const apiPath = '/domains/{domainId}/zone'.replace('{domainId}', domainId);
|
|
1846
3333
|
const payload: Payload = {};
|
|
1847
3334
|
if (typeof content !== 'undefined') {
|