@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
|
@@ -6,7 +6,8 @@ import { AuthMethod } from '../enums/auth-method';
|
|
|
6
6
|
import { OAuthProvider } from '../enums/o-auth-provider';
|
|
7
7
|
import { PlatformType } from '../enums/platform-type';
|
|
8
8
|
import { ApiService } from '../enums/api-service';
|
|
9
|
-
import { SMTPSecure } from '../enums/
|
|
9
|
+
import { SMTPSecure } from '../enums/smtp-secure';
|
|
10
|
+
import { Status } from '../enums/status';
|
|
10
11
|
import { EmailTemplateType } from '../enums/email-template-type';
|
|
11
12
|
import { EmailTemplateLocale } from '../enums/email-template-locale';
|
|
12
13
|
import { SmsTemplateType } from '../enums/sms-template-type';
|
|
@@ -17,541 +18,1646 @@ export declare class Projects {
|
|
|
17
18
|
/**
|
|
18
19
|
* Get a list of all projects. You can use the query params to filter your results.
|
|
19
20
|
*
|
|
20
|
-
* @param {string[]} queries
|
|
21
|
-
* @param {string} search
|
|
21
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, teamId
|
|
22
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
23
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
22
24
|
* @throws {AppwriteException}
|
|
23
25
|
* @returns {Promise<Models.ProjectList>}
|
|
24
26
|
*/
|
|
25
|
-
list(
|
|
27
|
+
list(params?: {
|
|
28
|
+
queries?: string[];
|
|
29
|
+
search?: string;
|
|
30
|
+
total?: boolean;
|
|
31
|
+
}): Promise<Models.ProjectList>;
|
|
32
|
+
/**
|
|
33
|
+
* Get a list of all projects. You can use the query params to filter your results.
|
|
34
|
+
*
|
|
35
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, teamId
|
|
36
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
37
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
38
|
+
* @throws {AppwriteException}
|
|
39
|
+
* @returns {Promise<Models.ProjectList>}
|
|
40
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
41
|
+
*/
|
|
42
|
+
list(queries?: string[], search?: string, total?: boolean): Promise<Models.ProjectList>;
|
|
26
43
|
/**
|
|
27
44
|
* Create a new project. You can create a maximum of 100 projects per account.
|
|
28
45
|
*
|
|
29
|
-
* @param {string} projectId
|
|
30
|
-
* @param {string} name
|
|
31
|
-
* @param {string} teamId
|
|
32
|
-
* @param {Region} region
|
|
33
|
-
* @param {string} description
|
|
34
|
-
* @param {string} logo
|
|
35
|
-
* @param {string} url
|
|
36
|
-
* @param {string} legalName
|
|
37
|
-
* @param {string} legalCountry
|
|
38
|
-
* @param {string} legalState
|
|
39
|
-
* @param {string} legalCity
|
|
40
|
-
* @param {string} legalAddress
|
|
41
|
-
* @param {string} legalTaxId
|
|
46
|
+
* @param {string} params.projectId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.
|
|
47
|
+
* @param {string} params.name - Project name. Max length: 128 chars.
|
|
48
|
+
* @param {string} params.teamId - Team unique ID.
|
|
49
|
+
* @param {Region} params.region - Project Region.
|
|
50
|
+
* @param {string} params.description - Project description. Max length: 256 chars.
|
|
51
|
+
* @param {string} params.logo - Project logo.
|
|
52
|
+
* @param {string} params.url - Project URL.
|
|
53
|
+
* @param {string} params.legalName - Project legal Name. Max length: 256 chars.
|
|
54
|
+
* @param {string} params.legalCountry - Project legal Country. Max length: 256 chars.
|
|
55
|
+
* @param {string} params.legalState - Project legal State. Max length: 256 chars.
|
|
56
|
+
* @param {string} params.legalCity - Project legal City. Max length: 256 chars.
|
|
57
|
+
* @param {string} params.legalAddress - Project legal Address. Max length: 256 chars.
|
|
58
|
+
* @param {string} params.legalTaxId - Project legal Tax ID. Max length: 256 chars.
|
|
42
59
|
* @throws {AppwriteException}
|
|
43
60
|
* @returns {Promise<Models.Project>}
|
|
44
61
|
*/
|
|
62
|
+
create(params: {
|
|
63
|
+
projectId: string;
|
|
64
|
+
name: string;
|
|
65
|
+
teamId: string;
|
|
66
|
+
region?: Region;
|
|
67
|
+
description?: string;
|
|
68
|
+
logo?: string;
|
|
69
|
+
url?: string;
|
|
70
|
+
legalName?: string;
|
|
71
|
+
legalCountry?: string;
|
|
72
|
+
legalState?: string;
|
|
73
|
+
legalCity?: string;
|
|
74
|
+
legalAddress?: string;
|
|
75
|
+
legalTaxId?: string;
|
|
76
|
+
}): Promise<Models.Project>;
|
|
77
|
+
/**
|
|
78
|
+
* Create a new project. You can create a maximum of 100 projects per account.
|
|
79
|
+
*
|
|
80
|
+
* @param {string} projectId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.
|
|
81
|
+
* @param {string} name - Project name. Max length: 128 chars.
|
|
82
|
+
* @param {string} teamId - Team unique ID.
|
|
83
|
+
* @param {Region} region - Project Region.
|
|
84
|
+
* @param {string} description - Project description. Max length: 256 chars.
|
|
85
|
+
* @param {string} logo - Project logo.
|
|
86
|
+
* @param {string} url - Project URL.
|
|
87
|
+
* @param {string} legalName - Project legal Name. Max length: 256 chars.
|
|
88
|
+
* @param {string} legalCountry - Project legal Country. Max length: 256 chars.
|
|
89
|
+
* @param {string} legalState - Project legal State. Max length: 256 chars.
|
|
90
|
+
* @param {string} legalCity - Project legal City. Max length: 256 chars.
|
|
91
|
+
* @param {string} legalAddress - Project legal Address. Max length: 256 chars.
|
|
92
|
+
* @param {string} legalTaxId - Project legal Tax ID. Max length: 256 chars.
|
|
93
|
+
* @throws {AppwriteException}
|
|
94
|
+
* @returns {Promise<Models.Project>}
|
|
95
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
96
|
+
*/
|
|
45
97
|
create(projectId: string, name: string, teamId: string, region?: Region, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
|
|
46
98
|
/**
|
|
47
|
-
* Get a project by its unique ID. This endpoint allows you to retrieve the project
|
|
99
|
+
* Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata.
|
|
48
100
|
*
|
|
49
|
-
* @param {string} projectId
|
|
101
|
+
* @param {string} params.projectId - Project unique ID.
|
|
50
102
|
* @throws {AppwriteException}
|
|
51
103
|
* @returns {Promise<Models.Project>}
|
|
52
104
|
*/
|
|
105
|
+
get(params: {
|
|
106
|
+
projectId: string;
|
|
107
|
+
}): Promise<Models.Project>;
|
|
108
|
+
/**
|
|
109
|
+
* Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata.
|
|
110
|
+
*
|
|
111
|
+
* @param {string} projectId - Project unique ID.
|
|
112
|
+
* @throws {AppwriteException}
|
|
113
|
+
* @returns {Promise<Models.Project>}
|
|
114
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
115
|
+
*/
|
|
53
116
|
get(projectId: string): Promise<Models.Project>;
|
|
54
117
|
/**
|
|
55
118
|
* Update a project by its unique ID.
|
|
56
119
|
*
|
|
57
|
-
* @param {string} projectId
|
|
58
|
-
* @param {string} name
|
|
59
|
-
* @param {string} description
|
|
60
|
-
* @param {string} logo
|
|
61
|
-
* @param {string} url
|
|
62
|
-
* @param {string} legalName
|
|
63
|
-
* @param {string} legalCountry
|
|
64
|
-
* @param {string} legalState
|
|
65
|
-
* @param {string} legalCity
|
|
66
|
-
* @param {string} legalAddress
|
|
67
|
-
* @param {string} legalTaxId
|
|
120
|
+
* @param {string} params.projectId - Project unique ID.
|
|
121
|
+
* @param {string} params.name - Project name. Max length: 128 chars.
|
|
122
|
+
* @param {string} params.description - Project description. Max length: 256 chars.
|
|
123
|
+
* @param {string} params.logo - Project logo.
|
|
124
|
+
* @param {string} params.url - Project URL.
|
|
125
|
+
* @param {string} params.legalName - Project legal name. Max length: 256 chars.
|
|
126
|
+
* @param {string} params.legalCountry - Project legal country. Max length: 256 chars.
|
|
127
|
+
* @param {string} params.legalState - Project legal state. Max length: 256 chars.
|
|
128
|
+
* @param {string} params.legalCity - Project legal city. Max length: 256 chars.
|
|
129
|
+
* @param {string} params.legalAddress - Project legal address. Max length: 256 chars.
|
|
130
|
+
* @param {string} params.legalTaxId - Project legal tax ID. Max length: 256 chars.
|
|
131
|
+
* @throws {AppwriteException}
|
|
132
|
+
* @returns {Promise<Models.Project>}
|
|
133
|
+
*/
|
|
134
|
+
update(params: {
|
|
135
|
+
projectId: string;
|
|
136
|
+
name: string;
|
|
137
|
+
description?: string;
|
|
138
|
+
logo?: string;
|
|
139
|
+
url?: string;
|
|
140
|
+
legalName?: string;
|
|
141
|
+
legalCountry?: string;
|
|
142
|
+
legalState?: string;
|
|
143
|
+
legalCity?: string;
|
|
144
|
+
legalAddress?: string;
|
|
145
|
+
legalTaxId?: string;
|
|
146
|
+
}): Promise<Models.Project>;
|
|
147
|
+
/**
|
|
148
|
+
* Update a project by its unique ID.
|
|
149
|
+
*
|
|
150
|
+
* @param {string} projectId - Project unique ID.
|
|
151
|
+
* @param {string} name - Project name. Max length: 128 chars.
|
|
152
|
+
* @param {string} description - Project description. Max length: 256 chars.
|
|
153
|
+
* @param {string} logo - Project logo.
|
|
154
|
+
* @param {string} url - Project URL.
|
|
155
|
+
* @param {string} legalName - Project legal name. Max length: 256 chars.
|
|
156
|
+
* @param {string} legalCountry - Project legal country. Max length: 256 chars.
|
|
157
|
+
* @param {string} legalState - Project legal state. Max length: 256 chars.
|
|
158
|
+
* @param {string} legalCity - Project legal city. Max length: 256 chars.
|
|
159
|
+
* @param {string} legalAddress - Project legal address. Max length: 256 chars.
|
|
160
|
+
* @param {string} legalTaxId - Project legal tax ID. Max length: 256 chars.
|
|
68
161
|
* @throws {AppwriteException}
|
|
69
162
|
* @returns {Promise<Models.Project>}
|
|
163
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
70
164
|
*/
|
|
71
165
|
update(projectId: string, name: string, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
|
|
72
166
|
/**
|
|
73
167
|
* Delete a project by its unique ID.
|
|
74
168
|
*
|
|
75
|
-
* @param {string} projectId
|
|
169
|
+
* @param {string} params.projectId - Project unique ID.
|
|
170
|
+
* @throws {AppwriteException}
|
|
171
|
+
* @returns {Promise<{}>}
|
|
172
|
+
*/
|
|
173
|
+
delete(params: {
|
|
174
|
+
projectId: string;
|
|
175
|
+
}): Promise<{}>;
|
|
176
|
+
/**
|
|
177
|
+
* Delete a project by its unique ID.
|
|
178
|
+
*
|
|
179
|
+
* @param {string} projectId - Project unique ID.
|
|
76
180
|
* @throws {AppwriteException}
|
|
77
181
|
* @returns {Promise<{}>}
|
|
182
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
78
183
|
*/
|
|
79
184
|
delete(projectId: string): Promise<{}>;
|
|
80
185
|
/**
|
|
81
186
|
* Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
|
|
82
187
|
*
|
|
83
|
-
* @param {string} projectId
|
|
84
|
-
* @param {Api} api
|
|
85
|
-
* @param {boolean} status
|
|
188
|
+
* @param {string} params.projectId - Project unique ID.
|
|
189
|
+
* @param {Api} params.api - API name.
|
|
190
|
+
* @param {boolean} params.status - API status.
|
|
86
191
|
* @throws {AppwriteException}
|
|
87
192
|
* @returns {Promise<Models.Project>}
|
|
193
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateAPIStatus` instead.
|
|
194
|
+
*/
|
|
195
|
+
updateApiStatus(params: {
|
|
196
|
+
projectId: string;
|
|
197
|
+
api: Api;
|
|
198
|
+
status: boolean;
|
|
199
|
+
}): Promise<Models.Project>;
|
|
200
|
+
/**
|
|
201
|
+
* Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
|
|
202
|
+
*
|
|
203
|
+
* @param {string} projectId - Project unique ID.
|
|
204
|
+
* @param {Api} api - API name.
|
|
205
|
+
* @param {boolean} status - API status.
|
|
206
|
+
* @throws {AppwriteException}
|
|
207
|
+
* @returns {Promise<Models.Project>}
|
|
208
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
88
209
|
*/
|
|
89
210
|
updateApiStatus(projectId: string, api: Api, status: boolean): Promise<Models.Project>;
|
|
211
|
+
/**
|
|
212
|
+
* Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
|
|
213
|
+
*
|
|
214
|
+
* @param {string} params.projectId - Project unique ID.
|
|
215
|
+
* @param {Api} params.api - API name.
|
|
216
|
+
* @param {boolean} params.status - API status.
|
|
217
|
+
* @throws {AppwriteException}
|
|
218
|
+
* @returns {Promise<Models.Project>}
|
|
219
|
+
*/
|
|
220
|
+
updateAPIStatus(params: {
|
|
221
|
+
projectId: string;
|
|
222
|
+
api: Api;
|
|
223
|
+
status: boolean;
|
|
224
|
+
}): Promise<Models.Project>;
|
|
225
|
+
/**
|
|
226
|
+
* Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
|
|
227
|
+
*
|
|
228
|
+
* @param {string} projectId - Project unique ID.
|
|
229
|
+
* @param {Api} api - API name.
|
|
230
|
+
* @param {boolean} status - API status.
|
|
231
|
+
* @throws {AppwriteException}
|
|
232
|
+
* @returns {Promise<Models.Project>}
|
|
233
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
234
|
+
*/
|
|
235
|
+
updateAPIStatus(projectId: string, api: Api, status: boolean): Promise<Models.Project>;
|
|
90
236
|
/**
|
|
91
237
|
* Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
|
|
92
238
|
*
|
|
93
|
-
* @param {string} projectId
|
|
94
|
-
* @param {boolean} status
|
|
239
|
+
* @param {string} params.projectId - Project unique ID.
|
|
240
|
+
* @param {boolean} params.status - API status.
|
|
95
241
|
* @throws {AppwriteException}
|
|
96
242
|
* @returns {Promise<Models.Project>}
|
|
243
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateAPIStatusAll` instead.
|
|
244
|
+
*/
|
|
245
|
+
updateApiStatusAll(params: {
|
|
246
|
+
projectId: string;
|
|
247
|
+
status: boolean;
|
|
248
|
+
}): Promise<Models.Project>;
|
|
249
|
+
/**
|
|
250
|
+
* Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
|
|
251
|
+
*
|
|
252
|
+
* @param {string} projectId - Project unique ID.
|
|
253
|
+
* @param {boolean} status - API status.
|
|
254
|
+
* @throws {AppwriteException}
|
|
255
|
+
* @returns {Promise<Models.Project>}
|
|
256
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
97
257
|
*/
|
|
98
258
|
updateApiStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
|
|
259
|
+
/**
|
|
260
|
+
* Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
|
|
261
|
+
*
|
|
262
|
+
* @param {string} params.projectId - Project unique ID.
|
|
263
|
+
* @param {boolean} params.status - API status.
|
|
264
|
+
* @throws {AppwriteException}
|
|
265
|
+
* @returns {Promise<Models.Project>}
|
|
266
|
+
*/
|
|
267
|
+
updateAPIStatusAll(params: {
|
|
268
|
+
projectId: string;
|
|
269
|
+
status: boolean;
|
|
270
|
+
}): Promise<Models.Project>;
|
|
271
|
+
/**
|
|
272
|
+
* Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
|
|
273
|
+
*
|
|
274
|
+
* @param {string} projectId - Project unique ID.
|
|
275
|
+
* @param {boolean} status - API status.
|
|
276
|
+
* @throws {AppwriteException}
|
|
277
|
+
* @returns {Promise<Models.Project>}
|
|
278
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
279
|
+
*/
|
|
280
|
+
updateAPIStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
|
|
281
|
+
/**
|
|
282
|
+
* Update how long sessions created within a project should stay active for.
|
|
283
|
+
*
|
|
284
|
+
* @param {string} params.projectId - Project unique ID.
|
|
285
|
+
* @param {number} params.duration - Project session length in seconds. Max length: 31536000 seconds.
|
|
286
|
+
* @throws {AppwriteException}
|
|
287
|
+
* @returns {Promise<Models.Project>}
|
|
288
|
+
*/
|
|
289
|
+
updateAuthDuration(params: {
|
|
290
|
+
projectId: string;
|
|
291
|
+
duration: number;
|
|
292
|
+
}): Promise<Models.Project>;
|
|
99
293
|
/**
|
|
100
294
|
* Update how long sessions created within a project should stay active for.
|
|
101
295
|
*
|
|
102
|
-
* @param {string} projectId
|
|
103
|
-
* @param {number} duration
|
|
296
|
+
* @param {string} projectId - Project unique ID.
|
|
297
|
+
* @param {number} duration - Project session length in seconds. Max length: 31536000 seconds.
|
|
104
298
|
* @throws {AppwriteException}
|
|
105
299
|
* @returns {Promise<Models.Project>}
|
|
300
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
106
301
|
*/
|
|
107
302
|
updateAuthDuration(projectId: string, duration: number): Promise<Models.Project>;
|
|
108
303
|
/**
|
|
109
304
|
* Update the maximum number of users allowed in this project. Set to 0 for unlimited users.
|
|
110
305
|
*
|
|
111
|
-
* @param {string} projectId
|
|
112
|
-
* @param {number} limit
|
|
306
|
+
* @param {string} params.projectId - Project unique ID.
|
|
307
|
+
* @param {number} params.limit - Set the max number of users allowed in this project. Use 0 for unlimited.
|
|
113
308
|
* @throws {AppwriteException}
|
|
114
309
|
* @returns {Promise<Models.Project>}
|
|
115
310
|
*/
|
|
311
|
+
updateAuthLimit(params: {
|
|
312
|
+
projectId: string;
|
|
313
|
+
limit: number;
|
|
314
|
+
}): Promise<Models.Project>;
|
|
315
|
+
/**
|
|
316
|
+
* Update the maximum number of users allowed in this project. Set to 0 for unlimited users.
|
|
317
|
+
*
|
|
318
|
+
* @param {string} projectId - Project unique ID.
|
|
319
|
+
* @param {number} limit - Set the max number of users allowed in this project. Use 0 for unlimited.
|
|
320
|
+
* @throws {AppwriteException}
|
|
321
|
+
* @returns {Promise<Models.Project>}
|
|
322
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
323
|
+
*/
|
|
116
324
|
updateAuthLimit(projectId: string, limit: number): Promise<Models.Project>;
|
|
117
325
|
/**
|
|
118
326
|
* Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
|
|
119
327
|
*
|
|
120
|
-
* @param {string} projectId
|
|
121
|
-
* @param {number} limit
|
|
328
|
+
* @param {string} params.projectId - Project unique ID.
|
|
329
|
+
* @param {number} params.limit - Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10
|
|
330
|
+
* @throws {AppwriteException}
|
|
331
|
+
* @returns {Promise<Models.Project>}
|
|
332
|
+
*/
|
|
333
|
+
updateAuthSessionsLimit(params: {
|
|
334
|
+
projectId: string;
|
|
335
|
+
limit: number;
|
|
336
|
+
}): Promise<Models.Project>;
|
|
337
|
+
/**
|
|
338
|
+
* Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
|
|
339
|
+
*
|
|
340
|
+
* @param {string} projectId - Project unique ID.
|
|
341
|
+
* @param {number} limit - Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10
|
|
122
342
|
* @throws {AppwriteException}
|
|
123
343
|
* @returns {Promise<Models.Project>}
|
|
344
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
124
345
|
*/
|
|
125
346
|
updateAuthSessionsLimit(projectId: string, limit: number): Promise<Models.Project>;
|
|
126
347
|
/**
|
|
127
348
|
* Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status.
|
|
128
349
|
*
|
|
129
|
-
* @param {string} projectId
|
|
130
|
-
* @param {boolean} userName
|
|
131
|
-
* @param {boolean} userEmail
|
|
132
|
-
* @param {boolean} mfa
|
|
350
|
+
* @param {string} params.projectId - Project unique ID.
|
|
351
|
+
* @param {boolean} params.userName - Set to true to show userName to members of a team.
|
|
352
|
+
* @param {boolean} params.userEmail - Set to true to show email to members of a team.
|
|
353
|
+
* @param {boolean} params.mfa - Set to true to show mfa to members of a team.
|
|
354
|
+
* @throws {AppwriteException}
|
|
355
|
+
* @returns {Promise<Models.Project>}
|
|
356
|
+
*/
|
|
357
|
+
updateMembershipsPrivacy(params: {
|
|
358
|
+
projectId: string;
|
|
359
|
+
userName: boolean;
|
|
360
|
+
userEmail: boolean;
|
|
361
|
+
mfa: boolean;
|
|
362
|
+
}): Promise<Models.Project>;
|
|
363
|
+
/**
|
|
364
|
+
* Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status.
|
|
365
|
+
*
|
|
366
|
+
* @param {string} projectId - Project unique ID.
|
|
367
|
+
* @param {boolean} userName - Set to true to show userName to members of a team.
|
|
368
|
+
* @param {boolean} userEmail - Set to true to show email to members of a team.
|
|
369
|
+
* @param {boolean} mfa - Set to true to show mfa to members of a team.
|
|
133
370
|
* @throws {AppwriteException}
|
|
134
371
|
* @returns {Promise<Models.Project>}
|
|
372
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
135
373
|
*/
|
|
136
374
|
updateMembershipsPrivacy(projectId: string, userName: boolean, userEmail: boolean, mfa: boolean): Promise<Models.Project>;
|
|
137
375
|
/**
|
|
138
376
|
* Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development.
|
|
139
377
|
*
|
|
140
|
-
* @param {string} projectId
|
|
141
|
-
* @param {object[]} numbers
|
|
378
|
+
* @param {string} params.projectId - Project unique ID.
|
|
379
|
+
* @param {object[]} params.numbers - An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.
|
|
380
|
+
* @throws {AppwriteException}
|
|
381
|
+
* @returns {Promise<Models.Project>}
|
|
382
|
+
*/
|
|
383
|
+
updateMockNumbers(params: {
|
|
384
|
+
projectId: string;
|
|
385
|
+
numbers: object[];
|
|
386
|
+
}): Promise<Models.Project>;
|
|
387
|
+
/**
|
|
388
|
+
* Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development.
|
|
389
|
+
*
|
|
390
|
+
* @param {string} projectId - Project unique ID.
|
|
391
|
+
* @param {object[]} numbers - An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.
|
|
142
392
|
* @throws {AppwriteException}
|
|
143
393
|
* @returns {Promise<Models.Project>}
|
|
394
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
144
395
|
*/
|
|
145
396
|
updateMockNumbers(projectId: string, numbers: object[]): Promise<Models.Project>;
|
|
146
397
|
/**
|
|
147
|
-
* Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don
|
|
398
|
+
* Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords.
|
|
148
399
|
*
|
|
149
|
-
* @param {string} projectId
|
|
150
|
-
* @param {boolean} enabled
|
|
400
|
+
* @param {string} params.projectId - Project unique ID.
|
|
401
|
+
* @param {boolean} params.enabled - Set whether or not to enable checking user's password against most commonly used passwords. Default is false.
|
|
151
402
|
* @throws {AppwriteException}
|
|
152
403
|
* @returns {Promise<Models.Project>}
|
|
153
404
|
*/
|
|
405
|
+
updateAuthPasswordDictionary(params: {
|
|
406
|
+
projectId: string;
|
|
407
|
+
enabled: boolean;
|
|
408
|
+
}): Promise<Models.Project>;
|
|
409
|
+
/**
|
|
410
|
+
* Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords.
|
|
411
|
+
*
|
|
412
|
+
* @param {string} projectId - Project unique ID.
|
|
413
|
+
* @param {boolean} enabled - Set whether or not to enable checking user's password against most commonly used passwords. Default is false.
|
|
414
|
+
* @throws {AppwriteException}
|
|
415
|
+
* @returns {Promise<Models.Project>}
|
|
416
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
417
|
+
*/
|
|
154
418
|
updateAuthPasswordDictionary(projectId: string, enabled: boolean): Promise<Models.Project>;
|
|
155
419
|
/**
|
|
156
420
|
* Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
|
|
157
421
|
*
|
|
158
|
-
* @param {string} projectId
|
|
159
|
-
* @param {number} limit
|
|
422
|
+
* @param {string} params.projectId - Project unique ID.
|
|
423
|
+
* @param {number} params.limit - Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0
|
|
424
|
+
* @throws {AppwriteException}
|
|
425
|
+
* @returns {Promise<Models.Project>}
|
|
426
|
+
*/
|
|
427
|
+
updateAuthPasswordHistory(params: {
|
|
428
|
+
projectId: string;
|
|
429
|
+
limit: number;
|
|
430
|
+
}): Promise<Models.Project>;
|
|
431
|
+
/**
|
|
432
|
+
* Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
|
|
433
|
+
*
|
|
434
|
+
* @param {string} projectId - Project unique ID.
|
|
435
|
+
* @param {number} limit - Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0
|
|
160
436
|
* @throws {AppwriteException}
|
|
161
437
|
* @returns {Promise<Models.Project>}
|
|
438
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
162
439
|
*/
|
|
163
440
|
updateAuthPasswordHistory(projectId: string, limit: number): Promise<Models.Project>;
|
|
164
441
|
/**
|
|
165
442
|
* Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords.
|
|
166
443
|
*
|
|
167
|
-
* @param {string} projectId
|
|
168
|
-
* @param {boolean} enabled
|
|
444
|
+
* @param {string} params.projectId - Project unique ID.
|
|
445
|
+
* @param {boolean} params.enabled - Set whether or not to check a password for similarity with personal data. Default is false.
|
|
446
|
+
* @throws {AppwriteException}
|
|
447
|
+
* @returns {Promise<Models.Project>}
|
|
448
|
+
*/
|
|
449
|
+
updatePersonalDataCheck(params: {
|
|
450
|
+
projectId: string;
|
|
451
|
+
enabled: boolean;
|
|
452
|
+
}): Promise<Models.Project>;
|
|
453
|
+
/**
|
|
454
|
+
* Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords.
|
|
455
|
+
*
|
|
456
|
+
* @param {string} projectId - Project unique ID.
|
|
457
|
+
* @param {boolean} enabled - Set whether or not to check a password for similarity with personal data. Default is false.
|
|
169
458
|
* @throws {AppwriteException}
|
|
170
459
|
* @returns {Promise<Models.Project>}
|
|
460
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
171
461
|
*/
|
|
172
462
|
updatePersonalDataCheck(projectId: string, enabled: boolean): Promise<Models.Project>;
|
|
173
463
|
/**
|
|
174
464
|
* Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.
|
|
175
465
|
*
|
|
176
|
-
* @param {string} projectId
|
|
177
|
-
* @param {boolean} alerts
|
|
466
|
+
* @param {string} params.projectId - Project unique ID.
|
|
467
|
+
* @param {boolean} params.alerts - Set to true to enable session emails.
|
|
178
468
|
* @throws {AppwriteException}
|
|
179
469
|
* @returns {Promise<Models.Project>}
|
|
180
470
|
*/
|
|
471
|
+
updateSessionAlerts(params: {
|
|
472
|
+
projectId: string;
|
|
473
|
+
alerts: boolean;
|
|
474
|
+
}): Promise<Models.Project>;
|
|
475
|
+
/**
|
|
476
|
+
* Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.
|
|
477
|
+
*
|
|
478
|
+
* @param {string} projectId - Project unique ID.
|
|
479
|
+
* @param {boolean} alerts - Set to true to enable session emails.
|
|
480
|
+
* @throws {AppwriteException}
|
|
481
|
+
* @returns {Promise<Models.Project>}
|
|
482
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
483
|
+
*/
|
|
181
484
|
updateSessionAlerts(projectId: string, alerts: boolean): Promise<Models.Project>;
|
|
485
|
+
/**
|
|
486
|
+
* Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.
|
|
487
|
+
*
|
|
488
|
+
* @param {string} params.projectId - Project unique ID.
|
|
489
|
+
* @param {boolean} params.enabled - Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change
|
|
490
|
+
* @throws {AppwriteException}
|
|
491
|
+
* @returns {Promise<Models.Project>}
|
|
492
|
+
*/
|
|
493
|
+
updateSessionInvalidation(params: {
|
|
494
|
+
projectId: string;
|
|
495
|
+
enabled: boolean;
|
|
496
|
+
}): Promise<Models.Project>;
|
|
497
|
+
/**
|
|
498
|
+
* Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.
|
|
499
|
+
*
|
|
500
|
+
* @param {string} projectId - Project unique ID.
|
|
501
|
+
* @param {boolean} enabled - Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change
|
|
502
|
+
* @throws {AppwriteException}
|
|
503
|
+
* @returns {Promise<Models.Project>}
|
|
504
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
505
|
+
*/
|
|
506
|
+
updateSessionInvalidation(projectId: string, enabled: boolean): Promise<Models.Project>;
|
|
507
|
+
/**
|
|
508
|
+
* Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project.
|
|
509
|
+
*
|
|
510
|
+
* @param {string} params.projectId - Project unique ID.
|
|
511
|
+
* @param {AuthMethod} params.method - Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
512
|
+
* @param {boolean} params.status - Set the status of this auth method.
|
|
513
|
+
* @throws {AppwriteException}
|
|
514
|
+
* @returns {Promise<Models.Project>}
|
|
515
|
+
*/
|
|
516
|
+
updateAuthStatus(params: {
|
|
517
|
+
projectId: string;
|
|
518
|
+
method: AuthMethod;
|
|
519
|
+
status: boolean;
|
|
520
|
+
}): Promise<Models.Project>;
|
|
182
521
|
/**
|
|
183
522
|
* Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project.
|
|
184
523
|
*
|
|
185
|
-
* @param {string} projectId
|
|
186
|
-
* @param {AuthMethod} method
|
|
187
|
-
* @param {boolean} status
|
|
524
|
+
* @param {string} projectId - Project unique ID.
|
|
525
|
+
* @param {AuthMethod} method - Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
526
|
+
* @param {boolean} status - Set the status of this auth method.
|
|
188
527
|
* @throws {AppwriteException}
|
|
189
528
|
* @returns {Promise<Models.Project>}
|
|
529
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
190
530
|
*/
|
|
191
531
|
updateAuthStatus(projectId: string, method: AuthMethod, status: boolean): Promise<Models.Project>;
|
|
192
532
|
/**
|
|
193
|
-
* List all the project
|
|
533
|
+
* List all the project\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'
|
|
534
|
+
*
|
|
535
|
+
* @param {string} params.projectId - Project unique ID.
|
|
536
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: accessedAt, expire
|
|
537
|
+
* @throws {AppwriteException}
|
|
538
|
+
* @returns {Promise<Models.DevKeyList>}
|
|
539
|
+
*/
|
|
540
|
+
listDevKeys(params: {
|
|
541
|
+
projectId: string;
|
|
542
|
+
queries?: string[];
|
|
543
|
+
}): Promise<Models.DevKeyList>;
|
|
544
|
+
/**
|
|
545
|
+
* List all the project\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'
|
|
194
546
|
*
|
|
195
|
-
* @param {string} projectId
|
|
196
|
-
* @param {string[]} queries
|
|
547
|
+
* @param {string} projectId - Project unique ID.
|
|
548
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: accessedAt, expire
|
|
197
549
|
* @throws {AppwriteException}
|
|
198
550
|
* @returns {Promise<Models.DevKeyList>}
|
|
551
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
199
552
|
*/
|
|
200
553
|
listDevKeys(projectId: string, queries?: string[]): Promise<Models.DevKeyList>;
|
|
201
554
|
/**
|
|
202
555
|
* Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.
|
|
203
556
|
*
|
|
204
|
-
* @param {string} projectId
|
|
205
|
-
* @param {string} name
|
|
206
|
-
* @param {string} expire
|
|
557
|
+
* @param {string} params.projectId - Project unique ID.
|
|
558
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
559
|
+
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
560
|
+
* @throws {AppwriteException}
|
|
561
|
+
* @returns {Promise<Models.DevKey>}
|
|
562
|
+
*/
|
|
563
|
+
createDevKey(params: {
|
|
564
|
+
projectId: string;
|
|
565
|
+
name: string;
|
|
566
|
+
expire: string;
|
|
567
|
+
}): Promise<Models.DevKey>;
|
|
568
|
+
/**
|
|
569
|
+
* Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.
|
|
570
|
+
*
|
|
571
|
+
* @param {string} projectId - Project unique ID.
|
|
572
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
573
|
+
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
207
574
|
* @throws {AppwriteException}
|
|
208
575
|
* @returns {Promise<Models.DevKey>}
|
|
576
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
209
577
|
*/
|
|
210
578
|
createDevKey(projectId: string, name: string, expire: string): Promise<Models.DevKey>;
|
|
211
579
|
/**
|
|
212
|
-
* Get a project
|
|
580
|
+
* Get a project\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.
|
|
581
|
+
*
|
|
582
|
+
* @param {string} params.projectId - Project unique ID.
|
|
583
|
+
* @param {string} params.keyId - Key unique ID.
|
|
584
|
+
* @throws {AppwriteException}
|
|
585
|
+
* @returns {Promise<Models.DevKey>}
|
|
586
|
+
*/
|
|
587
|
+
getDevKey(params: {
|
|
588
|
+
projectId: string;
|
|
589
|
+
keyId: string;
|
|
590
|
+
}): Promise<Models.DevKey>;
|
|
591
|
+
/**
|
|
592
|
+
* Get a project\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.
|
|
213
593
|
*
|
|
214
|
-
* @param {string} projectId
|
|
215
|
-
* @param {string} keyId
|
|
594
|
+
* @param {string} projectId - Project unique ID.
|
|
595
|
+
* @param {string} keyId - Key unique ID.
|
|
216
596
|
* @throws {AppwriteException}
|
|
217
597
|
* @returns {Promise<Models.DevKey>}
|
|
598
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
218
599
|
*/
|
|
219
600
|
getDevKey(projectId: string, keyId: string): Promise<Models.DevKey>;
|
|
220
601
|
/**
|
|
221
|
-
* Update a project
|
|
602
|
+
* Update a project\'s dev key by its unique ID. Use this endpoint to update a project\'s dev key name or expiration time.'
|
|
603
|
+
*
|
|
604
|
+
* @param {string} params.projectId - Project unique ID.
|
|
605
|
+
* @param {string} params.keyId - Key unique ID.
|
|
606
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
607
|
+
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
608
|
+
* @throws {AppwriteException}
|
|
609
|
+
* @returns {Promise<Models.DevKey>}
|
|
610
|
+
*/
|
|
611
|
+
updateDevKey(params: {
|
|
612
|
+
projectId: string;
|
|
613
|
+
keyId: string;
|
|
614
|
+
name: string;
|
|
615
|
+
expire: string;
|
|
616
|
+
}): Promise<Models.DevKey>;
|
|
617
|
+
/**
|
|
618
|
+
* Update a project\'s dev key by its unique ID. Use this endpoint to update a project\'s dev key name or expiration time.'
|
|
222
619
|
*
|
|
223
|
-
* @param {string} projectId
|
|
224
|
-
* @param {string} keyId
|
|
225
|
-
* @param {string} name
|
|
226
|
-
* @param {string} expire
|
|
620
|
+
* @param {string} projectId - Project unique ID.
|
|
621
|
+
* @param {string} keyId - Key unique ID.
|
|
622
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
623
|
+
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
227
624
|
* @throws {AppwriteException}
|
|
228
625
|
* @returns {Promise<Models.DevKey>}
|
|
626
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
229
627
|
*/
|
|
230
628
|
updateDevKey(projectId: string, keyId: string, name: string, expire: string): Promise<Models.DevKey>;
|
|
231
629
|
/**
|
|
232
|
-
* Delete a project
|
|
630
|
+
* Delete a project\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.
|
|
233
631
|
*
|
|
234
|
-
* @param {string} projectId
|
|
235
|
-
* @param {string} keyId
|
|
632
|
+
* @param {string} params.projectId - Project unique ID.
|
|
633
|
+
* @param {string} params.keyId - Key unique ID.
|
|
236
634
|
* @throws {AppwriteException}
|
|
237
635
|
* @returns {Promise<{}>}
|
|
238
636
|
*/
|
|
637
|
+
deleteDevKey(params: {
|
|
638
|
+
projectId: string;
|
|
639
|
+
keyId: string;
|
|
640
|
+
}): Promise<{}>;
|
|
641
|
+
/**
|
|
642
|
+
* Delete a project\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.
|
|
643
|
+
*
|
|
644
|
+
* @param {string} projectId - Project unique ID.
|
|
645
|
+
* @param {string} keyId - Key unique ID.
|
|
646
|
+
* @throws {AppwriteException}
|
|
647
|
+
* @returns {Promise<{}>}
|
|
648
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
649
|
+
*/
|
|
239
650
|
deleteDevKey(projectId: string, keyId: string): Promise<{}>;
|
|
240
651
|
/**
|
|
241
652
|
* Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
|
|
242
653
|
*
|
|
243
|
-
* @param {string} projectId
|
|
244
|
-
* @param {string[]} scopes
|
|
245
|
-
* @param {number} duration
|
|
654
|
+
* @param {string} params.projectId - Project unique ID.
|
|
655
|
+
* @param {string[]} params.scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
|
|
656
|
+
* @param {number} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
246
657
|
* @throws {AppwriteException}
|
|
247
658
|
* @returns {Promise<Models.Jwt>}
|
|
248
659
|
*/
|
|
660
|
+
createJWT(params: {
|
|
661
|
+
projectId: string;
|
|
662
|
+
scopes: string[];
|
|
663
|
+
duration?: number;
|
|
664
|
+
}): Promise<Models.Jwt>;
|
|
665
|
+
/**
|
|
666
|
+
* Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
|
|
667
|
+
*
|
|
668
|
+
* @param {string} projectId - Project unique ID.
|
|
669
|
+
* @param {string[]} scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
|
|
670
|
+
* @param {number} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
671
|
+
* @throws {AppwriteException}
|
|
672
|
+
* @returns {Promise<Models.Jwt>}
|
|
673
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
674
|
+
*/
|
|
249
675
|
createJWT(projectId: string, scopes: string[], duration?: number): Promise<Models.Jwt>;
|
|
250
676
|
/**
|
|
251
677
|
* Get a list of all API keys from the current project.
|
|
252
678
|
*
|
|
253
|
-
* @param {string} projectId
|
|
679
|
+
* @param {string} params.projectId - Project unique ID.
|
|
680
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
681
|
+
* @throws {AppwriteException}
|
|
682
|
+
* @returns {Promise<Models.KeyList>}
|
|
683
|
+
*/
|
|
684
|
+
listKeys(params: {
|
|
685
|
+
projectId: string;
|
|
686
|
+
total?: boolean;
|
|
687
|
+
}): Promise<Models.KeyList>;
|
|
688
|
+
/**
|
|
689
|
+
* Get a list of all API keys from the current project.
|
|
690
|
+
*
|
|
691
|
+
* @param {string} projectId - Project unique ID.
|
|
692
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
254
693
|
* @throws {AppwriteException}
|
|
255
694
|
* @returns {Promise<Models.KeyList>}
|
|
695
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
256
696
|
*/
|
|
257
|
-
listKeys(projectId: string): Promise<Models.KeyList>;
|
|
697
|
+
listKeys(projectId: string, total?: boolean): Promise<Models.KeyList>;
|
|
258
698
|
/**
|
|
259
|
-
* Create a new API key. It
|
|
699
|
+
* Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
260
700
|
*
|
|
261
|
-
* @param {string} projectId
|
|
262
|
-
* @param {string} name
|
|
263
|
-
* @param {string[]} scopes
|
|
264
|
-
* @param {string} expire
|
|
701
|
+
* @param {string} params.projectId - Project unique ID.
|
|
702
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
703
|
+
* @param {string[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
704
|
+
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
265
705
|
* @throws {AppwriteException}
|
|
266
706
|
* @returns {Promise<Models.Key>}
|
|
267
707
|
*/
|
|
268
|
-
createKey(
|
|
708
|
+
createKey(params: {
|
|
709
|
+
projectId: string;
|
|
710
|
+
name: string;
|
|
711
|
+
scopes?: string[];
|
|
712
|
+
expire?: string;
|
|
713
|
+
}): Promise<Models.Key>;
|
|
269
714
|
/**
|
|
270
|
-
*
|
|
715
|
+
* Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
271
716
|
*
|
|
272
|
-
* @param {string} projectId
|
|
273
|
-
* @param {string}
|
|
717
|
+
* @param {string} projectId - Project unique ID.
|
|
718
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
719
|
+
* @param {string[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
720
|
+
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
274
721
|
* @throws {AppwriteException}
|
|
275
722
|
* @returns {Promise<Models.Key>}
|
|
723
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
724
|
+
*/
|
|
725
|
+
createKey(projectId: string, name: string, scopes?: string[], expire?: string): Promise<Models.Key>;
|
|
726
|
+
/**
|
|
727
|
+
* Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.
|
|
728
|
+
*
|
|
729
|
+
* @param {string} params.projectId - Project unique ID.
|
|
730
|
+
* @param {string} params.keyId - Key unique ID.
|
|
731
|
+
* @throws {AppwriteException}
|
|
732
|
+
* @returns {Promise<Models.Key>}
|
|
733
|
+
*/
|
|
734
|
+
getKey(params: {
|
|
735
|
+
projectId: string;
|
|
736
|
+
keyId: string;
|
|
737
|
+
}): Promise<Models.Key>;
|
|
738
|
+
/**
|
|
739
|
+
* Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.
|
|
740
|
+
*
|
|
741
|
+
* @param {string} projectId - Project unique ID.
|
|
742
|
+
* @param {string} keyId - Key unique ID.
|
|
743
|
+
* @throws {AppwriteException}
|
|
744
|
+
* @returns {Promise<Models.Key>}
|
|
745
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
276
746
|
*/
|
|
277
747
|
getKey(projectId: string, keyId: string): Promise<Models.Key>;
|
|
278
748
|
/**
|
|
279
749
|
* Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
|
|
280
750
|
*
|
|
281
|
-
* @param {string} projectId
|
|
282
|
-
* @param {string} keyId
|
|
283
|
-
* @param {string} name
|
|
284
|
-
* @param {string[]} scopes
|
|
285
|
-
* @param {string} expire
|
|
751
|
+
* @param {string} params.projectId - Project unique ID.
|
|
752
|
+
* @param {string} params.keyId - Key unique ID.
|
|
753
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
754
|
+
* @param {string[]} params.scopes - Key scopes list. Maximum of 100 events are allowed.
|
|
755
|
+
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
756
|
+
* @throws {AppwriteException}
|
|
757
|
+
* @returns {Promise<Models.Key>}
|
|
758
|
+
*/
|
|
759
|
+
updateKey(params: {
|
|
760
|
+
projectId: string;
|
|
761
|
+
keyId: string;
|
|
762
|
+
name: string;
|
|
763
|
+
scopes?: string[];
|
|
764
|
+
expire?: string;
|
|
765
|
+
}): Promise<Models.Key>;
|
|
766
|
+
/**
|
|
767
|
+
* Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
|
|
768
|
+
*
|
|
769
|
+
* @param {string} projectId - Project unique ID.
|
|
770
|
+
* @param {string} keyId - Key unique ID.
|
|
771
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
772
|
+
* @param {string[]} scopes - Key scopes list. Maximum of 100 events are allowed.
|
|
773
|
+
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
286
774
|
* @throws {AppwriteException}
|
|
287
775
|
* @returns {Promise<Models.Key>}
|
|
776
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
777
|
+
*/
|
|
778
|
+
updateKey(projectId: string, keyId: string, name: string, scopes?: string[], expire?: string): Promise<Models.Key>;
|
|
779
|
+
/**
|
|
780
|
+
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
781
|
+
*
|
|
782
|
+
* @param {string} params.projectId - Project unique ID.
|
|
783
|
+
* @param {string} params.keyId - Key unique ID.
|
|
784
|
+
* @throws {AppwriteException}
|
|
785
|
+
* @returns {Promise<{}>}
|
|
288
786
|
*/
|
|
289
|
-
|
|
787
|
+
deleteKey(params: {
|
|
788
|
+
projectId: string;
|
|
789
|
+
keyId: string;
|
|
790
|
+
}): Promise<{}>;
|
|
290
791
|
/**
|
|
291
792
|
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
292
793
|
*
|
|
293
|
-
* @param {string} projectId
|
|
294
|
-
* @param {string} keyId
|
|
794
|
+
* @param {string} projectId - Project unique ID.
|
|
795
|
+
* @param {string} keyId - Key unique ID.
|
|
295
796
|
* @throws {AppwriteException}
|
|
296
797
|
* @returns {Promise<{}>}
|
|
798
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
297
799
|
*/
|
|
298
800
|
deleteKey(projectId: string, keyId: string): Promise<{}>;
|
|
299
801
|
/**
|
|
300
802
|
* Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers.
|
|
301
803
|
*
|
|
302
|
-
* @param {string} projectId
|
|
303
|
-
* @param {OAuthProvider} provider
|
|
304
|
-
* @param {string} appId
|
|
305
|
-
* @param {string} secret
|
|
306
|
-
* @param {boolean} enabled
|
|
804
|
+
* @param {string} params.projectId - Project unique ID.
|
|
805
|
+
* @param {OAuthProvider} params.provider - Provider Name
|
|
806
|
+
* @param {string} params.appId - Provider app ID. Max length: 256 chars.
|
|
807
|
+
* @param {string} params.secret - Provider secret key. Max length: 512 chars.
|
|
808
|
+
* @param {boolean} params.enabled - Provider status. Set to 'false' to disable new session creation.
|
|
809
|
+
* @throws {AppwriteException}
|
|
810
|
+
* @returns {Promise<Models.Project>}
|
|
811
|
+
*/
|
|
812
|
+
updateOAuth2(params: {
|
|
813
|
+
projectId: string;
|
|
814
|
+
provider: OAuthProvider;
|
|
815
|
+
appId?: string;
|
|
816
|
+
secret?: string;
|
|
817
|
+
enabled?: boolean;
|
|
818
|
+
}): Promise<Models.Project>;
|
|
819
|
+
/**
|
|
820
|
+
* Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers.
|
|
821
|
+
*
|
|
822
|
+
* @param {string} projectId - Project unique ID.
|
|
823
|
+
* @param {OAuthProvider} provider - Provider Name
|
|
824
|
+
* @param {string} appId - Provider app ID. Max length: 256 chars.
|
|
825
|
+
* @param {string} secret - Provider secret key. Max length: 512 chars.
|
|
826
|
+
* @param {boolean} enabled - Provider status. Set to 'false' to disable new session creation.
|
|
307
827
|
* @throws {AppwriteException}
|
|
308
828
|
* @returns {Promise<Models.Project>}
|
|
829
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
309
830
|
*/
|
|
310
831
|
updateOAuth2(projectId: string, provider: OAuthProvider, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
|
|
311
832
|
/**
|
|
312
833
|
* Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
|
313
834
|
*
|
|
314
|
-
* @param {string} projectId
|
|
835
|
+
* @param {string} params.projectId - Project unique ID.
|
|
836
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
315
837
|
* @throws {AppwriteException}
|
|
316
838
|
* @returns {Promise<Models.PlatformList>}
|
|
317
839
|
*/
|
|
318
|
-
listPlatforms(
|
|
840
|
+
listPlatforms(params: {
|
|
841
|
+
projectId: string;
|
|
842
|
+
total?: boolean;
|
|
843
|
+
}): Promise<Models.PlatformList>;
|
|
844
|
+
/**
|
|
845
|
+
* Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
|
846
|
+
*
|
|
847
|
+
* @param {string} projectId - Project unique ID.
|
|
848
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
849
|
+
* @throws {AppwriteException}
|
|
850
|
+
* @returns {Promise<Models.PlatformList>}
|
|
851
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
852
|
+
*/
|
|
853
|
+
listPlatforms(projectId: string, total?: boolean): Promise<Models.PlatformList>;
|
|
319
854
|
/**
|
|
320
855
|
* Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
|
|
321
856
|
*
|
|
322
|
-
* @param {string} projectId
|
|
323
|
-
* @param {PlatformType} type
|
|
324
|
-
* @param {string} name
|
|
325
|
-
* @param {string} key
|
|
326
|
-
* @param {string} store
|
|
327
|
-
* @param {string} hostname
|
|
857
|
+
* @param {string} params.projectId - Project unique ID.
|
|
858
|
+
* @param {PlatformType} params.type - Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.
|
|
859
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
860
|
+
* @param {string} params.key - Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.
|
|
861
|
+
* @param {string} params.store - App store or Google Play store ID. Max length: 256 chars.
|
|
862
|
+
* @param {string} params.hostname - Platform client hostname. Max length: 256 chars.
|
|
328
863
|
* @throws {AppwriteException}
|
|
329
864
|
* @returns {Promise<Models.Platform>}
|
|
330
865
|
*/
|
|
866
|
+
createPlatform(params: {
|
|
867
|
+
projectId: string;
|
|
868
|
+
type: PlatformType;
|
|
869
|
+
name: string;
|
|
870
|
+
key?: string;
|
|
871
|
+
store?: string;
|
|
872
|
+
hostname?: string;
|
|
873
|
+
}): Promise<Models.Platform>;
|
|
874
|
+
/**
|
|
875
|
+
* Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
|
|
876
|
+
*
|
|
877
|
+
* @param {string} projectId - Project unique ID.
|
|
878
|
+
* @param {PlatformType} type - Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.
|
|
879
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
880
|
+
* @param {string} key - Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.
|
|
881
|
+
* @param {string} store - App store or Google Play store ID. Max length: 256 chars.
|
|
882
|
+
* @param {string} hostname - Platform client hostname. Max length: 256 chars.
|
|
883
|
+
* @throws {AppwriteException}
|
|
884
|
+
* @returns {Promise<Models.Platform>}
|
|
885
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
886
|
+
*/
|
|
331
887
|
createPlatform(projectId: string, type: PlatformType, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
|
|
332
888
|
/**
|
|
333
|
-
* Get a platform by its unique ID. This endpoint returns the platform
|
|
889
|
+
* Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.
|
|
890
|
+
*
|
|
891
|
+
* @param {string} params.projectId - Project unique ID.
|
|
892
|
+
* @param {string} params.platformId - Platform unique ID.
|
|
893
|
+
* @throws {AppwriteException}
|
|
894
|
+
* @returns {Promise<Models.Platform>}
|
|
895
|
+
*/
|
|
896
|
+
getPlatform(params: {
|
|
897
|
+
projectId: string;
|
|
898
|
+
platformId: string;
|
|
899
|
+
}): Promise<Models.Platform>;
|
|
900
|
+
/**
|
|
901
|
+
* Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.
|
|
334
902
|
*
|
|
335
|
-
* @param {string} projectId
|
|
336
|
-
* @param {string} platformId
|
|
903
|
+
* @param {string} projectId - Project unique ID.
|
|
904
|
+
* @param {string} platformId - Platform unique ID.
|
|
337
905
|
* @throws {AppwriteException}
|
|
338
906
|
* @returns {Promise<Models.Platform>}
|
|
907
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
339
908
|
*/
|
|
340
909
|
getPlatform(projectId: string, platformId: string): Promise<Models.Platform>;
|
|
341
910
|
/**
|
|
342
|
-
* Update a platform by its unique ID. Use this endpoint to update the platform
|
|
911
|
+
* Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname.
|
|
912
|
+
*
|
|
913
|
+
* @param {string} params.projectId - Project unique ID.
|
|
914
|
+
* @param {string} params.platformId - Platform unique ID.
|
|
915
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
916
|
+
* @param {string} params.key - Package name for android or bundle ID for iOS. Max length: 256 chars.
|
|
917
|
+
* @param {string} params.store - App store or Google Play store ID. Max length: 256 chars.
|
|
918
|
+
* @param {string} params.hostname - Platform client URL. Max length: 256 chars.
|
|
919
|
+
* @throws {AppwriteException}
|
|
920
|
+
* @returns {Promise<Models.Platform>}
|
|
921
|
+
*/
|
|
922
|
+
updatePlatform(params: {
|
|
923
|
+
projectId: string;
|
|
924
|
+
platformId: string;
|
|
925
|
+
name: string;
|
|
926
|
+
key?: string;
|
|
927
|
+
store?: string;
|
|
928
|
+
hostname?: string;
|
|
929
|
+
}): Promise<Models.Platform>;
|
|
930
|
+
/**
|
|
931
|
+
* Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname.
|
|
343
932
|
*
|
|
344
|
-
* @param {string} projectId
|
|
345
|
-
* @param {string} platformId
|
|
346
|
-
* @param {string} name
|
|
347
|
-
* @param {string} key
|
|
348
|
-
* @param {string} store
|
|
349
|
-
* @param {string} hostname
|
|
933
|
+
* @param {string} projectId - Project unique ID.
|
|
934
|
+
* @param {string} platformId - Platform unique ID.
|
|
935
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
936
|
+
* @param {string} key - Package name for android or bundle ID for iOS. Max length: 256 chars.
|
|
937
|
+
* @param {string} store - App store or Google Play store ID. Max length: 256 chars.
|
|
938
|
+
* @param {string} hostname - Platform client URL. Max length: 256 chars.
|
|
350
939
|
* @throws {AppwriteException}
|
|
351
940
|
* @returns {Promise<Models.Platform>}
|
|
941
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
352
942
|
*/
|
|
353
943
|
updatePlatform(projectId: string, platformId: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
|
|
354
944
|
/**
|
|
355
945
|
* Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
|
|
356
946
|
*
|
|
357
|
-
* @param {string} projectId
|
|
358
|
-
* @param {string} platformId
|
|
947
|
+
* @param {string} params.projectId - Project unique ID.
|
|
948
|
+
* @param {string} params.platformId - Platform unique ID.
|
|
359
949
|
* @throws {AppwriteException}
|
|
360
950
|
* @returns {Promise<{}>}
|
|
361
951
|
*/
|
|
952
|
+
deletePlatform(params: {
|
|
953
|
+
projectId: string;
|
|
954
|
+
platformId: string;
|
|
955
|
+
}): Promise<{}>;
|
|
956
|
+
/**
|
|
957
|
+
* Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
|
|
958
|
+
*
|
|
959
|
+
* @param {string} projectId - Project unique ID.
|
|
960
|
+
* @param {string} platformId - Platform unique ID.
|
|
961
|
+
* @throws {AppwriteException}
|
|
962
|
+
* @returns {Promise<{}>}
|
|
963
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
964
|
+
*/
|
|
362
965
|
deletePlatform(projectId: string, platformId: string): Promise<{}>;
|
|
363
966
|
/**
|
|
364
967
|
* Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
|
|
365
968
|
*
|
|
366
|
-
* @param {string} projectId
|
|
367
|
-
* @param {ApiService} service
|
|
368
|
-
* @param {boolean} status
|
|
969
|
+
* @param {string} params.projectId - Project unique ID.
|
|
970
|
+
* @param {ApiService} params.service - Service name.
|
|
971
|
+
* @param {boolean} params.status - Service status.
|
|
369
972
|
* @throws {AppwriteException}
|
|
370
973
|
* @returns {Promise<Models.Project>}
|
|
371
974
|
*/
|
|
975
|
+
updateServiceStatus(params: {
|
|
976
|
+
projectId: string;
|
|
977
|
+
service: ApiService;
|
|
978
|
+
status: boolean;
|
|
979
|
+
}): Promise<Models.Project>;
|
|
980
|
+
/**
|
|
981
|
+
* Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
|
|
982
|
+
*
|
|
983
|
+
* @param {string} projectId - Project unique ID.
|
|
984
|
+
* @param {ApiService} service - Service name.
|
|
985
|
+
* @param {boolean} status - Service status.
|
|
986
|
+
* @throws {AppwriteException}
|
|
987
|
+
* @returns {Promise<Models.Project>}
|
|
988
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
989
|
+
*/
|
|
372
990
|
updateServiceStatus(projectId: string, service: ApiService, status: boolean): Promise<Models.Project>;
|
|
373
991
|
/**
|
|
374
992
|
* Update the status of all services. Use this endpoint to enable or disable all optional services at once.
|
|
375
993
|
*
|
|
376
|
-
* @param {string} projectId
|
|
377
|
-
* @param {boolean} status
|
|
994
|
+
* @param {string} params.projectId - Project unique ID.
|
|
995
|
+
* @param {boolean} params.status - Service status.
|
|
378
996
|
* @throws {AppwriteException}
|
|
379
997
|
* @returns {Promise<Models.Project>}
|
|
380
998
|
*/
|
|
999
|
+
updateServiceStatusAll(params: {
|
|
1000
|
+
projectId: string;
|
|
1001
|
+
status: boolean;
|
|
1002
|
+
}): Promise<Models.Project>;
|
|
1003
|
+
/**
|
|
1004
|
+
* Update the status of all services. Use this endpoint to enable or disable all optional services at once.
|
|
1005
|
+
*
|
|
1006
|
+
* @param {string} projectId - Project unique ID.
|
|
1007
|
+
* @param {boolean} status - Service status.
|
|
1008
|
+
* @throws {AppwriteException}
|
|
1009
|
+
* @returns {Promise<Models.Project>}
|
|
1010
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1011
|
+
*/
|
|
381
1012
|
updateServiceStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
|
|
382
1013
|
/**
|
|
383
|
-
* Update the SMTP configuration for your project. Use this endpoint to configure your project
|
|
1014
|
+
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
1015
|
+
*
|
|
1016
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1017
|
+
* @param {boolean} params.enabled - Enable custom SMTP service
|
|
1018
|
+
* @param {string} params.senderName - Name of the email sender
|
|
1019
|
+
* @param {string} params.senderEmail - Email of the sender
|
|
1020
|
+
* @param {string} params.replyTo - Reply to email
|
|
1021
|
+
* @param {string} params.host - SMTP server host name
|
|
1022
|
+
* @param {number} params.port - SMTP server port
|
|
1023
|
+
* @param {string} params.username - SMTP server username
|
|
1024
|
+
* @param {string} params.password - SMTP server password
|
|
1025
|
+
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
1026
|
+
* @throws {AppwriteException}
|
|
1027
|
+
* @returns {Promise<Models.Project>}
|
|
1028
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateSMTP` instead.
|
|
1029
|
+
*/
|
|
1030
|
+
updateSmtp(params: {
|
|
1031
|
+
projectId: string;
|
|
1032
|
+
enabled: boolean;
|
|
1033
|
+
senderName?: string;
|
|
1034
|
+
senderEmail?: string;
|
|
1035
|
+
replyTo?: string;
|
|
1036
|
+
host?: string;
|
|
1037
|
+
port?: number;
|
|
1038
|
+
username?: string;
|
|
1039
|
+
password?: string;
|
|
1040
|
+
secure?: SMTPSecure;
|
|
1041
|
+
}): Promise<Models.Project>;
|
|
1042
|
+
/**
|
|
1043
|
+
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
384
1044
|
*
|
|
385
|
-
* @param {string} projectId
|
|
386
|
-
* @param {boolean} enabled
|
|
387
|
-
* @param {string} senderName
|
|
388
|
-
* @param {string} senderEmail
|
|
389
|
-
* @param {string} replyTo
|
|
390
|
-
* @param {string} host
|
|
391
|
-
* @param {number} port
|
|
392
|
-
* @param {string} username
|
|
393
|
-
* @param {string} password
|
|
394
|
-
* @param {SMTPSecure} secure
|
|
1045
|
+
* @param {string} projectId - Project unique ID.
|
|
1046
|
+
* @param {boolean} enabled - Enable custom SMTP service
|
|
1047
|
+
* @param {string} senderName - Name of the email sender
|
|
1048
|
+
* @param {string} senderEmail - Email of the sender
|
|
1049
|
+
* @param {string} replyTo - Reply to email
|
|
1050
|
+
* @param {string} host - SMTP server host name
|
|
1051
|
+
* @param {number} port - SMTP server port
|
|
1052
|
+
* @param {string} username - SMTP server username
|
|
1053
|
+
* @param {string} password - SMTP server password
|
|
1054
|
+
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
395
1055
|
* @throws {AppwriteException}
|
|
396
1056
|
* @returns {Promise<Models.Project>}
|
|
1057
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
397
1058
|
*/
|
|
398
1059
|
updateSmtp(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
|
|
1060
|
+
/**
|
|
1061
|
+
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
1062
|
+
*
|
|
1063
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1064
|
+
* @param {boolean} params.enabled - Enable custom SMTP service
|
|
1065
|
+
* @param {string} params.senderName - Name of the email sender
|
|
1066
|
+
* @param {string} params.senderEmail - Email of the sender
|
|
1067
|
+
* @param {string} params.replyTo - Reply to email
|
|
1068
|
+
* @param {string} params.host - SMTP server host name
|
|
1069
|
+
* @param {number} params.port - SMTP server port
|
|
1070
|
+
* @param {string} params.username - SMTP server username
|
|
1071
|
+
* @param {string} params.password - SMTP server password
|
|
1072
|
+
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
1073
|
+
* @throws {AppwriteException}
|
|
1074
|
+
* @returns {Promise<Models.Project>}
|
|
1075
|
+
*/
|
|
1076
|
+
updateSMTP(params: {
|
|
1077
|
+
projectId: string;
|
|
1078
|
+
enabled: boolean;
|
|
1079
|
+
senderName?: string;
|
|
1080
|
+
senderEmail?: string;
|
|
1081
|
+
replyTo?: string;
|
|
1082
|
+
host?: string;
|
|
1083
|
+
port?: number;
|
|
1084
|
+
username?: string;
|
|
1085
|
+
password?: string;
|
|
1086
|
+
secure?: SMTPSecure;
|
|
1087
|
+
}): Promise<Models.Project>;
|
|
1088
|
+
/**
|
|
1089
|
+
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
1090
|
+
*
|
|
1091
|
+
* @param {string} projectId - Project unique ID.
|
|
1092
|
+
* @param {boolean} enabled - Enable custom SMTP service
|
|
1093
|
+
* @param {string} senderName - Name of the email sender
|
|
1094
|
+
* @param {string} senderEmail - Email of the sender
|
|
1095
|
+
* @param {string} replyTo - Reply to email
|
|
1096
|
+
* @param {string} host - SMTP server host name
|
|
1097
|
+
* @param {number} port - SMTP server port
|
|
1098
|
+
* @param {string} username - SMTP server username
|
|
1099
|
+
* @param {string} password - SMTP server password
|
|
1100
|
+
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
1101
|
+
* @throws {AppwriteException}
|
|
1102
|
+
* @returns {Promise<Models.Project>}
|
|
1103
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1104
|
+
*/
|
|
1105
|
+
updateSMTP(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
|
|
399
1106
|
/**
|
|
400
1107
|
* Send a test email to verify SMTP configuration.
|
|
401
1108
|
*
|
|
402
|
-
* @param {string} projectId
|
|
403
|
-
* @param {string[]} emails
|
|
404
|
-
* @param {string} senderName
|
|
405
|
-
* @param {string} senderEmail
|
|
406
|
-
* @param {string} host
|
|
407
|
-
* @param {string} replyTo
|
|
408
|
-
* @param {number} port
|
|
409
|
-
* @param {string} username
|
|
410
|
-
* @param {string} password
|
|
411
|
-
* @param {SMTPSecure} secure
|
|
1109
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1110
|
+
* @param {string[]} params.emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
|
|
1111
|
+
* @param {string} params.senderName - Name of the email sender
|
|
1112
|
+
* @param {string} params.senderEmail - Email of the sender
|
|
1113
|
+
* @param {string} params.host - SMTP server host name
|
|
1114
|
+
* @param {string} params.replyTo - Reply to email
|
|
1115
|
+
* @param {number} params.port - SMTP server port
|
|
1116
|
+
* @param {string} params.username - SMTP server username
|
|
1117
|
+
* @param {string} params.password - SMTP server password
|
|
1118
|
+
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
412
1119
|
* @throws {AppwriteException}
|
|
413
1120
|
* @returns {Promise<{}>}
|
|
1121
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.createSMTPTest` instead.
|
|
1122
|
+
*/
|
|
1123
|
+
createSmtpTest(params: {
|
|
1124
|
+
projectId: string;
|
|
1125
|
+
emails: string[];
|
|
1126
|
+
senderName: string;
|
|
1127
|
+
senderEmail: string;
|
|
1128
|
+
host: string;
|
|
1129
|
+
replyTo?: string;
|
|
1130
|
+
port?: number;
|
|
1131
|
+
username?: string;
|
|
1132
|
+
password?: string;
|
|
1133
|
+
secure?: SMTPSecure;
|
|
1134
|
+
}): Promise<{}>;
|
|
1135
|
+
/**
|
|
1136
|
+
* Send a test email to verify SMTP configuration.
|
|
1137
|
+
*
|
|
1138
|
+
* @param {string} projectId - Project unique ID.
|
|
1139
|
+
* @param {string[]} emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
|
|
1140
|
+
* @param {string} senderName - Name of the email sender
|
|
1141
|
+
* @param {string} senderEmail - Email of the sender
|
|
1142
|
+
* @param {string} host - SMTP server host name
|
|
1143
|
+
* @param {string} replyTo - Reply to email
|
|
1144
|
+
* @param {number} port - SMTP server port
|
|
1145
|
+
* @param {string} username - SMTP server username
|
|
1146
|
+
* @param {string} password - SMTP server password
|
|
1147
|
+
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
1148
|
+
* @throws {AppwriteException}
|
|
1149
|
+
* @returns {Promise<{}>}
|
|
1150
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
414
1151
|
*/
|
|
415
1152
|
createSmtpTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
|
|
1153
|
+
/**
|
|
1154
|
+
* Send a test email to verify SMTP configuration.
|
|
1155
|
+
*
|
|
1156
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1157
|
+
* @param {string[]} params.emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
|
|
1158
|
+
* @param {string} params.senderName - Name of the email sender
|
|
1159
|
+
* @param {string} params.senderEmail - Email of the sender
|
|
1160
|
+
* @param {string} params.host - SMTP server host name
|
|
1161
|
+
* @param {string} params.replyTo - Reply to email
|
|
1162
|
+
* @param {number} params.port - SMTP server port
|
|
1163
|
+
* @param {string} params.username - SMTP server username
|
|
1164
|
+
* @param {string} params.password - SMTP server password
|
|
1165
|
+
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
1166
|
+
* @throws {AppwriteException}
|
|
1167
|
+
* @returns {Promise<{}>}
|
|
1168
|
+
*/
|
|
1169
|
+
createSMTPTest(params: {
|
|
1170
|
+
projectId: string;
|
|
1171
|
+
emails: string[];
|
|
1172
|
+
senderName: string;
|
|
1173
|
+
senderEmail: string;
|
|
1174
|
+
host: string;
|
|
1175
|
+
replyTo?: string;
|
|
1176
|
+
port?: number;
|
|
1177
|
+
username?: string;
|
|
1178
|
+
password?: string;
|
|
1179
|
+
secure?: SMTPSecure;
|
|
1180
|
+
}): Promise<{}>;
|
|
1181
|
+
/**
|
|
1182
|
+
* Send a test email to verify SMTP configuration.
|
|
1183
|
+
*
|
|
1184
|
+
* @param {string} projectId - Project unique ID.
|
|
1185
|
+
* @param {string[]} emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
|
|
1186
|
+
* @param {string} senderName - Name of the email sender
|
|
1187
|
+
* @param {string} senderEmail - Email of the sender
|
|
1188
|
+
* @param {string} host - SMTP server host name
|
|
1189
|
+
* @param {string} replyTo - Reply to email
|
|
1190
|
+
* @param {number} port - SMTP server port
|
|
1191
|
+
* @param {string} username - SMTP server username
|
|
1192
|
+
* @param {string} password - SMTP server password
|
|
1193
|
+
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
1194
|
+
* @throws {AppwriteException}
|
|
1195
|
+
* @returns {Promise<{}>}
|
|
1196
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1197
|
+
*/
|
|
1198
|
+
createSMTPTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
|
|
1199
|
+
/**
|
|
1200
|
+
* Update the status of a project
|
|
1201
|
+
*
|
|
1202
|
+
* @param {string} params.projectId - Project ID
|
|
1203
|
+
* @param {Status} params.status - New status for the project
|
|
1204
|
+
* @throws {AppwriteException}
|
|
1205
|
+
* @returns {Promise<{}>}
|
|
1206
|
+
*/
|
|
1207
|
+
updateStatus(params: {
|
|
1208
|
+
projectId: string;
|
|
1209
|
+
status: Status;
|
|
1210
|
+
}): Promise<{}>;
|
|
1211
|
+
/**
|
|
1212
|
+
* Update the status of a project
|
|
1213
|
+
*
|
|
1214
|
+
* @param {string} projectId - Project ID
|
|
1215
|
+
* @param {Status} status - New status for the project
|
|
1216
|
+
* @throws {AppwriteException}
|
|
1217
|
+
* @returns {Promise<{}>}
|
|
1218
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1219
|
+
*/
|
|
1220
|
+
updateStatus(projectId: string, status: Status): Promise<{}>;
|
|
1221
|
+
/**
|
|
1222
|
+
* Update the team ID of a project allowing for it to be transferred to another team.
|
|
1223
|
+
*
|
|
1224
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1225
|
+
* @param {string} params.teamId - Team ID of the team to transfer project to.
|
|
1226
|
+
* @throws {AppwriteException}
|
|
1227
|
+
* @returns {Promise<Models.Project>}
|
|
1228
|
+
*/
|
|
1229
|
+
updateTeam(params: {
|
|
1230
|
+
projectId: string;
|
|
1231
|
+
teamId: string;
|
|
1232
|
+
}): Promise<Models.Project>;
|
|
416
1233
|
/**
|
|
417
1234
|
* Update the team ID of a project allowing for it to be transferred to another team.
|
|
418
1235
|
*
|
|
419
|
-
* @param {string} projectId
|
|
420
|
-
* @param {string} teamId
|
|
1236
|
+
* @param {string} projectId - Project unique ID.
|
|
1237
|
+
* @param {string} teamId - Team ID of the team to transfer project to.
|
|
421
1238
|
* @throws {AppwriteException}
|
|
422
1239
|
* @returns {Promise<Models.Project>}
|
|
1240
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
423
1241
|
*/
|
|
424
1242
|
updateTeam(projectId: string, teamId: string): Promise<Models.Project>;
|
|
425
1243
|
/**
|
|
426
1244
|
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
427
1245
|
*
|
|
428
|
-
* @param {string} projectId
|
|
429
|
-
* @param {EmailTemplateType} type
|
|
430
|
-
* @param {EmailTemplateLocale} locale
|
|
1246
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1247
|
+
* @param {EmailTemplateType} params.type - Template type
|
|
1248
|
+
* @param {EmailTemplateLocale} params.locale - Template locale
|
|
1249
|
+
* @throws {AppwriteException}
|
|
1250
|
+
* @returns {Promise<Models.EmailTemplate>}
|
|
1251
|
+
*/
|
|
1252
|
+
getEmailTemplate(params: {
|
|
1253
|
+
projectId: string;
|
|
1254
|
+
type: EmailTemplateType;
|
|
1255
|
+
locale: EmailTemplateLocale;
|
|
1256
|
+
}): Promise<Models.EmailTemplate>;
|
|
1257
|
+
/**
|
|
1258
|
+
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
1259
|
+
*
|
|
1260
|
+
* @param {string} projectId - Project unique ID.
|
|
1261
|
+
* @param {EmailTemplateType} type - Template type
|
|
1262
|
+
* @param {EmailTemplateLocale} locale - Template locale
|
|
431
1263
|
* @throws {AppwriteException}
|
|
432
1264
|
* @returns {Promise<Models.EmailTemplate>}
|
|
1265
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
433
1266
|
*/
|
|
434
1267
|
getEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
|
|
435
1268
|
/**
|
|
436
1269
|
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
437
1270
|
*
|
|
438
|
-
* @param {string} projectId
|
|
439
|
-
* @param {EmailTemplateType} type
|
|
440
|
-
* @param {EmailTemplateLocale} locale
|
|
441
|
-
* @param {string} subject
|
|
442
|
-
* @param {string} message
|
|
443
|
-
* @param {string} senderName
|
|
444
|
-
* @param {string} senderEmail
|
|
445
|
-
* @param {string} replyTo
|
|
1271
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1272
|
+
* @param {EmailTemplateType} params.type - Template type
|
|
1273
|
+
* @param {EmailTemplateLocale} params.locale - Template locale
|
|
1274
|
+
* @param {string} params.subject - Email Subject
|
|
1275
|
+
* @param {string} params.message - Template message
|
|
1276
|
+
* @param {string} params.senderName - Name of the email sender
|
|
1277
|
+
* @param {string} params.senderEmail - Email of the sender
|
|
1278
|
+
* @param {string} params.replyTo - Reply to email
|
|
446
1279
|
* @throws {AppwriteException}
|
|
447
1280
|
* @returns {Promise<Models.EmailTemplate>}
|
|
448
1281
|
*/
|
|
1282
|
+
updateEmailTemplate(params: {
|
|
1283
|
+
projectId: string;
|
|
1284
|
+
type: EmailTemplateType;
|
|
1285
|
+
locale: EmailTemplateLocale;
|
|
1286
|
+
subject: string;
|
|
1287
|
+
message: string;
|
|
1288
|
+
senderName?: string;
|
|
1289
|
+
senderEmail?: string;
|
|
1290
|
+
replyTo?: string;
|
|
1291
|
+
}): Promise<Models.EmailTemplate>;
|
|
1292
|
+
/**
|
|
1293
|
+
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
1294
|
+
*
|
|
1295
|
+
* @param {string} projectId - Project unique ID.
|
|
1296
|
+
* @param {EmailTemplateType} type - Template type
|
|
1297
|
+
* @param {EmailTemplateLocale} locale - Template locale
|
|
1298
|
+
* @param {string} subject - Email Subject
|
|
1299
|
+
* @param {string} message - Template message
|
|
1300
|
+
* @param {string} senderName - Name of the email sender
|
|
1301
|
+
* @param {string} senderEmail - Email of the sender
|
|
1302
|
+
* @param {string} replyTo - Reply to email
|
|
1303
|
+
* @throws {AppwriteException}
|
|
1304
|
+
* @returns {Promise<Models.EmailTemplate>}
|
|
1305
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1306
|
+
*/
|
|
449
1307
|
updateEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.EmailTemplate>;
|
|
450
1308
|
/**
|
|
451
1309
|
* Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state.
|
|
452
1310
|
*
|
|
453
|
-
* @param {string} projectId
|
|
454
|
-
* @param {EmailTemplateType} type
|
|
455
|
-
* @param {EmailTemplateLocale} locale
|
|
1311
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1312
|
+
* @param {EmailTemplateType} params.type - Template type
|
|
1313
|
+
* @param {EmailTemplateLocale} params.locale - Template locale
|
|
456
1314
|
* @throws {AppwriteException}
|
|
457
1315
|
* @returns {Promise<Models.EmailTemplate>}
|
|
458
1316
|
*/
|
|
1317
|
+
deleteEmailTemplate(params: {
|
|
1318
|
+
projectId: string;
|
|
1319
|
+
type: EmailTemplateType;
|
|
1320
|
+
locale: EmailTemplateLocale;
|
|
1321
|
+
}): Promise<Models.EmailTemplate>;
|
|
1322
|
+
/**
|
|
1323
|
+
* Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state.
|
|
1324
|
+
*
|
|
1325
|
+
* @param {string} projectId - Project unique ID.
|
|
1326
|
+
* @param {EmailTemplateType} type - Template type
|
|
1327
|
+
* @param {EmailTemplateLocale} locale - Template locale
|
|
1328
|
+
* @throws {AppwriteException}
|
|
1329
|
+
* @returns {Promise<Models.EmailTemplate>}
|
|
1330
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1331
|
+
*/
|
|
459
1332
|
deleteEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
|
|
460
1333
|
/**
|
|
461
|
-
* Get a custom SMS template for the specified locale and type returning it
|
|
1334
|
+
* Get a custom SMS template for the specified locale and type returning it's contents.
|
|
462
1335
|
*
|
|
463
|
-
* @param {string} projectId
|
|
464
|
-
* @param {SmsTemplateType} type
|
|
465
|
-
* @param {SmsTemplateLocale} locale
|
|
1336
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1337
|
+
* @param {SmsTemplateType} params.type - Template type
|
|
1338
|
+
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
466
1339
|
* @throws {AppwriteException}
|
|
467
1340
|
* @returns {Promise<Models.SmsTemplate>}
|
|
1341
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.getSMSTemplate` instead.
|
|
1342
|
+
*/
|
|
1343
|
+
getSmsTemplate(params: {
|
|
1344
|
+
projectId: string;
|
|
1345
|
+
type: SmsTemplateType;
|
|
1346
|
+
locale: SmsTemplateLocale;
|
|
1347
|
+
}): Promise<Models.SmsTemplate>;
|
|
1348
|
+
/**
|
|
1349
|
+
* Get a custom SMS template for the specified locale and type returning it's contents.
|
|
1350
|
+
*
|
|
1351
|
+
* @param {string} projectId - Project unique ID.
|
|
1352
|
+
* @param {SmsTemplateType} type - Template type
|
|
1353
|
+
* @param {SmsTemplateLocale} locale - Template locale
|
|
1354
|
+
* @throws {AppwriteException}
|
|
1355
|
+
* @returns {Promise<Models.SmsTemplate>}
|
|
1356
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
468
1357
|
*/
|
|
469
1358
|
getSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
|
|
1359
|
+
/**
|
|
1360
|
+
* Get a custom SMS template for the specified locale and type returning it's contents.
|
|
1361
|
+
*
|
|
1362
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1363
|
+
* @param {SmsTemplateType} params.type - Template type
|
|
1364
|
+
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
1365
|
+
* @throws {AppwriteException}
|
|
1366
|
+
* @returns {Promise<Models.SmsTemplate>}
|
|
1367
|
+
*/
|
|
1368
|
+
getSMSTemplate(params: {
|
|
1369
|
+
projectId: string;
|
|
1370
|
+
type: SmsTemplateType;
|
|
1371
|
+
locale: SmsTemplateLocale;
|
|
1372
|
+
}): Promise<Models.SmsTemplate>;
|
|
1373
|
+
/**
|
|
1374
|
+
* Get a custom SMS template for the specified locale and type returning it's contents.
|
|
1375
|
+
*
|
|
1376
|
+
* @param {string} projectId - Project unique ID.
|
|
1377
|
+
* @param {SmsTemplateType} type - Template type
|
|
1378
|
+
* @param {SmsTemplateLocale} locale - Template locale
|
|
1379
|
+
* @throws {AppwriteException}
|
|
1380
|
+
* @returns {Promise<Models.SmsTemplate>}
|
|
1381
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1382
|
+
*/
|
|
1383
|
+
getSMSTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
|
|
1384
|
+
/**
|
|
1385
|
+
* Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
|
|
1386
|
+
*
|
|
1387
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1388
|
+
* @param {SmsTemplateType} params.type - Template type
|
|
1389
|
+
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
1390
|
+
* @param {string} params.message - Template message
|
|
1391
|
+
* @throws {AppwriteException}
|
|
1392
|
+
* @returns {Promise<Models.SmsTemplate>}
|
|
1393
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateSMSTemplate` instead.
|
|
1394
|
+
*/
|
|
1395
|
+
updateSmsTemplate(params: {
|
|
1396
|
+
projectId: string;
|
|
1397
|
+
type: SmsTemplateType;
|
|
1398
|
+
locale: SmsTemplateLocale;
|
|
1399
|
+
message: string;
|
|
1400
|
+
}): Promise<Models.SmsTemplate>;
|
|
470
1401
|
/**
|
|
471
1402
|
* Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
|
|
472
1403
|
*
|
|
473
|
-
* @param {string} projectId
|
|
474
|
-
* @param {SmsTemplateType} type
|
|
475
|
-
* @param {SmsTemplateLocale} locale
|
|
476
|
-
* @param {string} message
|
|
1404
|
+
* @param {string} projectId - Project unique ID.
|
|
1405
|
+
* @param {SmsTemplateType} type - Template type
|
|
1406
|
+
* @param {SmsTemplateLocale} locale - Template locale
|
|
1407
|
+
* @param {string} message - Template message
|
|
477
1408
|
* @throws {AppwriteException}
|
|
478
1409
|
* @returns {Promise<Models.SmsTemplate>}
|
|
1410
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
479
1411
|
*/
|
|
480
1412
|
updateSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale, message: string): Promise<Models.SmsTemplate>;
|
|
1413
|
+
/**
|
|
1414
|
+
* Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
|
|
1415
|
+
*
|
|
1416
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1417
|
+
* @param {SmsTemplateType} params.type - Template type
|
|
1418
|
+
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
1419
|
+
* @param {string} params.message - Template message
|
|
1420
|
+
* @throws {AppwriteException}
|
|
1421
|
+
* @returns {Promise<Models.SmsTemplate>}
|
|
1422
|
+
*/
|
|
1423
|
+
updateSMSTemplate(params: {
|
|
1424
|
+
projectId: string;
|
|
1425
|
+
type: SmsTemplateType;
|
|
1426
|
+
locale: SmsTemplateLocale;
|
|
1427
|
+
message: string;
|
|
1428
|
+
}): Promise<Models.SmsTemplate>;
|
|
1429
|
+
/**
|
|
1430
|
+
* Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
|
|
1431
|
+
*
|
|
1432
|
+
* @param {string} projectId - Project unique ID.
|
|
1433
|
+
* @param {SmsTemplateType} type - Template type
|
|
1434
|
+
* @param {SmsTemplateLocale} locale - Template locale
|
|
1435
|
+
* @param {string} message - Template message
|
|
1436
|
+
* @throws {AppwriteException}
|
|
1437
|
+
* @returns {Promise<Models.SmsTemplate>}
|
|
1438
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1439
|
+
*/
|
|
1440
|
+
updateSMSTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale, message: string): Promise<Models.SmsTemplate>;
|
|
1441
|
+
/**
|
|
1442
|
+
* Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
|
|
1443
|
+
*
|
|
1444
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1445
|
+
* @param {SmsTemplateType} params.type - Template type
|
|
1446
|
+
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
1447
|
+
* @throws {AppwriteException}
|
|
1448
|
+
* @returns {Promise<Models.SmsTemplate>}
|
|
1449
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.deleteSMSTemplate` instead.
|
|
1450
|
+
*/
|
|
1451
|
+
deleteSmsTemplate(params: {
|
|
1452
|
+
projectId: string;
|
|
1453
|
+
type: SmsTemplateType;
|
|
1454
|
+
locale: SmsTemplateLocale;
|
|
1455
|
+
}): Promise<Models.SmsTemplate>;
|
|
481
1456
|
/**
|
|
482
1457
|
* Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
|
|
483
1458
|
*
|
|
484
|
-
* @param {string} projectId
|
|
485
|
-
* @param {SmsTemplateType} type
|
|
486
|
-
* @param {SmsTemplateLocale} locale
|
|
1459
|
+
* @param {string} projectId - Project unique ID.
|
|
1460
|
+
* @param {SmsTemplateType} type - Template type
|
|
1461
|
+
* @param {SmsTemplateLocale} locale - Template locale
|
|
487
1462
|
* @throws {AppwriteException}
|
|
488
1463
|
* @returns {Promise<Models.SmsTemplate>}
|
|
1464
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
489
1465
|
*/
|
|
490
1466
|
deleteSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
|
|
1467
|
+
/**
|
|
1468
|
+
* Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
|
|
1469
|
+
*
|
|
1470
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1471
|
+
* @param {SmsTemplateType} params.type - Template type
|
|
1472
|
+
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
1473
|
+
* @throws {AppwriteException}
|
|
1474
|
+
* @returns {Promise<Models.SmsTemplate>}
|
|
1475
|
+
*/
|
|
1476
|
+
deleteSMSTemplate(params: {
|
|
1477
|
+
projectId: string;
|
|
1478
|
+
type: SmsTemplateType;
|
|
1479
|
+
locale: SmsTemplateLocale;
|
|
1480
|
+
}): Promise<Models.SmsTemplate>;
|
|
1481
|
+
/**
|
|
1482
|
+
* Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
|
|
1483
|
+
*
|
|
1484
|
+
* @param {string} projectId - Project unique ID.
|
|
1485
|
+
* @param {SmsTemplateType} type - Template type
|
|
1486
|
+
* @param {SmsTemplateLocale} locale - Template locale
|
|
1487
|
+
* @throws {AppwriteException}
|
|
1488
|
+
* @returns {Promise<Models.SmsTemplate>}
|
|
1489
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1490
|
+
*/
|
|
1491
|
+
deleteSMSTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
|
|
491
1492
|
/**
|
|
492
1493
|
* Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
|
|
493
1494
|
*
|
|
494
|
-
* @param {string} projectId
|
|
1495
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1496
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
495
1497
|
* @throws {AppwriteException}
|
|
496
1498
|
* @returns {Promise<Models.WebhookList>}
|
|
497
1499
|
*/
|
|
498
|
-
listWebhooks(
|
|
1500
|
+
listWebhooks(params: {
|
|
1501
|
+
projectId: string;
|
|
1502
|
+
total?: boolean;
|
|
1503
|
+
}): Promise<Models.WebhookList>;
|
|
1504
|
+
/**
|
|
1505
|
+
* Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
|
|
1506
|
+
*
|
|
1507
|
+
* @param {string} projectId - Project unique ID.
|
|
1508
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1509
|
+
* @throws {AppwriteException}
|
|
1510
|
+
* @returns {Promise<Models.WebhookList>}
|
|
1511
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1512
|
+
*/
|
|
1513
|
+
listWebhooks(projectId: string, total?: boolean): Promise<Models.WebhookList>;
|
|
1514
|
+
/**
|
|
1515
|
+
* Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
|
|
1516
|
+
*
|
|
1517
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1518
|
+
* @param {string} params.name - Webhook name. Max length: 128 chars.
|
|
1519
|
+
* @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
|
|
1520
|
+
* @param {string} params.url - Webhook URL.
|
|
1521
|
+
* @param {boolean} params.security - Certificate verification, false for disabled or true for enabled.
|
|
1522
|
+
* @param {boolean} params.enabled - Enable or disable a webhook.
|
|
1523
|
+
* @param {string} params.httpUser - Webhook HTTP user. Max length: 256 chars.
|
|
1524
|
+
* @param {string} params.httpPass - Webhook HTTP password. Max length: 256 chars.
|
|
1525
|
+
* @throws {AppwriteException}
|
|
1526
|
+
* @returns {Promise<Models.Webhook>}
|
|
1527
|
+
*/
|
|
1528
|
+
createWebhook(params: {
|
|
1529
|
+
projectId: string;
|
|
1530
|
+
name: string;
|
|
1531
|
+
events: string[];
|
|
1532
|
+
url: string;
|
|
1533
|
+
security: boolean;
|
|
1534
|
+
enabled?: boolean;
|
|
1535
|
+
httpUser?: string;
|
|
1536
|
+
httpPass?: string;
|
|
1537
|
+
}): Promise<Models.Webhook>;
|
|
499
1538
|
/**
|
|
500
1539
|
* Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
|
|
501
1540
|
*
|
|
502
|
-
* @param {string} projectId
|
|
503
|
-
* @param {string} name
|
|
504
|
-
* @param {string[]} events
|
|
505
|
-
* @param {string} url
|
|
506
|
-
* @param {boolean} security
|
|
507
|
-
* @param {boolean} enabled
|
|
508
|
-
* @param {string} httpUser
|
|
509
|
-
* @param {string} httpPass
|
|
1541
|
+
* @param {string} projectId - Project unique ID.
|
|
1542
|
+
* @param {string} name - Webhook name. Max length: 128 chars.
|
|
1543
|
+
* @param {string[]} events - Events list. Maximum of 100 events are allowed.
|
|
1544
|
+
* @param {string} url - Webhook URL.
|
|
1545
|
+
* @param {boolean} security - Certificate verification, false for disabled or true for enabled.
|
|
1546
|
+
* @param {boolean} enabled - Enable or disable a webhook.
|
|
1547
|
+
* @param {string} httpUser - Webhook HTTP user. Max length: 256 chars.
|
|
1548
|
+
* @param {string} httpPass - Webhook HTTP password. Max length: 256 chars.
|
|
510
1549
|
* @throws {AppwriteException}
|
|
511
1550
|
* @returns {Promise<Models.Webhook>}
|
|
1551
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
512
1552
|
*/
|
|
513
1553
|
createWebhook(projectId: string, name: string, events: string[], url: string, security: boolean, enabled?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
|
|
514
1554
|
/**
|
|
515
1555
|
* Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
|
|
516
1556
|
*
|
|
517
|
-
* @param {string} projectId
|
|
518
|
-
* @param {string} webhookId
|
|
1557
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1558
|
+
* @param {string} params.webhookId - Webhook unique ID.
|
|
519
1559
|
* @throws {AppwriteException}
|
|
520
1560
|
* @returns {Promise<Models.Webhook>}
|
|
521
1561
|
*/
|
|
1562
|
+
getWebhook(params: {
|
|
1563
|
+
projectId: string;
|
|
1564
|
+
webhookId: string;
|
|
1565
|
+
}): Promise<Models.Webhook>;
|
|
1566
|
+
/**
|
|
1567
|
+
* Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
|
|
1568
|
+
*
|
|
1569
|
+
* @param {string} projectId - Project unique ID.
|
|
1570
|
+
* @param {string} webhookId - Webhook unique ID.
|
|
1571
|
+
* @throws {AppwriteException}
|
|
1572
|
+
* @returns {Promise<Models.Webhook>}
|
|
1573
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1574
|
+
*/
|
|
522
1575
|
getWebhook(projectId: string, webhookId: string): Promise<Models.Webhook>;
|
|
523
1576
|
/**
|
|
524
1577
|
* Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
|
|
525
1578
|
*
|
|
526
|
-
* @param {string} projectId
|
|
527
|
-
* @param {string} webhookId
|
|
528
|
-
* @param {string} name
|
|
529
|
-
* @param {string[]} events
|
|
530
|
-
* @param {string} url
|
|
531
|
-
* @param {boolean} security
|
|
532
|
-
* @param {boolean} enabled
|
|
533
|
-
* @param {string} httpUser
|
|
534
|
-
* @param {string} httpPass
|
|
1579
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1580
|
+
* @param {string} params.webhookId - Webhook unique ID.
|
|
1581
|
+
* @param {string} params.name - Webhook name. Max length: 128 chars.
|
|
1582
|
+
* @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
|
|
1583
|
+
* @param {string} params.url - Webhook URL.
|
|
1584
|
+
* @param {boolean} params.security - Certificate verification, false for disabled or true for enabled.
|
|
1585
|
+
* @param {boolean} params.enabled - Enable or disable a webhook.
|
|
1586
|
+
* @param {string} params.httpUser - Webhook HTTP user. Max length: 256 chars.
|
|
1587
|
+
* @param {string} params.httpPass - Webhook HTTP password. Max length: 256 chars.
|
|
1588
|
+
* @throws {AppwriteException}
|
|
1589
|
+
* @returns {Promise<Models.Webhook>}
|
|
1590
|
+
*/
|
|
1591
|
+
updateWebhook(params: {
|
|
1592
|
+
projectId: string;
|
|
1593
|
+
webhookId: string;
|
|
1594
|
+
name: string;
|
|
1595
|
+
events: string[];
|
|
1596
|
+
url: string;
|
|
1597
|
+
security: boolean;
|
|
1598
|
+
enabled?: boolean;
|
|
1599
|
+
httpUser?: string;
|
|
1600
|
+
httpPass?: string;
|
|
1601
|
+
}): Promise<Models.Webhook>;
|
|
1602
|
+
/**
|
|
1603
|
+
* Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
|
|
1604
|
+
*
|
|
1605
|
+
* @param {string} projectId - Project unique ID.
|
|
1606
|
+
* @param {string} webhookId - Webhook unique ID.
|
|
1607
|
+
* @param {string} name - Webhook name. Max length: 128 chars.
|
|
1608
|
+
* @param {string[]} events - Events list. Maximum of 100 events are allowed.
|
|
1609
|
+
* @param {string} url - Webhook URL.
|
|
1610
|
+
* @param {boolean} security - Certificate verification, false for disabled or true for enabled.
|
|
1611
|
+
* @param {boolean} enabled - Enable or disable a webhook.
|
|
1612
|
+
* @param {string} httpUser - Webhook HTTP user. Max length: 256 chars.
|
|
1613
|
+
* @param {string} httpPass - Webhook HTTP password. Max length: 256 chars.
|
|
535
1614
|
* @throws {AppwriteException}
|
|
536
1615
|
* @returns {Promise<Models.Webhook>}
|
|
1616
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
537
1617
|
*/
|
|
538
1618
|
updateWebhook(projectId: string, webhookId: string, name: string, events: string[], url: string, security: boolean, enabled?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
|
|
539
1619
|
/**
|
|
540
1620
|
* Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
|
|
541
1621
|
*
|
|
542
|
-
* @param {string} projectId
|
|
543
|
-
* @param {string} webhookId
|
|
1622
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1623
|
+
* @param {string} params.webhookId - Webhook unique ID.
|
|
544
1624
|
* @throws {AppwriteException}
|
|
545
1625
|
* @returns {Promise<{}>}
|
|
546
1626
|
*/
|
|
1627
|
+
deleteWebhook(params: {
|
|
1628
|
+
projectId: string;
|
|
1629
|
+
webhookId: string;
|
|
1630
|
+
}): Promise<{}>;
|
|
1631
|
+
/**
|
|
1632
|
+
* Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
|
|
1633
|
+
*
|
|
1634
|
+
* @param {string} projectId - Project unique ID.
|
|
1635
|
+
* @param {string} webhookId - Webhook unique ID.
|
|
1636
|
+
* @throws {AppwriteException}
|
|
1637
|
+
* @returns {Promise<{}>}
|
|
1638
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1639
|
+
*/
|
|
547
1640
|
deleteWebhook(projectId: string, webhookId: string): Promise<{}>;
|
|
548
1641
|
/**
|
|
549
1642
|
* Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
|
|
550
1643
|
*
|
|
551
|
-
* @param {string} projectId
|
|
552
|
-
* @param {string} webhookId
|
|
1644
|
+
* @param {string} params.projectId - Project unique ID.
|
|
1645
|
+
* @param {string} params.webhookId - Webhook unique ID.
|
|
1646
|
+
* @throws {AppwriteException}
|
|
1647
|
+
* @returns {Promise<Models.Webhook>}
|
|
1648
|
+
*/
|
|
1649
|
+
updateWebhookSignature(params: {
|
|
1650
|
+
projectId: string;
|
|
1651
|
+
webhookId: string;
|
|
1652
|
+
}): Promise<Models.Webhook>;
|
|
1653
|
+
/**
|
|
1654
|
+
* Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
|
|
1655
|
+
*
|
|
1656
|
+
* @param {string} projectId - Project unique ID.
|
|
1657
|
+
* @param {string} webhookId - Webhook unique ID.
|
|
553
1658
|
* @throws {AppwriteException}
|
|
554
1659
|
* @returns {Promise<Models.Webhook>}
|
|
1660
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
555
1661
|
*/
|
|
556
1662
|
updateWebhookSignature(projectId: string, webhookId: string): Promise<Models.Webhook>;
|
|
557
1663
|
}
|