@appwrite.io/console 1.10.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yml +9 -8
- package/CHANGELOG.md +10 -0
- package/LICENSE +1 -1
- package/README.md +4 -4
- package/dist/cjs/sdk.js +15258 -6062
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +15256 -6063
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +15258 -6062
- package/docs/examples/account/create-billing-address.md +8 -8
- package/docs/examples/account/create-email-password-session.md +4 -4
- package/docs/examples/account/create-email-token.md +5 -5
- package/docs/examples/account/{update-magic-u-r-l-session.md → create-email-verification.md} +3 -4
- package/docs/examples/account/{update-m-f-a.md → create-jwt.md} +3 -3
- package/docs/examples/account/{create-magic-u-r-l-token.md → create-magic-url-token.md} +6 -6
- package/docs/examples/account/create-mfa-authenticator.md +3 -3
- package/docs/examples/account/create-mfa-challenge.md +3 -3
- package/docs/examples/account/create-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-o-auth2token.md → create-o-auth-2-session.md} +6 -6
- package/docs/examples/account/{create-o-auth2session.md → create-o-auth-2-token.md} +6 -6
- package/docs/examples/account/create-phone-token.md +4 -4
- package/docs/examples/account/create-push-target.md +5 -5
- package/docs/examples/account/create-recovery.md +4 -4
- package/docs/examples/account/create-session.md +4 -4
- package/docs/examples/account/create-verification.md +3 -3
- package/docs/examples/account/create.md +6 -6
- package/docs/examples/account/delete-billing-address.md +3 -3
- package/docs/examples/account/delete-identity.md +3 -3
- package/docs/examples/account/delete-mfa-authenticator.md +3 -3
- package/docs/examples/account/delete-payment-method.md +3 -3
- package/docs/examples/account/delete-push-target.md +3 -3
- package/docs/examples/account/delete-session.md +3 -3
- package/docs/examples/account/get-billing-address.md +3 -3
- package/docs/examples/account/get-coupon.md +3 -3
- package/docs/examples/account/get-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/get-payment-method.md +3 -3
- package/docs/examples/account/get-session.md +3 -3
- package/docs/examples/account/list-billing-addresses.md +3 -3
- package/docs/examples/account/list-identities.md +4 -3
- package/docs/examples/account/list-invoices.md +3 -3
- package/docs/examples/account/list-logs.md +4 -3
- package/docs/examples/account/list-mfa-factors.md +1 -1
- package/docs/examples/account/list-payment-methods.md +3 -3
- package/docs/examples/account/update-billing-address.md +9 -9
- package/docs/examples/account/update-email-verification.md +14 -0
- package/docs/examples/account/update-email.md +4 -4
- package/docs/examples/account/update-magic-url-session.md +14 -0
- package/docs/examples/account/update-mfa-authenticator.md +4 -4
- package/docs/examples/account/update-mfa-challenge.md +4 -4
- package/docs/examples/account/update-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-j-w-t.md → update-mfa.md} +3 -1
- package/docs/examples/account/update-name.md +3 -3
- package/docs/examples/account/update-password.md +4 -4
- package/docs/examples/account/update-payment-method-mandate-options.md +3 -3
- package/docs/examples/account/update-payment-method-provider.md +6 -5
- package/docs/examples/account/update-payment-method.md +6 -5
- package/docs/examples/account/update-phone-session.md +4 -4
- package/docs/examples/account/update-phone-verification.md +4 -4
- package/docs/examples/account/update-phone.md +4 -4
- package/docs/examples/account/update-prefs.md +7 -3
- package/docs/examples/account/update-push-target.md +4 -4
- package/docs/examples/account/update-recovery.md +5 -5
- package/docs/examples/account/update-session.md +3 -3
- package/docs/examples/account/update-verification.md +4 -4
- package/docs/examples/assistant/chat.md +3 -3
- package/docs/examples/avatars/get-browser.md +6 -6
- package/docs/examples/avatars/get-credit-card.md +6 -6
- package/docs/examples/avatars/get-favicon.md +3 -3
- package/docs/examples/avatars/get-flag.md +6 -6
- package/docs/examples/avatars/get-image.md +5 -5
- package/docs/examples/avatars/get-initials.md +6 -6
- package/docs/examples/avatars/{get-q-r.md → get-qr.md} +6 -6
- package/docs/examples/avatars/get-screenshot.md +35 -0
- package/docs/examples/backups/create-archive.md +4 -4
- package/docs/examples/backups/create-policy.md +9 -9
- package/docs/examples/backups/create-restoration.md +6 -6
- package/docs/examples/backups/delete-archive.md +3 -3
- package/docs/examples/backups/delete-policy.md +3 -3
- package/docs/examples/backups/get-archive.md +3 -3
- package/docs/examples/backups/get-policy.md +3 -3
- package/docs/examples/backups/get-restoration.md +3 -3
- package/docs/examples/backups/list-archives.md +3 -3
- package/docs/examples/backups/list-policies.md +3 -3
- package/docs/examples/backups/list-restorations.md +3 -3
- package/docs/examples/backups/update-policy.md +7 -7
- package/docs/examples/console/create-program-membership.md +3 -3
- package/docs/examples/console/create-source.md +7 -7
- package/docs/examples/console/get-campaign.md +3 -3
- package/docs/examples/console/get-coupon.md +3 -3
- package/docs/examples/console/{plans.md → get-plan.md} +3 -1
- package/docs/examples/console/get-plans.md +13 -0
- package/docs/examples/console/{regions.md → get-program.md} +3 -1
- package/docs/examples/console/get-regions.md +13 -0
- package/docs/examples/console/get-resource.md +4 -4
- package/docs/examples/console/suggest-columns.md +17 -0
- package/docs/examples/console/suggest-indexes.md +16 -0
- package/docs/examples/databases/create-boolean-attribute.md +8 -8
- package/docs/examples/databases/create-collection.md +11 -9
- package/docs/examples/databases/create-datetime-attribute.md +8 -8
- package/docs/examples/databases/create-document.md +15 -8
- package/docs/examples/databases/create-documents.md +6 -5
- package/docs/examples/databases/create-email-attribute.md +8 -8
- package/docs/examples/databases/create-enum-attribute.md +9 -9
- package/docs/examples/databases/create-float-attribute.md +10 -10
- package/docs/examples/databases/create-index.md +9 -9
- package/docs/examples/databases/create-integer-attribute.md +10 -10
- package/docs/examples/databases/create-ip-attribute.md +8 -8
- package/docs/examples/databases/create-line-attribute.md +17 -0
- package/docs/examples/databases/create-operations.md +24 -0
- package/docs/examples/databases/create-point-attribute.md +17 -0
- package/docs/examples/databases/create-polygon-attribute.md +17 -0
- package/docs/examples/databases/create-relationship-attribute.md +10 -10
- package/docs/examples/databases/create-string-attribute.md +10 -10
- package/docs/examples/databases/create-transaction.md +13 -0
- package/docs/examples/databases/create-url-attribute.md +8 -8
- package/docs/examples/databases/create.md +5 -5
- package/docs/examples/databases/decrement-document-attribute.md +9 -8
- package/docs/examples/databases/delete-attribute.md +5 -5
- package/docs/examples/databases/delete-collection.md +4 -4
- package/docs/examples/databases/delete-document.md +6 -5
- package/docs/examples/databases/delete-documents.md +6 -5
- package/docs/examples/databases/delete-index.md +5 -5
- package/docs/examples/databases/{get-database-usage.md → delete-transaction.md} +4 -5
- package/docs/examples/databases/delete.md +3 -3
- package/docs/examples/databases/get-attribute.md +5 -5
- package/docs/examples/databases/get-collection-usage.md +6 -6
- package/docs/examples/databases/get-collection.md +4 -4
- package/docs/examples/databases/get-document.md +7 -6
- package/docs/examples/databases/get-index.md +5 -5
- package/docs/examples/databases/get-transaction.md +13 -0
- package/docs/examples/databases/get-usage.md +5 -4
- package/docs/examples/databases/get.md +3 -3
- package/docs/examples/databases/increment-document-attribute.md +9 -8
- package/docs/examples/databases/list-attributes.md +6 -5
- package/docs/examples/databases/list-collection-logs.md +5 -5
- package/docs/examples/databases/list-collections.md +6 -5
- package/docs/examples/databases/list-document-logs.md +6 -6
- package/docs/examples/databases/list-documents.md +7 -5
- package/docs/examples/databases/list-indexes.md +6 -5
- package/docs/examples/databases/list-logs.md +4 -4
- package/docs/examples/databases/list-transactions.md +13 -0
- package/docs/examples/databases/list-usage.md +13 -0
- package/docs/examples/databases/list.md +5 -4
- package/docs/examples/databases/update-boolean-attribute.md +8 -8
- package/docs/examples/databases/update-collection.md +9 -9
- package/docs/examples/databases/update-datetime-attribute.md +8 -8
- package/docs/examples/databases/update-document.md +15 -8
- package/docs/examples/databases/update-documents.md +13 -6
- package/docs/examples/databases/update-email-attribute.md +8 -8
- package/docs/examples/databases/update-enum-attribute.md +9 -9
- package/docs/examples/databases/update-float-attribute.md +10 -10
- package/docs/examples/databases/update-integer-attribute.md +10 -10
- package/docs/examples/databases/update-ip-attribute.md +8 -8
- package/docs/examples/databases/update-line-attribute.md +18 -0
- package/docs/examples/databases/update-point-attribute.md +18 -0
- package/docs/examples/databases/update-polygon-attribute.md +18 -0
- package/docs/examples/databases/update-relationship-attribute.md +7 -7
- package/docs/examples/databases/update-string-attribute.md +9 -9
- package/docs/examples/databases/update-transaction.md +15 -0
- package/docs/examples/databases/update-url-attribute.md +8 -8
- package/docs/examples/databases/update.md +5 -5
- package/docs/examples/databases/upsert-document.md +15 -8
- package/docs/examples/databases/upsert-documents.md +6 -5
- package/docs/examples/domains/create-preset-google-workspace.md +3 -3
- package/docs/examples/domains/create-preset-i-cloud.md +3 -3
- package/docs/examples/domains/create-preset-mailgun.md +3 -3
- package/docs/examples/domains/create-preset-outlook.md +3 -3
- package/docs/examples/domains/create-preset-proton-mail.md +3 -3
- package/docs/examples/domains/create-preset-zoho.md +3 -3
- package/docs/examples/domains/create-record-a.md +7 -7
- package/docs/examples/domains/{create-record-a-a-a-a.md → create-record-aaaa.md} +7 -7
- package/docs/examples/domains/create-record-alias.md +7 -7
- package/docs/examples/domains/{create-record-n-s.md → create-record-caa.md} +7 -7
- package/docs/examples/domains/{create-record-c-a-a.md → create-record-cname.md} +7 -7
- package/docs/examples/domains/{create-record-h-t-t-p-s.md → create-record-https.md} +7 -7
- package/docs/examples/domains/create-record-mx.md +18 -0
- package/docs/examples/domains/create-record-ns.md +17 -0
- package/docs/examples/domains/create-record-srv.md +20 -0
- package/docs/examples/domains/{create-record-c-n-a-m-e.md → create-record-txt.md} +7 -7
- package/docs/examples/domains/create.md +4 -4
- package/docs/examples/domains/delete-record.md +4 -4
- package/docs/examples/domains/delete.md +3 -3
- package/docs/examples/domains/get-preset-google-workspace.md +3 -3
- package/docs/examples/domains/get-preset-i-cloud.md +3 -3
- package/docs/examples/domains/get-preset-mailgun.md +3 -3
- package/docs/examples/domains/get-preset-outlook.md +3 -3
- package/docs/examples/domains/get-preset-proton-mail.md +3 -3
- package/docs/examples/domains/get-preset-zoho.md +3 -3
- package/docs/examples/domains/get-record.md +4 -4
- package/docs/examples/domains/get-zone.md +3 -3
- package/docs/examples/domains/get.md +3 -3
- package/docs/examples/domains/list-records.md +4 -4
- package/docs/examples/domains/list.md +4 -4
- package/docs/examples/domains/update-nameservers.md +3 -3
- package/docs/examples/domains/update-record-a.md +8 -8
- package/docs/examples/domains/update-record-aaaa.md +18 -0
- package/docs/examples/domains/update-record-alias.md +8 -8
- package/docs/examples/domains/update-record-caa.md +18 -0
- package/docs/examples/domains/update-record-cname.md +18 -0
- package/docs/examples/domains/update-record-https.md +18 -0
- package/docs/examples/domains/update-record-mx.md +19 -0
- package/docs/examples/domains/update-record-ns.md +18 -0
- package/docs/examples/domains/update-record-srv.md +21 -0
- package/docs/examples/domains/update-record-txt.md +18 -0
- package/docs/examples/domains/update-team.md +4 -4
- package/docs/examples/domains/update-zone.md +4 -4
- package/docs/examples/functions/create-deployment.md +7 -7
- package/docs/examples/functions/create-duplicate-deployment.md +5 -5
- package/docs/examples/functions/create-execution.md +9 -9
- package/docs/examples/functions/create-template-deployment.md +10 -9
- package/docs/examples/functions/create-variable.md +6 -6
- package/docs/examples/functions/create-vcs-deployment.md +7 -7
- package/docs/examples/functions/create.md +21 -21
- package/docs/examples/functions/delete-deployment.md +4 -4
- package/docs/examples/functions/delete-execution.md +4 -4
- package/docs/examples/functions/delete-variable.md +4 -4
- package/docs/examples/functions/delete.md +3 -3
- package/docs/examples/functions/get-deployment-download.md +5 -5
- package/docs/examples/functions/get-deployment.md +4 -4
- package/docs/examples/functions/get-execution.md +4 -4
- package/docs/examples/functions/get-template.md +3 -3
- package/docs/examples/functions/get-usage.md +5 -5
- package/docs/examples/functions/get-variable.md +4 -4
- package/docs/examples/functions/get.md +3 -3
- package/docs/examples/functions/list-deployments.md +6 -5
- package/docs/examples/functions/list-executions.md +5 -4
- package/docs/examples/functions/list-templates.md +7 -6
- package/docs/examples/functions/list-usage.md +4 -4
- package/docs/examples/functions/list-variables.md +3 -3
- package/docs/examples/functions/list.md +5 -4
- package/docs/examples/functions/update-deployment-status.md +4 -4
- package/docs/examples/functions/update-function-deployment.md +4 -4
- package/docs/examples/functions/update-variable.md +7 -7
- package/docs/examples/functions/update.md +21 -21
- package/docs/examples/graphql/mutation.md +3 -3
- package/docs/examples/graphql/query.md +3 -3
- package/docs/examples/health/get-certificate.md +3 -3
- package/docs/examples/health/get-failed-jobs.md +5 -5
- package/docs/examples/health/get-queue-billing-project-aggregation.md +3 -3
- package/docs/examples/health/get-queue-billing-team-aggregation.md +3 -3
- package/docs/examples/health/get-queue-builds.md +3 -3
- package/docs/examples/health/get-queue-certificates.md +3 -3
- package/docs/examples/health/get-queue-databases.md +4 -4
- package/docs/examples/health/get-queue-deletes.md +3 -3
- package/docs/examples/health/get-queue-functions.md +3 -3
- package/docs/examples/health/get-queue-logs.md +3 -3
- package/docs/examples/health/get-queue-mails.md +3 -3
- package/docs/examples/health/get-queue-messaging.md +3 -3
- package/docs/examples/health/get-queue-migrations.md +3 -3
- package/docs/examples/health/get-queue-priority-builds.md +3 -3
- package/docs/examples/health/get-queue-region-manager.md +3 -3
- package/docs/examples/health/get-queue-stats-resources.md +3 -3
- package/docs/examples/health/get-queue-threats.md +13 -0
- package/docs/examples/health/get-queue-usage.md +3 -3
- package/docs/examples/health/get-queue-webhooks.md +3 -3
- package/docs/examples/messaging/create-apns-provider.md +10 -10
- package/docs/examples/messaging/create-email.md +14 -14
- package/docs/examples/messaging/create-fcm-provider.md +6 -6
- package/docs/examples/messaging/create-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{create-msg91provider.md → create-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/create-push.md +21 -21
- package/docs/examples/messaging/create-resend-provider.md +20 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/create-sms.md +9 -9
- package/docs/examples/messaging/create-smtp-provider.md +16 -16
- package/docs/examples/messaging/create-subscriber.md +5 -5
- package/docs/examples/messaging/create-telesign-provider.md +8 -8
- package/docs/examples/messaging/create-textmagic-provider.md +8 -8
- package/docs/examples/messaging/create-topic.md +5 -5
- package/docs/examples/messaging/create-twilio-provider.md +8 -8
- package/docs/examples/messaging/create-vonage-provider.md +8 -8
- package/docs/examples/messaging/delete-provider.md +3 -3
- package/docs/examples/messaging/delete-subscriber.md +4 -4
- package/docs/examples/messaging/delete-topic.md +3 -3
- package/docs/examples/messaging/delete.md +3 -3
- package/docs/examples/messaging/get-message.md +3 -3
- package/docs/examples/messaging/get-provider.md +3 -3
- package/docs/examples/messaging/get-subscriber.md +4 -4
- package/docs/examples/messaging/get-topic.md +3 -3
- package/docs/examples/messaging/list-message-logs.md +5 -4
- package/docs/examples/messaging/list-messages.md +5 -4
- package/docs/examples/messaging/list-provider-logs.md +5 -4
- package/docs/examples/messaging/list-providers.md +5 -4
- package/docs/examples/messaging/list-subscriber-logs.md +5 -4
- package/docs/examples/messaging/list-subscribers.md +6 -5
- package/docs/examples/messaging/list-targets.md +5 -4
- package/docs/examples/messaging/list-topic-logs.md +5 -4
- package/docs/examples/messaging/list-topics.md +5 -4
- package/docs/examples/messaging/update-apns-provider.md +10 -10
- package/docs/examples/messaging/update-email.md +14 -14
- package/docs/examples/messaging/update-fcm-provider.md +6 -6
- package/docs/examples/messaging/update-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{update-msg91provider.md → update-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/update-push.md +21 -21
- package/docs/examples/messaging/update-resend-provider.md +20 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/update-sms.md +9 -9
- package/docs/examples/messaging/update-smtp-provider.md +16 -16
- package/docs/examples/messaging/update-telesign-provider.md +8 -8
- package/docs/examples/messaging/update-textmagic-provider.md +8 -8
- package/docs/examples/messaging/update-topic.md +5 -5
- package/docs/examples/messaging/update-twilio-provider.md +8 -8
- package/docs/examples/messaging/update-vonage-provider.md +8 -8
- package/docs/examples/migrations/create-appwrite-migration.md +6 -6
- package/docs/examples/migrations/create-csv-export.md +21 -0
- package/docs/examples/migrations/{create-csv-migration.md → create-csv-import.md} +6 -5
- package/docs/examples/migrations/create-firebase-migration.md +4 -4
- package/docs/examples/migrations/create-n-host-migration.md +10 -10
- package/docs/examples/migrations/create-supabase-migration.md +9 -9
- package/docs/examples/migrations/delete.md +3 -3
- package/docs/examples/migrations/get-appwrite-report.md +6 -6
- package/docs/examples/migrations/get-firebase-report.md +4 -4
- package/docs/examples/migrations/get-n-host-report.md +10 -10
- package/docs/examples/migrations/get-supabase-report.md +9 -9
- package/docs/examples/migrations/get.md +3 -3
- package/docs/examples/migrations/list.md +5 -4
- package/docs/examples/migrations/retry.md +3 -3
- package/docs/examples/organizations/add-credit.md +4 -4
- package/docs/examples/organizations/cancel-downgrade.md +3 -3
- package/docs/examples/organizations/create-downgrade-feedback.md +17 -0
- package/docs/examples/organizations/create-invoice-payment.md +5 -5
- package/docs/examples/organizations/create.md +13 -12
- package/docs/examples/organizations/delete-backup-payment-method.md +3 -3
- package/docs/examples/organizations/delete-billing-address.md +3 -3
- package/docs/examples/organizations/delete-default-payment-method.md +3 -3
- package/docs/examples/organizations/delete.md +3 -3
- package/docs/examples/organizations/estimation-create-organization.md +8 -7
- package/docs/examples/organizations/estimation-delete-organization.md +3 -3
- package/docs/examples/organizations/estimation-update-plan.md +7 -7
- package/docs/examples/organizations/get-aggregation.md +6 -4
- package/docs/examples/organizations/get-available-credits.md +3 -3
- package/docs/examples/organizations/get-billing-address.md +4 -4
- package/docs/examples/organizations/get-credit.md +4 -4
- package/docs/examples/organizations/get-invoice-download.md +4 -4
- package/docs/examples/organizations/get-invoice-view.md +4 -4
- package/docs/examples/organizations/get-invoice.md +4 -4
- package/docs/examples/organizations/get-payment-method.md +4 -4
- package/docs/examples/organizations/get-plan.md +3 -3
- package/docs/examples/organizations/get-scopes.md +3 -3
- package/docs/examples/organizations/get-usage.md +5 -5
- package/docs/examples/organizations/list-aggregations.md +4 -4
- package/docs/examples/organizations/list-credits.md +4 -4
- package/docs/examples/organizations/list-invoices.md +4 -4
- package/docs/examples/organizations/list.md +4 -4
- package/docs/examples/organizations/set-backup-payment-method.md +4 -4
- package/docs/examples/organizations/set-billing-address.md +4 -4
- package/docs/examples/organizations/set-billing-email.md +4 -4
- package/docs/examples/organizations/set-billing-tax-id.md +4 -4
- package/docs/examples/organizations/set-default-payment-method.md +4 -4
- package/docs/examples/organizations/update-budget.md +5 -5
- package/docs/examples/organizations/update-plan.md +11 -11
- package/docs/examples/organizations/update-projects.md +4 -4
- package/docs/examples/organizations/validate-invoice.md +4 -4
- package/docs/examples/organizations/validate-payment.md +4 -4
- package/docs/examples/project/create-variable.md +5 -5
- package/docs/examples/project/delete-variable.md +3 -3
- package/docs/examples/project/get-usage.md +5 -5
- package/docs/examples/project/get-variable.md +3 -3
- package/docs/examples/project/update-variable.md +6 -6
- package/docs/examples/projects/create-dev-key.md +5 -5
- package/docs/examples/projects/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/projects/create-key.md +6 -6
- package/docs/examples/projects/create-platform.md +8 -8
- package/docs/examples/projects/create-smtp-test.md +12 -12
- package/docs/examples/projects/create-webhook.md +10 -10
- package/docs/examples/projects/create.md +16 -16
- package/docs/examples/projects/delete-dev-key.md +4 -4
- package/docs/examples/projects/delete-email-template.md +5 -5
- package/docs/examples/projects/delete-key.md +4 -4
- package/docs/examples/projects/delete-platform.md +4 -4
- package/docs/examples/projects/delete-sms-template.md +5 -5
- package/docs/examples/projects/delete-webhook.md +4 -4
- package/docs/examples/projects/delete.md +3 -3
- package/docs/examples/projects/get-dev-key.md +4 -4
- package/docs/examples/projects/get-email-template.md +5 -5
- package/docs/examples/projects/get-key.md +4 -4
- package/docs/examples/projects/get-platform.md +4 -4
- package/docs/examples/projects/get-sms-template.md +5 -5
- package/docs/examples/projects/get-webhook.md +4 -4
- package/docs/examples/projects/get.md +3 -3
- package/docs/examples/projects/list-dev-keys.md +4 -4
- package/docs/examples/projects/list-keys.md +4 -3
- package/docs/examples/projects/list-platforms.md +4 -3
- package/docs/examples/projects/list-webhooks.md +4 -3
- package/docs/examples/projects/list.md +5 -4
- package/docs/examples/projects/update-api-status-all.md +4 -4
- package/docs/examples/projects/update-api-status.md +6 -6
- package/docs/examples/projects/update-auth-duration.md +4 -4
- package/docs/examples/projects/update-auth-limit.md +4 -4
- package/docs/examples/projects/update-auth-password-dictionary.md +4 -4
- package/docs/examples/projects/update-auth-password-history.md +4 -4
- package/docs/examples/projects/update-auth-sessions-limit.md +4 -4
- package/docs/examples/projects/update-auth-status.md +5 -5
- package/docs/examples/projects/update-dev-key.md +6 -6
- package/docs/examples/projects/update-email-template.md +10 -10
- package/docs/examples/projects/update-key.md +7 -7
- package/docs/examples/projects/update-memberships-privacy.md +6 -6
- package/docs/examples/projects/update-mock-numbers.md +4 -4
- package/docs/examples/projects/{update-o-auth2.md → update-o-auth-2.md} +7 -7
- package/docs/examples/projects/update-personal-data-check.md +4 -4
- package/docs/examples/projects/update-platform.md +8 -8
- package/docs/examples/projects/update-service-status-all.md +4 -4
- package/docs/examples/projects/update-service-status.md +5 -5
- package/docs/examples/projects/update-session-alerts.md +4 -4
- package/docs/examples/projects/update-session-invalidation.md +14 -0
- package/docs/examples/projects/update-sms-template.md +6 -6
- package/docs/examples/projects/update-smtp.md +12 -12
- package/docs/examples/projects/update-status.md +14 -0
- package/docs/examples/projects/update-team.md +4 -4
- package/docs/examples/projects/update-webhook-signature.md +4 -4
- package/docs/examples/projects/update-webhook.md +11 -11
- package/docs/examples/projects/update.md +13 -13
- package/docs/examples/proxy/{create-a-p-i-rule.md → create-api-rule.md} +3 -3
- package/docs/examples/proxy/create-function-rule.md +5 -5
- package/docs/examples/proxy/create-redirect-rule.md +8 -8
- package/docs/examples/proxy/create-site-rule.md +5 -5
- package/docs/examples/proxy/delete-rule.md +3 -3
- package/docs/examples/proxy/get-rule.md +3 -3
- package/docs/examples/proxy/list-rules.md +5 -4
- package/docs/examples/proxy/update-rule-verification.md +3 -3
- package/docs/examples/sites/create-deployment.md +8 -8
- package/docs/examples/sites/create-duplicate-deployment.md +4 -4
- package/docs/examples/sites/create-template-deployment.md +10 -9
- package/docs/examples/sites/create-variable.md +6 -6
- package/docs/examples/sites/create-vcs-deployment.md +7 -7
- package/docs/examples/sites/create.md +21 -21
- package/docs/examples/sites/delete-deployment.md +4 -4
- package/docs/examples/sites/delete-log.md +4 -4
- package/docs/examples/sites/delete-variable.md +4 -4
- package/docs/examples/sites/delete.md +3 -3
- package/docs/examples/sites/get-deployment-download.md +5 -5
- package/docs/examples/sites/get-deployment.md +4 -4
- package/docs/examples/sites/get-log.md +4 -4
- package/docs/examples/sites/get-template.md +3 -3
- package/docs/examples/sites/get-usage.md +5 -5
- package/docs/examples/sites/get-variable.md +4 -4
- package/docs/examples/sites/get.md +3 -3
- package/docs/examples/sites/list-deployments.md +6 -5
- package/docs/examples/sites/list-logs.md +5 -4
- package/docs/examples/sites/list-templates.md +6 -6
- package/docs/examples/sites/list-usage.md +4 -4
- package/docs/examples/sites/list-variables.md +3 -3
- package/docs/examples/sites/list.md +5 -4
- package/docs/examples/sites/update-deployment-status.md +4 -4
- package/docs/examples/sites/update-site-deployment.md +4 -4
- package/docs/examples/sites/update-variable.md +7 -7
- package/docs/examples/sites/update.md +21 -21
- package/docs/examples/storage/create-bucket.md +14 -13
- package/docs/examples/storage/create-file.md +7 -7
- package/docs/examples/storage/delete-bucket.md +3 -3
- package/docs/examples/storage/delete-file.md +4 -4
- package/docs/examples/storage/get-bucket-usage.md +5 -5
- package/docs/examples/storage/get-bucket.md +3 -3
- package/docs/examples/storage/get-file-download.md +5 -5
- package/docs/examples/storage/get-file-preview.md +16 -16
- package/docs/examples/storage/get-file-view.md +5 -5
- package/docs/examples/storage/get-file.md +4 -4
- package/docs/examples/storage/get-usage.md +4 -4
- package/docs/examples/storage/list-buckets.md +5 -4
- package/docs/examples/storage/list-files.md +6 -5
- package/docs/examples/storage/update-bucket.md +14 -13
- package/docs/examples/storage/update-file.md +7 -7
- package/docs/examples/tablesdb/create-boolean-column.md +18 -0
- package/docs/examples/tablesdb/create-datetime-column.md +18 -0
- package/docs/examples/tablesdb/create-email-column.md +18 -0
- package/docs/examples/tablesdb/create-enum-column.md +19 -0
- package/docs/examples/tablesdb/create-float-column.md +20 -0
- package/docs/examples/tablesdb/create-index.md +19 -0
- package/docs/examples/tablesdb/create-integer-column.md +20 -0
- package/docs/examples/tablesdb/create-ip-column.md +18 -0
- package/docs/examples/tablesdb/create-line-column.md +17 -0
- package/docs/examples/tablesdb/create-operations.md +24 -0
- package/docs/examples/tablesdb/create-point-column.md +17 -0
- package/docs/examples/tablesdb/create-polygon-column.md +17 -0
- package/docs/examples/tablesdb/create-relationship-column.md +20 -0
- package/docs/examples/tablesdb/create-row.md +24 -0
- package/docs/examples/tablesdb/create-rows.md +16 -0
- package/docs/examples/tablesdb/create-string-column.md +20 -0
- package/docs/examples/tablesdb/create-table.md +20 -0
- package/docs/examples/tablesdb/create-transaction.md +13 -0
- package/docs/examples/tablesdb/create-url-column.md +18 -0
- package/docs/examples/tablesdb/create.md +15 -0
- package/docs/examples/tablesdb/decrement-row-column.md +19 -0
- package/docs/examples/tablesdb/delete-column.md +15 -0
- package/docs/examples/tablesdb/delete-index.md +15 -0
- package/docs/examples/tablesdb/delete-row.md +16 -0
- package/docs/examples/tablesdb/delete-rows.md +16 -0
- package/docs/examples/tablesdb/delete-table.md +14 -0
- package/docs/examples/tablesdb/delete-transaction.md +13 -0
- package/docs/examples/tablesdb/delete.md +13 -0
- package/docs/examples/tablesdb/get-column.md +15 -0
- package/docs/examples/tablesdb/get-index.md +15 -0
- package/docs/examples/tablesdb/get-row.md +17 -0
- package/docs/examples/tablesdb/get-table-usage.md +15 -0
- package/docs/examples/tablesdb/get-table.md +14 -0
- package/docs/examples/tablesdb/get-transaction.md +13 -0
- package/docs/examples/tablesdb/get-usage.md +14 -0
- package/docs/examples/tablesdb/get.md +13 -0
- package/docs/examples/tablesdb/increment-row-column.md +19 -0
- package/docs/examples/tablesdb/list-columns.md +16 -0
- package/docs/examples/tablesdb/list-indexes.md +16 -0
- package/docs/examples/tablesdb/list-row-logs.md +16 -0
- package/docs/examples/tablesdb/list-rows.md +17 -0
- package/docs/examples/tablesdb/list-table-logs.md +15 -0
- package/docs/examples/tablesdb/list-tables.md +16 -0
- package/docs/examples/tablesdb/list-transactions.md +13 -0
- package/docs/examples/tablesdb/list-usage.md +13 -0
- package/docs/examples/tablesdb/list.md +15 -0
- package/docs/examples/tablesdb/update-boolean-column.md +18 -0
- package/docs/examples/tablesdb/update-datetime-column.md +18 -0
- package/docs/examples/tablesdb/update-email-column.md +18 -0
- package/docs/examples/tablesdb/update-enum-column.md +19 -0
- package/docs/examples/tablesdb/update-float-column.md +20 -0
- package/docs/examples/tablesdb/update-integer-column.md +20 -0
- package/docs/examples/tablesdb/update-ip-column.md +18 -0
- package/docs/examples/tablesdb/update-line-column.md +18 -0
- package/docs/examples/tablesdb/update-point-column.md +18 -0
- package/docs/examples/tablesdb/update-polygon-column.md +18 -0
- package/docs/examples/tablesdb/update-relationship-column.md +17 -0
- package/docs/examples/tablesdb/update-row.md +24 -0
- package/docs/examples/tablesdb/update-rows.md +23 -0
- package/docs/examples/tablesdb/update-string-column.md +19 -0
- package/docs/examples/tablesdb/update-table.md +18 -0
- package/docs/examples/tablesdb/update-transaction.md +15 -0
- package/docs/examples/tablesdb/update-url-column.md +18 -0
- package/docs/examples/tablesdb/update.md +15 -0
- package/docs/examples/tablesdb/upsert-row.md +24 -0
- package/docs/examples/tablesdb/upsert-rows.md +16 -0
- package/docs/examples/teams/create-membership.md +9 -9
- package/docs/examples/teams/create.md +5 -5
- package/docs/examples/teams/delete-membership.md +4 -4
- package/docs/examples/teams/delete.md +3 -3
- package/docs/examples/teams/get-membership.md +4 -4
- package/docs/examples/teams/get-prefs.md +3 -3
- package/docs/examples/teams/get.md +3 -3
- package/docs/examples/teams/list-logs.md +5 -4
- package/docs/examples/teams/list-memberships.md +6 -5
- package/docs/examples/teams/list.md +5 -4
- package/docs/examples/teams/update-membership-status.md +6 -6
- package/docs/examples/teams/update-membership.md +5 -5
- package/docs/examples/teams/update-name.md +4 -4
- package/docs/examples/teams/update-prefs.md +4 -4
- package/docs/examples/tokens/create-file-token.md +5 -5
- package/docs/examples/tokens/delete.md +3 -3
- package/docs/examples/tokens/get.md +3 -3
- package/docs/examples/tokens/list.md +6 -5
- package/docs/examples/tokens/update.md +4 -4
- package/docs/examples/users/{create-m-d5user.md → create-argon-2-user.md} +6 -6
- package/docs/examples/users/create-bcrypt-user.md +6 -6
- package/docs/examples/users/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/users/{create-argon2user.md → create-md-5-user.md} +6 -6
- package/docs/examples/users/create-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/{create-p-h-pass-user.md → create-ph-pass-user.md} +6 -6
- package/docs/examples/users/create-scrypt-modified-user.md +9 -9
- package/docs/examples/users/create-scrypt-user.md +11 -11
- package/docs/examples/users/create-session.md +3 -3
- package/docs/examples/users/{create-s-h-a-user.md → create-sha-user.md} +7 -7
- package/docs/examples/users/create-target.md +8 -8
- package/docs/examples/users/create-token.md +5 -5
- package/docs/examples/users/create.md +7 -7
- package/docs/examples/users/delete-identity.md +3 -3
- package/docs/examples/users/delete-mfa-authenticator.md +4 -4
- package/docs/examples/users/delete-session.md +4 -4
- package/docs/examples/users/delete-sessions.md +3 -3
- package/docs/examples/users/delete-target.md +4 -4
- package/docs/examples/users/delete.md +3 -3
- package/docs/examples/users/get-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/get-prefs.md +3 -3
- package/docs/examples/users/get-target.md +4 -4
- package/docs/examples/users/get-usage.md +4 -4
- package/docs/examples/users/get.md +3 -3
- package/docs/examples/users/list-identities.md +5 -4
- package/docs/examples/users/list-logs.md +5 -4
- package/docs/examples/users/list-memberships.md +6 -5
- package/docs/examples/users/list-mfa-factors.md +3 -3
- package/docs/examples/users/list-sessions.md +4 -3
- package/docs/examples/users/list-targets.md +5 -4
- package/docs/examples/users/list.md +5 -4
- package/docs/examples/users/update-email-verification.md +4 -4
- package/docs/examples/users/update-email.md +4 -4
- package/docs/examples/users/update-labels.md +4 -4
- package/docs/examples/users/update-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/update-mfa.md +4 -4
- package/docs/examples/users/update-name.md +4 -4
- package/docs/examples/users/update-password.md +4 -4
- package/docs/examples/users/update-phone-verification.md +4 -4
- package/docs/examples/users/update-phone.md +4 -4
- package/docs/examples/users/update-prefs.md +4 -4
- package/docs/examples/users/update-status.md +4 -4
- package/docs/examples/users/update-target.md +7 -7
- package/docs/examples/vcs/create-repository-detection.md +6 -6
- package/docs/examples/vcs/create-repository.md +5 -5
- package/docs/examples/vcs/delete-installation.md +3 -3
- package/docs/examples/vcs/get-installation.md +3 -3
- package/docs/examples/vcs/get-repository-contents.md +6 -6
- package/docs/examples/vcs/get-repository.md +4 -4
- package/docs/examples/vcs/list-installations.md +5 -4
- package/docs/examples/vcs/list-repositories.md +6 -5
- package/docs/examples/vcs/list-repository-branches.md +4 -4
- package/docs/examples/vcs/update-external-deployments.md +5 -5
- package/package.json +4 -4
- package/src/client.ts +71 -7
- package/src/enums/api-service.ts +1 -0
- package/src/enums/attribute-status.ts +7 -0
- package/src/enums/billing-plan-group.ts +5 -0
- package/src/enums/build-runtime.ts +2 -0
- package/src/enums/column-status.ts +7 -0
- package/src/enums/credit-card.ts +1 -1
- package/src/enums/database-type.ts +4 -0
- package/src/enums/deployment-status.ts +7 -0
- package/src/enums/execution-method.ts +1 -0
- package/src/enums/execution-status.ts +7 -0
- package/src/enums/execution-trigger.ts +5 -0
- package/src/enums/framework.ts +1 -0
- package/src/enums/health-antivirus-status.ts +5 -0
- package/src/enums/health-check-status.ts +4 -0
- package/src/enums/index-status.ts +7 -0
- package/src/enums/index-type.ts +1 -0
- package/src/enums/message-status.ts +7 -0
- package/src/enums/o-auth-provider.ts +3 -0
- package/src/enums/platform.ts +4 -0
- package/src/enums/proxy-rule-deployment-resource-type.ts +4 -0
- package/src/enums/proxy-rule-status.ts +6 -0
- package/src/enums/region.ts +3 -0
- package/src/enums/runtime.ts +2 -0
- package/src/enums/status.ts +4 -0
- package/src/enums/template-reference-type.ts +5 -0
- package/src/enums/theme.ts +4 -0
- package/src/enums/timezone.ts +421 -0
- package/src/enums/{user-usage-range.ts → usage-range.ts} +1 -1
- package/src/enums/{v-c-s-deployment-type.ts → vcs-reference-type.ts} +1 -1
- package/src/index.ts +27 -11
- package/src/models.ts +1692 -238
- package/src/operator.ts +308 -0
- package/src/query.ts +246 -2
- package/src/services/account.ts +2205 -223
- package/src/services/assistant.ts +29 -3
- package/src/services/avatars.ts +486 -33
- package/src/services/backups.ts +389 -42
- package/src/services/console.ts +492 -19
- package/src/services/databases.ts +3521 -431
- package/src/services/domains.ts +1684 -197
- package/src/services/functions.ts +1162 -149
- package/src/services/graphql.ts +55 -4
- package/src/services/health.ts +560 -41
- package/src/services/locale.ts +9 -0
- package/src/services/messaging.ts +3367 -380
- package/src/services/migrations.ts +641 -65
- package/src/services/organizations.ts +1323 -128
- package/src/services/project.ts +168 -17
- package/src/services/projects.ts +2742 -266
- package/src/services/proxy.ts +265 -26
- package/src/services/realtime.ts +437 -0
- package/src/services/sites.ts +1098 -140
- package/src/services/storage.ts +651 -82
- package/src/services/tables-db.ts +5439 -0
- package/src/services/teams.ts +512 -55
- package/src/services/tokens.ts +167 -16
- package/src/services/users.ts +1873 -181
- package/src/services/vcs.ts +359 -39
- package/types/client.d.ts +33 -5
- package/types/enums/api-service.d.ts +1 -0
- package/types/enums/attribute-status.d.ts +7 -0
- package/types/enums/billing-plan-group.d.ts +5 -0
- package/types/enums/build-runtime.d.ts +3 -1
- package/types/enums/column-status.d.ts +7 -0
- package/types/enums/credit-card.d.ts +1 -1
- package/types/enums/database-type.d.ts +4 -0
- package/types/enums/deployment-status.d.ts +7 -0
- package/types/enums/execution-method.d.ts +2 -1
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/framework.d.ts +1 -0
- package/types/enums/health-antivirus-status.d.ts +5 -0
- package/types/enums/health-check-status.d.ts +4 -0
- package/types/enums/index-status.d.ts +7 -0
- package/types/enums/index-type.d.ts +2 -1
- package/types/enums/message-status.d.ts +7 -0
- package/types/enums/o-auth-provider.d.ts +4 -1
- package/types/enums/platform.d.ts +4 -0
- package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
- package/types/enums/proxy-rule-status.d.ts +6 -0
- package/types/enums/region.d.ts +4 -1
- package/types/enums/runtime.d.ts +3 -1
- package/types/enums/status.d.ts +4 -0
- package/types/enums/template-reference-type.d.ts +5 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +421 -0
- package/types/enums/{site-usage-range.d.ts → usage-range.d.ts} +1 -1
- package/types/enums/{v-c-s-deployment-type.d.ts → vcs-reference-type.d.ts} +1 -1
- package/types/index.d.ts +27 -11
- package/types/models.d.ts +1664 -245
- package/types/operator.d.ts +180 -0
- package/types/query.d.ts +198 -2
- package/types/services/account.d.ts +985 -123
- package/types/services/assistant.d.ts +13 -2
- package/types/services/avatars.d.ts +244 -26
- package/types/services/backups.d.ts +190 -30
- package/types/services/console.d.ts +201 -14
- package/types/services/databases.d.ts +1731 -284
- package/types/services/domains.d.ts +904 -152
- package/types/services/functions.d.ts +616 -125
- package/types/services/graphql.d.ts +24 -2
- package/types/services/health.d.ts +245 -23
- package/types/services/messaging.d.ts +1660 -271
- package/types/services/migrations.d.ts +319 -53
- package/types/services/organizations.d.ts +635 -97
- package/types/services/project.d.ts +81 -12
- package/types/services/projects.d.ts +1308 -202
- package/types/services/proxy.d.ts +128 -19
- package/types/services/realtime.d.ts +118 -0
- package/types/services/sites.d.ts +577 -116
- package/types/services/storage.d.ts +354 -73
- package/types/services/tables-db.d.ts +2040 -0
- package/types/services/teams.d.ts +260 -44
- package/types/services/tokens.d.ts +80 -12
- package/types/services/users.d.ts +881 -124
- package/types/services/vcs.d.ts +179 -31
- package/docs/examples/domains/create-record-m-x.md +0 -18
- package/docs/examples/domains/create-record-s-r-v.md +0 -20
- package/docs/examples/domains/create-record-t-x-t.md +0 -17
- package/docs/examples/domains/update-record-a-a-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-n-a-m-e.md +0 -18
- package/docs/examples/domains/update-record-h-t-t-p-s.md +0 -18
- package/docs/examples/domains/update-record-m-x.md +0 -19
- package/docs/examples/domains/update-record-n-s.md +0 -18
- package/docs/examples/domains/update-record-s-r-v.md +0 -21
- package/docs/examples/domains/update-record-t-x-t.md +0 -18
- package/src/enums/billing-plan.ts +0 -5
- package/src/enums/database-usage-range.ts +0 -5
- package/src/enums/function-usage-range.ts +0 -5
- package/src/enums/site-usage-range.ts +0 -5
- package/src/enums/storage-usage-range.ts +0 -5
- package/types/enums/billing-plan.d.ts +0 -5
- package/types/enums/database-usage-range.d.ts +0 -5
- package/types/enums/function-usage-range.d.ts +0 -5
- package/types/enums/storage-usage-range.d.ts +0 -5
- package/types/enums/user-usage-range.d.ts +0 -5
- /package/docs/examples/health/{get-d-b.md → get-db.md} +0 -0
- /package/docs/examples/locale/{list-countries-e-u.md → list-countries-eu.md} +0 -0
- /package/src/enums/{s-m-t-p-secure.ts → smtp-secure.ts} +0 -0
- /package/src/enums/{v-c-s-detection-type.ts → vcs-detection-type.ts} +0 -0
- /package/types/enums/{s-m-t-p-secure.d.ts → smtp-secure.d.ts} +0 -0
- /package/types/enums/{v-c-s-detection-type.d.ts → vcs-detection-type.d.ts} +0 -0
|
@@ -1,427 +1,1184 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
3
|
import { PasswordHash } from '../enums/password-hash';
|
|
4
|
-
import {
|
|
4
|
+
import { UsageRange } from '../enums/usage-range';
|
|
5
5
|
import { AuthenticatorType } from '../enums/authenticator-type';
|
|
6
6
|
import { MessagingProviderType } from '../enums/messaging-provider-type';
|
|
7
7
|
export declare class Users {
|
|
8
8
|
client: Client;
|
|
9
9
|
constructor(client: Client);
|
|
10
10
|
/**
|
|
11
|
-
* Get a list of all the project
|
|
11
|
+
* Get a list of all the project's users. You can use the query params to filter your results.
|
|
12
12
|
*
|
|
13
|
-
* @param {string[]} queries
|
|
14
|
-
* @param {string} search
|
|
13
|
+
* @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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
|
|
14
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
15
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
15
16
|
* @throws {AppwriteException}
|
|
16
17
|
* @returns {Promise<Models.UserList<Preferences>>}
|
|
17
18
|
*/
|
|
18
|
-
list<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
19
|
+
list<Preferences extends Models.Preferences = Models.DefaultPreferences>(params?: {
|
|
20
|
+
queries?: string[];
|
|
21
|
+
search?: string;
|
|
22
|
+
total?: boolean;
|
|
23
|
+
}): Promise<Models.UserList<Preferences>>;
|
|
24
|
+
/**
|
|
25
|
+
* Get a list of all the project's users. You can use the query params to filter your results.
|
|
26
|
+
*
|
|
27
|
+
* @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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
|
|
28
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
29
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
30
|
+
* @throws {AppwriteException}
|
|
31
|
+
* @returns {Promise<Models.UserList<Preferences>>}
|
|
32
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
33
|
+
*/
|
|
34
|
+
list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string, total?: boolean): Promise<Models.UserList<Preferences>>;
|
|
35
|
+
/**
|
|
36
|
+
* Create a new user.
|
|
37
|
+
*
|
|
38
|
+
* @param {string} params.userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
39
|
+
* @param {string} params.email - User email.
|
|
40
|
+
* @param {string} params.phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
41
|
+
* @param {string} params.password - Plain text user password. Must be at least 8 chars.
|
|
42
|
+
* @param {string} params.name - User name. Max length: 128 chars.
|
|
43
|
+
* @throws {AppwriteException}
|
|
44
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
45
|
+
*/
|
|
46
|
+
create<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
47
|
+
userId: string;
|
|
48
|
+
email?: string;
|
|
49
|
+
phone?: string;
|
|
50
|
+
password?: string;
|
|
51
|
+
name?: string;
|
|
52
|
+
}): Promise<Models.User<Preferences>>;
|
|
19
53
|
/**
|
|
20
54
|
* Create a new user.
|
|
21
55
|
*
|
|
22
|
-
* @param {string} userId
|
|
23
|
-
* @param {string} email
|
|
24
|
-
* @param {string} phone
|
|
25
|
-
* @param {string} password
|
|
26
|
-
* @param {string} name
|
|
56
|
+
* @param {string} userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
57
|
+
* @param {string} email - User email.
|
|
58
|
+
* @param {string} phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
59
|
+
* @param {string} password - Plain text user password. Must be at least 8 chars.
|
|
60
|
+
* @param {string} name - User name. Max length: 128 chars.
|
|
27
61
|
* @throws {AppwriteException}
|
|
28
62
|
* @returns {Promise<Models.User<Preferences>>}
|
|
63
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
29
64
|
*/
|
|
30
65
|
create<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email?: string, phone?: string, password?: string, name?: string): Promise<Models.User<Preferences>>;
|
|
31
66
|
/**
|
|
32
67
|
* Create a new user. Password provided must be hashed with the [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
33
68
|
*
|
|
34
|
-
* @param {string} userId
|
|
35
|
-
* @param {string} email
|
|
36
|
-
* @param {string} password
|
|
37
|
-
* @param {string} name
|
|
69
|
+
* @param {string} params.userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
70
|
+
* @param {string} params.email - User email.
|
|
71
|
+
* @param {string} params.password - User password hashed using Argon2.
|
|
72
|
+
* @param {string} params.name - User name. Max length: 128 chars.
|
|
38
73
|
* @throws {AppwriteException}
|
|
39
74
|
* @returns {Promise<Models.User<Preferences>>}
|
|
40
75
|
*/
|
|
76
|
+
createArgon2User<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
77
|
+
userId: string;
|
|
78
|
+
email: string;
|
|
79
|
+
password: string;
|
|
80
|
+
name?: string;
|
|
81
|
+
}): Promise<Models.User<Preferences>>;
|
|
82
|
+
/**
|
|
83
|
+
* Create a new user. Password provided must be hashed with the [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
84
|
+
*
|
|
85
|
+
* @param {string} userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
86
|
+
* @param {string} email - User email.
|
|
87
|
+
* @param {string} password - User password hashed using Argon2.
|
|
88
|
+
* @param {string} name - User name. Max length: 128 chars.
|
|
89
|
+
* @throws {AppwriteException}
|
|
90
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
91
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
92
|
+
*/
|
|
41
93
|
createArgon2User<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
42
94
|
/**
|
|
43
95
|
* Create a new user. Password provided must be hashed with the [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
44
96
|
*
|
|
45
|
-
* @param {string} userId
|
|
46
|
-
* @param {string} email
|
|
47
|
-
* @param {string} password
|
|
48
|
-
* @param {string} name
|
|
97
|
+
* @param {string} params.userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
98
|
+
* @param {string} params.email - User email.
|
|
99
|
+
* @param {string} params.password - User password hashed using Bcrypt.
|
|
100
|
+
* @param {string} params.name - User name. Max length: 128 chars.
|
|
101
|
+
* @throws {AppwriteException}
|
|
102
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
103
|
+
*/
|
|
104
|
+
createBcryptUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
105
|
+
userId: string;
|
|
106
|
+
email: string;
|
|
107
|
+
password: string;
|
|
108
|
+
name?: string;
|
|
109
|
+
}): Promise<Models.User<Preferences>>;
|
|
110
|
+
/**
|
|
111
|
+
* Create a new user. Password provided must be hashed with the [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
112
|
+
*
|
|
113
|
+
* @param {string} userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
114
|
+
* @param {string} email - User email.
|
|
115
|
+
* @param {string} password - User password hashed using Bcrypt.
|
|
116
|
+
* @param {string} name - User name. Max length: 128 chars.
|
|
49
117
|
* @throws {AppwriteException}
|
|
50
118
|
* @returns {Promise<Models.User<Preferences>>}
|
|
119
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
51
120
|
*/
|
|
52
121
|
createBcryptUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
53
122
|
/**
|
|
54
123
|
* Get identities for all users.
|
|
55
124
|
*
|
|
56
|
-
* @param {string[]} queries
|
|
57
|
-
* @param {string} search
|
|
125
|
+
* @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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
|
|
126
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
127
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
58
128
|
* @throws {AppwriteException}
|
|
59
129
|
* @returns {Promise<Models.IdentityList>}
|
|
60
130
|
*/
|
|
61
|
-
listIdentities(
|
|
131
|
+
listIdentities(params?: {
|
|
132
|
+
queries?: string[];
|
|
133
|
+
search?: string;
|
|
134
|
+
total?: boolean;
|
|
135
|
+
}): Promise<Models.IdentityList>;
|
|
136
|
+
/**
|
|
137
|
+
* Get identities for all users.
|
|
138
|
+
*
|
|
139
|
+
* @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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
|
|
140
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
141
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
142
|
+
* @throws {AppwriteException}
|
|
143
|
+
* @returns {Promise<Models.IdentityList>}
|
|
144
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
145
|
+
*/
|
|
146
|
+
listIdentities(queries?: string[], search?: string, total?: boolean): Promise<Models.IdentityList>;
|
|
62
147
|
/**
|
|
63
148
|
* Delete an identity by its unique ID.
|
|
64
149
|
*
|
|
65
|
-
* @param {string} identityId
|
|
150
|
+
* @param {string} params.identityId - Identity ID.
|
|
66
151
|
* @throws {AppwriteException}
|
|
67
152
|
* @returns {Promise<{}>}
|
|
68
153
|
*/
|
|
154
|
+
deleteIdentity(params: {
|
|
155
|
+
identityId: string;
|
|
156
|
+
}): Promise<{}>;
|
|
157
|
+
/**
|
|
158
|
+
* Delete an identity by its unique ID.
|
|
159
|
+
*
|
|
160
|
+
* @param {string} identityId - Identity ID.
|
|
161
|
+
* @throws {AppwriteException}
|
|
162
|
+
* @returns {Promise<{}>}
|
|
163
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
164
|
+
*/
|
|
69
165
|
deleteIdentity(identityId: string): Promise<{}>;
|
|
70
166
|
/**
|
|
71
167
|
* Create a new user. Password provided must be hashed with the [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
72
168
|
*
|
|
73
|
-
* @param {string} userId
|
|
74
|
-
* @param {string} email
|
|
75
|
-
* @param {string} password
|
|
76
|
-
* @param {string} name
|
|
169
|
+
* @param {string} params.userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
170
|
+
* @param {string} params.email - User email.
|
|
171
|
+
* @param {string} params.password - User password hashed using MD5.
|
|
172
|
+
* @param {string} params.name - User name. Max length: 128 chars.
|
|
173
|
+
* @throws {AppwriteException}
|
|
174
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
175
|
+
*/
|
|
176
|
+
createMD5User<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
177
|
+
userId: string;
|
|
178
|
+
email: string;
|
|
179
|
+
password: string;
|
|
180
|
+
name?: string;
|
|
181
|
+
}): Promise<Models.User<Preferences>>;
|
|
182
|
+
/**
|
|
183
|
+
* Create a new user. Password provided must be hashed with the [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
184
|
+
*
|
|
185
|
+
* @param {string} userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
186
|
+
* @param {string} email - User email.
|
|
187
|
+
* @param {string} password - User password hashed using MD5.
|
|
188
|
+
* @param {string} name - User name. Max length: 128 chars.
|
|
77
189
|
* @throws {AppwriteException}
|
|
78
190
|
* @returns {Promise<Models.User<Preferences>>}
|
|
191
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
79
192
|
*/
|
|
80
193
|
createMD5User<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
81
194
|
/**
|
|
82
195
|
* Create a new user. Password provided must be hashed with the [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
83
196
|
*
|
|
84
|
-
* @param {string} userId
|
|
85
|
-
* @param {string} email
|
|
86
|
-
* @param {string} password
|
|
87
|
-
* @param {string} name
|
|
197
|
+
* @param {string} params.userId - User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
198
|
+
* @param {string} params.email - User email.
|
|
199
|
+
* @param {string} params.password - User password hashed using PHPass.
|
|
200
|
+
* @param {string} params.name - User name. Max length: 128 chars.
|
|
88
201
|
* @throws {AppwriteException}
|
|
89
202
|
* @returns {Promise<Models.User<Preferences>>}
|
|
90
203
|
*/
|
|
204
|
+
createPHPassUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
205
|
+
userId: string;
|
|
206
|
+
email: string;
|
|
207
|
+
password: string;
|
|
208
|
+
name?: string;
|
|
209
|
+
}): Promise<Models.User<Preferences>>;
|
|
210
|
+
/**
|
|
211
|
+
* Create a new user. Password provided must be hashed with the [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
212
|
+
*
|
|
213
|
+
* @param {string} userId - User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
214
|
+
* @param {string} email - User email.
|
|
215
|
+
* @param {string} password - User password hashed using PHPass.
|
|
216
|
+
* @param {string} name - User name. Max length: 128 chars.
|
|
217
|
+
* @throws {AppwriteException}
|
|
218
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
219
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
220
|
+
*/
|
|
91
221
|
createPHPassUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
92
222
|
/**
|
|
93
223
|
* Create a new user. Password provided must be hashed with the [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
94
224
|
*
|
|
95
|
-
* @param {string} userId
|
|
96
|
-
* @param {string} email
|
|
97
|
-
* @param {string} password
|
|
98
|
-
* @param {string} passwordSalt
|
|
99
|
-
* @param {number} passwordCpu
|
|
100
|
-
* @param {number} passwordMemory
|
|
101
|
-
* @param {number} passwordParallel
|
|
102
|
-
* @param {number} passwordLength
|
|
103
|
-
* @param {string} name
|
|
225
|
+
* @param {string} params.userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
226
|
+
* @param {string} params.email - User email.
|
|
227
|
+
* @param {string} params.password - User password hashed using Scrypt.
|
|
228
|
+
* @param {string} params.passwordSalt - Optional salt used to hash password.
|
|
229
|
+
* @param {number} params.passwordCpu - Optional CPU cost used to hash password.
|
|
230
|
+
* @param {number} params.passwordMemory - Optional memory cost used to hash password.
|
|
231
|
+
* @param {number} params.passwordParallel - Optional parallelization cost used to hash password.
|
|
232
|
+
* @param {number} params.passwordLength - Optional hash length used to hash password.
|
|
233
|
+
* @param {string} params.name - User name. Max length: 128 chars.
|
|
234
|
+
* @throws {AppwriteException}
|
|
235
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
236
|
+
*/
|
|
237
|
+
createScryptUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
238
|
+
userId: string;
|
|
239
|
+
email: string;
|
|
240
|
+
password: string;
|
|
241
|
+
passwordSalt: string;
|
|
242
|
+
passwordCpu: number;
|
|
243
|
+
passwordMemory: number;
|
|
244
|
+
passwordParallel: number;
|
|
245
|
+
passwordLength: number;
|
|
246
|
+
name?: string;
|
|
247
|
+
}): Promise<Models.User<Preferences>>;
|
|
248
|
+
/**
|
|
249
|
+
* Create a new user. Password provided must be hashed with the [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
250
|
+
*
|
|
251
|
+
* @param {string} userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
252
|
+
* @param {string} email - User email.
|
|
253
|
+
* @param {string} password - User password hashed using Scrypt.
|
|
254
|
+
* @param {string} passwordSalt - Optional salt used to hash password.
|
|
255
|
+
* @param {number} passwordCpu - Optional CPU cost used to hash password.
|
|
256
|
+
* @param {number} passwordMemory - Optional memory cost used to hash password.
|
|
257
|
+
* @param {number} passwordParallel - Optional parallelization cost used to hash password.
|
|
258
|
+
* @param {number} passwordLength - Optional hash length used to hash password.
|
|
259
|
+
* @param {string} name - User name. Max length: 128 chars.
|
|
104
260
|
* @throws {AppwriteException}
|
|
105
261
|
* @returns {Promise<Models.User<Preferences>>}
|
|
262
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
106
263
|
*/
|
|
107
264
|
createScryptUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, passwordSalt: string, passwordCpu: number, passwordMemory: number, passwordParallel: number, passwordLength: number, name?: string): Promise<Models.User<Preferences>>;
|
|
108
265
|
/**
|
|
109
266
|
* Create a new user. Password provided must be hashed with the [Scrypt Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
110
267
|
*
|
|
111
|
-
* @param {string} userId
|
|
112
|
-
* @param {string} email
|
|
113
|
-
* @param {string} password
|
|
114
|
-
* @param {string} passwordSalt
|
|
115
|
-
* @param {string} passwordSaltSeparator
|
|
116
|
-
* @param {string} passwordSignerKey
|
|
117
|
-
* @param {string} name
|
|
268
|
+
* @param {string} params.userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
269
|
+
* @param {string} params.email - User email.
|
|
270
|
+
* @param {string} params.password - User password hashed using Scrypt Modified.
|
|
271
|
+
* @param {string} params.passwordSalt - Salt used to hash password.
|
|
272
|
+
* @param {string} params.passwordSaltSeparator - Salt separator used to hash password.
|
|
273
|
+
* @param {string} params.passwordSignerKey - Signer key used to hash password.
|
|
274
|
+
* @param {string} params.name - User name. Max length: 128 chars.
|
|
118
275
|
* @throws {AppwriteException}
|
|
119
276
|
* @returns {Promise<Models.User<Preferences>>}
|
|
120
277
|
*/
|
|
278
|
+
createScryptModifiedUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
279
|
+
userId: string;
|
|
280
|
+
email: string;
|
|
281
|
+
password: string;
|
|
282
|
+
passwordSalt: string;
|
|
283
|
+
passwordSaltSeparator: string;
|
|
284
|
+
passwordSignerKey: string;
|
|
285
|
+
name?: string;
|
|
286
|
+
}): Promise<Models.User<Preferences>>;
|
|
287
|
+
/**
|
|
288
|
+
* Create a new user. Password provided must be hashed with the [Scrypt Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
289
|
+
*
|
|
290
|
+
* @param {string} userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
291
|
+
* @param {string} email - User email.
|
|
292
|
+
* @param {string} password - User password hashed using Scrypt Modified.
|
|
293
|
+
* @param {string} passwordSalt - Salt used to hash password.
|
|
294
|
+
* @param {string} passwordSaltSeparator - Salt separator used to hash password.
|
|
295
|
+
* @param {string} passwordSignerKey - Signer key used to hash password.
|
|
296
|
+
* @param {string} name - User name. Max length: 128 chars.
|
|
297
|
+
* @throws {AppwriteException}
|
|
298
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
299
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
300
|
+
*/
|
|
121
301
|
createScryptModifiedUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, passwordSalt: string, passwordSaltSeparator: string, passwordSignerKey: string, name?: string): Promise<Models.User<Preferences>>;
|
|
122
302
|
/**
|
|
123
303
|
* Create a new user. Password provided must be hashed with the [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
124
304
|
*
|
|
125
|
-
* @param {string} userId
|
|
126
|
-
* @param {string} email
|
|
127
|
-
* @param {string} password
|
|
128
|
-
* @param {PasswordHash} passwordVersion
|
|
129
|
-
* @param {string} name
|
|
305
|
+
* @param {string} params.userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
306
|
+
* @param {string} params.email - User email.
|
|
307
|
+
* @param {string} params.password - User password hashed using SHA.
|
|
308
|
+
* @param {PasswordHash} params.passwordVersion - Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512/224', 'sha512/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'
|
|
309
|
+
* @param {string} params.name - User name. Max length: 128 chars.
|
|
130
310
|
* @throws {AppwriteException}
|
|
131
311
|
* @returns {Promise<Models.User<Preferences>>}
|
|
132
312
|
*/
|
|
313
|
+
createSHAUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
314
|
+
userId: string;
|
|
315
|
+
email: string;
|
|
316
|
+
password: string;
|
|
317
|
+
passwordVersion?: PasswordHash;
|
|
318
|
+
name?: string;
|
|
319
|
+
}): Promise<Models.User<Preferences>>;
|
|
320
|
+
/**
|
|
321
|
+
* Create a new user. Password provided must be hashed with the [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
322
|
+
*
|
|
323
|
+
* @param {string} userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
324
|
+
* @param {string} email - User email.
|
|
325
|
+
* @param {string} password - User password hashed using SHA.
|
|
326
|
+
* @param {PasswordHash} passwordVersion - Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512/224', 'sha512/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'
|
|
327
|
+
* @param {string} name - User name. Max length: 128 chars.
|
|
328
|
+
* @throws {AppwriteException}
|
|
329
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
330
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
331
|
+
*/
|
|
133
332
|
createSHAUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, passwordVersion?: PasswordHash, name?: string): Promise<Models.User<Preferences>>;
|
|
134
333
|
/**
|
|
135
334
|
* Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
|
|
136
335
|
*
|
|
137
336
|
*
|
|
138
|
-
* @param {
|
|
337
|
+
* @param {UsageRange} params.range - Date range.
|
|
338
|
+
* @throws {AppwriteException}
|
|
339
|
+
* @returns {Promise<Models.UsageUsers>}
|
|
340
|
+
*/
|
|
341
|
+
getUsage(params?: {
|
|
342
|
+
range?: UsageRange;
|
|
343
|
+
}): Promise<Models.UsageUsers>;
|
|
344
|
+
/**
|
|
345
|
+
* Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
|
|
346
|
+
*
|
|
347
|
+
*
|
|
348
|
+
* @param {UsageRange} range - Date range.
|
|
139
349
|
* @throws {AppwriteException}
|
|
140
350
|
* @returns {Promise<Models.UsageUsers>}
|
|
351
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
352
|
+
*/
|
|
353
|
+
getUsage(range?: UsageRange): Promise<Models.UsageUsers>;
|
|
354
|
+
/**
|
|
355
|
+
* Get a user by its unique ID.
|
|
356
|
+
*
|
|
357
|
+
* @param {string} params.userId - User ID.
|
|
358
|
+
* @throws {AppwriteException}
|
|
359
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
141
360
|
*/
|
|
142
|
-
|
|
361
|
+
get<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
362
|
+
userId: string;
|
|
363
|
+
}): Promise<Models.User<Preferences>>;
|
|
143
364
|
/**
|
|
144
365
|
* Get a user by its unique ID.
|
|
145
366
|
*
|
|
146
|
-
* @param {string} userId
|
|
367
|
+
* @param {string} userId - User ID.
|
|
147
368
|
* @throws {AppwriteException}
|
|
148
369
|
* @returns {Promise<Models.User<Preferences>>}
|
|
370
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
149
371
|
*/
|
|
150
372
|
get<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string): Promise<Models.User<Preferences>>;
|
|
151
373
|
/**
|
|
152
|
-
* Delete a user by its unique ID, thereby releasing it
|
|
374
|
+
* Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) endpoint instead.
|
|
375
|
+
*
|
|
376
|
+
* @param {string} params.userId - User ID.
|
|
377
|
+
* @throws {AppwriteException}
|
|
378
|
+
* @returns {Promise<{}>}
|
|
379
|
+
*/
|
|
380
|
+
delete(params: {
|
|
381
|
+
userId: string;
|
|
382
|
+
}): Promise<{}>;
|
|
383
|
+
/**
|
|
384
|
+
* Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) endpoint instead.
|
|
153
385
|
*
|
|
154
|
-
* @param {string} userId
|
|
386
|
+
* @param {string} userId - User ID.
|
|
155
387
|
* @throws {AppwriteException}
|
|
156
388
|
* @returns {Promise<{}>}
|
|
389
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
157
390
|
*/
|
|
158
391
|
delete(userId: string): Promise<{}>;
|
|
159
392
|
/**
|
|
160
393
|
* Update the user email by its unique ID.
|
|
161
394
|
*
|
|
162
|
-
* @param {string} userId
|
|
163
|
-
* @param {string} email
|
|
395
|
+
* @param {string} params.userId - User ID.
|
|
396
|
+
* @param {string} params.email - User email.
|
|
164
397
|
* @throws {AppwriteException}
|
|
165
398
|
* @returns {Promise<Models.User<Preferences>>}
|
|
166
399
|
*/
|
|
400
|
+
updateEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
401
|
+
userId: string;
|
|
402
|
+
email: string;
|
|
403
|
+
}): Promise<Models.User<Preferences>>;
|
|
404
|
+
/**
|
|
405
|
+
* Update the user email by its unique ID.
|
|
406
|
+
*
|
|
407
|
+
* @param {string} userId - User ID.
|
|
408
|
+
* @param {string} email - User email.
|
|
409
|
+
* @throws {AppwriteException}
|
|
410
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
411
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
412
|
+
*/
|
|
167
413
|
updateEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
|
|
168
414
|
/**
|
|
169
415
|
* Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.
|
|
170
416
|
*
|
|
171
|
-
* @param {string} userId
|
|
172
|
-
* @param {string} sessionId
|
|
173
|
-
* @param {number} duration
|
|
417
|
+
* @param {string} params.userId - User ID.
|
|
418
|
+
* @param {string} params.sessionId - Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.
|
|
419
|
+
* @param {number} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
174
420
|
* @throws {AppwriteException}
|
|
175
421
|
* @returns {Promise<Models.Jwt>}
|
|
176
422
|
*/
|
|
423
|
+
createJWT(params: {
|
|
424
|
+
userId: string;
|
|
425
|
+
sessionId?: string;
|
|
426
|
+
duration?: number;
|
|
427
|
+
}): Promise<Models.Jwt>;
|
|
428
|
+
/**
|
|
429
|
+
* Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.
|
|
430
|
+
*
|
|
431
|
+
* @param {string} userId - User ID.
|
|
432
|
+
* @param {string} sessionId - Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.
|
|
433
|
+
* @param {number} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
434
|
+
* @throws {AppwriteException}
|
|
435
|
+
* @returns {Promise<Models.Jwt>}
|
|
436
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
437
|
+
*/
|
|
177
438
|
createJWT(userId: string, sessionId?: string, duration?: number): Promise<Models.Jwt>;
|
|
178
439
|
/**
|
|
179
440
|
* Update the user labels by its unique ID.
|
|
180
441
|
*
|
|
181
|
-
* Labels can be used to grant access to resources. While teams are a way for user
|
|
442
|
+
* Labels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https://appwrite.io/docs/permissions) for more info.
|
|
443
|
+
*
|
|
444
|
+
* @param {string} params.userId - User ID.
|
|
445
|
+
* @param {string[]} params.labels - Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
|
|
446
|
+
* @throws {AppwriteException}
|
|
447
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
448
|
+
*/
|
|
449
|
+
updateLabels<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
450
|
+
userId: string;
|
|
451
|
+
labels: string[];
|
|
452
|
+
}): Promise<Models.User<Preferences>>;
|
|
453
|
+
/**
|
|
454
|
+
* Update the user labels by its unique ID.
|
|
455
|
+
*
|
|
456
|
+
* Labels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https://appwrite.io/docs/permissions) for more info.
|
|
182
457
|
*
|
|
183
|
-
* @param {string} userId
|
|
184
|
-
* @param {string[]} labels
|
|
458
|
+
* @param {string} userId - User ID.
|
|
459
|
+
* @param {string[]} labels - Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
|
|
185
460
|
* @throws {AppwriteException}
|
|
186
461
|
* @returns {Promise<Models.User<Preferences>>}
|
|
462
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
187
463
|
*/
|
|
188
464
|
updateLabels<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, labels: string[]): Promise<Models.User<Preferences>>;
|
|
189
465
|
/**
|
|
190
466
|
* Get the user activity logs list by its unique ID.
|
|
191
467
|
*
|
|
192
|
-
* @param {string} userId
|
|
193
|
-
* @param {string[]} queries
|
|
468
|
+
* @param {string} params.userId - User ID.
|
|
469
|
+
* @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). Only supported methods are limit and offset
|
|
470
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
194
471
|
* @throws {AppwriteException}
|
|
195
472
|
* @returns {Promise<Models.LogList>}
|
|
196
473
|
*/
|
|
197
|
-
listLogs(
|
|
474
|
+
listLogs(params: {
|
|
475
|
+
userId: string;
|
|
476
|
+
queries?: string[];
|
|
477
|
+
total?: boolean;
|
|
478
|
+
}): Promise<Models.LogList>;
|
|
479
|
+
/**
|
|
480
|
+
* Get the user activity logs list by its unique ID.
|
|
481
|
+
*
|
|
482
|
+
* @param {string} userId - User ID.
|
|
483
|
+
* @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). Only supported methods are limit and offset
|
|
484
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
485
|
+
* @throws {AppwriteException}
|
|
486
|
+
* @returns {Promise<Models.LogList>}
|
|
487
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
488
|
+
*/
|
|
489
|
+
listLogs(userId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
|
|
490
|
+
/**
|
|
491
|
+
* Get the user membership list by its unique ID.
|
|
492
|
+
*
|
|
493
|
+
* @param {string} params.userId - User ID.
|
|
494
|
+
* @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: userId, teamId, invited, joined, confirm, roles
|
|
495
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
496
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
497
|
+
* @throws {AppwriteException}
|
|
498
|
+
* @returns {Promise<Models.MembershipList>}
|
|
499
|
+
*/
|
|
500
|
+
listMemberships(params: {
|
|
501
|
+
userId: string;
|
|
502
|
+
queries?: string[];
|
|
503
|
+
search?: string;
|
|
504
|
+
total?: boolean;
|
|
505
|
+
}): Promise<Models.MembershipList>;
|
|
198
506
|
/**
|
|
199
507
|
* Get the user membership list by its unique ID.
|
|
200
508
|
*
|
|
201
|
-
* @param {string} userId
|
|
202
|
-
* @param {string[]} queries
|
|
203
|
-
* @param {string} search
|
|
509
|
+
* @param {string} userId - User ID.
|
|
510
|
+
* @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: userId, teamId, invited, joined, confirm, roles
|
|
511
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
512
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
204
513
|
* @throws {AppwriteException}
|
|
205
514
|
* @returns {Promise<Models.MembershipList>}
|
|
515
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
206
516
|
*/
|
|
207
|
-
listMemberships(userId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
|
|
517
|
+
listMemberships(userId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.MembershipList>;
|
|
208
518
|
/**
|
|
209
519
|
* Enable or disable MFA on a user account.
|
|
210
520
|
*
|
|
211
|
-
* @param {string} userId
|
|
212
|
-
* @param {boolean} mfa
|
|
521
|
+
* @param {string} params.userId - User ID.
|
|
522
|
+
* @param {boolean} params.mfa - Enable or disable MFA.
|
|
213
523
|
* @throws {AppwriteException}
|
|
214
524
|
* @returns {Promise<Models.User<Preferences>>}
|
|
525
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Users.updateMFA` instead.
|
|
526
|
+
*/
|
|
527
|
+
updateMfa<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
528
|
+
userId: string;
|
|
529
|
+
mfa: boolean;
|
|
530
|
+
}): Promise<Models.User<Preferences>>;
|
|
531
|
+
/**
|
|
532
|
+
* Enable or disable MFA on a user account.
|
|
533
|
+
*
|
|
534
|
+
* @param {string} userId - User ID.
|
|
535
|
+
* @param {boolean} mfa - Enable or disable MFA.
|
|
536
|
+
* @throws {AppwriteException}
|
|
537
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
538
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
215
539
|
*/
|
|
216
540
|
updateMfa<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, mfa: boolean): Promise<Models.User<Preferences>>;
|
|
541
|
+
/**
|
|
542
|
+
* Enable or disable MFA on a user account.
|
|
543
|
+
*
|
|
544
|
+
* @param {string} params.userId - User ID.
|
|
545
|
+
* @param {boolean} params.mfa - Enable or disable MFA.
|
|
546
|
+
* @throws {AppwriteException}
|
|
547
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
548
|
+
*/
|
|
549
|
+
updateMFA<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
550
|
+
userId: string;
|
|
551
|
+
mfa: boolean;
|
|
552
|
+
}): Promise<Models.User<Preferences>>;
|
|
553
|
+
/**
|
|
554
|
+
* Enable or disable MFA on a user account.
|
|
555
|
+
*
|
|
556
|
+
* @param {string} userId - User ID.
|
|
557
|
+
* @param {boolean} mfa - Enable or disable MFA.
|
|
558
|
+
* @throws {AppwriteException}
|
|
559
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
560
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
561
|
+
*/
|
|
562
|
+
updateMFA<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, mfa: boolean): Promise<Models.User<Preferences>>;
|
|
217
563
|
/**
|
|
218
564
|
* Delete an authenticator app.
|
|
219
565
|
*
|
|
220
|
-
* @param {string} userId
|
|
221
|
-
* @param {AuthenticatorType} type
|
|
566
|
+
* @param {string} params.userId - User ID.
|
|
567
|
+
* @param {AuthenticatorType} params.type - Type of authenticator.
|
|
222
568
|
* @throws {AppwriteException}
|
|
223
569
|
* @returns {Promise<{}>}
|
|
570
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Users.deleteMFAAuthenticator` instead.
|
|
571
|
+
*/
|
|
572
|
+
deleteMfaAuthenticator(params: {
|
|
573
|
+
userId: string;
|
|
574
|
+
type: AuthenticatorType;
|
|
575
|
+
}): Promise<{}>;
|
|
576
|
+
/**
|
|
577
|
+
* Delete an authenticator app.
|
|
578
|
+
*
|
|
579
|
+
* @param {string} userId - User ID.
|
|
580
|
+
* @param {AuthenticatorType} type - Type of authenticator.
|
|
581
|
+
* @throws {AppwriteException}
|
|
582
|
+
* @returns {Promise<{}>}
|
|
583
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
224
584
|
*/
|
|
225
585
|
deleteMfaAuthenticator(userId: string, type: AuthenticatorType): Promise<{}>;
|
|
586
|
+
/**
|
|
587
|
+
* Delete an authenticator app.
|
|
588
|
+
*
|
|
589
|
+
* @param {string} params.userId - User ID.
|
|
590
|
+
* @param {AuthenticatorType} params.type - Type of authenticator.
|
|
591
|
+
* @throws {AppwriteException}
|
|
592
|
+
* @returns {Promise<{}>}
|
|
593
|
+
*/
|
|
594
|
+
deleteMFAAuthenticator(params: {
|
|
595
|
+
userId: string;
|
|
596
|
+
type: AuthenticatorType;
|
|
597
|
+
}): Promise<{}>;
|
|
598
|
+
/**
|
|
599
|
+
* Delete an authenticator app.
|
|
600
|
+
*
|
|
601
|
+
* @param {string} userId - User ID.
|
|
602
|
+
* @param {AuthenticatorType} type - Type of authenticator.
|
|
603
|
+
* @throws {AppwriteException}
|
|
604
|
+
* @returns {Promise<{}>}
|
|
605
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
606
|
+
*/
|
|
607
|
+
deleteMFAAuthenticator(userId: string, type: AuthenticatorType): Promise<{}>;
|
|
608
|
+
/**
|
|
609
|
+
* List the factors available on the account to be used as a MFA challange.
|
|
610
|
+
*
|
|
611
|
+
* @param {string} params.userId - User ID.
|
|
612
|
+
* @throws {AppwriteException}
|
|
613
|
+
* @returns {Promise<Models.MfaFactors>}
|
|
614
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Users.listMFAFactors` instead.
|
|
615
|
+
*/
|
|
616
|
+
listMfaFactors(params: {
|
|
617
|
+
userId: string;
|
|
618
|
+
}): Promise<Models.MfaFactors>;
|
|
226
619
|
/**
|
|
227
620
|
* List the factors available on the account to be used as a MFA challange.
|
|
228
621
|
*
|
|
229
|
-
* @param {string} userId
|
|
622
|
+
* @param {string} userId - User ID.
|
|
230
623
|
* @throws {AppwriteException}
|
|
231
624
|
* @returns {Promise<Models.MfaFactors>}
|
|
625
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
232
626
|
*/
|
|
233
627
|
listMfaFactors(userId: string): Promise<Models.MfaFactors>;
|
|
628
|
+
/**
|
|
629
|
+
* List the factors available on the account to be used as a MFA challange.
|
|
630
|
+
*
|
|
631
|
+
* @param {string} params.userId - User ID.
|
|
632
|
+
* @throws {AppwriteException}
|
|
633
|
+
* @returns {Promise<Models.MfaFactors>}
|
|
634
|
+
*/
|
|
635
|
+
listMFAFactors(params: {
|
|
636
|
+
userId: string;
|
|
637
|
+
}): Promise<Models.MfaFactors>;
|
|
638
|
+
/**
|
|
639
|
+
* List the factors available on the account to be used as a MFA challange.
|
|
640
|
+
*
|
|
641
|
+
* @param {string} userId - User ID.
|
|
642
|
+
* @throws {AppwriteException}
|
|
643
|
+
* @returns {Promise<Models.MfaFactors>}
|
|
644
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
645
|
+
*/
|
|
646
|
+
listMFAFactors(userId: string): Promise<Models.MfaFactors>;
|
|
234
647
|
/**
|
|
235
648
|
* Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
|
|
236
649
|
*
|
|
237
|
-
* @param {string} userId
|
|
650
|
+
* @param {string} params.userId - User ID.
|
|
238
651
|
* @throws {AppwriteException}
|
|
239
652
|
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
653
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Users.getMFARecoveryCodes` instead.
|
|
654
|
+
*/
|
|
655
|
+
getMfaRecoveryCodes(params: {
|
|
656
|
+
userId: string;
|
|
657
|
+
}): Promise<Models.MfaRecoveryCodes>;
|
|
658
|
+
/**
|
|
659
|
+
* Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
|
|
660
|
+
*
|
|
661
|
+
* @param {string} userId - User ID.
|
|
662
|
+
* @throws {AppwriteException}
|
|
663
|
+
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
664
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
240
665
|
*/
|
|
241
666
|
getMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
|
|
667
|
+
/**
|
|
668
|
+
* Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
|
|
669
|
+
*
|
|
670
|
+
* @param {string} params.userId - User ID.
|
|
671
|
+
* @throws {AppwriteException}
|
|
672
|
+
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
673
|
+
*/
|
|
674
|
+
getMFARecoveryCodes(params: {
|
|
675
|
+
userId: string;
|
|
676
|
+
}): Promise<Models.MfaRecoveryCodes>;
|
|
677
|
+
/**
|
|
678
|
+
* Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
|
|
679
|
+
*
|
|
680
|
+
* @param {string} userId - User ID.
|
|
681
|
+
* @throws {AppwriteException}
|
|
682
|
+
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
683
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
684
|
+
*/
|
|
685
|
+
getMFARecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
|
|
242
686
|
/**
|
|
243
687
|
* Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
|
|
244
688
|
*
|
|
245
|
-
* @param {string} userId
|
|
689
|
+
* @param {string} params.userId - User ID.
|
|
246
690
|
* @throws {AppwriteException}
|
|
247
691
|
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
692
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Users.updateMFARecoveryCodes` instead.
|
|
693
|
+
*/
|
|
694
|
+
updateMfaRecoveryCodes(params: {
|
|
695
|
+
userId: string;
|
|
696
|
+
}): Promise<Models.MfaRecoveryCodes>;
|
|
697
|
+
/**
|
|
698
|
+
* Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
|
|
699
|
+
*
|
|
700
|
+
* @param {string} userId - User ID.
|
|
701
|
+
* @throws {AppwriteException}
|
|
702
|
+
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
703
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
248
704
|
*/
|
|
249
705
|
updateMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
|
|
706
|
+
/**
|
|
707
|
+
* Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
|
|
708
|
+
*
|
|
709
|
+
* @param {string} params.userId - User ID.
|
|
710
|
+
* @throws {AppwriteException}
|
|
711
|
+
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
712
|
+
*/
|
|
713
|
+
updateMFARecoveryCodes(params: {
|
|
714
|
+
userId: string;
|
|
715
|
+
}): Promise<Models.MfaRecoveryCodes>;
|
|
716
|
+
/**
|
|
717
|
+
* Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
|
|
718
|
+
*
|
|
719
|
+
* @param {string} userId - User ID.
|
|
720
|
+
* @throws {AppwriteException}
|
|
721
|
+
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
722
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
723
|
+
*/
|
|
724
|
+
updateMFARecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
|
|
250
725
|
/**
|
|
251
726
|
* Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method by client SDK.
|
|
252
727
|
*
|
|
253
|
-
* @param {string} userId
|
|
728
|
+
* @param {string} params.userId - User ID.
|
|
254
729
|
* @throws {AppwriteException}
|
|
255
730
|
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
731
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Users.createMFARecoveryCodes` instead.
|
|
732
|
+
*/
|
|
733
|
+
createMfaRecoveryCodes(params: {
|
|
734
|
+
userId: string;
|
|
735
|
+
}): Promise<Models.MfaRecoveryCodes>;
|
|
736
|
+
/**
|
|
737
|
+
* Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method by client SDK.
|
|
738
|
+
*
|
|
739
|
+
* @param {string} userId - User ID.
|
|
740
|
+
* @throws {AppwriteException}
|
|
741
|
+
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
742
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
256
743
|
*/
|
|
257
744
|
createMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
|
|
745
|
+
/**
|
|
746
|
+
* Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method by client SDK.
|
|
747
|
+
*
|
|
748
|
+
* @param {string} params.userId - User ID.
|
|
749
|
+
* @throws {AppwriteException}
|
|
750
|
+
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
751
|
+
*/
|
|
752
|
+
createMFARecoveryCodes(params: {
|
|
753
|
+
userId: string;
|
|
754
|
+
}): Promise<Models.MfaRecoveryCodes>;
|
|
755
|
+
/**
|
|
756
|
+
* Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method by client SDK.
|
|
757
|
+
*
|
|
758
|
+
* @param {string} userId - User ID.
|
|
759
|
+
* @throws {AppwriteException}
|
|
760
|
+
* @returns {Promise<Models.MfaRecoveryCodes>}
|
|
761
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
762
|
+
*/
|
|
763
|
+
createMFARecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
|
|
764
|
+
/**
|
|
765
|
+
* Update the user name by its unique ID.
|
|
766
|
+
*
|
|
767
|
+
* @param {string} params.userId - User ID.
|
|
768
|
+
* @param {string} params.name - User name. Max length: 128 chars.
|
|
769
|
+
* @throws {AppwriteException}
|
|
770
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
771
|
+
*/
|
|
772
|
+
updateName<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
773
|
+
userId: string;
|
|
774
|
+
name: string;
|
|
775
|
+
}): Promise<Models.User<Preferences>>;
|
|
258
776
|
/**
|
|
259
777
|
* Update the user name by its unique ID.
|
|
260
778
|
*
|
|
261
|
-
* @param {string} userId
|
|
262
|
-
* @param {string} name
|
|
779
|
+
* @param {string} userId - User ID.
|
|
780
|
+
* @param {string} name - User name. Max length: 128 chars.
|
|
263
781
|
* @throws {AppwriteException}
|
|
264
782
|
* @returns {Promise<Models.User<Preferences>>}
|
|
783
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
265
784
|
*/
|
|
266
785
|
updateName<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, name: string): Promise<Models.User<Preferences>>;
|
|
267
786
|
/**
|
|
268
787
|
* Update the user password by its unique ID.
|
|
269
788
|
*
|
|
270
|
-
* @param {string} userId
|
|
271
|
-
* @param {string} password
|
|
789
|
+
* @param {string} params.userId - User ID.
|
|
790
|
+
* @param {string} params.password - New user password. Must be at least 8 chars.
|
|
272
791
|
* @throws {AppwriteException}
|
|
273
792
|
* @returns {Promise<Models.User<Preferences>>}
|
|
274
793
|
*/
|
|
794
|
+
updatePassword<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
795
|
+
userId: string;
|
|
796
|
+
password: string;
|
|
797
|
+
}): Promise<Models.User<Preferences>>;
|
|
798
|
+
/**
|
|
799
|
+
* Update the user password by its unique ID.
|
|
800
|
+
*
|
|
801
|
+
* @param {string} userId - User ID.
|
|
802
|
+
* @param {string} password - New user password. Must be at least 8 chars.
|
|
803
|
+
* @throws {AppwriteException}
|
|
804
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
805
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
806
|
+
*/
|
|
275
807
|
updatePassword<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, password: string): Promise<Models.User<Preferences>>;
|
|
276
808
|
/**
|
|
277
809
|
* Update the user phone by its unique ID.
|
|
278
810
|
*
|
|
279
|
-
* @param {string} userId
|
|
280
|
-
* @param {string} number
|
|
811
|
+
* @param {string} params.userId - User ID.
|
|
812
|
+
* @param {string} params.number - User phone number.
|
|
813
|
+
* @throws {AppwriteException}
|
|
814
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
815
|
+
*/
|
|
816
|
+
updatePhone<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
817
|
+
userId: string;
|
|
818
|
+
number: string;
|
|
819
|
+
}): Promise<Models.User<Preferences>>;
|
|
820
|
+
/**
|
|
821
|
+
* Update the user phone by its unique ID.
|
|
822
|
+
*
|
|
823
|
+
* @param {string} userId - User ID.
|
|
824
|
+
* @param {string} number - User phone number.
|
|
281
825
|
* @throws {AppwriteException}
|
|
282
826
|
* @returns {Promise<Models.User<Preferences>>}
|
|
827
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
283
828
|
*/
|
|
284
829
|
updatePhone<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, number: string): Promise<Models.User<Preferences>>;
|
|
285
830
|
/**
|
|
286
831
|
* Get the user preferences by its unique ID.
|
|
287
832
|
*
|
|
288
|
-
* @param {string} userId
|
|
833
|
+
* @param {string} params.userId - User ID.
|
|
834
|
+
* @throws {AppwriteException}
|
|
835
|
+
* @returns {Promise<Preferences>}
|
|
836
|
+
*/
|
|
837
|
+
getPrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
838
|
+
userId: string;
|
|
839
|
+
}): Promise<Preferences>;
|
|
840
|
+
/**
|
|
841
|
+
* Get the user preferences by its unique ID.
|
|
842
|
+
*
|
|
843
|
+
* @param {string} userId - User ID.
|
|
289
844
|
* @throws {AppwriteException}
|
|
290
845
|
* @returns {Promise<Preferences>}
|
|
846
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
291
847
|
*/
|
|
292
848
|
getPrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string): Promise<Preferences>;
|
|
293
849
|
/**
|
|
294
850
|
* Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.
|
|
295
851
|
*
|
|
296
|
-
* @param {string} userId
|
|
297
|
-
* @param {object} prefs
|
|
852
|
+
* @param {string} params.userId - User ID.
|
|
853
|
+
* @param {object} params.prefs - Prefs key-value JSON object.
|
|
298
854
|
* @throws {AppwriteException}
|
|
299
855
|
* @returns {Promise<Preferences>}
|
|
300
856
|
*/
|
|
857
|
+
updatePrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
858
|
+
userId: string;
|
|
859
|
+
prefs: object;
|
|
860
|
+
}): Promise<Preferences>;
|
|
861
|
+
/**
|
|
862
|
+
* Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.
|
|
863
|
+
*
|
|
864
|
+
* @param {string} userId - User ID.
|
|
865
|
+
* @param {object} prefs - Prefs key-value JSON object.
|
|
866
|
+
* @throws {AppwriteException}
|
|
867
|
+
* @returns {Promise<Preferences>}
|
|
868
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
869
|
+
*/
|
|
301
870
|
updatePrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, prefs: object): Promise<Preferences>;
|
|
302
871
|
/**
|
|
303
872
|
* Get the user sessions list by its unique ID.
|
|
304
873
|
*
|
|
305
|
-
* @param {string} userId
|
|
874
|
+
* @param {string} params.userId - User ID.
|
|
875
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
306
876
|
* @throws {AppwriteException}
|
|
307
877
|
* @returns {Promise<Models.SessionList>}
|
|
308
878
|
*/
|
|
309
|
-
listSessions(
|
|
879
|
+
listSessions(params: {
|
|
880
|
+
userId: string;
|
|
881
|
+
total?: boolean;
|
|
882
|
+
}): Promise<Models.SessionList>;
|
|
883
|
+
/**
|
|
884
|
+
* Get the user sessions list by its unique ID.
|
|
885
|
+
*
|
|
886
|
+
* @param {string} userId - User ID.
|
|
887
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
888
|
+
* @throws {AppwriteException}
|
|
889
|
+
* @returns {Promise<Models.SessionList>}
|
|
890
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
891
|
+
*/
|
|
892
|
+
listSessions(userId: string, total?: boolean): Promise<Models.SessionList>;
|
|
310
893
|
/**
|
|
311
894
|
* Creates a session for a user. Returns an immediately usable session object.
|
|
312
895
|
*
|
|
313
896
|
* If you want to generate a token for a custom authentication flow, use the [POST /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) endpoint.
|
|
314
897
|
*
|
|
315
|
-
* @param {string} userId
|
|
898
|
+
* @param {string} params.userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
316
899
|
* @throws {AppwriteException}
|
|
317
900
|
* @returns {Promise<Models.Session>}
|
|
318
901
|
*/
|
|
902
|
+
createSession(params: {
|
|
903
|
+
userId: string;
|
|
904
|
+
}): Promise<Models.Session>;
|
|
905
|
+
/**
|
|
906
|
+
* Creates a session for a user. Returns an immediately usable session object.
|
|
907
|
+
*
|
|
908
|
+
* If you want to generate a token for a custom authentication flow, use the [POST /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) endpoint.
|
|
909
|
+
*
|
|
910
|
+
* @param {string} userId - User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
911
|
+
* @throws {AppwriteException}
|
|
912
|
+
* @returns {Promise<Models.Session>}
|
|
913
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
914
|
+
*/
|
|
319
915
|
createSession(userId: string): Promise<Models.Session>;
|
|
320
916
|
/**
|
|
321
|
-
* Delete all user
|
|
917
|
+
* Delete all user's sessions by using the user's unique ID.
|
|
322
918
|
*
|
|
323
|
-
* @param {string} userId
|
|
919
|
+
* @param {string} params.userId - User ID.
|
|
324
920
|
* @throws {AppwriteException}
|
|
325
921
|
* @returns {Promise<{}>}
|
|
326
922
|
*/
|
|
923
|
+
deleteSessions(params: {
|
|
924
|
+
userId: string;
|
|
925
|
+
}): Promise<{}>;
|
|
926
|
+
/**
|
|
927
|
+
* Delete all user's sessions by using the user's unique ID.
|
|
928
|
+
*
|
|
929
|
+
* @param {string} userId - User ID.
|
|
930
|
+
* @throws {AppwriteException}
|
|
931
|
+
* @returns {Promise<{}>}
|
|
932
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
933
|
+
*/
|
|
327
934
|
deleteSessions(userId: string): Promise<{}>;
|
|
328
935
|
/**
|
|
329
936
|
* Delete a user sessions by its unique ID.
|
|
330
937
|
*
|
|
331
|
-
* @param {string} userId
|
|
332
|
-
* @param {string} sessionId
|
|
938
|
+
* @param {string} params.userId - User ID.
|
|
939
|
+
* @param {string} params.sessionId - Session ID.
|
|
940
|
+
* @throws {AppwriteException}
|
|
941
|
+
* @returns {Promise<{}>}
|
|
942
|
+
*/
|
|
943
|
+
deleteSession(params: {
|
|
944
|
+
userId: string;
|
|
945
|
+
sessionId: string;
|
|
946
|
+
}): Promise<{}>;
|
|
947
|
+
/**
|
|
948
|
+
* Delete a user sessions by its unique ID.
|
|
949
|
+
*
|
|
950
|
+
* @param {string} userId - User ID.
|
|
951
|
+
* @param {string} sessionId - Session ID.
|
|
333
952
|
* @throws {AppwriteException}
|
|
334
953
|
* @returns {Promise<{}>}
|
|
954
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
335
955
|
*/
|
|
336
956
|
deleteSession(userId: string, sessionId: string): Promise<{}>;
|
|
337
957
|
/**
|
|
338
|
-
* Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user
|
|
958
|
+
* Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.
|
|
959
|
+
*
|
|
960
|
+
* @param {string} params.userId - User ID.
|
|
961
|
+
* @param {boolean} params.status - User Status. To activate the user pass `true` and to block the user pass `false`.
|
|
962
|
+
* @throws {AppwriteException}
|
|
963
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
964
|
+
*/
|
|
965
|
+
updateStatus<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
966
|
+
userId: string;
|
|
967
|
+
status: boolean;
|
|
968
|
+
}): Promise<Models.User<Preferences>>;
|
|
969
|
+
/**
|
|
970
|
+
* Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.
|
|
339
971
|
*
|
|
340
|
-
* @param {string} userId
|
|
341
|
-
* @param {boolean} status
|
|
972
|
+
* @param {string} userId - User ID.
|
|
973
|
+
* @param {boolean} status - User Status. To activate the user pass `true` and to block the user pass `false`.
|
|
342
974
|
* @throws {AppwriteException}
|
|
343
975
|
* @returns {Promise<Models.User<Preferences>>}
|
|
976
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
344
977
|
*/
|
|
345
978
|
updateStatus<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, status: boolean): Promise<Models.User<Preferences>>;
|
|
346
979
|
/**
|
|
347
980
|
* List the messaging targets that are associated with a user.
|
|
348
981
|
*
|
|
349
|
-
* @param {string} userId
|
|
350
|
-
* @param {string[]} queries
|
|
982
|
+
* @param {string} params.userId - User ID.
|
|
983
|
+
* @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: userId, providerId, identifier, providerType
|
|
984
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
985
|
+
* @throws {AppwriteException}
|
|
986
|
+
* @returns {Promise<Models.TargetList>}
|
|
987
|
+
*/
|
|
988
|
+
listTargets(params: {
|
|
989
|
+
userId: string;
|
|
990
|
+
queries?: string[];
|
|
991
|
+
total?: boolean;
|
|
992
|
+
}): Promise<Models.TargetList>;
|
|
993
|
+
/**
|
|
994
|
+
* List the messaging targets that are associated with a user.
|
|
995
|
+
*
|
|
996
|
+
* @param {string} userId - User ID.
|
|
997
|
+
* @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: userId, providerId, identifier, providerType
|
|
998
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
351
999
|
* @throws {AppwriteException}
|
|
352
1000
|
* @returns {Promise<Models.TargetList>}
|
|
1001
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1002
|
+
*/
|
|
1003
|
+
listTargets(userId: string, queries?: string[], total?: boolean): Promise<Models.TargetList>;
|
|
1004
|
+
/**
|
|
1005
|
+
* Create a messaging target.
|
|
1006
|
+
*
|
|
1007
|
+
* @param {string} params.userId - User ID.
|
|
1008
|
+
* @param {string} params.targetId - Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
1009
|
+
* @param {MessagingProviderType} params.providerType - The target provider type. Can be one of the following: `email`, `sms` or `push`.
|
|
1010
|
+
* @param {string} params.identifier - The target identifier (token, email, phone etc.)
|
|
1011
|
+
* @param {string} params.providerId - Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.
|
|
1012
|
+
* @param {string} params.name - Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.
|
|
1013
|
+
* @throws {AppwriteException}
|
|
1014
|
+
* @returns {Promise<Models.Target>}
|
|
353
1015
|
*/
|
|
354
|
-
|
|
1016
|
+
createTarget(params: {
|
|
1017
|
+
userId: string;
|
|
1018
|
+
targetId: string;
|
|
1019
|
+
providerType: MessagingProviderType;
|
|
1020
|
+
identifier: string;
|
|
1021
|
+
providerId?: string;
|
|
1022
|
+
name?: string;
|
|
1023
|
+
}): Promise<Models.Target>;
|
|
355
1024
|
/**
|
|
356
1025
|
* Create a messaging target.
|
|
357
1026
|
*
|
|
358
|
-
* @param {string} userId
|
|
359
|
-
* @param {string} targetId
|
|
360
|
-
* @param {MessagingProviderType} providerType
|
|
361
|
-
* @param {string} identifier
|
|
362
|
-
* @param {string} providerId
|
|
363
|
-
* @param {string} name
|
|
1027
|
+
* @param {string} userId - User ID.
|
|
1028
|
+
* @param {string} targetId - Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
1029
|
+
* @param {MessagingProviderType} providerType - The target provider type. Can be one of the following: `email`, `sms` or `push`.
|
|
1030
|
+
* @param {string} identifier - The target identifier (token, email, phone etc.)
|
|
1031
|
+
* @param {string} providerId - Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.
|
|
1032
|
+
* @param {string} name - Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.
|
|
364
1033
|
* @throws {AppwriteException}
|
|
365
1034
|
* @returns {Promise<Models.Target>}
|
|
1035
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
366
1036
|
*/
|
|
367
1037
|
createTarget(userId: string, targetId: string, providerType: MessagingProviderType, identifier: string, providerId?: string, name?: string): Promise<Models.Target>;
|
|
368
1038
|
/**
|
|
369
|
-
* Get a user
|
|
1039
|
+
* Get a user's push notification target by ID.
|
|
370
1040
|
*
|
|
371
|
-
* @param {string} userId
|
|
372
|
-
* @param {string} targetId
|
|
1041
|
+
* @param {string} params.userId - User ID.
|
|
1042
|
+
* @param {string} params.targetId - Target ID.
|
|
373
1043
|
* @throws {AppwriteException}
|
|
374
1044
|
* @returns {Promise<Models.Target>}
|
|
375
1045
|
*/
|
|
1046
|
+
getTarget(params: {
|
|
1047
|
+
userId: string;
|
|
1048
|
+
targetId: string;
|
|
1049
|
+
}): Promise<Models.Target>;
|
|
1050
|
+
/**
|
|
1051
|
+
* Get a user's push notification target by ID.
|
|
1052
|
+
*
|
|
1053
|
+
* @param {string} userId - User ID.
|
|
1054
|
+
* @param {string} targetId - Target ID.
|
|
1055
|
+
* @throws {AppwriteException}
|
|
1056
|
+
* @returns {Promise<Models.Target>}
|
|
1057
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1058
|
+
*/
|
|
376
1059
|
getTarget(userId: string, targetId: string): Promise<Models.Target>;
|
|
377
1060
|
/**
|
|
378
1061
|
* Update a messaging target.
|
|
379
1062
|
*
|
|
380
|
-
* @param {string} userId
|
|
381
|
-
* @param {string} targetId
|
|
382
|
-
* @param {string} identifier
|
|
383
|
-
* @param {string} providerId
|
|
384
|
-
* @param {string} name
|
|
1063
|
+
* @param {string} params.userId - User ID.
|
|
1064
|
+
* @param {string} params.targetId - Target ID.
|
|
1065
|
+
* @param {string} params.identifier - The target identifier (token, email, phone etc.)
|
|
1066
|
+
* @param {string} params.providerId - Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.
|
|
1067
|
+
* @param {string} params.name - Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.
|
|
385
1068
|
* @throws {AppwriteException}
|
|
386
1069
|
* @returns {Promise<Models.Target>}
|
|
387
1070
|
*/
|
|
1071
|
+
updateTarget(params: {
|
|
1072
|
+
userId: string;
|
|
1073
|
+
targetId: string;
|
|
1074
|
+
identifier?: string;
|
|
1075
|
+
providerId?: string;
|
|
1076
|
+
name?: string;
|
|
1077
|
+
}): Promise<Models.Target>;
|
|
1078
|
+
/**
|
|
1079
|
+
* Update a messaging target.
|
|
1080
|
+
*
|
|
1081
|
+
* @param {string} userId - User ID.
|
|
1082
|
+
* @param {string} targetId - Target ID.
|
|
1083
|
+
* @param {string} identifier - The target identifier (token, email, phone etc.)
|
|
1084
|
+
* @param {string} providerId - Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.
|
|
1085
|
+
* @param {string} name - Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.
|
|
1086
|
+
* @throws {AppwriteException}
|
|
1087
|
+
* @returns {Promise<Models.Target>}
|
|
1088
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1089
|
+
*/
|
|
388
1090
|
updateTarget(userId: string, targetId: string, identifier?: string, providerId?: string, name?: string): Promise<Models.Target>;
|
|
389
1091
|
/**
|
|
390
1092
|
* Delete a messaging target.
|
|
391
1093
|
*
|
|
392
|
-
* @param {string} userId
|
|
393
|
-
* @param {string} targetId
|
|
1094
|
+
* @param {string} params.userId - User ID.
|
|
1095
|
+
* @param {string} params.targetId - Target ID.
|
|
394
1096
|
* @throws {AppwriteException}
|
|
395
1097
|
* @returns {Promise<{}>}
|
|
396
1098
|
*/
|
|
1099
|
+
deleteTarget(params: {
|
|
1100
|
+
userId: string;
|
|
1101
|
+
targetId: string;
|
|
1102
|
+
}): Promise<{}>;
|
|
1103
|
+
/**
|
|
1104
|
+
* Delete a messaging target.
|
|
1105
|
+
*
|
|
1106
|
+
* @param {string} userId - User ID.
|
|
1107
|
+
* @param {string} targetId - Target ID.
|
|
1108
|
+
* @throws {AppwriteException}
|
|
1109
|
+
* @returns {Promise<{}>}
|
|
1110
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1111
|
+
*/
|
|
397
1112
|
deleteTarget(userId: string, targetId: string): Promise<{}>;
|
|
398
1113
|
/**
|
|
399
1114
|
* Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process.
|
|
400
1115
|
*
|
|
401
1116
|
*
|
|
402
|
-
* @param {string} userId
|
|
403
|
-
* @param {number} length
|
|
404
|
-
* @param {number} expire
|
|
1117
|
+
* @param {string} params.userId - User ID.
|
|
1118
|
+
* @param {number} params.length - Token length in characters. The default length is 6 characters
|
|
1119
|
+
* @param {number} params.expire - Token expiration period in seconds. The default expiration is 15 minutes.
|
|
1120
|
+
* @throws {AppwriteException}
|
|
1121
|
+
* @returns {Promise<Models.Token>}
|
|
1122
|
+
*/
|
|
1123
|
+
createToken(params: {
|
|
1124
|
+
userId: string;
|
|
1125
|
+
length?: number;
|
|
1126
|
+
expire?: number;
|
|
1127
|
+
}): Promise<Models.Token>;
|
|
1128
|
+
/**
|
|
1129
|
+
* Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process.
|
|
1130
|
+
*
|
|
1131
|
+
*
|
|
1132
|
+
* @param {string} userId - User ID.
|
|
1133
|
+
* @param {number} length - Token length in characters. The default length is 6 characters
|
|
1134
|
+
* @param {number} expire - Token expiration period in seconds. The default expiration is 15 minutes.
|
|
405
1135
|
* @throws {AppwriteException}
|
|
406
1136
|
* @returns {Promise<Models.Token>}
|
|
1137
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
407
1138
|
*/
|
|
408
1139
|
createToken(userId: string, length?: number, expire?: number): Promise<Models.Token>;
|
|
409
1140
|
/**
|
|
410
1141
|
* Update the user email verification status by its unique ID.
|
|
411
1142
|
*
|
|
412
|
-
* @param {string} userId
|
|
413
|
-
* @param {boolean} emailVerification
|
|
1143
|
+
* @param {string} params.userId - User ID.
|
|
1144
|
+
* @param {boolean} params.emailVerification - User email verification status.
|
|
1145
|
+
* @throws {AppwriteException}
|
|
1146
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
1147
|
+
*/
|
|
1148
|
+
updateEmailVerification<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
1149
|
+
userId: string;
|
|
1150
|
+
emailVerification: boolean;
|
|
1151
|
+
}): Promise<Models.User<Preferences>>;
|
|
1152
|
+
/**
|
|
1153
|
+
* Update the user email verification status by its unique ID.
|
|
1154
|
+
*
|
|
1155
|
+
* @param {string} userId - User ID.
|
|
1156
|
+
* @param {boolean} emailVerification - User email verification status.
|
|
414
1157
|
* @throws {AppwriteException}
|
|
415
1158
|
* @returns {Promise<Models.User<Preferences>>}
|
|
1159
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
416
1160
|
*/
|
|
417
1161
|
updateEmailVerification<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, emailVerification: boolean): Promise<Models.User<Preferences>>;
|
|
418
1162
|
/**
|
|
419
1163
|
* Update the user phone verification status by its unique ID.
|
|
420
1164
|
*
|
|
421
|
-
* @param {string} userId
|
|
422
|
-
* @param {boolean} phoneVerification
|
|
1165
|
+
* @param {string} params.userId - User ID.
|
|
1166
|
+
* @param {boolean} params.phoneVerification - User phone verification status.
|
|
1167
|
+
* @throws {AppwriteException}
|
|
1168
|
+
* @returns {Promise<Models.User<Preferences>>}
|
|
1169
|
+
*/
|
|
1170
|
+
updatePhoneVerification<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
1171
|
+
userId: string;
|
|
1172
|
+
phoneVerification: boolean;
|
|
1173
|
+
}): Promise<Models.User<Preferences>>;
|
|
1174
|
+
/**
|
|
1175
|
+
* Update the user phone verification status by its unique ID.
|
|
1176
|
+
*
|
|
1177
|
+
* @param {string} userId - User ID.
|
|
1178
|
+
* @param {boolean} phoneVerification - User phone verification status.
|
|
423
1179
|
* @throws {AppwriteException}
|
|
424
1180
|
* @returns {Promise<Models.User<Preferences>>}
|
|
1181
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
425
1182
|
*/
|
|
426
1183
|
updatePhoneVerification<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, phoneVerification: boolean): Promise<Models.User<Preferences>>;
|
|
427
1184
|
}
|