@appwrite.io/console 1.10.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yml +9 -8
- package/CHANGELOG.md +6 -0
- package/LICENSE +1 -1
- package/README.md +4 -4
- package/dist/cjs/sdk.js +15239 -6070
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +15237 -6071
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +15239 -6070
- package/docs/examples/account/create-billing-address.md +8 -8
- package/docs/examples/account/create-email-password-session.md +4 -4
- package/docs/examples/account/create-email-token.md +5 -5
- package/docs/examples/account/{update-magic-u-r-l-session.md → create-email-verification.md} +3 -4
- package/docs/examples/account/{update-m-f-a.md → create-jwt.md} +3 -3
- package/docs/examples/account/{create-magic-u-r-l-token.md → create-magic-url-token.md} +6 -6
- package/docs/examples/account/create-mfa-authenticator.md +3 -3
- package/docs/examples/account/create-mfa-challenge.md +3 -3
- package/docs/examples/account/create-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-o-auth2token.md → create-o-auth-2-session.md} +6 -6
- package/docs/examples/account/{create-o-auth2session.md → create-o-auth-2-token.md} +6 -6
- package/docs/examples/account/create-phone-token.md +4 -4
- package/docs/examples/account/create-push-target.md +5 -5
- package/docs/examples/account/create-recovery.md +4 -4
- package/docs/examples/account/create-session.md +4 -4
- package/docs/examples/account/create-verification.md +3 -3
- package/docs/examples/account/create.md +6 -6
- package/docs/examples/account/delete-billing-address.md +3 -3
- package/docs/examples/account/delete-identity.md +3 -3
- package/docs/examples/account/delete-mfa-authenticator.md +3 -3
- package/docs/examples/account/delete-payment-method.md +3 -3
- package/docs/examples/account/delete-push-target.md +3 -3
- package/docs/examples/account/delete-session.md +3 -3
- package/docs/examples/account/get-billing-address.md +3 -3
- package/docs/examples/account/get-coupon.md +3 -3
- package/docs/examples/account/get-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/get-payment-method.md +3 -3
- package/docs/examples/account/get-session.md +3 -3
- package/docs/examples/account/list-billing-addresses.md +3 -3
- package/docs/examples/account/list-identities.md +4 -3
- package/docs/examples/account/list-invoices.md +3 -3
- package/docs/examples/account/list-logs.md +4 -3
- package/docs/examples/account/list-mfa-factors.md +1 -1
- package/docs/examples/account/list-payment-methods.md +3 -3
- package/docs/examples/account/update-billing-address.md +9 -9
- package/docs/examples/account/update-email-verification.md +14 -0
- package/docs/examples/account/update-email.md +4 -4
- package/docs/examples/account/update-magic-url-session.md +14 -0
- package/docs/examples/account/update-mfa-authenticator.md +4 -4
- package/docs/examples/account/update-mfa-challenge.md +4 -4
- package/docs/examples/account/update-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-j-w-t.md → update-mfa.md} +3 -1
- package/docs/examples/account/update-name.md +3 -3
- package/docs/examples/account/update-password.md +4 -4
- package/docs/examples/account/update-payment-method-mandate-options.md +3 -3
- package/docs/examples/account/update-payment-method-provider.md +6 -5
- package/docs/examples/account/update-payment-method.md +6 -5
- package/docs/examples/account/update-phone-session.md +4 -4
- package/docs/examples/account/update-phone-verification.md +4 -4
- package/docs/examples/account/update-phone.md +4 -4
- package/docs/examples/account/update-prefs.md +7 -3
- package/docs/examples/account/update-push-target.md +4 -4
- package/docs/examples/account/update-recovery.md +5 -5
- package/docs/examples/account/update-session.md +3 -3
- package/docs/examples/account/update-verification.md +4 -4
- package/docs/examples/assistant/chat.md +3 -3
- package/docs/examples/avatars/get-browser.md +6 -6
- package/docs/examples/avatars/get-credit-card.md +6 -6
- package/docs/examples/avatars/get-favicon.md +3 -3
- package/docs/examples/avatars/get-flag.md +6 -6
- package/docs/examples/avatars/get-image.md +5 -5
- package/docs/examples/avatars/get-initials.md +6 -6
- package/docs/examples/avatars/{get-q-r.md → get-qr.md} +6 -6
- package/docs/examples/avatars/get-screenshot.md +35 -0
- package/docs/examples/backups/create-archive.md +4 -4
- package/docs/examples/backups/create-policy.md +9 -9
- package/docs/examples/backups/create-restoration.md +6 -6
- package/docs/examples/backups/delete-archive.md +3 -3
- package/docs/examples/backups/delete-policy.md +3 -3
- package/docs/examples/backups/get-archive.md +3 -3
- package/docs/examples/backups/get-policy.md +3 -3
- package/docs/examples/backups/get-restoration.md +3 -3
- package/docs/examples/backups/list-archives.md +3 -3
- package/docs/examples/backups/list-policies.md +3 -3
- package/docs/examples/backups/list-restorations.md +3 -3
- package/docs/examples/backups/update-policy.md +7 -7
- package/docs/examples/console/create-program-membership.md +3 -3
- package/docs/examples/console/create-source.md +7 -7
- package/docs/examples/console/get-campaign.md +3 -3
- package/docs/examples/console/get-coupon.md +3 -3
- package/docs/examples/console/{plans.md → get-plan.md} +3 -1
- package/docs/examples/console/get-plans.md +13 -0
- package/docs/examples/console/{regions.md → get-program.md} +3 -1
- package/docs/examples/console/get-regions.md +13 -0
- package/docs/examples/console/get-resource.md +4 -4
- package/docs/examples/console/suggest-columns.md +17 -0
- package/docs/examples/console/suggest-indexes.md +16 -0
- package/docs/examples/databases/create-boolean-attribute.md +8 -8
- package/docs/examples/databases/create-collection.md +11 -9
- package/docs/examples/databases/create-datetime-attribute.md +8 -8
- package/docs/examples/databases/create-document.md +15 -8
- package/docs/examples/databases/create-documents.md +6 -5
- package/docs/examples/databases/create-email-attribute.md +8 -8
- package/docs/examples/databases/create-enum-attribute.md +9 -9
- package/docs/examples/databases/create-float-attribute.md +10 -10
- package/docs/examples/databases/create-index.md +9 -9
- package/docs/examples/databases/create-integer-attribute.md +10 -10
- package/docs/examples/databases/create-ip-attribute.md +8 -8
- package/docs/examples/databases/create-line-attribute.md +17 -0
- package/docs/examples/databases/create-operations.md +24 -0
- package/docs/examples/databases/create-point-attribute.md +17 -0
- package/docs/examples/databases/create-polygon-attribute.md +17 -0
- package/docs/examples/databases/create-relationship-attribute.md +10 -10
- package/docs/examples/databases/create-string-attribute.md +10 -10
- package/docs/examples/databases/create-transaction.md +13 -0
- package/docs/examples/databases/create-url-attribute.md +8 -8
- package/docs/examples/databases/create.md +5 -5
- package/docs/examples/databases/decrement-document-attribute.md +9 -8
- package/docs/examples/databases/delete-attribute.md +5 -5
- package/docs/examples/databases/delete-collection.md +4 -4
- package/docs/examples/databases/delete-document.md +6 -5
- package/docs/examples/databases/delete-documents.md +6 -5
- package/docs/examples/databases/delete-index.md +5 -5
- package/docs/examples/databases/{get-database-usage.md → delete-transaction.md} +4 -5
- package/docs/examples/databases/delete.md +3 -3
- package/docs/examples/databases/get-attribute.md +5 -5
- package/docs/examples/databases/get-collection-usage.md +6 -6
- package/docs/examples/databases/get-collection.md +4 -4
- package/docs/examples/databases/get-document.md +7 -6
- package/docs/examples/databases/get-index.md +5 -5
- package/docs/examples/databases/get-transaction.md +13 -0
- package/docs/examples/databases/get-usage.md +5 -4
- package/docs/examples/databases/get.md +3 -3
- package/docs/examples/databases/increment-document-attribute.md +9 -8
- package/docs/examples/databases/list-attributes.md +6 -5
- package/docs/examples/databases/list-collection-logs.md +5 -5
- package/docs/examples/databases/list-collections.md +6 -5
- package/docs/examples/databases/list-document-logs.md +6 -6
- package/docs/examples/databases/list-documents.md +7 -5
- package/docs/examples/databases/list-indexes.md +6 -5
- package/docs/examples/databases/list-logs.md +4 -4
- package/docs/examples/databases/list-transactions.md +13 -0
- package/docs/examples/databases/list-usage.md +13 -0
- package/docs/examples/databases/list.md +5 -4
- package/docs/examples/databases/update-boolean-attribute.md +8 -8
- package/docs/examples/databases/update-collection.md +9 -9
- package/docs/examples/databases/update-datetime-attribute.md +8 -8
- package/docs/examples/databases/update-document.md +15 -8
- package/docs/examples/databases/update-documents.md +13 -6
- package/docs/examples/databases/update-email-attribute.md +8 -8
- package/docs/examples/databases/update-enum-attribute.md +9 -9
- package/docs/examples/databases/update-float-attribute.md +10 -10
- package/docs/examples/databases/update-integer-attribute.md +10 -10
- package/docs/examples/databases/update-ip-attribute.md +8 -8
- package/docs/examples/databases/update-line-attribute.md +18 -0
- package/docs/examples/databases/update-point-attribute.md +18 -0
- package/docs/examples/databases/update-polygon-attribute.md +18 -0
- package/docs/examples/databases/update-relationship-attribute.md +7 -7
- package/docs/examples/databases/update-string-attribute.md +9 -9
- package/docs/examples/databases/update-transaction.md +15 -0
- package/docs/examples/databases/update-url-attribute.md +8 -8
- package/docs/examples/databases/update.md +5 -5
- package/docs/examples/databases/upsert-document.md +15 -8
- package/docs/examples/databases/upsert-documents.md +6 -5
- package/docs/examples/domains/create-preset-google-workspace.md +3 -3
- package/docs/examples/domains/create-preset-i-cloud.md +3 -3
- package/docs/examples/domains/create-preset-mailgun.md +3 -3
- package/docs/examples/domains/create-preset-outlook.md +3 -3
- package/docs/examples/domains/create-preset-proton-mail.md +3 -3
- package/docs/examples/domains/create-preset-zoho.md +3 -3
- package/docs/examples/domains/create-record-a.md +7 -7
- package/docs/examples/domains/{create-record-a-a-a-a.md → create-record-aaaa.md} +7 -7
- package/docs/examples/domains/create-record-alias.md +7 -7
- package/docs/examples/domains/{create-record-n-s.md → create-record-caa.md} +7 -7
- package/docs/examples/domains/{create-record-c-a-a.md → create-record-cname.md} +7 -7
- package/docs/examples/domains/{create-record-h-t-t-p-s.md → create-record-https.md} +7 -7
- package/docs/examples/domains/create-record-mx.md +18 -0
- package/docs/examples/domains/create-record-ns.md +17 -0
- package/docs/examples/domains/create-record-srv.md +20 -0
- package/docs/examples/domains/{create-record-c-n-a-m-e.md → create-record-txt.md} +7 -7
- package/docs/examples/domains/create.md +4 -4
- package/docs/examples/domains/delete-record.md +4 -4
- package/docs/examples/domains/delete.md +3 -3
- package/docs/examples/domains/get-preset-google-workspace.md +3 -3
- package/docs/examples/domains/get-preset-i-cloud.md +3 -3
- package/docs/examples/domains/get-preset-mailgun.md +3 -3
- package/docs/examples/domains/get-preset-outlook.md +3 -3
- package/docs/examples/domains/get-preset-proton-mail.md +3 -3
- package/docs/examples/domains/get-preset-zoho.md +3 -3
- package/docs/examples/domains/get-record.md +4 -4
- package/docs/examples/domains/get-zone.md +3 -3
- package/docs/examples/domains/get.md +3 -3
- package/docs/examples/domains/list-records.md +4 -4
- package/docs/examples/domains/list.md +4 -4
- package/docs/examples/domains/update-nameservers.md +3 -3
- package/docs/examples/domains/update-record-a.md +8 -8
- package/docs/examples/domains/update-record-aaaa.md +18 -0
- package/docs/examples/domains/update-record-alias.md +8 -8
- package/docs/examples/domains/update-record-caa.md +18 -0
- package/docs/examples/domains/update-record-cname.md +18 -0
- package/docs/examples/domains/update-record-https.md +18 -0
- package/docs/examples/domains/update-record-mx.md +19 -0
- package/docs/examples/domains/update-record-ns.md +18 -0
- package/docs/examples/domains/update-record-srv.md +21 -0
- package/docs/examples/domains/update-record-txt.md +18 -0
- package/docs/examples/domains/update-team.md +4 -4
- package/docs/examples/domains/update-zone.md +4 -4
- package/docs/examples/functions/create-deployment.md +7 -7
- package/docs/examples/functions/create-duplicate-deployment.md +5 -5
- package/docs/examples/functions/create-execution.md +9 -9
- package/docs/examples/functions/create-template-deployment.md +10 -9
- package/docs/examples/functions/create-variable.md +6 -6
- package/docs/examples/functions/create-vcs-deployment.md +7 -7
- package/docs/examples/functions/create.md +21 -21
- package/docs/examples/functions/delete-deployment.md +4 -4
- package/docs/examples/functions/delete-execution.md +4 -4
- package/docs/examples/functions/delete-variable.md +4 -4
- package/docs/examples/functions/delete.md +3 -3
- package/docs/examples/functions/get-deployment-download.md +5 -5
- package/docs/examples/functions/get-deployment.md +4 -4
- package/docs/examples/functions/get-execution.md +4 -4
- package/docs/examples/functions/get-template.md +3 -3
- package/docs/examples/functions/get-usage.md +5 -5
- package/docs/examples/functions/get-variable.md +4 -4
- package/docs/examples/functions/get.md +3 -3
- package/docs/examples/functions/list-deployments.md +6 -5
- package/docs/examples/functions/list-executions.md +5 -4
- package/docs/examples/functions/list-templates.md +7 -6
- package/docs/examples/functions/list-usage.md +4 -4
- package/docs/examples/functions/list-variables.md +3 -3
- package/docs/examples/functions/list.md +5 -4
- package/docs/examples/functions/update-deployment-status.md +4 -4
- package/docs/examples/functions/update-function-deployment.md +4 -4
- package/docs/examples/functions/update-variable.md +7 -7
- package/docs/examples/functions/update.md +21 -21
- package/docs/examples/graphql/mutation.md +3 -3
- package/docs/examples/graphql/query.md +3 -3
- package/docs/examples/health/get-certificate.md +3 -3
- package/docs/examples/health/get-failed-jobs.md +5 -5
- package/docs/examples/health/get-queue-billing-project-aggregation.md +3 -3
- package/docs/examples/health/get-queue-billing-team-aggregation.md +3 -3
- package/docs/examples/health/get-queue-builds.md +3 -3
- package/docs/examples/health/get-queue-certificates.md +3 -3
- package/docs/examples/health/get-queue-databases.md +4 -4
- package/docs/examples/health/get-queue-deletes.md +3 -3
- package/docs/examples/health/get-queue-functions.md +3 -3
- package/docs/examples/health/get-queue-logs.md +3 -3
- package/docs/examples/health/get-queue-mails.md +3 -3
- package/docs/examples/health/get-queue-messaging.md +3 -3
- package/docs/examples/health/get-queue-migrations.md +3 -3
- package/docs/examples/health/get-queue-priority-builds.md +3 -3
- package/docs/examples/health/get-queue-region-manager.md +3 -3
- package/docs/examples/health/get-queue-stats-resources.md +3 -3
- package/docs/examples/health/get-queue-threats.md +13 -0
- package/docs/examples/health/get-queue-usage.md +3 -3
- package/docs/examples/health/get-queue-webhooks.md +3 -3
- package/docs/examples/messaging/create-apns-provider.md +10 -10
- package/docs/examples/messaging/create-email.md +14 -14
- package/docs/examples/messaging/create-fcm-provider.md +6 -6
- package/docs/examples/messaging/create-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{create-msg91provider.md → create-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/create-push.md +21 -21
- package/docs/examples/messaging/create-resend-provider.md +20 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/create-sms.md +9 -9
- package/docs/examples/messaging/create-smtp-provider.md +16 -16
- package/docs/examples/messaging/create-subscriber.md +5 -5
- package/docs/examples/messaging/create-telesign-provider.md +8 -8
- package/docs/examples/messaging/create-textmagic-provider.md +8 -8
- package/docs/examples/messaging/create-topic.md +5 -5
- package/docs/examples/messaging/create-twilio-provider.md +8 -8
- package/docs/examples/messaging/create-vonage-provider.md +8 -8
- package/docs/examples/messaging/delete-provider.md +3 -3
- package/docs/examples/messaging/delete-subscriber.md +4 -4
- package/docs/examples/messaging/delete-topic.md +3 -3
- package/docs/examples/messaging/delete.md +3 -3
- package/docs/examples/messaging/get-message.md +3 -3
- package/docs/examples/messaging/get-provider.md +3 -3
- package/docs/examples/messaging/get-subscriber.md +4 -4
- package/docs/examples/messaging/get-topic.md +3 -3
- package/docs/examples/messaging/list-message-logs.md +5 -4
- package/docs/examples/messaging/list-messages.md +5 -4
- package/docs/examples/messaging/list-provider-logs.md +5 -4
- package/docs/examples/messaging/list-providers.md +5 -4
- package/docs/examples/messaging/list-subscriber-logs.md +5 -4
- package/docs/examples/messaging/list-subscribers.md +6 -5
- package/docs/examples/messaging/list-targets.md +5 -4
- package/docs/examples/messaging/list-topic-logs.md +5 -4
- package/docs/examples/messaging/list-topics.md +5 -4
- package/docs/examples/messaging/update-apns-provider.md +10 -10
- package/docs/examples/messaging/update-email.md +14 -14
- package/docs/examples/messaging/update-fcm-provider.md +6 -6
- package/docs/examples/messaging/update-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{update-msg91provider.md → update-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/update-push.md +21 -21
- package/docs/examples/messaging/update-resend-provider.md +20 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/update-sms.md +9 -9
- package/docs/examples/messaging/update-smtp-provider.md +16 -16
- package/docs/examples/messaging/update-telesign-provider.md +8 -8
- package/docs/examples/messaging/update-textmagic-provider.md +8 -8
- package/docs/examples/messaging/update-topic.md +5 -5
- package/docs/examples/messaging/update-twilio-provider.md +8 -8
- package/docs/examples/messaging/update-vonage-provider.md +8 -8
- package/docs/examples/migrations/create-appwrite-migration.md +6 -6
- package/docs/examples/migrations/create-csv-export.md +21 -0
- package/docs/examples/migrations/{create-csv-migration.md → create-csv-import.md} +6 -5
- package/docs/examples/migrations/create-firebase-migration.md +4 -4
- package/docs/examples/migrations/create-n-host-migration.md +10 -10
- package/docs/examples/migrations/create-supabase-migration.md +9 -9
- package/docs/examples/migrations/delete.md +3 -3
- package/docs/examples/migrations/get-appwrite-report.md +6 -6
- package/docs/examples/migrations/get-firebase-report.md +4 -4
- package/docs/examples/migrations/get-n-host-report.md +10 -10
- package/docs/examples/migrations/get-supabase-report.md +9 -9
- package/docs/examples/migrations/get.md +3 -3
- package/docs/examples/migrations/list.md +5 -4
- package/docs/examples/migrations/retry.md +3 -3
- package/docs/examples/organizations/add-credit.md +4 -4
- package/docs/examples/organizations/cancel-downgrade.md +3 -3
- package/docs/examples/organizations/create-downgrade-feedback.md +17 -0
- package/docs/examples/organizations/create-invoice-payment.md +5 -5
- package/docs/examples/organizations/create.md +13 -12
- package/docs/examples/organizations/delete-backup-payment-method.md +3 -3
- package/docs/examples/organizations/delete-billing-address.md +3 -3
- package/docs/examples/organizations/delete-default-payment-method.md +3 -3
- package/docs/examples/organizations/delete.md +3 -3
- package/docs/examples/organizations/estimation-create-organization.md +8 -7
- package/docs/examples/organizations/estimation-delete-organization.md +3 -3
- package/docs/examples/organizations/estimation-update-plan.md +7 -7
- package/docs/examples/organizations/get-aggregation.md +6 -4
- package/docs/examples/organizations/get-available-credits.md +3 -3
- package/docs/examples/organizations/get-billing-address.md +4 -4
- package/docs/examples/organizations/get-credit.md +4 -4
- package/docs/examples/organizations/get-invoice-download.md +4 -4
- package/docs/examples/organizations/get-invoice-view.md +4 -4
- package/docs/examples/organizations/get-invoice.md +4 -4
- package/docs/examples/organizations/get-payment-method.md +4 -4
- package/docs/examples/organizations/get-plan.md +3 -3
- package/docs/examples/organizations/get-scopes.md +3 -3
- package/docs/examples/organizations/get-usage.md +5 -5
- package/docs/examples/organizations/list-aggregations.md +4 -4
- package/docs/examples/organizations/list-credits.md +4 -4
- package/docs/examples/organizations/list-invoices.md +4 -4
- package/docs/examples/organizations/list.md +4 -4
- package/docs/examples/organizations/set-backup-payment-method.md +4 -4
- package/docs/examples/organizations/set-billing-address.md +4 -4
- package/docs/examples/organizations/set-billing-email.md +4 -4
- package/docs/examples/organizations/set-billing-tax-id.md +4 -4
- package/docs/examples/organizations/set-default-payment-method.md +4 -4
- package/docs/examples/organizations/update-budget.md +5 -5
- package/docs/examples/organizations/update-plan.md +11 -11
- package/docs/examples/organizations/update-projects.md +4 -4
- package/docs/examples/organizations/validate-invoice.md +4 -4
- package/docs/examples/organizations/validate-payment.md +4 -4
- package/docs/examples/project/create-variable.md +5 -5
- package/docs/examples/project/delete-variable.md +3 -3
- package/docs/examples/project/get-usage.md +5 -5
- package/docs/examples/project/get-variable.md +3 -3
- package/docs/examples/project/update-variable.md +6 -6
- package/docs/examples/projects/create-dev-key.md +5 -5
- package/docs/examples/projects/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/projects/create-key.md +6 -6
- package/docs/examples/projects/create-platform.md +8 -8
- package/docs/examples/projects/create-smtp-test.md +12 -12
- package/docs/examples/projects/create-webhook.md +10 -10
- package/docs/examples/projects/create.md +16 -16
- package/docs/examples/projects/delete-dev-key.md +4 -4
- package/docs/examples/projects/delete-email-template.md +5 -5
- package/docs/examples/projects/delete-key.md +4 -4
- package/docs/examples/projects/delete-platform.md +4 -4
- package/docs/examples/projects/delete-sms-template.md +5 -5
- package/docs/examples/projects/delete-webhook.md +4 -4
- package/docs/examples/projects/delete.md +3 -3
- package/docs/examples/projects/get-dev-key.md +4 -4
- package/docs/examples/projects/get-email-template.md +5 -5
- package/docs/examples/projects/get-key.md +4 -4
- package/docs/examples/projects/get-platform.md +4 -4
- package/docs/examples/projects/get-sms-template.md +5 -5
- package/docs/examples/projects/get-webhook.md +4 -4
- package/docs/examples/projects/get.md +3 -3
- package/docs/examples/projects/list-dev-keys.md +4 -4
- package/docs/examples/projects/list-keys.md +4 -3
- package/docs/examples/projects/list-platforms.md +4 -3
- package/docs/examples/projects/list-webhooks.md +4 -3
- package/docs/examples/projects/list.md +5 -4
- package/docs/examples/projects/update-api-status-all.md +4 -4
- package/docs/examples/projects/update-api-status.md +6 -6
- package/docs/examples/projects/update-auth-duration.md +4 -4
- package/docs/examples/projects/update-auth-limit.md +4 -4
- package/docs/examples/projects/update-auth-password-dictionary.md +4 -4
- package/docs/examples/projects/update-auth-password-history.md +4 -4
- package/docs/examples/projects/update-auth-sessions-limit.md +4 -4
- package/docs/examples/projects/update-auth-status.md +5 -5
- package/docs/examples/projects/update-dev-key.md +6 -6
- package/docs/examples/projects/update-email-template.md +10 -10
- package/docs/examples/projects/update-key.md +7 -7
- package/docs/examples/projects/update-memberships-privacy.md +6 -6
- package/docs/examples/projects/update-mock-numbers.md +4 -4
- package/docs/examples/projects/{update-o-auth2.md → update-o-auth-2.md} +7 -7
- package/docs/examples/projects/update-personal-data-check.md +4 -4
- package/docs/examples/projects/update-platform.md +8 -8
- package/docs/examples/projects/update-service-status-all.md +4 -4
- package/docs/examples/projects/update-service-status.md +5 -5
- package/docs/examples/projects/update-session-alerts.md +4 -4
- package/docs/examples/projects/update-session-invalidation.md +14 -0
- package/docs/examples/projects/update-sms-template.md +6 -6
- package/docs/examples/projects/update-smtp.md +12 -12
- package/docs/examples/projects/update-status.md +14 -0
- package/docs/examples/projects/update-team.md +4 -4
- package/docs/examples/projects/update-webhook-signature.md +4 -4
- package/docs/examples/projects/update-webhook.md +11 -11
- package/docs/examples/projects/update.md +13 -13
- package/docs/examples/proxy/{create-a-p-i-rule.md → create-api-rule.md} +3 -3
- package/docs/examples/proxy/create-function-rule.md +5 -5
- package/docs/examples/proxy/create-redirect-rule.md +8 -8
- package/docs/examples/proxy/create-site-rule.md +5 -5
- package/docs/examples/proxy/delete-rule.md +3 -3
- package/docs/examples/proxy/get-rule.md +3 -3
- package/docs/examples/proxy/list-rules.md +5 -4
- package/docs/examples/proxy/update-rule-verification.md +3 -3
- package/docs/examples/sites/create-deployment.md +8 -8
- package/docs/examples/sites/create-duplicate-deployment.md +4 -4
- package/docs/examples/sites/create-template-deployment.md +10 -9
- package/docs/examples/sites/create-variable.md +6 -6
- package/docs/examples/sites/create-vcs-deployment.md +7 -7
- package/docs/examples/sites/create.md +21 -21
- package/docs/examples/sites/delete-deployment.md +4 -4
- package/docs/examples/sites/delete-log.md +4 -4
- package/docs/examples/sites/delete-variable.md +4 -4
- package/docs/examples/sites/delete.md +3 -3
- package/docs/examples/sites/get-deployment-download.md +5 -5
- package/docs/examples/sites/get-deployment.md +4 -4
- package/docs/examples/sites/get-log.md +4 -4
- package/docs/examples/sites/get-template.md +3 -3
- package/docs/examples/sites/get-usage.md +5 -5
- package/docs/examples/sites/get-variable.md +4 -4
- package/docs/examples/sites/get.md +3 -3
- package/docs/examples/sites/list-deployments.md +6 -5
- package/docs/examples/sites/list-logs.md +5 -4
- package/docs/examples/sites/list-templates.md +6 -6
- package/docs/examples/sites/list-usage.md +4 -4
- package/docs/examples/sites/list-variables.md +3 -3
- package/docs/examples/sites/list.md +5 -4
- package/docs/examples/sites/update-deployment-status.md +4 -4
- package/docs/examples/sites/update-site-deployment.md +4 -4
- package/docs/examples/sites/update-variable.md +7 -7
- package/docs/examples/sites/update.md +21 -21
- package/docs/examples/storage/create-bucket.md +14 -13
- package/docs/examples/storage/create-file.md +7 -7
- package/docs/examples/storage/delete-bucket.md +3 -3
- package/docs/examples/storage/delete-file.md +4 -4
- package/docs/examples/storage/get-bucket-usage.md +5 -5
- package/docs/examples/storage/get-bucket.md +3 -3
- package/docs/examples/storage/get-file-download.md +5 -5
- package/docs/examples/storage/get-file-preview.md +16 -16
- package/docs/examples/storage/get-file-view.md +5 -5
- package/docs/examples/storage/get-file.md +4 -4
- package/docs/examples/storage/get-usage.md +4 -4
- package/docs/examples/storage/list-buckets.md +5 -4
- package/docs/examples/storage/list-files.md +6 -5
- package/docs/examples/storage/update-bucket.md +14 -13
- package/docs/examples/storage/update-file.md +7 -7
- package/docs/examples/tablesdb/create-boolean-column.md +18 -0
- package/docs/examples/tablesdb/create-datetime-column.md +18 -0
- package/docs/examples/tablesdb/create-email-column.md +18 -0
- package/docs/examples/tablesdb/create-enum-column.md +19 -0
- package/docs/examples/tablesdb/create-float-column.md +20 -0
- package/docs/examples/tablesdb/create-index.md +19 -0
- package/docs/examples/tablesdb/create-integer-column.md +20 -0
- package/docs/examples/tablesdb/create-ip-column.md +18 -0
- package/docs/examples/tablesdb/create-line-column.md +17 -0
- package/docs/examples/tablesdb/create-operations.md +24 -0
- package/docs/examples/tablesdb/create-point-column.md +17 -0
- package/docs/examples/tablesdb/create-polygon-column.md +17 -0
- package/docs/examples/tablesdb/create-relationship-column.md +20 -0
- package/docs/examples/tablesdb/create-row.md +24 -0
- package/docs/examples/tablesdb/create-rows.md +16 -0
- package/docs/examples/tablesdb/create-string-column.md +20 -0
- package/docs/examples/tablesdb/create-table.md +20 -0
- package/docs/examples/tablesdb/create-transaction.md +13 -0
- package/docs/examples/tablesdb/create-url-column.md +18 -0
- package/docs/examples/tablesdb/create.md +15 -0
- package/docs/examples/tablesdb/decrement-row-column.md +19 -0
- package/docs/examples/tablesdb/delete-column.md +15 -0
- package/docs/examples/tablesdb/delete-index.md +15 -0
- package/docs/examples/tablesdb/delete-row.md +16 -0
- package/docs/examples/tablesdb/delete-rows.md +16 -0
- package/docs/examples/tablesdb/delete-table.md +14 -0
- package/docs/examples/tablesdb/delete-transaction.md +13 -0
- package/docs/examples/tablesdb/delete.md +13 -0
- package/docs/examples/tablesdb/get-column.md +15 -0
- package/docs/examples/tablesdb/get-index.md +15 -0
- package/docs/examples/tablesdb/get-row.md +17 -0
- package/docs/examples/tablesdb/get-table-usage.md +15 -0
- package/docs/examples/tablesdb/get-table.md +14 -0
- package/docs/examples/tablesdb/get-transaction.md +13 -0
- package/docs/examples/tablesdb/get-usage.md +14 -0
- package/docs/examples/tablesdb/get.md +13 -0
- package/docs/examples/tablesdb/increment-row-column.md +19 -0
- package/docs/examples/tablesdb/list-columns.md +16 -0
- package/docs/examples/tablesdb/list-indexes.md +16 -0
- package/docs/examples/tablesdb/list-row-logs.md +16 -0
- package/docs/examples/tablesdb/list-rows.md +17 -0
- package/docs/examples/tablesdb/list-table-logs.md +15 -0
- package/docs/examples/tablesdb/list-tables.md +16 -0
- package/docs/examples/tablesdb/list-transactions.md +13 -0
- package/docs/examples/tablesdb/list-usage.md +13 -0
- package/docs/examples/tablesdb/list.md +15 -0
- package/docs/examples/tablesdb/update-boolean-column.md +18 -0
- package/docs/examples/tablesdb/update-datetime-column.md +18 -0
- package/docs/examples/tablesdb/update-email-column.md +18 -0
- package/docs/examples/tablesdb/update-enum-column.md +19 -0
- package/docs/examples/tablesdb/update-float-column.md +20 -0
- package/docs/examples/tablesdb/update-integer-column.md +20 -0
- package/docs/examples/tablesdb/update-ip-column.md +18 -0
- package/docs/examples/tablesdb/update-line-column.md +18 -0
- package/docs/examples/tablesdb/update-point-column.md +18 -0
- package/docs/examples/tablesdb/update-polygon-column.md +18 -0
- package/docs/examples/tablesdb/update-relationship-column.md +17 -0
- package/docs/examples/tablesdb/update-row.md +24 -0
- package/docs/examples/tablesdb/update-rows.md +23 -0
- package/docs/examples/tablesdb/update-string-column.md +19 -0
- package/docs/examples/tablesdb/update-table.md +18 -0
- package/docs/examples/tablesdb/update-transaction.md +15 -0
- package/docs/examples/tablesdb/update-url-column.md +18 -0
- package/docs/examples/tablesdb/update.md +15 -0
- package/docs/examples/tablesdb/upsert-row.md +24 -0
- package/docs/examples/tablesdb/upsert-rows.md +16 -0
- package/docs/examples/teams/create-membership.md +9 -9
- package/docs/examples/teams/create.md +5 -5
- package/docs/examples/teams/delete-membership.md +4 -4
- package/docs/examples/teams/delete.md +3 -3
- package/docs/examples/teams/get-membership.md +4 -4
- package/docs/examples/teams/get-prefs.md +3 -3
- package/docs/examples/teams/get.md +3 -3
- package/docs/examples/teams/list-logs.md +5 -4
- package/docs/examples/teams/list-memberships.md +6 -5
- package/docs/examples/teams/list.md +5 -4
- package/docs/examples/teams/update-membership-status.md +6 -6
- package/docs/examples/teams/update-membership.md +5 -5
- package/docs/examples/teams/update-name.md +4 -4
- package/docs/examples/teams/update-prefs.md +4 -4
- package/docs/examples/tokens/create-file-token.md +5 -5
- package/docs/examples/tokens/delete.md +3 -3
- package/docs/examples/tokens/get.md +3 -3
- package/docs/examples/tokens/list.md +6 -5
- package/docs/examples/tokens/update.md +4 -4
- package/docs/examples/users/{create-m-d5user.md → create-argon-2-user.md} +6 -6
- package/docs/examples/users/create-bcrypt-user.md +6 -6
- package/docs/examples/users/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/users/{create-argon2user.md → create-md-5-user.md} +6 -6
- package/docs/examples/users/create-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/{create-p-h-pass-user.md → create-ph-pass-user.md} +6 -6
- package/docs/examples/users/create-scrypt-modified-user.md +9 -9
- package/docs/examples/users/create-scrypt-user.md +11 -11
- package/docs/examples/users/create-session.md +3 -3
- package/docs/examples/users/{create-s-h-a-user.md → create-sha-user.md} +7 -7
- package/docs/examples/users/create-target.md +8 -8
- package/docs/examples/users/create-token.md +5 -5
- package/docs/examples/users/create.md +7 -7
- package/docs/examples/users/delete-identity.md +3 -3
- package/docs/examples/users/delete-mfa-authenticator.md +4 -4
- package/docs/examples/users/delete-session.md +4 -4
- package/docs/examples/users/delete-sessions.md +3 -3
- package/docs/examples/users/delete-target.md +4 -4
- package/docs/examples/users/delete.md +3 -3
- package/docs/examples/users/get-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/get-prefs.md +3 -3
- package/docs/examples/users/get-target.md +4 -4
- package/docs/examples/users/get-usage.md +4 -4
- package/docs/examples/users/get.md +3 -3
- package/docs/examples/users/list-identities.md +5 -4
- package/docs/examples/users/list-logs.md +5 -4
- package/docs/examples/users/list-memberships.md +6 -5
- package/docs/examples/users/list-mfa-factors.md +3 -3
- package/docs/examples/users/list-sessions.md +4 -3
- package/docs/examples/users/list-targets.md +5 -4
- package/docs/examples/users/list.md +5 -4
- package/docs/examples/users/update-email-verification.md +4 -4
- package/docs/examples/users/update-email.md +4 -4
- package/docs/examples/users/update-labels.md +4 -4
- package/docs/examples/users/update-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/update-mfa.md +4 -4
- package/docs/examples/users/update-name.md +4 -4
- package/docs/examples/users/update-password.md +4 -4
- package/docs/examples/users/update-phone-verification.md +4 -4
- package/docs/examples/users/update-phone.md +4 -4
- package/docs/examples/users/update-prefs.md +4 -4
- package/docs/examples/users/update-status.md +4 -4
- package/docs/examples/users/update-target.md +7 -7
- package/docs/examples/vcs/create-repository-detection.md +6 -6
- package/docs/examples/vcs/create-repository.md +5 -5
- package/docs/examples/vcs/delete-installation.md +3 -3
- package/docs/examples/vcs/get-installation.md +3 -3
- package/docs/examples/vcs/get-repository-contents.md +6 -6
- package/docs/examples/vcs/get-repository.md +4 -4
- package/docs/examples/vcs/list-installations.md +5 -4
- package/docs/examples/vcs/list-repositories.md +6 -5
- package/docs/examples/vcs/list-repository-branches.md +4 -4
- package/docs/examples/vcs/update-external-deployments.md +5 -5
- package/package.json +4 -4
- package/src/client.ts +42 -7
- package/src/enums/api-service.ts +1 -0
- package/src/enums/attribute-status.ts +7 -0
- package/src/enums/billing-plan-group.ts +5 -0
- package/src/enums/build-runtime.ts +2 -0
- package/src/enums/column-status.ts +7 -0
- package/src/enums/credit-card.ts +1 -1
- package/src/enums/database-type.ts +4 -0
- package/src/enums/deployment-status.ts +7 -0
- package/src/enums/execution-method.ts +1 -0
- package/src/enums/execution-status.ts +7 -0
- package/src/enums/execution-trigger.ts +5 -0
- package/src/enums/framework.ts +1 -0
- package/src/enums/health-antivirus-status.ts +5 -0
- package/src/enums/health-check-status.ts +4 -0
- package/src/enums/index-status.ts +7 -0
- package/src/enums/index-type.ts +1 -0
- package/src/enums/message-status.ts +7 -0
- package/src/enums/o-auth-provider.ts +3 -0
- package/src/enums/platform.ts +4 -0
- package/src/enums/proxy-rule-deployment-resource-type.ts +4 -0
- package/src/enums/proxy-rule-status.ts +6 -0
- package/src/enums/region.ts +3 -0
- package/src/enums/runtime.ts +2 -0
- package/src/enums/status.ts +4 -0
- package/src/enums/template-reference-type.ts +5 -0
- package/src/enums/theme.ts +4 -0
- package/src/enums/timezone.ts +421 -0
- package/src/enums/{user-usage-range.ts → usage-range.ts} +1 -1
- package/src/enums/{v-c-s-deployment-type.ts → vcs-reference-type.ts} +1 -1
- package/src/index.ts +27 -11
- package/src/models.ts +1692 -238
- package/src/operator.ts +308 -0
- package/src/query.ts +246 -2
- package/src/services/account.ts +2205 -223
- package/src/services/assistant.ts +29 -3
- package/src/services/avatars.ts +486 -33
- package/src/services/backups.ts +389 -42
- package/src/services/console.ts +492 -19
- package/src/services/databases.ts +3521 -431
- package/src/services/domains.ts +1684 -197
- package/src/services/functions.ts +1162 -149
- package/src/services/graphql.ts +55 -4
- package/src/services/health.ts +560 -41
- package/src/services/locale.ts +9 -0
- package/src/services/messaging.ts +3367 -380
- package/src/services/migrations.ts +641 -65
- package/src/services/organizations.ts +1323 -128
- package/src/services/project.ts +168 -17
- package/src/services/projects.ts +2742 -266
- package/src/services/proxy.ts +265 -26
- package/src/services/realtime.ts +437 -0
- package/src/services/sites.ts +1098 -140
- package/src/services/storage.ts +651 -82
- package/src/services/tables-db.ts +5439 -0
- package/src/services/teams.ts +512 -55
- package/src/services/tokens.ts +167 -16
- package/src/services/users.ts +1873 -181
- package/src/services/vcs.ts +359 -39
- package/types/client.d.ts +14 -5
- package/types/enums/api-service.d.ts +1 -0
- package/types/enums/attribute-status.d.ts +7 -0
- package/types/enums/billing-plan-group.d.ts +5 -0
- package/types/enums/build-runtime.d.ts +3 -1
- package/types/enums/column-status.d.ts +7 -0
- package/types/enums/credit-card.d.ts +1 -1
- package/types/enums/database-type.d.ts +4 -0
- package/types/enums/deployment-status.d.ts +7 -0
- package/types/enums/execution-method.d.ts +2 -1
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/framework.d.ts +1 -0
- package/types/enums/health-antivirus-status.d.ts +5 -0
- package/types/enums/health-check-status.d.ts +4 -0
- package/types/enums/index-status.d.ts +7 -0
- package/types/enums/index-type.d.ts +2 -1
- package/types/enums/message-status.d.ts +7 -0
- package/types/enums/o-auth-provider.d.ts +4 -1
- package/types/enums/platform.d.ts +4 -0
- package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
- package/types/enums/proxy-rule-status.d.ts +6 -0
- package/types/enums/region.d.ts +4 -1
- package/types/enums/runtime.d.ts +3 -1
- package/types/enums/status.d.ts +4 -0
- package/types/enums/template-reference-type.d.ts +5 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +421 -0
- package/types/enums/{site-usage-range.d.ts → usage-range.d.ts} +1 -1
- package/types/enums/{v-c-s-deployment-type.d.ts → vcs-reference-type.d.ts} +1 -1
- package/types/index.d.ts +27 -11
- package/types/models.d.ts +1664 -245
- package/types/operator.d.ts +180 -0
- package/types/query.d.ts +198 -2
- package/types/services/account.d.ts +985 -123
- package/types/services/assistant.d.ts +13 -2
- package/types/services/avatars.d.ts +244 -26
- package/types/services/backups.d.ts +190 -30
- package/types/services/console.d.ts +201 -14
- package/types/services/databases.d.ts +1731 -284
- package/types/services/domains.d.ts +904 -152
- package/types/services/functions.d.ts +616 -125
- package/types/services/graphql.d.ts +24 -2
- package/types/services/health.d.ts +245 -23
- package/types/services/messaging.d.ts +1660 -271
- package/types/services/migrations.d.ts +319 -53
- package/types/services/organizations.d.ts +635 -97
- package/types/services/project.d.ts +81 -12
- package/types/services/projects.d.ts +1308 -202
- package/types/services/proxy.d.ts +128 -19
- package/types/services/realtime.d.ts +118 -0
- package/types/services/sites.d.ts +577 -116
- package/types/services/storage.d.ts +354 -73
- package/types/services/tables-db.d.ts +2040 -0
- package/types/services/teams.d.ts +260 -44
- package/types/services/tokens.d.ts +80 -12
- package/types/services/users.d.ts +881 -124
- package/types/services/vcs.d.ts +179 -31
- package/docs/examples/domains/create-record-m-x.md +0 -18
- package/docs/examples/domains/create-record-s-r-v.md +0 -20
- package/docs/examples/domains/create-record-t-x-t.md +0 -17
- package/docs/examples/domains/update-record-a-a-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-n-a-m-e.md +0 -18
- package/docs/examples/domains/update-record-h-t-t-p-s.md +0 -18
- package/docs/examples/domains/update-record-m-x.md +0 -19
- package/docs/examples/domains/update-record-n-s.md +0 -18
- package/docs/examples/domains/update-record-s-r-v.md +0 -21
- package/docs/examples/domains/update-record-t-x-t.md +0 -18
- package/src/enums/billing-plan.ts +0 -5
- package/src/enums/database-usage-range.ts +0 -5
- package/src/enums/function-usage-range.ts +0 -5
- package/src/enums/site-usage-range.ts +0 -5
- package/src/enums/storage-usage-range.ts +0 -5
- package/types/enums/billing-plan.d.ts +0 -5
- package/types/enums/database-usage-range.d.ts +0 -5
- package/types/enums/function-usage-range.d.ts +0 -5
- package/types/enums/storage-usage-range.d.ts +0 -5
- package/types/enums/user-usage-range.d.ts +0 -5
- /package/docs/examples/health/{get-d-b.md → get-db.md} +0 -0
- /package/docs/examples/locale/{list-countries-e-u.md → list-countries-eu.md} +0 -0
- /package/src/enums/{s-m-t-p-secure.ts → smtp-secure.ts} +0 -0
- /package/src/enums/{v-c-s-detection-type.ts → vcs-detection-type.ts} +0 -0
- /package/types/enums/{s-m-t-p-secure.d.ts → smtp-secure.d.ts} +0 -0
- /package/types/enums/{v-c-s-detection-type.d.ts → vcs-detection-type.d.ts} +0 -0
|
@@ -8,593 +8,1982 @@ export declare class Messaging {
|
|
|
8
8
|
/**
|
|
9
9
|
* Get a list of all messages from the current Appwrite project.
|
|
10
10
|
*
|
|
11
|
-
* @param {string[]} queries
|
|
12
|
-
* @param {string} search
|
|
11
|
+
* @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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType
|
|
12
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
13
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
13
14
|
* @throws {AppwriteException}
|
|
14
15
|
* @returns {Promise<Models.MessageList>}
|
|
15
16
|
*/
|
|
16
|
-
listMessages(
|
|
17
|
+
listMessages(params?: {
|
|
18
|
+
queries?: string[];
|
|
19
|
+
search?: string;
|
|
20
|
+
total?: boolean;
|
|
21
|
+
}): Promise<Models.MessageList>;
|
|
22
|
+
/**
|
|
23
|
+
* Get a list of all messages from the current Appwrite project.
|
|
24
|
+
*
|
|
25
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType
|
|
26
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
27
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
28
|
+
* @throws {AppwriteException}
|
|
29
|
+
* @returns {Promise<Models.MessageList>}
|
|
30
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
31
|
+
*/
|
|
32
|
+
listMessages(queries?: string[], search?: string, total?: boolean): Promise<Models.MessageList>;
|
|
17
33
|
/**
|
|
18
34
|
* Create a new email message.
|
|
19
35
|
*
|
|
20
|
-
* @param {string} messageId
|
|
21
|
-
* @param {string} subject
|
|
22
|
-
* @param {string} content
|
|
23
|
-
* @param {string[]} topics
|
|
24
|
-
* @param {string[]} users
|
|
25
|
-
* @param {string[]} targets
|
|
26
|
-
* @param {string[]} cc
|
|
27
|
-
* @param {string[]} bcc
|
|
28
|
-
* @param {string[]} attachments
|
|
29
|
-
* @param {boolean} draft
|
|
30
|
-
* @param {boolean} html
|
|
31
|
-
* @param {string} scheduledAt
|
|
36
|
+
* @param {string} params.messageId - Message 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.
|
|
37
|
+
* @param {string} params.subject - Email Subject.
|
|
38
|
+
* @param {string} params.content - Email Content.
|
|
39
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
40
|
+
* @param {string[]} params.users - List of User IDs.
|
|
41
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
42
|
+
* @param {string[]} params.cc - Array of target IDs to be added as CC.
|
|
43
|
+
* @param {string[]} params.bcc - Array of target IDs to be added as BCC.
|
|
44
|
+
* @param {string[]} params.attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
45
|
+
* @param {boolean} params.draft - Is message a draft
|
|
46
|
+
* @param {boolean} params.html - Is content of type HTML
|
|
47
|
+
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
32
48
|
* @throws {AppwriteException}
|
|
33
49
|
* @returns {Promise<Models.Message>}
|
|
34
50
|
*/
|
|
51
|
+
createEmail(params: {
|
|
52
|
+
messageId: string;
|
|
53
|
+
subject: string;
|
|
54
|
+
content: string;
|
|
55
|
+
topics?: string[];
|
|
56
|
+
users?: string[];
|
|
57
|
+
targets?: string[];
|
|
58
|
+
cc?: string[];
|
|
59
|
+
bcc?: string[];
|
|
60
|
+
attachments?: string[];
|
|
61
|
+
draft?: boolean;
|
|
62
|
+
html?: boolean;
|
|
63
|
+
scheduledAt?: string;
|
|
64
|
+
}): Promise<Models.Message>;
|
|
65
|
+
/**
|
|
66
|
+
* Create a new email message.
|
|
67
|
+
*
|
|
68
|
+
* @param {string} messageId - Message 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.
|
|
69
|
+
* @param {string} subject - Email Subject.
|
|
70
|
+
* @param {string} content - Email Content.
|
|
71
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
72
|
+
* @param {string[]} users - List of User IDs.
|
|
73
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
74
|
+
* @param {string[]} cc - Array of target IDs to be added as CC.
|
|
75
|
+
* @param {string[]} bcc - Array of target IDs to be added as BCC.
|
|
76
|
+
* @param {string[]} attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
77
|
+
* @param {boolean} draft - Is message a draft
|
|
78
|
+
* @param {boolean} html - Is content of type HTML
|
|
79
|
+
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
80
|
+
* @throws {AppwriteException}
|
|
81
|
+
* @returns {Promise<Models.Message>}
|
|
82
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
83
|
+
*/
|
|
35
84
|
createEmail(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: string[], cc?: string[], bcc?: string[], attachments?: string[], draft?: boolean, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
36
85
|
/**
|
|
37
86
|
* Update an email message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
38
87
|
*
|
|
39
88
|
*
|
|
40
|
-
* @param {string} messageId
|
|
41
|
-
* @param {string[]} topics
|
|
42
|
-
* @param {string[]} users
|
|
43
|
-
* @param {string[]} targets
|
|
44
|
-
* @param {string} subject
|
|
45
|
-
* @param {string} content
|
|
46
|
-
* @param {boolean} draft
|
|
47
|
-
* @param {boolean} html
|
|
48
|
-
* @param {string[]} cc
|
|
49
|
-
* @param {string[]} bcc
|
|
50
|
-
* @param {string} scheduledAt
|
|
51
|
-
* @param {string[]} attachments
|
|
89
|
+
* @param {string} params.messageId - Message ID.
|
|
90
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
91
|
+
* @param {string[]} params.users - List of User IDs.
|
|
92
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
93
|
+
* @param {string} params.subject - Email Subject.
|
|
94
|
+
* @param {string} params.content - Email Content.
|
|
95
|
+
* @param {boolean} params.draft - Is message a draft
|
|
96
|
+
* @param {boolean} params.html - Is content of type HTML
|
|
97
|
+
* @param {string[]} params.cc - Array of target IDs to be added as CC.
|
|
98
|
+
* @param {string[]} params.bcc - Array of target IDs to be added as BCC.
|
|
99
|
+
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
100
|
+
* @param {string[]} params.attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
101
|
+
* @throws {AppwriteException}
|
|
102
|
+
* @returns {Promise<Models.Message>}
|
|
103
|
+
*/
|
|
104
|
+
updateEmail(params: {
|
|
105
|
+
messageId: string;
|
|
106
|
+
topics?: string[];
|
|
107
|
+
users?: string[];
|
|
108
|
+
targets?: string[];
|
|
109
|
+
subject?: string;
|
|
110
|
+
content?: string;
|
|
111
|
+
draft?: boolean;
|
|
112
|
+
html?: boolean;
|
|
113
|
+
cc?: string[];
|
|
114
|
+
bcc?: string[];
|
|
115
|
+
scheduledAt?: string;
|
|
116
|
+
attachments?: string[];
|
|
117
|
+
}): Promise<Models.Message>;
|
|
118
|
+
/**
|
|
119
|
+
* Update an email message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
120
|
+
*
|
|
121
|
+
*
|
|
122
|
+
* @param {string} messageId - Message ID.
|
|
123
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
124
|
+
* @param {string[]} users - List of User IDs.
|
|
125
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
126
|
+
* @param {string} subject - Email Subject.
|
|
127
|
+
* @param {string} content - Email Content.
|
|
128
|
+
* @param {boolean} draft - Is message a draft
|
|
129
|
+
* @param {boolean} html - Is content of type HTML
|
|
130
|
+
* @param {string[]} cc - Array of target IDs to be added as CC.
|
|
131
|
+
* @param {string[]} bcc - Array of target IDs to be added as BCC.
|
|
132
|
+
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
133
|
+
* @param {string[]} attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
52
134
|
* @throws {AppwriteException}
|
|
53
135
|
* @returns {Promise<Models.Message>}
|
|
136
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
54
137
|
*/
|
|
55
138
|
updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, draft?: boolean, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string, attachments?: string[]): Promise<Models.Message>;
|
|
56
139
|
/**
|
|
57
140
|
* Create a new push notification.
|
|
58
141
|
*
|
|
59
|
-
* @param {string} messageId
|
|
60
|
-
* @param {string} title
|
|
61
|
-
* @param {string} body
|
|
62
|
-
* @param {string[]} topics
|
|
63
|
-
* @param {string[]} users
|
|
64
|
-
* @param {string[]} targets
|
|
65
|
-
* @param {object} data
|
|
66
|
-
* @param {string} action
|
|
67
|
-
* @param {string} image
|
|
68
|
-
* @param {string} icon
|
|
69
|
-
* @param {string} sound
|
|
70
|
-
* @param {string} color
|
|
71
|
-
* @param {string} tag
|
|
72
|
-
* @param {number} badge
|
|
73
|
-
* @param {boolean} draft
|
|
74
|
-
* @param {string} scheduledAt
|
|
75
|
-
* @param {boolean} contentAvailable
|
|
76
|
-
* @param {boolean} critical
|
|
77
|
-
* @param {MessagePriority} priority
|
|
142
|
+
* @param {string} params.messageId - Message 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.
|
|
143
|
+
* @param {string} params.title - Title for push notification.
|
|
144
|
+
* @param {string} params.body - Body for push notification.
|
|
145
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
146
|
+
* @param {string[]} params.users - List of User IDs.
|
|
147
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
148
|
+
* @param {object} params.data - Additional key-value pair data for push notification.
|
|
149
|
+
* @param {string} params.action - Action for push notification.
|
|
150
|
+
* @param {string} params.image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
151
|
+
* @param {string} params.icon - Icon for push notification. Available only for Android and Web Platform.
|
|
152
|
+
* @param {string} params.sound - Sound for push notification. Available only for Android and iOS Platform.
|
|
153
|
+
* @param {string} params.color - Color for push notification. Available only for Android Platform.
|
|
154
|
+
* @param {string} params.tag - Tag for push notification. Available only for Android Platform.
|
|
155
|
+
* @param {number} params.badge - Badge for push notification. Available only for iOS Platform.
|
|
156
|
+
* @param {boolean} params.draft - Is message a draft
|
|
157
|
+
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
158
|
+
* @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
159
|
+
* @param {boolean} params.critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
160
|
+
* @param {MessagePriority} params.priority - Set the notification priority. "normal" will consider device state and may not deliver notifications immediately. "high" will always attempt to immediately deliver the notification.
|
|
78
161
|
* @throws {AppwriteException}
|
|
79
162
|
* @returns {Promise<Models.Message>}
|
|
80
163
|
*/
|
|
164
|
+
createPush(params: {
|
|
165
|
+
messageId: string;
|
|
166
|
+
title?: string;
|
|
167
|
+
body?: string;
|
|
168
|
+
topics?: string[];
|
|
169
|
+
users?: string[];
|
|
170
|
+
targets?: string[];
|
|
171
|
+
data?: object;
|
|
172
|
+
action?: string;
|
|
173
|
+
image?: string;
|
|
174
|
+
icon?: string;
|
|
175
|
+
sound?: string;
|
|
176
|
+
color?: string;
|
|
177
|
+
tag?: string;
|
|
178
|
+
badge?: number;
|
|
179
|
+
draft?: boolean;
|
|
180
|
+
scheduledAt?: string;
|
|
181
|
+
contentAvailable?: boolean;
|
|
182
|
+
critical?: boolean;
|
|
183
|
+
priority?: MessagePriority;
|
|
184
|
+
}): Promise<Models.Message>;
|
|
185
|
+
/**
|
|
186
|
+
* Create a new push notification.
|
|
187
|
+
*
|
|
188
|
+
* @param {string} messageId - Message 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.
|
|
189
|
+
* @param {string} title - Title for push notification.
|
|
190
|
+
* @param {string} body - Body for push notification.
|
|
191
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
192
|
+
* @param {string[]} users - List of User IDs.
|
|
193
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
194
|
+
* @param {object} data - Additional key-value pair data for push notification.
|
|
195
|
+
* @param {string} action - Action for push notification.
|
|
196
|
+
* @param {string} image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
197
|
+
* @param {string} icon - Icon for push notification. Available only for Android and Web Platform.
|
|
198
|
+
* @param {string} sound - Sound for push notification. Available only for Android and iOS Platform.
|
|
199
|
+
* @param {string} color - Color for push notification. Available only for Android Platform.
|
|
200
|
+
* @param {string} tag - Tag for push notification. Available only for Android Platform.
|
|
201
|
+
* @param {number} badge - Badge for push notification. Available only for iOS Platform.
|
|
202
|
+
* @param {boolean} draft - Is message a draft
|
|
203
|
+
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
204
|
+
* @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
205
|
+
* @param {boolean} critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
206
|
+
* @param {MessagePriority} priority - Set the notification priority. "normal" will consider device state and may not deliver notifications immediately. "high" will always attempt to immediately deliver the notification.
|
|
207
|
+
* @throws {AppwriteException}
|
|
208
|
+
* @returns {Promise<Models.Message>}
|
|
209
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
210
|
+
*/
|
|
81
211
|
createPush(messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority): Promise<Models.Message>;
|
|
82
212
|
/**
|
|
83
213
|
* Update a push notification by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
84
214
|
*
|
|
85
215
|
*
|
|
86
|
-
* @param {string} messageId
|
|
87
|
-
* @param {string[]} topics
|
|
88
|
-
* @param {string[]} users
|
|
89
|
-
* @param {string[]} targets
|
|
90
|
-
* @param {string} title
|
|
91
|
-
* @param {string} body
|
|
92
|
-
* @param {object} data
|
|
93
|
-
* @param {string} action
|
|
94
|
-
* @param {string} image
|
|
95
|
-
* @param {string} icon
|
|
96
|
-
* @param {string} sound
|
|
97
|
-
* @param {string} color
|
|
98
|
-
* @param {string} tag
|
|
99
|
-
* @param {number} badge
|
|
100
|
-
* @param {boolean} draft
|
|
101
|
-
* @param {string} scheduledAt
|
|
102
|
-
* @param {boolean} contentAvailable
|
|
103
|
-
* @param {boolean} critical
|
|
104
|
-
* @param {MessagePriority} priority
|
|
216
|
+
* @param {string} params.messageId - Message ID.
|
|
217
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
218
|
+
* @param {string[]} params.users - List of User IDs.
|
|
219
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
220
|
+
* @param {string} params.title - Title for push notification.
|
|
221
|
+
* @param {string} params.body - Body for push notification.
|
|
222
|
+
* @param {object} params.data - Additional Data for push notification.
|
|
223
|
+
* @param {string} params.action - Action for push notification.
|
|
224
|
+
* @param {string} params.image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
225
|
+
* @param {string} params.icon - Icon for push notification. Available only for Android and Web platforms.
|
|
226
|
+
* @param {string} params.sound - Sound for push notification. Available only for Android and iOS platforms.
|
|
227
|
+
* @param {string} params.color - Color for push notification. Available only for Android platforms.
|
|
228
|
+
* @param {string} params.tag - Tag for push notification. Available only for Android platforms.
|
|
229
|
+
* @param {number} params.badge - Badge for push notification. Available only for iOS platforms.
|
|
230
|
+
* @param {boolean} params.draft - Is message a draft
|
|
231
|
+
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
232
|
+
* @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
233
|
+
* @param {boolean} params.critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
234
|
+
* @param {MessagePriority} params.priority - Set the notification priority. "normal" will consider device battery state and may send notifications later. "high" will always attempt to immediately deliver the notification.
|
|
105
235
|
* @throws {AppwriteException}
|
|
106
236
|
* @returns {Promise<Models.Message>}
|
|
107
237
|
*/
|
|
238
|
+
updatePush(params: {
|
|
239
|
+
messageId: string;
|
|
240
|
+
topics?: string[];
|
|
241
|
+
users?: string[];
|
|
242
|
+
targets?: string[];
|
|
243
|
+
title?: string;
|
|
244
|
+
body?: string;
|
|
245
|
+
data?: object;
|
|
246
|
+
action?: string;
|
|
247
|
+
image?: string;
|
|
248
|
+
icon?: string;
|
|
249
|
+
sound?: string;
|
|
250
|
+
color?: string;
|
|
251
|
+
tag?: string;
|
|
252
|
+
badge?: number;
|
|
253
|
+
draft?: boolean;
|
|
254
|
+
scheduledAt?: string;
|
|
255
|
+
contentAvailable?: boolean;
|
|
256
|
+
critical?: boolean;
|
|
257
|
+
priority?: MessagePriority;
|
|
258
|
+
}): Promise<Models.Message>;
|
|
259
|
+
/**
|
|
260
|
+
* Update a push notification by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
261
|
+
*
|
|
262
|
+
*
|
|
263
|
+
* @param {string} messageId - Message ID.
|
|
264
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
265
|
+
* @param {string[]} users - List of User IDs.
|
|
266
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
267
|
+
* @param {string} title - Title for push notification.
|
|
268
|
+
* @param {string} body - Body for push notification.
|
|
269
|
+
* @param {object} data - Additional Data for push notification.
|
|
270
|
+
* @param {string} action - Action for push notification.
|
|
271
|
+
* @param {string} image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
272
|
+
* @param {string} icon - Icon for push notification. Available only for Android and Web platforms.
|
|
273
|
+
* @param {string} sound - Sound for push notification. Available only for Android and iOS platforms.
|
|
274
|
+
* @param {string} color - Color for push notification. Available only for Android platforms.
|
|
275
|
+
* @param {string} tag - Tag for push notification. Available only for Android platforms.
|
|
276
|
+
* @param {number} badge - Badge for push notification. Available only for iOS platforms.
|
|
277
|
+
* @param {boolean} draft - Is message a draft
|
|
278
|
+
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
279
|
+
* @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
280
|
+
* @param {boolean} critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
281
|
+
* @param {MessagePriority} priority - Set the notification priority. "normal" will consider device battery state and may send notifications later. "high" will always attempt to immediately deliver the notification.
|
|
282
|
+
* @throws {AppwriteException}
|
|
283
|
+
* @returns {Promise<Models.Message>}
|
|
284
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
285
|
+
*/
|
|
108
286
|
updatePush(messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority): Promise<Models.Message>;
|
|
109
287
|
/**
|
|
110
288
|
* Create a new SMS message.
|
|
111
289
|
*
|
|
112
|
-
* @param {string} messageId
|
|
113
|
-
* @param {string} content
|
|
114
|
-
* @param {string[]} topics
|
|
115
|
-
* @param {string[]} users
|
|
116
|
-
* @param {string[]} targets
|
|
117
|
-
* @param {boolean} draft
|
|
118
|
-
* @param {string} scheduledAt
|
|
290
|
+
* @param {string} params.messageId - Message 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} params.content - SMS Content.
|
|
292
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
293
|
+
* @param {string[]} params.users - List of User IDs.
|
|
294
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
295
|
+
* @param {boolean} params.draft - Is message a draft
|
|
296
|
+
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
119
297
|
* @throws {AppwriteException}
|
|
120
298
|
* @returns {Promise<Models.Message>}
|
|
299
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.createSMS` instead.
|
|
300
|
+
*/
|
|
301
|
+
createSms(params: {
|
|
302
|
+
messageId: string;
|
|
303
|
+
content: string;
|
|
304
|
+
topics?: string[];
|
|
305
|
+
users?: string[];
|
|
306
|
+
targets?: string[];
|
|
307
|
+
draft?: boolean;
|
|
308
|
+
scheduledAt?: string;
|
|
309
|
+
}): Promise<Models.Message>;
|
|
310
|
+
/**
|
|
311
|
+
* Create a new SMS message.
|
|
312
|
+
*
|
|
313
|
+
* @param {string} messageId - Message 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.
|
|
314
|
+
* @param {string} content - SMS Content.
|
|
315
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
316
|
+
* @param {string[]} users - List of User IDs.
|
|
317
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
318
|
+
* @param {boolean} draft - Is message a draft
|
|
319
|
+
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
320
|
+
* @throws {AppwriteException}
|
|
321
|
+
* @returns {Promise<Models.Message>}
|
|
322
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
121
323
|
*/
|
|
122
324
|
createSms(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
325
|
+
/**
|
|
326
|
+
* Create a new SMS message.
|
|
327
|
+
*
|
|
328
|
+
* @param {string} params.messageId - Message 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.
|
|
329
|
+
* @param {string} params.content - SMS Content.
|
|
330
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
331
|
+
* @param {string[]} params.users - List of User IDs.
|
|
332
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
333
|
+
* @param {boolean} params.draft - Is message a draft
|
|
334
|
+
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
335
|
+
* @throws {AppwriteException}
|
|
336
|
+
* @returns {Promise<Models.Message>}
|
|
337
|
+
*/
|
|
338
|
+
createSMS(params: {
|
|
339
|
+
messageId: string;
|
|
340
|
+
content: string;
|
|
341
|
+
topics?: string[];
|
|
342
|
+
users?: string[];
|
|
343
|
+
targets?: string[];
|
|
344
|
+
draft?: boolean;
|
|
345
|
+
scheduledAt?: string;
|
|
346
|
+
}): Promise<Models.Message>;
|
|
347
|
+
/**
|
|
348
|
+
* Create a new SMS message.
|
|
349
|
+
*
|
|
350
|
+
* @param {string} messageId - Message 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.
|
|
351
|
+
* @param {string} content - SMS Content.
|
|
352
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
353
|
+
* @param {string[]} users - List of User IDs.
|
|
354
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
355
|
+
* @param {boolean} draft - Is message a draft
|
|
356
|
+
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
357
|
+
* @throws {AppwriteException}
|
|
358
|
+
* @returns {Promise<Models.Message>}
|
|
359
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
360
|
+
*/
|
|
361
|
+
createSMS(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
123
362
|
/**
|
|
124
363
|
* Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
125
364
|
*
|
|
126
365
|
*
|
|
127
|
-
* @param {string} messageId
|
|
128
|
-
* @param {string[]} topics
|
|
129
|
-
* @param {string[]} users
|
|
130
|
-
* @param {string[]} targets
|
|
131
|
-
* @param {string} content
|
|
132
|
-
* @param {boolean} draft
|
|
133
|
-
* @param {string} scheduledAt
|
|
366
|
+
* @param {string} params.messageId - Message ID.
|
|
367
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
368
|
+
* @param {string[]} params.users - List of User IDs.
|
|
369
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
370
|
+
* @param {string} params.content - Email Content.
|
|
371
|
+
* @param {boolean} params.draft - Is message a draft
|
|
372
|
+
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
134
373
|
* @throws {AppwriteException}
|
|
135
374
|
* @returns {Promise<Models.Message>}
|
|
375
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.updateSMS` instead.
|
|
376
|
+
*/
|
|
377
|
+
updateSms(params: {
|
|
378
|
+
messageId: string;
|
|
379
|
+
topics?: string[];
|
|
380
|
+
users?: string[];
|
|
381
|
+
targets?: string[];
|
|
382
|
+
content?: string;
|
|
383
|
+
draft?: boolean;
|
|
384
|
+
scheduledAt?: string;
|
|
385
|
+
}): Promise<Models.Message>;
|
|
386
|
+
/**
|
|
387
|
+
* Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
388
|
+
*
|
|
389
|
+
*
|
|
390
|
+
* @param {string} messageId - Message ID.
|
|
391
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
392
|
+
* @param {string[]} users - List of User IDs.
|
|
393
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
394
|
+
* @param {string} content - Email Content.
|
|
395
|
+
* @param {boolean} draft - Is message a draft
|
|
396
|
+
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
397
|
+
* @throws {AppwriteException}
|
|
398
|
+
* @returns {Promise<Models.Message>}
|
|
399
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
136
400
|
*/
|
|
137
401
|
updateSms(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
402
|
+
/**
|
|
403
|
+
* Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
404
|
+
*
|
|
405
|
+
*
|
|
406
|
+
* @param {string} params.messageId - Message ID.
|
|
407
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
408
|
+
* @param {string[]} params.users - List of User IDs.
|
|
409
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
410
|
+
* @param {string} params.content - Email Content.
|
|
411
|
+
* @param {boolean} params.draft - Is message a draft
|
|
412
|
+
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
413
|
+
* @throws {AppwriteException}
|
|
414
|
+
* @returns {Promise<Models.Message>}
|
|
415
|
+
*/
|
|
416
|
+
updateSMS(params: {
|
|
417
|
+
messageId: string;
|
|
418
|
+
topics?: string[];
|
|
419
|
+
users?: string[];
|
|
420
|
+
targets?: string[];
|
|
421
|
+
content?: string;
|
|
422
|
+
draft?: boolean;
|
|
423
|
+
scheduledAt?: string;
|
|
424
|
+
}): Promise<Models.Message>;
|
|
425
|
+
/**
|
|
426
|
+
* Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
427
|
+
*
|
|
428
|
+
*
|
|
429
|
+
* @param {string} messageId - Message ID.
|
|
430
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
431
|
+
* @param {string[]} users - List of User IDs.
|
|
432
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
433
|
+
* @param {string} content - Email Content.
|
|
434
|
+
* @param {boolean} draft - Is message a draft
|
|
435
|
+
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
436
|
+
* @throws {AppwriteException}
|
|
437
|
+
* @returns {Promise<Models.Message>}
|
|
438
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
439
|
+
*/
|
|
440
|
+
updateSMS(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
441
|
+
/**
|
|
442
|
+
* Get a message by its unique ID.
|
|
443
|
+
*
|
|
444
|
+
*
|
|
445
|
+
* @param {string} params.messageId - Message ID.
|
|
446
|
+
* @throws {AppwriteException}
|
|
447
|
+
* @returns {Promise<Models.Message>}
|
|
448
|
+
*/
|
|
449
|
+
getMessage(params: {
|
|
450
|
+
messageId: string;
|
|
451
|
+
}): Promise<Models.Message>;
|
|
138
452
|
/**
|
|
139
453
|
* Get a message by its unique ID.
|
|
140
454
|
*
|
|
141
455
|
*
|
|
142
|
-
* @param {string} messageId
|
|
456
|
+
* @param {string} messageId - Message ID.
|
|
143
457
|
* @throws {AppwriteException}
|
|
144
458
|
* @returns {Promise<Models.Message>}
|
|
459
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
145
460
|
*/
|
|
146
461
|
getMessage(messageId: string): Promise<Models.Message>;
|
|
147
462
|
/**
|
|
148
463
|
* Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.
|
|
149
464
|
*
|
|
150
|
-
* @param {string} messageId
|
|
465
|
+
* @param {string} params.messageId - Message ID.
|
|
151
466
|
* @throws {AppwriteException}
|
|
152
467
|
* @returns {Promise<{}>}
|
|
153
468
|
*/
|
|
469
|
+
delete(params: {
|
|
470
|
+
messageId: string;
|
|
471
|
+
}): Promise<{}>;
|
|
472
|
+
/**
|
|
473
|
+
* Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.
|
|
474
|
+
*
|
|
475
|
+
* @param {string} messageId - Message ID.
|
|
476
|
+
* @throws {AppwriteException}
|
|
477
|
+
* @returns {Promise<{}>}
|
|
478
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
479
|
+
*/
|
|
154
480
|
delete(messageId: string): Promise<{}>;
|
|
155
481
|
/**
|
|
156
482
|
* Get the message activity logs listed by its unique ID.
|
|
157
483
|
*
|
|
158
|
-
* @param {string} messageId
|
|
159
|
-
* @param {string[]} queries
|
|
484
|
+
* @param {string} params.messageId - Message ID.
|
|
485
|
+
* @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
|
|
486
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
160
487
|
* @throws {AppwriteException}
|
|
161
488
|
* @returns {Promise<Models.LogList>}
|
|
162
489
|
*/
|
|
163
|
-
listMessageLogs(
|
|
490
|
+
listMessageLogs(params: {
|
|
491
|
+
messageId: string;
|
|
492
|
+
queries?: string[];
|
|
493
|
+
total?: boolean;
|
|
494
|
+
}): Promise<Models.LogList>;
|
|
495
|
+
/**
|
|
496
|
+
* Get the message activity logs listed by its unique ID.
|
|
497
|
+
*
|
|
498
|
+
* @param {string} messageId - Message ID.
|
|
499
|
+
* @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
|
|
500
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
501
|
+
* @throws {AppwriteException}
|
|
502
|
+
* @returns {Promise<Models.LogList>}
|
|
503
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
504
|
+
*/
|
|
505
|
+
listMessageLogs(messageId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
|
|
506
|
+
/**
|
|
507
|
+
* Get a list of the targets associated with a message.
|
|
508
|
+
*
|
|
509
|
+
* @param {string} params.messageId - Message ID.
|
|
510
|
+
* @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
|
|
511
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
512
|
+
* @throws {AppwriteException}
|
|
513
|
+
* @returns {Promise<Models.TargetList>}
|
|
514
|
+
*/
|
|
515
|
+
listTargets(params: {
|
|
516
|
+
messageId: string;
|
|
517
|
+
queries?: string[];
|
|
518
|
+
total?: boolean;
|
|
519
|
+
}): Promise<Models.TargetList>;
|
|
164
520
|
/**
|
|
165
521
|
* Get a list of the targets associated with a message.
|
|
166
522
|
*
|
|
167
|
-
* @param {string} messageId
|
|
168
|
-
* @param {string[]} queries
|
|
523
|
+
* @param {string} messageId - Message ID.
|
|
524
|
+
* @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
|
|
525
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
169
526
|
* @throws {AppwriteException}
|
|
170
527
|
* @returns {Promise<Models.TargetList>}
|
|
528
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
171
529
|
*/
|
|
172
|
-
listTargets(messageId: string, queries?: string[]): Promise<Models.TargetList>;
|
|
530
|
+
listTargets(messageId: string, queries?: string[], total?: boolean): Promise<Models.TargetList>;
|
|
173
531
|
/**
|
|
174
532
|
* Get a list of all providers from the current Appwrite project.
|
|
175
533
|
*
|
|
176
|
-
* @param {string[]} queries
|
|
177
|
-
* @param {string} search
|
|
534
|
+
* @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, provider, type, enabled
|
|
535
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
536
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
178
537
|
* @throws {AppwriteException}
|
|
179
538
|
* @returns {Promise<Models.ProviderList>}
|
|
180
539
|
*/
|
|
181
|
-
listProviders(
|
|
540
|
+
listProviders(params?: {
|
|
541
|
+
queries?: string[];
|
|
542
|
+
search?: string;
|
|
543
|
+
total?: boolean;
|
|
544
|
+
}): Promise<Models.ProviderList>;
|
|
545
|
+
/**
|
|
546
|
+
* Get a list of all providers from the current Appwrite project.
|
|
547
|
+
*
|
|
548
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled
|
|
549
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
550
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
551
|
+
* @throws {AppwriteException}
|
|
552
|
+
* @returns {Promise<Models.ProviderList>}
|
|
553
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
554
|
+
*/
|
|
555
|
+
listProviders(queries?: string[], search?: string, total?: boolean): Promise<Models.ProviderList>;
|
|
556
|
+
/**
|
|
557
|
+
* Create a new Apple Push Notification service provider.
|
|
558
|
+
*
|
|
559
|
+
* @param {string} params.providerId - Provider 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.
|
|
560
|
+
* @param {string} params.name - Provider name.
|
|
561
|
+
* @param {string} params.authKey - APNS authentication key.
|
|
562
|
+
* @param {string} params.authKeyId - APNS authentication key ID.
|
|
563
|
+
* @param {string} params.teamId - APNS team ID.
|
|
564
|
+
* @param {string} params.bundleId - APNS bundle ID.
|
|
565
|
+
* @param {boolean} params.sandbox - Use APNS sandbox environment.
|
|
566
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
567
|
+
* @throws {AppwriteException}
|
|
568
|
+
* @returns {Promise<Models.Provider>}
|
|
569
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.createAPNSProvider` instead.
|
|
570
|
+
*/
|
|
571
|
+
createApnsProvider(params: {
|
|
572
|
+
providerId: string;
|
|
573
|
+
name: string;
|
|
574
|
+
authKey?: string;
|
|
575
|
+
authKeyId?: string;
|
|
576
|
+
teamId?: string;
|
|
577
|
+
bundleId?: string;
|
|
578
|
+
sandbox?: boolean;
|
|
579
|
+
enabled?: boolean;
|
|
580
|
+
}): Promise<Models.Provider>;
|
|
182
581
|
/**
|
|
183
582
|
* Create a new Apple Push Notification service provider.
|
|
184
583
|
*
|
|
185
|
-
* @param {string} providerId
|
|
186
|
-
* @param {string} name
|
|
187
|
-
* @param {string} authKey
|
|
188
|
-
* @param {string} authKeyId
|
|
189
|
-
* @param {string} teamId
|
|
190
|
-
* @param {string} bundleId
|
|
191
|
-
* @param {boolean} sandbox
|
|
192
|
-
* @param {boolean} enabled
|
|
584
|
+
* @param {string} providerId - Provider 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.
|
|
585
|
+
* @param {string} name - Provider name.
|
|
586
|
+
* @param {string} authKey - APNS authentication key.
|
|
587
|
+
* @param {string} authKeyId - APNS authentication key ID.
|
|
588
|
+
* @param {string} teamId - APNS team ID.
|
|
589
|
+
* @param {string} bundleId - APNS bundle ID.
|
|
590
|
+
* @param {boolean} sandbox - Use APNS sandbox environment.
|
|
591
|
+
* @param {boolean} enabled - Set as enabled.
|
|
193
592
|
* @throws {AppwriteException}
|
|
194
593
|
* @returns {Promise<Models.Provider>}
|
|
594
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
195
595
|
*/
|
|
196
596
|
createApnsProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean, enabled?: boolean): Promise<Models.Provider>;
|
|
597
|
+
/**
|
|
598
|
+
* Create a new Apple Push Notification service provider.
|
|
599
|
+
*
|
|
600
|
+
* @param {string} params.providerId - Provider 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.
|
|
601
|
+
* @param {string} params.name - Provider name.
|
|
602
|
+
* @param {string} params.authKey - APNS authentication key.
|
|
603
|
+
* @param {string} params.authKeyId - APNS authentication key ID.
|
|
604
|
+
* @param {string} params.teamId - APNS team ID.
|
|
605
|
+
* @param {string} params.bundleId - APNS bundle ID.
|
|
606
|
+
* @param {boolean} params.sandbox - Use APNS sandbox environment.
|
|
607
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
608
|
+
* @throws {AppwriteException}
|
|
609
|
+
* @returns {Promise<Models.Provider>}
|
|
610
|
+
*/
|
|
611
|
+
createAPNSProvider(params: {
|
|
612
|
+
providerId: string;
|
|
613
|
+
name: string;
|
|
614
|
+
authKey?: string;
|
|
615
|
+
authKeyId?: string;
|
|
616
|
+
teamId?: string;
|
|
617
|
+
bundleId?: string;
|
|
618
|
+
sandbox?: boolean;
|
|
619
|
+
enabled?: boolean;
|
|
620
|
+
}): Promise<Models.Provider>;
|
|
621
|
+
/**
|
|
622
|
+
* Create a new Apple Push Notification service provider.
|
|
623
|
+
*
|
|
624
|
+
* @param {string} providerId - Provider 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.
|
|
625
|
+
* @param {string} name - Provider name.
|
|
626
|
+
* @param {string} authKey - APNS authentication key.
|
|
627
|
+
* @param {string} authKeyId - APNS authentication key ID.
|
|
628
|
+
* @param {string} teamId - APNS team ID.
|
|
629
|
+
* @param {string} bundleId - APNS bundle ID.
|
|
630
|
+
* @param {boolean} sandbox - Use APNS sandbox environment.
|
|
631
|
+
* @param {boolean} enabled - Set as enabled.
|
|
632
|
+
* @throws {AppwriteException}
|
|
633
|
+
* @returns {Promise<Models.Provider>}
|
|
634
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
635
|
+
*/
|
|
636
|
+
createAPNSProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean, enabled?: boolean): Promise<Models.Provider>;
|
|
637
|
+
/**
|
|
638
|
+
* Update a Apple Push Notification service provider by its unique ID.
|
|
639
|
+
*
|
|
640
|
+
* @param {string} params.providerId - Provider ID.
|
|
641
|
+
* @param {string} params.name - Provider name.
|
|
642
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
643
|
+
* @param {string} params.authKey - APNS authentication key.
|
|
644
|
+
* @param {string} params.authKeyId - APNS authentication key ID.
|
|
645
|
+
* @param {string} params.teamId - APNS team ID.
|
|
646
|
+
* @param {string} params.bundleId - APNS bundle ID.
|
|
647
|
+
* @param {boolean} params.sandbox - Use APNS sandbox environment.
|
|
648
|
+
* @throws {AppwriteException}
|
|
649
|
+
* @returns {Promise<Models.Provider>}
|
|
650
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.updateAPNSProvider` instead.
|
|
651
|
+
*/
|
|
652
|
+
updateApnsProvider(params: {
|
|
653
|
+
providerId: string;
|
|
654
|
+
name?: string;
|
|
655
|
+
enabled?: boolean;
|
|
656
|
+
authKey?: string;
|
|
657
|
+
authKeyId?: string;
|
|
658
|
+
teamId?: string;
|
|
659
|
+
bundleId?: string;
|
|
660
|
+
sandbox?: boolean;
|
|
661
|
+
}): Promise<Models.Provider>;
|
|
197
662
|
/**
|
|
198
663
|
* Update a Apple Push Notification service provider by its unique ID.
|
|
199
664
|
*
|
|
200
|
-
* @param {string} providerId
|
|
201
|
-
* @param {string} name
|
|
202
|
-
* @param {boolean} enabled
|
|
203
|
-
* @param {string} authKey
|
|
204
|
-
* @param {string} authKeyId
|
|
205
|
-
* @param {string} teamId
|
|
206
|
-
* @param {string} bundleId
|
|
207
|
-
* @param {boolean} sandbox
|
|
665
|
+
* @param {string} providerId - Provider ID.
|
|
666
|
+
* @param {string} name - Provider name.
|
|
667
|
+
* @param {boolean} enabled - Set as enabled.
|
|
668
|
+
* @param {string} authKey - APNS authentication key.
|
|
669
|
+
* @param {string} authKeyId - APNS authentication key ID.
|
|
670
|
+
* @param {string} teamId - APNS team ID.
|
|
671
|
+
* @param {string} bundleId - APNS bundle ID.
|
|
672
|
+
* @param {boolean} sandbox - Use APNS sandbox environment.
|
|
208
673
|
* @throws {AppwriteException}
|
|
209
674
|
* @returns {Promise<Models.Provider>}
|
|
675
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
210
676
|
*/
|
|
211
677
|
updateApnsProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean): Promise<Models.Provider>;
|
|
678
|
+
/**
|
|
679
|
+
* Update a Apple Push Notification service provider by its unique ID.
|
|
680
|
+
*
|
|
681
|
+
* @param {string} params.providerId - Provider ID.
|
|
682
|
+
* @param {string} params.name - Provider name.
|
|
683
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
684
|
+
* @param {string} params.authKey - APNS authentication key.
|
|
685
|
+
* @param {string} params.authKeyId - APNS authentication key ID.
|
|
686
|
+
* @param {string} params.teamId - APNS team ID.
|
|
687
|
+
* @param {string} params.bundleId - APNS bundle ID.
|
|
688
|
+
* @param {boolean} params.sandbox - Use APNS sandbox environment.
|
|
689
|
+
* @throws {AppwriteException}
|
|
690
|
+
* @returns {Promise<Models.Provider>}
|
|
691
|
+
*/
|
|
692
|
+
updateAPNSProvider(params: {
|
|
693
|
+
providerId: string;
|
|
694
|
+
name?: string;
|
|
695
|
+
enabled?: boolean;
|
|
696
|
+
authKey?: string;
|
|
697
|
+
authKeyId?: string;
|
|
698
|
+
teamId?: string;
|
|
699
|
+
bundleId?: string;
|
|
700
|
+
sandbox?: boolean;
|
|
701
|
+
}): Promise<Models.Provider>;
|
|
702
|
+
/**
|
|
703
|
+
* Update a Apple Push Notification service provider by its unique ID.
|
|
704
|
+
*
|
|
705
|
+
* @param {string} providerId - Provider ID.
|
|
706
|
+
* @param {string} name - Provider name.
|
|
707
|
+
* @param {boolean} enabled - Set as enabled.
|
|
708
|
+
* @param {string} authKey - APNS authentication key.
|
|
709
|
+
* @param {string} authKeyId - APNS authentication key ID.
|
|
710
|
+
* @param {string} teamId - APNS team ID.
|
|
711
|
+
* @param {string} bundleId - APNS bundle ID.
|
|
712
|
+
* @param {boolean} sandbox - Use APNS sandbox environment.
|
|
713
|
+
* @throws {AppwriteException}
|
|
714
|
+
* @returns {Promise<Models.Provider>}
|
|
715
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
716
|
+
*/
|
|
717
|
+
updateAPNSProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean): Promise<Models.Provider>;
|
|
212
718
|
/**
|
|
213
719
|
* Create a new Firebase Cloud Messaging provider.
|
|
214
720
|
*
|
|
215
|
-
* @param {string} providerId
|
|
216
|
-
* @param {string} name
|
|
217
|
-
* @param {object} serviceAccountJSON
|
|
218
|
-
* @param {boolean} enabled
|
|
721
|
+
* @param {string} params.providerId - Provider 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.
|
|
722
|
+
* @param {string} params.name - Provider name.
|
|
723
|
+
* @param {object} params.serviceAccountJSON - FCM service account JSON.
|
|
724
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
219
725
|
* @throws {AppwriteException}
|
|
220
726
|
* @returns {Promise<Models.Provider>}
|
|
727
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.createFCMProvider` instead.
|
|
728
|
+
*/
|
|
729
|
+
createFcmProvider(params: {
|
|
730
|
+
providerId: string;
|
|
731
|
+
name: string;
|
|
732
|
+
serviceAccountJSON?: object;
|
|
733
|
+
enabled?: boolean;
|
|
734
|
+
}): Promise<Models.Provider>;
|
|
735
|
+
/**
|
|
736
|
+
* Create a new Firebase Cloud Messaging provider.
|
|
737
|
+
*
|
|
738
|
+
* @param {string} providerId - Provider 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.
|
|
739
|
+
* @param {string} name - Provider name.
|
|
740
|
+
* @param {object} serviceAccountJSON - FCM service account JSON.
|
|
741
|
+
* @param {boolean} enabled - Set as enabled.
|
|
742
|
+
* @throws {AppwriteException}
|
|
743
|
+
* @returns {Promise<Models.Provider>}
|
|
744
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
221
745
|
*/
|
|
222
746
|
createFcmProvider(providerId: string, name: string, serviceAccountJSON?: object, enabled?: boolean): Promise<Models.Provider>;
|
|
747
|
+
/**
|
|
748
|
+
* Create a new Firebase Cloud Messaging provider.
|
|
749
|
+
*
|
|
750
|
+
* @param {string} params.providerId - Provider 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.
|
|
751
|
+
* @param {string} params.name - Provider name.
|
|
752
|
+
* @param {object} params.serviceAccountJSON - FCM service account JSON.
|
|
753
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
754
|
+
* @throws {AppwriteException}
|
|
755
|
+
* @returns {Promise<Models.Provider>}
|
|
756
|
+
*/
|
|
757
|
+
createFCMProvider(params: {
|
|
758
|
+
providerId: string;
|
|
759
|
+
name: string;
|
|
760
|
+
serviceAccountJSON?: object;
|
|
761
|
+
enabled?: boolean;
|
|
762
|
+
}): Promise<Models.Provider>;
|
|
763
|
+
/**
|
|
764
|
+
* Create a new Firebase Cloud Messaging provider.
|
|
765
|
+
*
|
|
766
|
+
* @param {string} providerId - Provider 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.
|
|
767
|
+
* @param {string} name - Provider name.
|
|
768
|
+
* @param {object} serviceAccountJSON - FCM service account JSON.
|
|
769
|
+
* @param {boolean} enabled - Set as enabled.
|
|
770
|
+
* @throws {AppwriteException}
|
|
771
|
+
* @returns {Promise<Models.Provider>}
|
|
772
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
773
|
+
*/
|
|
774
|
+
createFCMProvider(providerId: string, name: string, serviceAccountJSON?: object, enabled?: boolean): Promise<Models.Provider>;
|
|
223
775
|
/**
|
|
224
776
|
* Update a Firebase Cloud Messaging provider by its unique ID.
|
|
225
777
|
*
|
|
226
|
-
* @param {string} providerId
|
|
227
|
-
* @param {string} name
|
|
228
|
-
* @param {boolean} enabled
|
|
229
|
-
* @param {object} serviceAccountJSON
|
|
778
|
+
* @param {string} params.providerId - Provider ID.
|
|
779
|
+
* @param {string} params.name - Provider name.
|
|
780
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
781
|
+
* @param {object} params.serviceAccountJSON - FCM service account JSON.
|
|
230
782
|
* @throws {AppwriteException}
|
|
231
783
|
* @returns {Promise<Models.Provider>}
|
|
784
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.updateFCMProvider` instead.
|
|
785
|
+
*/
|
|
786
|
+
updateFcmProvider(params: {
|
|
787
|
+
providerId: string;
|
|
788
|
+
name?: string;
|
|
789
|
+
enabled?: boolean;
|
|
790
|
+
serviceAccountJSON?: object;
|
|
791
|
+
}): Promise<Models.Provider>;
|
|
792
|
+
/**
|
|
793
|
+
* Update a Firebase Cloud Messaging provider by its unique ID.
|
|
794
|
+
*
|
|
795
|
+
* @param {string} providerId - Provider ID.
|
|
796
|
+
* @param {string} name - Provider name.
|
|
797
|
+
* @param {boolean} enabled - Set as enabled.
|
|
798
|
+
* @param {object} serviceAccountJSON - FCM service account JSON.
|
|
799
|
+
* @throws {AppwriteException}
|
|
800
|
+
* @returns {Promise<Models.Provider>}
|
|
801
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
232
802
|
*/
|
|
233
803
|
updateFcmProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
|
|
804
|
+
/**
|
|
805
|
+
* Update a Firebase Cloud Messaging provider by its unique ID.
|
|
806
|
+
*
|
|
807
|
+
* @param {string} params.providerId - Provider ID.
|
|
808
|
+
* @param {string} params.name - Provider name.
|
|
809
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
810
|
+
* @param {object} params.serviceAccountJSON - FCM service account JSON.
|
|
811
|
+
* @throws {AppwriteException}
|
|
812
|
+
* @returns {Promise<Models.Provider>}
|
|
813
|
+
*/
|
|
814
|
+
updateFCMProvider(params: {
|
|
815
|
+
providerId: string;
|
|
816
|
+
name?: string;
|
|
817
|
+
enabled?: boolean;
|
|
818
|
+
serviceAccountJSON?: object;
|
|
819
|
+
}): Promise<Models.Provider>;
|
|
820
|
+
/**
|
|
821
|
+
* Update a Firebase Cloud Messaging provider by its unique ID.
|
|
822
|
+
*
|
|
823
|
+
* @param {string} providerId - Provider ID.
|
|
824
|
+
* @param {string} name - Provider name.
|
|
825
|
+
* @param {boolean} enabled - Set as enabled.
|
|
826
|
+
* @param {object} serviceAccountJSON - FCM service account JSON.
|
|
827
|
+
* @throws {AppwriteException}
|
|
828
|
+
* @returns {Promise<Models.Provider>}
|
|
829
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
830
|
+
*/
|
|
831
|
+
updateFCMProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
|
|
832
|
+
/**
|
|
833
|
+
* Create a new Mailgun provider.
|
|
834
|
+
*
|
|
835
|
+
* @param {string} params.providerId - Provider 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.
|
|
836
|
+
* @param {string} params.name - Provider name.
|
|
837
|
+
* @param {string} params.apiKey - Mailgun API Key.
|
|
838
|
+
* @param {string} params.domain - Mailgun Domain.
|
|
839
|
+
* @param {boolean} params.isEuRegion - Set as EU region.
|
|
840
|
+
* @param {string} params.fromName - Sender Name.
|
|
841
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
842
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.
|
|
843
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.
|
|
844
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
845
|
+
* @throws {AppwriteException}
|
|
846
|
+
* @returns {Promise<Models.Provider>}
|
|
847
|
+
*/
|
|
848
|
+
createMailgunProvider(params: {
|
|
849
|
+
providerId: string;
|
|
850
|
+
name: string;
|
|
851
|
+
apiKey?: string;
|
|
852
|
+
domain?: string;
|
|
853
|
+
isEuRegion?: boolean;
|
|
854
|
+
fromName?: string;
|
|
855
|
+
fromEmail?: string;
|
|
856
|
+
replyToName?: string;
|
|
857
|
+
replyToEmail?: string;
|
|
858
|
+
enabled?: boolean;
|
|
859
|
+
}): Promise<Models.Provider>;
|
|
234
860
|
/**
|
|
235
861
|
* Create a new Mailgun provider.
|
|
236
862
|
*
|
|
237
|
-
* @param {string} providerId
|
|
238
|
-
* @param {string} name
|
|
239
|
-
* @param {string} apiKey
|
|
240
|
-
* @param {string} domain
|
|
241
|
-
* @param {boolean} isEuRegion
|
|
242
|
-
* @param {string} fromName
|
|
243
|
-
* @param {string} fromEmail
|
|
244
|
-
* @param {string} replyToName
|
|
245
|
-
* @param {string} replyToEmail
|
|
246
|
-
* @param {boolean} enabled
|
|
863
|
+
* @param {string} providerId - Provider 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.
|
|
864
|
+
* @param {string} name - Provider name.
|
|
865
|
+
* @param {string} apiKey - Mailgun API Key.
|
|
866
|
+
* @param {string} domain - Mailgun Domain.
|
|
867
|
+
* @param {boolean} isEuRegion - Set as EU region.
|
|
868
|
+
* @param {string} fromName - Sender Name.
|
|
869
|
+
* @param {string} fromEmail - Sender email address.
|
|
870
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.
|
|
871
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.
|
|
872
|
+
* @param {boolean} enabled - Set as enabled.
|
|
247
873
|
* @throws {AppwriteException}
|
|
248
874
|
* @returns {Promise<Models.Provider>}
|
|
875
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
249
876
|
*/
|
|
250
877
|
createMailgunProvider(providerId: string, name: string, apiKey?: string, domain?: string, isEuRegion?: boolean, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
251
878
|
/**
|
|
252
879
|
* Update a Mailgun provider by its unique ID.
|
|
253
880
|
*
|
|
254
|
-
* @param {string} providerId
|
|
255
|
-
* @param {string} name
|
|
256
|
-
* @param {string} apiKey
|
|
257
|
-
* @param {string} domain
|
|
258
|
-
* @param {boolean} isEuRegion
|
|
259
|
-
* @param {boolean} enabled
|
|
260
|
-
* @param {string} fromName
|
|
261
|
-
* @param {string} fromEmail
|
|
262
|
-
* @param {string} replyToName
|
|
263
|
-
* @param {string} replyToEmail
|
|
881
|
+
* @param {string} params.providerId - Provider ID.
|
|
882
|
+
* @param {string} params.name - Provider name.
|
|
883
|
+
* @param {string} params.apiKey - Mailgun API Key.
|
|
884
|
+
* @param {string} params.domain - Mailgun Domain.
|
|
885
|
+
* @param {boolean} params.isEuRegion - Set as EU region.
|
|
886
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
887
|
+
* @param {string} params.fromName - Sender Name.
|
|
888
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
889
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
890
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
264
891
|
* @throws {AppwriteException}
|
|
265
892
|
* @returns {Promise<Models.Provider>}
|
|
266
893
|
*/
|
|
894
|
+
updateMailgunProvider(params: {
|
|
895
|
+
providerId: string;
|
|
896
|
+
name?: string;
|
|
897
|
+
apiKey?: string;
|
|
898
|
+
domain?: string;
|
|
899
|
+
isEuRegion?: boolean;
|
|
900
|
+
enabled?: boolean;
|
|
901
|
+
fromName?: string;
|
|
902
|
+
fromEmail?: string;
|
|
903
|
+
replyToName?: string;
|
|
904
|
+
replyToEmail?: string;
|
|
905
|
+
}): Promise<Models.Provider>;
|
|
906
|
+
/**
|
|
907
|
+
* Update a Mailgun provider by its unique ID.
|
|
908
|
+
*
|
|
909
|
+
* @param {string} providerId - Provider ID.
|
|
910
|
+
* @param {string} name - Provider name.
|
|
911
|
+
* @param {string} apiKey - Mailgun API Key.
|
|
912
|
+
* @param {string} domain - Mailgun Domain.
|
|
913
|
+
* @param {boolean} isEuRegion - Set as EU region.
|
|
914
|
+
* @param {boolean} enabled - Set as enabled.
|
|
915
|
+
* @param {string} fromName - Sender Name.
|
|
916
|
+
* @param {string} fromEmail - Sender email address.
|
|
917
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
918
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
919
|
+
* @throws {AppwriteException}
|
|
920
|
+
* @returns {Promise<Models.Provider>}
|
|
921
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
922
|
+
*/
|
|
267
923
|
updateMailgunProvider(providerId: string, name?: string, apiKey?: string, domain?: string, isEuRegion?: boolean, enabled?: boolean, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
|
|
268
924
|
/**
|
|
269
925
|
* Create a new MSG91 provider.
|
|
270
926
|
*
|
|
271
|
-
* @param {string} providerId
|
|
272
|
-
* @param {string} name
|
|
273
|
-
* @param {string} templateId
|
|
274
|
-
* @param {string} senderId
|
|
275
|
-
* @param {string} authKey
|
|
276
|
-
* @param {boolean} enabled
|
|
927
|
+
* @param {string} params.providerId - Provider 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.
|
|
928
|
+
* @param {string} params.name - Provider name.
|
|
929
|
+
* @param {string} params.templateId - Msg91 template ID
|
|
930
|
+
* @param {string} params.senderId - Msg91 sender ID.
|
|
931
|
+
* @param {string} params.authKey - Msg91 auth key.
|
|
932
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
277
933
|
* @throws {AppwriteException}
|
|
278
934
|
* @returns {Promise<Models.Provider>}
|
|
279
935
|
*/
|
|
936
|
+
createMsg91Provider(params: {
|
|
937
|
+
providerId: string;
|
|
938
|
+
name: string;
|
|
939
|
+
templateId?: string;
|
|
940
|
+
senderId?: string;
|
|
941
|
+
authKey?: string;
|
|
942
|
+
enabled?: boolean;
|
|
943
|
+
}): Promise<Models.Provider>;
|
|
944
|
+
/**
|
|
945
|
+
* Create a new MSG91 provider.
|
|
946
|
+
*
|
|
947
|
+
* @param {string} providerId - Provider 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.
|
|
948
|
+
* @param {string} name - Provider name.
|
|
949
|
+
* @param {string} templateId - Msg91 template ID
|
|
950
|
+
* @param {string} senderId - Msg91 sender ID.
|
|
951
|
+
* @param {string} authKey - Msg91 auth key.
|
|
952
|
+
* @param {boolean} enabled - Set as enabled.
|
|
953
|
+
* @throws {AppwriteException}
|
|
954
|
+
* @returns {Promise<Models.Provider>}
|
|
955
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
956
|
+
*/
|
|
280
957
|
createMsg91Provider(providerId: string, name: string, templateId?: string, senderId?: string, authKey?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
281
958
|
/**
|
|
282
959
|
* Update a MSG91 provider by its unique ID.
|
|
283
960
|
*
|
|
284
|
-
* @param {string} providerId
|
|
285
|
-
* @param {string} name
|
|
286
|
-
* @param {boolean} enabled
|
|
287
|
-
* @param {string} templateId
|
|
288
|
-
* @param {string} senderId
|
|
289
|
-
* @param {string} authKey
|
|
961
|
+
* @param {string} params.providerId - Provider ID.
|
|
962
|
+
* @param {string} params.name - Provider name.
|
|
963
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
964
|
+
* @param {string} params.templateId - Msg91 template ID.
|
|
965
|
+
* @param {string} params.senderId - Msg91 sender ID.
|
|
966
|
+
* @param {string} params.authKey - Msg91 auth key.
|
|
967
|
+
* @throws {AppwriteException}
|
|
968
|
+
* @returns {Promise<Models.Provider>}
|
|
969
|
+
*/
|
|
970
|
+
updateMsg91Provider(params: {
|
|
971
|
+
providerId: string;
|
|
972
|
+
name?: string;
|
|
973
|
+
enabled?: boolean;
|
|
974
|
+
templateId?: string;
|
|
975
|
+
senderId?: string;
|
|
976
|
+
authKey?: string;
|
|
977
|
+
}): Promise<Models.Provider>;
|
|
978
|
+
/**
|
|
979
|
+
* Update a MSG91 provider by its unique ID.
|
|
980
|
+
*
|
|
981
|
+
* @param {string} providerId - Provider ID.
|
|
982
|
+
* @param {string} name - Provider name.
|
|
983
|
+
* @param {boolean} enabled - Set as enabled.
|
|
984
|
+
* @param {string} templateId - Msg91 template ID.
|
|
985
|
+
* @param {string} senderId - Msg91 sender ID.
|
|
986
|
+
* @param {string} authKey - Msg91 auth key.
|
|
290
987
|
* @throws {AppwriteException}
|
|
291
988
|
* @returns {Promise<Models.Provider>}
|
|
989
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
292
990
|
*/
|
|
293
991
|
updateMsg91Provider(providerId: string, name?: string, enabled?: boolean, templateId?: string, senderId?: string, authKey?: string): Promise<Models.Provider>;
|
|
992
|
+
/**
|
|
993
|
+
* Create a new Resend provider.
|
|
994
|
+
*
|
|
995
|
+
* @param {string} params.providerId - Provider 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.
|
|
996
|
+
* @param {string} params.name - Provider name.
|
|
997
|
+
* @param {string} params.apiKey - Resend API key.
|
|
998
|
+
* @param {string} params.fromName - Sender Name.
|
|
999
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1000
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1001
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1002
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1003
|
+
* @throws {AppwriteException}
|
|
1004
|
+
* @returns {Promise<Models.Provider>}
|
|
1005
|
+
*/
|
|
1006
|
+
createResendProvider(params: {
|
|
1007
|
+
providerId: string;
|
|
1008
|
+
name: string;
|
|
1009
|
+
apiKey?: string;
|
|
1010
|
+
fromName?: string;
|
|
1011
|
+
fromEmail?: string;
|
|
1012
|
+
replyToName?: string;
|
|
1013
|
+
replyToEmail?: string;
|
|
1014
|
+
enabled?: boolean;
|
|
1015
|
+
}): Promise<Models.Provider>;
|
|
1016
|
+
/**
|
|
1017
|
+
* Create a new Resend provider.
|
|
1018
|
+
*
|
|
1019
|
+
* @param {string} providerId - Provider 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.
|
|
1020
|
+
* @param {string} name - Provider name.
|
|
1021
|
+
* @param {string} apiKey - Resend API key.
|
|
1022
|
+
* @param {string} fromName - Sender Name.
|
|
1023
|
+
* @param {string} fromEmail - Sender email address.
|
|
1024
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1025
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1026
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1027
|
+
* @throws {AppwriteException}
|
|
1028
|
+
* @returns {Promise<Models.Provider>}
|
|
1029
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1030
|
+
*/
|
|
1031
|
+
createResendProvider(providerId: string, name: string, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
1032
|
+
/**
|
|
1033
|
+
* Update a Resend provider by its unique ID.
|
|
1034
|
+
*
|
|
1035
|
+
* @param {string} params.providerId - Provider ID.
|
|
1036
|
+
* @param {string} params.name - Provider name.
|
|
1037
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1038
|
+
* @param {string} params.apiKey - Resend API key.
|
|
1039
|
+
* @param {string} params.fromName - Sender Name.
|
|
1040
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1041
|
+
* @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1042
|
+
* @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1043
|
+
* @throws {AppwriteException}
|
|
1044
|
+
* @returns {Promise<Models.Provider>}
|
|
1045
|
+
*/
|
|
1046
|
+
updateResendProvider(params: {
|
|
1047
|
+
providerId: string;
|
|
1048
|
+
name?: string;
|
|
1049
|
+
enabled?: boolean;
|
|
1050
|
+
apiKey?: string;
|
|
1051
|
+
fromName?: string;
|
|
1052
|
+
fromEmail?: string;
|
|
1053
|
+
replyToName?: string;
|
|
1054
|
+
replyToEmail?: string;
|
|
1055
|
+
}): Promise<Models.Provider>;
|
|
1056
|
+
/**
|
|
1057
|
+
* Update a Resend provider by its unique ID.
|
|
1058
|
+
*
|
|
1059
|
+
* @param {string} providerId - Provider ID.
|
|
1060
|
+
* @param {string} name - Provider name.
|
|
1061
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1062
|
+
* @param {string} apiKey - Resend API key.
|
|
1063
|
+
* @param {string} fromName - Sender Name.
|
|
1064
|
+
* @param {string} fromEmail - Sender email address.
|
|
1065
|
+
* @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1066
|
+
* @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1067
|
+
* @throws {AppwriteException}
|
|
1068
|
+
* @returns {Promise<Models.Provider>}
|
|
1069
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1070
|
+
*/
|
|
1071
|
+
updateResendProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
|
|
294
1072
|
/**
|
|
295
1073
|
* Create a new Sendgrid provider.
|
|
296
1074
|
*
|
|
297
|
-
* @param {string} providerId
|
|
298
|
-
* @param {string} name
|
|
299
|
-
* @param {string} apiKey
|
|
300
|
-
* @param {string} fromName
|
|
301
|
-
* @param {string} fromEmail
|
|
302
|
-
* @param {string} replyToName
|
|
303
|
-
* @param {string} replyToEmail
|
|
304
|
-
* @param {boolean} enabled
|
|
1075
|
+
* @param {string} params.providerId - Provider 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.
|
|
1076
|
+
* @param {string} params.name - Provider name.
|
|
1077
|
+
* @param {string} params.apiKey - Sendgrid API key.
|
|
1078
|
+
* @param {string} params.fromName - Sender Name.
|
|
1079
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1080
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1081
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1082
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
305
1083
|
* @throws {AppwriteException}
|
|
306
1084
|
* @returns {Promise<Models.Provider>}
|
|
307
1085
|
*/
|
|
1086
|
+
createSendgridProvider(params: {
|
|
1087
|
+
providerId: string;
|
|
1088
|
+
name: string;
|
|
1089
|
+
apiKey?: string;
|
|
1090
|
+
fromName?: string;
|
|
1091
|
+
fromEmail?: string;
|
|
1092
|
+
replyToName?: string;
|
|
1093
|
+
replyToEmail?: string;
|
|
1094
|
+
enabled?: boolean;
|
|
1095
|
+
}): Promise<Models.Provider>;
|
|
1096
|
+
/**
|
|
1097
|
+
* Create a new Sendgrid provider.
|
|
1098
|
+
*
|
|
1099
|
+
* @param {string} providerId - Provider 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.
|
|
1100
|
+
* @param {string} name - Provider name.
|
|
1101
|
+
* @param {string} apiKey - Sendgrid API key.
|
|
1102
|
+
* @param {string} fromName - Sender Name.
|
|
1103
|
+
* @param {string} fromEmail - Sender email address.
|
|
1104
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1105
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1106
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1107
|
+
* @throws {AppwriteException}
|
|
1108
|
+
* @returns {Promise<Models.Provider>}
|
|
1109
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1110
|
+
*/
|
|
308
1111
|
createSendgridProvider(providerId: string, name: string, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
309
1112
|
/**
|
|
310
1113
|
* Update a Sendgrid provider by its unique ID.
|
|
311
1114
|
*
|
|
312
|
-
* @param {string} providerId
|
|
313
|
-
* @param {string} name
|
|
314
|
-
* @param {boolean} enabled
|
|
315
|
-
* @param {string} apiKey
|
|
316
|
-
* @param {string} fromName
|
|
317
|
-
* @param {string} fromEmail
|
|
318
|
-
* @param {string} replyToName
|
|
319
|
-
* @param {string} replyToEmail
|
|
1115
|
+
* @param {string} params.providerId - Provider ID.
|
|
1116
|
+
* @param {string} params.name - Provider name.
|
|
1117
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1118
|
+
* @param {string} params.apiKey - Sendgrid API key.
|
|
1119
|
+
* @param {string} params.fromName - Sender Name.
|
|
1120
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1121
|
+
* @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1122
|
+
* @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
320
1123
|
* @throws {AppwriteException}
|
|
321
1124
|
* @returns {Promise<Models.Provider>}
|
|
322
1125
|
*/
|
|
1126
|
+
updateSendgridProvider(params: {
|
|
1127
|
+
providerId: string;
|
|
1128
|
+
name?: string;
|
|
1129
|
+
enabled?: boolean;
|
|
1130
|
+
apiKey?: string;
|
|
1131
|
+
fromName?: string;
|
|
1132
|
+
fromEmail?: string;
|
|
1133
|
+
replyToName?: string;
|
|
1134
|
+
replyToEmail?: string;
|
|
1135
|
+
}): Promise<Models.Provider>;
|
|
1136
|
+
/**
|
|
1137
|
+
* Update a Sendgrid provider by its unique ID.
|
|
1138
|
+
*
|
|
1139
|
+
* @param {string} providerId - Provider ID.
|
|
1140
|
+
* @param {string} name - Provider name.
|
|
1141
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1142
|
+
* @param {string} apiKey - Sendgrid API key.
|
|
1143
|
+
* @param {string} fromName - Sender Name.
|
|
1144
|
+
* @param {string} fromEmail - Sender email address.
|
|
1145
|
+
* @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1146
|
+
* @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1147
|
+
* @throws {AppwriteException}
|
|
1148
|
+
* @returns {Promise<Models.Provider>}
|
|
1149
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1150
|
+
*/
|
|
323
1151
|
updateSendgridProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
|
|
324
1152
|
/**
|
|
325
1153
|
* Create a new SMTP provider.
|
|
326
1154
|
*
|
|
327
|
-
* @param {string} providerId
|
|
328
|
-
* @param {string} name
|
|
329
|
-
* @param {string} host
|
|
330
|
-
* @param {number} port
|
|
331
|
-
* @param {string} username
|
|
332
|
-
* @param {string} password
|
|
333
|
-
* @param {SmtpEncryption} encryption
|
|
334
|
-
* @param {boolean} autoTLS
|
|
335
|
-
* @param {string} mailer
|
|
336
|
-
* @param {string} fromName
|
|
337
|
-
* @param {string} fromEmail
|
|
338
|
-
* @param {string} replyToName
|
|
339
|
-
* @param {string} replyToEmail
|
|
340
|
-
* @param {boolean} enabled
|
|
1155
|
+
* @param {string} params.providerId - Provider 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.
|
|
1156
|
+
* @param {string} params.name - Provider name.
|
|
1157
|
+
* @param {string} params.host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
1158
|
+
* @param {number} params.port - The default SMTP server port.
|
|
1159
|
+
* @param {string} params.username - Authentication username.
|
|
1160
|
+
* @param {string} params.password - Authentication password.
|
|
1161
|
+
* @param {SmtpEncryption} params.encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
1162
|
+
* @param {boolean} params.autoTLS - Enable SMTP AutoTLS feature.
|
|
1163
|
+
* @param {string} params.mailer - The value to use for the X-Mailer header.
|
|
1164
|
+
* @param {string} params.fromName - Sender Name.
|
|
1165
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1166
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1167
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1168
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
341
1169
|
* @throws {AppwriteException}
|
|
342
1170
|
* @returns {Promise<Models.Provider>}
|
|
1171
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.createSMTPProvider` instead.
|
|
1172
|
+
*/
|
|
1173
|
+
createSmtpProvider(params: {
|
|
1174
|
+
providerId: string;
|
|
1175
|
+
name: string;
|
|
1176
|
+
host: string;
|
|
1177
|
+
port?: number;
|
|
1178
|
+
username?: string;
|
|
1179
|
+
password?: string;
|
|
1180
|
+
encryption?: SmtpEncryption;
|
|
1181
|
+
autoTLS?: boolean;
|
|
1182
|
+
mailer?: string;
|
|
1183
|
+
fromName?: string;
|
|
1184
|
+
fromEmail?: string;
|
|
1185
|
+
replyToName?: string;
|
|
1186
|
+
replyToEmail?: string;
|
|
1187
|
+
enabled?: boolean;
|
|
1188
|
+
}): Promise<Models.Provider>;
|
|
1189
|
+
/**
|
|
1190
|
+
* Create a new SMTP provider.
|
|
1191
|
+
*
|
|
1192
|
+
* @param {string} providerId - Provider 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.
|
|
1193
|
+
* @param {string} name - Provider name.
|
|
1194
|
+
* @param {string} host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
1195
|
+
* @param {number} port - The default SMTP server port.
|
|
1196
|
+
* @param {string} username - Authentication username.
|
|
1197
|
+
* @param {string} password - Authentication password.
|
|
1198
|
+
* @param {SmtpEncryption} encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
1199
|
+
* @param {boolean} autoTLS - Enable SMTP AutoTLS feature.
|
|
1200
|
+
* @param {string} mailer - The value to use for the X-Mailer header.
|
|
1201
|
+
* @param {string} fromName - Sender Name.
|
|
1202
|
+
* @param {string} fromEmail - Sender email address.
|
|
1203
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1204
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1205
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1206
|
+
* @throws {AppwriteException}
|
|
1207
|
+
* @returns {Promise<Models.Provider>}
|
|
1208
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
343
1209
|
*/
|
|
344
1210
|
createSmtpProvider(providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
1211
|
+
/**
|
|
1212
|
+
* Create a new SMTP provider.
|
|
1213
|
+
*
|
|
1214
|
+
* @param {string} params.providerId - Provider 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.
|
|
1215
|
+
* @param {string} params.name - Provider name.
|
|
1216
|
+
* @param {string} params.host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
1217
|
+
* @param {number} params.port - The default SMTP server port.
|
|
1218
|
+
* @param {string} params.username - Authentication username.
|
|
1219
|
+
* @param {string} params.password - Authentication password.
|
|
1220
|
+
* @param {SmtpEncryption} params.encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
1221
|
+
* @param {boolean} params.autoTLS - Enable SMTP AutoTLS feature.
|
|
1222
|
+
* @param {string} params.mailer - The value to use for the X-Mailer header.
|
|
1223
|
+
* @param {string} params.fromName - Sender Name.
|
|
1224
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1225
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1226
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1227
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1228
|
+
* @throws {AppwriteException}
|
|
1229
|
+
* @returns {Promise<Models.Provider>}
|
|
1230
|
+
*/
|
|
1231
|
+
createSMTPProvider(params: {
|
|
1232
|
+
providerId: string;
|
|
1233
|
+
name: string;
|
|
1234
|
+
host: string;
|
|
1235
|
+
port?: number;
|
|
1236
|
+
username?: string;
|
|
1237
|
+
password?: string;
|
|
1238
|
+
encryption?: SmtpEncryption;
|
|
1239
|
+
autoTLS?: boolean;
|
|
1240
|
+
mailer?: string;
|
|
1241
|
+
fromName?: string;
|
|
1242
|
+
fromEmail?: string;
|
|
1243
|
+
replyToName?: string;
|
|
1244
|
+
replyToEmail?: string;
|
|
1245
|
+
enabled?: boolean;
|
|
1246
|
+
}): Promise<Models.Provider>;
|
|
1247
|
+
/**
|
|
1248
|
+
* Create a new SMTP provider.
|
|
1249
|
+
*
|
|
1250
|
+
* @param {string} providerId - Provider 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.
|
|
1251
|
+
* @param {string} name - Provider name.
|
|
1252
|
+
* @param {string} host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
1253
|
+
* @param {number} port - The default SMTP server port.
|
|
1254
|
+
* @param {string} username - Authentication username.
|
|
1255
|
+
* @param {string} password - Authentication password.
|
|
1256
|
+
* @param {SmtpEncryption} encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
1257
|
+
* @param {boolean} autoTLS - Enable SMTP AutoTLS feature.
|
|
1258
|
+
* @param {string} mailer - The value to use for the X-Mailer header.
|
|
1259
|
+
* @param {string} fromName - Sender Name.
|
|
1260
|
+
* @param {string} fromEmail - Sender email address.
|
|
1261
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1262
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1263
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1264
|
+
* @throws {AppwriteException}
|
|
1265
|
+
* @returns {Promise<Models.Provider>}
|
|
1266
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1267
|
+
*/
|
|
1268
|
+
createSMTPProvider(providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
345
1269
|
/**
|
|
346
1270
|
* Update a SMTP provider by its unique ID.
|
|
347
1271
|
*
|
|
348
|
-
* @param {string} providerId
|
|
349
|
-
* @param {string} name
|
|
350
|
-
* @param {string} host
|
|
351
|
-
* @param {number} port
|
|
352
|
-
* @param {string} username
|
|
353
|
-
* @param {string} password
|
|
354
|
-
* @param {SmtpEncryption} encryption
|
|
355
|
-
* @param {boolean} autoTLS
|
|
356
|
-
* @param {string} mailer
|
|
357
|
-
* @param {string} fromName
|
|
358
|
-
* @param {string} fromEmail
|
|
359
|
-
* @param {string} replyToName
|
|
360
|
-
* @param {string} replyToEmail
|
|
361
|
-
* @param {boolean} enabled
|
|
1272
|
+
* @param {string} params.providerId - Provider ID.
|
|
1273
|
+
* @param {string} params.name - Provider name.
|
|
1274
|
+
* @param {string} params.host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
1275
|
+
* @param {number} params.port - SMTP port.
|
|
1276
|
+
* @param {string} params.username - Authentication username.
|
|
1277
|
+
* @param {string} params.password - Authentication password.
|
|
1278
|
+
* @param {SmtpEncryption} params.encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
1279
|
+
* @param {boolean} params.autoTLS - Enable SMTP AutoTLS feature.
|
|
1280
|
+
* @param {string} params.mailer - The value to use for the X-Mailer header.
|
|
1281
|
+
* @param {string} params.fromName - Sender Name.
|
|
1282
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1283
|
+
* @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1284
|
+
* @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1285
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
362
1286
|
* @throws {AppwriteException}
|
|
363
1287
|
* @returns {Promise<Models.Provider>}
|
|
1288
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.updateSMTPProvider` instead.
|
|
1289
|
+
*/
|
|
1290
|
+
updateSmtpProvider(params: {
|
|
1291
|
+
providerId: string;
|
|
1292
|
+
name?: string;
|
|
1293
|
+
host?: string;
|
|
1294
|
+
port?: number;
|
|
1295
|
+
username?: string;
|
|
1296
|
+
password?: string;
|
|
1297
|
+
encryption?: SmtpEncryption;
|
|
1298
|
+
autoTLS?: boolean;
|
|
1299
|
+
mailer?: string;
|
|
1300
|
+
fromName?: string;
|
|
1301
|
+
fromEmail?: string;
|
|
1302
|
+
replyToName?: string;
|
|
1303
|
+
replyToEmail?: string;
|
|
1304
|
+
enabled?: boolean;
|
|
1305
|
+
}): Promise<Models.Provider>;
|
|
1306
|
+
/**
|
|
1307
|
+
* Update a SMTP provider by its unique ID.
|
|
1308
|
+
*
|
|
1309
|
+
* @param {string} providerId - Provider ID.
|
|
1310
|
+
* @param {string} name - Provider name.
|
|
1311
|
+
* @param {string} host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
1312
|
+
* @param {number} port - SMTP port.
|
|
1313
|
+
* @param {string} username - Authentication username.
|
|
1314
|
+
* @param {string} password - Authentication password.
|
|
1315
|
+
* @param {SmtpEncryption} encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
1316
|
+
* @param {boolean} autoTLS - Enable SMTP AutoTLS feature.
|
|
1317
|
+
* @param {string} mailer - The value to use for the X-Mailer header.
|
|
1318
|
+
* @param {string} fromName - Sender Name.
|
|
1319
|
+
* @param {string} fromEmail - Sender email address.
|
|
1320
|
+
* @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1321
|
+
* @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1322
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1323
|
+
* @throws {AppwriteException}
|
|
1324
|
+
* @returns {Promise<Models.Provider>}
|
|
1325
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
364
1326
|
*/
|
|
365
1327
|
updateSmtpProvider(providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
1328
|
+
/**
|
|
1329
|
+
* Update a SMTP provider by its unique ID.
|
|
1330
|
+
*
|
|
1331
|
+
* @param {string} params.providerId - Provider ID.
|
|
1332
|
+
* @param {string} params.name - Provider name.
|
|
1333
|
+
* @param {string} params.host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
1334
|
+
* @param {number} params.port - SMTP port.
|
|
1335
|
+
* @param {string} params.username - Authentication username.
|
|
1336
|
+
* @param {string} params.password - Authentication password.
|
|
1337
|
+
* @param {SmtpEncryption} params.encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
1338
|
+
* @param {boolean} params.autoTLS - Enable SMTP AutoTLS feature.
|
|
1339
|
+
* @param {string} params.mailer - The value to use for the X-Mailer header.
|
|
1340
|
+
* @param {string} params.fromName - Sender Name.
|
|
1341
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1342
|
+
* @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1343
|
+
* @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1344
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1345
|
+
* @throws {AppwriteException}
|
|
1346
|
+
* @returns {Promise<Models.Provider>}
|
|
1347
|
+
*/
|
|
1348
|
+
updateSMTPProvider(params: {
|
|
1349
|
+
providerId: string;
|
|
1350
|
+
name?: string;
|
|
1351
|
+
host?: string;
|
|
1352
|
+
port?: number;
|
|
1353
|
+
username?: string;
|
|
1354
|
+
password?: string;
|
|
1355
|
+
encryption?: SmtpEncryption;
|
|
1356
|
+
autoTLS?: boolean;
|
|
1357
|
+
mailer?: string;
|
|
1358
|
+
fromName?: string;
|
|
1359
|
+
fromEmail?: string;
|
|
1360
|
+
replyToName?: string;
|
|
1361
|
+
replyToEmail?: string;
|
|
1362
|
+
enabled?: boolean;
|
|
1363
|
+
}): Promise<Models.Provider>;
|
|
1364
|
+
/**
|
|
1365
|
+
* Update a SMTP provider by its unique ID.
|
|
1366
|
+
*
|
|
1367
|
+
* @param {string} providerId - Provider ID.
|
|
1368
|
+
* @param {string} name - Provider name.
|
|
1369
|
+
* @param {string} host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
1370
|
+
* @param {number} port - SMTP port.
|
|
1371
|
+
* @param {string} username - Authentication username.
|
|
1372
|
+
* @param {string} password - Authentication password.
|
|
1373
|
+
* @param {SmtpEncryption} encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
1374
|
+
* @param {boolean} autoTLS - Enable SMTP AutoTLS feature.
|
|
1375
|
+
* @param {string} mailer - The value to use for the X-Mailer header.
|
|
1376
|
+
* @param {string} fromName - Sender Name.
|
|
1377
|
+
* @param {string} fromEmail - Sender email address.
|
|
1378
|
+
* @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1379
|
+
* @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1380
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1381
|
+
* @throws {AppwriteException}
|
|
1382
|
+
* @returns {Promise<Models.Provider>}
|
|
1383
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1384
|
+
*/
|
|
1385
|
+
updateSMTPProvider(providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
1386
|
+
/**
|
|
1387
|
+
* Create a new Telesign provider.
|
|
1388
|
+
*
|
|
1389
|
+
* @param {string} params.providerId - Provider 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.
|
|
1390
|
+
* @param {string} params.name - Provider name.
|
|
1391
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1392
|
+
* @param {string} params.customerId - Telesign customer ID.
|
|
1393
|
+
* @param {string} params.apiKey - Telesign API key.
|
|
1394
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1395
|
+
* @throws {AppwriteException}
|
|
1396
|
+
* @returns {Promise<Models.Provider>}
|
|
1397
|
+
*/
|
|
1398
|
+
createTelesignProvider(params: {
|
|
1399
|
+
providerId: string;
|
|
1400
|
+
name: string;
|
|
1401
|
+
from?: string;
|
|
1402
|
+
customerId?: string;
|
|
1403
|
+
apiKey?: string;
|
|
1404
|
+
enabled?: boolean;
|
|
1405
|
+
}): Promise<Models.Provider>;
|
|
366
1406
|
/**
|
|
367
1407
|
* Create a new Telesign provider.
|
|
368
1408
|
*
|
|
369
|
-
* @param {string} providerId
|
|
370
|
-
* @param {string} name
|
|
371
|
-
* @param {string} from
|
|
372
|
-
* @param {string} customerId
|
|
373
|
-
* @param {string} apiKey
|
|
374
|
-
* @param {boolean} enabled
|
|
1409
|
+
* @param {string} providerId - Provider 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.
|
|
1410
|
+
* @param {string} name - Provider name.
|
|
1411
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1412
|
+
* @param {string} customerId - Telesign customer ID.
|
|
1413
|
+
* @param {string} apiKey - Telesign API key.
|
|
1414
|
+
* @param {boolean} enabled - Set as enabled.
|
|
375
1415
|
* @throws {AppwriteException}
|
|
376
1416
|
* @returns {Promise<Models.Provider>}
|
|
1417
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
377
1418
|
*/
|
|
378
1419
|
createTelesignProvider(providerId: string, name: string, from?: string, customerId?: string, apiKey?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
379
1420
|
/**
|
|
380
1421
|
* Update a Telesign provider by its unique ID.
|
|
381
1422
|
*
|
|
382
|
-
* @param {string} providerId
|
|
383
|
-
* @param {string} name
|
|
384
|
-
* @param {boolean} enabled
|
|
385
|
-
* @param {string} customerId
|
|
386
|
-
* @param {string} apiKey
|
|
387
|
-
* @param {string} from
|
|
1423
|
+
* @param {string} params.providerId - Provider ID.
|
|
1424
|
+
* @param {string} params.name - Provider name.
|
|
1425
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1426
|
+
* @param {string} params.customerId - Telesign customer ID.
|
|
1427
|
+
* @param {string} params.apiKey - Telesign API key.
|
|
1428
|
+
* @param {string} params.from - Sender number.
|
|
1429
|
+
* @throws {AppwriteException}
|
|
1430
|
+
* @returns {Promise<Models.Provider>}
|
|
1431
|
+
*/
|
|
1432
|
+
updateTelesignProvider(params: {
|
|
1433
|
+
providerId: string;
|
|
1434
|
+
name?: string;
|
|
1435
|
+
enabled?: boolean;
|
|
1436
|
+
customerId?: string;
|
|
1437
|
+
apiKey?: string;
|
|
1438
|
+
from?: string;
|
|
1439
|
+
}): Promise<Models.Provider>;
|
|
1440
|
+
/**
|
|
1441
|
+
* Update a Telesign provider by its unique ID.
|
|
1442
|
+
*
|
|
1443
|
+
* @param {string} providerId - Provider ID.
|
|
1444
|
+
* @param {string} name - Provider name.
|
|
1445
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1446
|
+
* @param {string} customerId - Telesign customer ID.
|
|
1447
|
+
* @param {string} apiKey - Telesign API key.
|
|
1448
|
+
* @param {string} from - Sender number.
|
|
388
1449
|
* @throws {AppwriteException}
|
|
389
1450
|
* @returns {Promise<Models.Provider>}
|
|
1451
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
390
1452
|
*/
|
|
391
1453
|
updateTelesignProvider(providerId: string, name?: string, enabled?: boolean, customerId?: string, apiKey?: string, from?: string): Promise<Models.Provider>;
|
|
392
1454
|
/**
|
|
393
1455
|
* Create a new Textmagic provider.
|
|
394
1456
|
*
|
|
395
|
-
* @param {string} providerId
|
|
396
|
-
* @param {string} name
|
|
397
|
-
* @param {string} from
|
|
398
|
-
* @param {string} username
|
|
399
|
-
* @param {string} apiKey
|
|
400
|
-
* @param {boolean} enabled
|
|
1457
|
+
* @param {string} params.providerId - Provider 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.
|
|
1458
|
+
* @param {string} params.name - Provider name.
|
|
1459
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1460
|
+
* @param {string} params.username - Textmagic username.
|
|
1461
|
+
* @param {string} params.apiKey - Textmagic apiKey.
|
|
1462
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1463
|
+
* @throws {AppwriteException}
|
|
1464
|
+
* @returns {Promise<Models.Provider>}
|
|
1465
|
+
*/
|
|
1466
|
+
createTextmagicProvider(params: {
|
|
1467
|
+
providerId: string;
|
|
1468
|
+
name: string;
|
|
1469
|
+
from?: string;
|
|
1470
|
+
username?: string;
|
|
1471
|
+
apiKey?: string;
|
|
1472
|
+
enabled?: boolean;
|
|
1473
|
+
}): Promise<Models.Provider>;
|
|
1474
|
+
/**
|
|
1475
|
+
* Create a new Textmagic provider.
|
|
1476
|
+
*
|
|
1477
|
+
* @param {string} providerId - Provider 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.
|
|
1478
|
+
* @param {string} name - Provider name.
|
|
1479
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1480
|
+
* @param {string} username - Textmagic username.
|
|
1481
|
+
* @param {string} apiKey - Textmagic apiKey.
|
|
1482
|
+
* @param {boolean} enabled - Set as enabled.
|
|
401
1483
|
* @throws {AppwriteException}
|
|
402
1484
|
* @returns {Promise<Models.Provider>}
|
|
1485
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
403
1486
|
*/
|
|
404
1487
|
createTextmagicProvider(providerId: string, name: string, from?: string, username?: string, apiKey?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
405
1488
|
/**
|
|
406
1489
|
* Update a Textmagic provider by its unique ID.
|
|
407
1490
|
*
|
|
408
|
-
* @param {string} providerId
|
|
409
|
-
* @param {string} name
|
|
410
|
-
* @param {boolean} enabled
|
|
411
|
-
* @param {string} username
|
|
412
|
-
* @param {string} apiKey
|
|
413
|
-
* @param {string} from
|
|
1491
|
+
* @param {string} params.providerId - Provider ID.
|
|
1492
|
+
* @param {string} params.name - Provider name.
|
|
1493
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1494
|
+
* @param {string} params.username - Textmagic username.
|
|
1495
|
+
* @param {string} params.apiKey - Textmagic apiKey.
|
|
1496
|
+
* @param {string} params.from - Sender number.
|
|
1497
|
+
* @throws {AppwriteException}
|
|
1498
|
+
* @returns {Promise<Models.Provider>}
|
|
1499
|
+
*/
|
|
1500
|
+
updateTextmagicProvider(params: {
|
|
1501
|
+
providerId: string;
|
|
1502
|
+
name?: string;
|
|
1503
|
+
enabled?: boolean;
|
|
1504
|
+
username?: string;
|
|
1505
|
+
apiKey?: string;
|
|
1506
|
+
from?: string;
|
|
1507
|
+
}): Promise<Models.Provider>;
|
|
1508
|
+
/**
|
|
1509
|
+
* Update a Textmagic provider by its unique ID.
|
|
1510
|
+
*
|
|
1511
|
+
* @param {string} providerId - Provider ID.
|
|
1512
|
+
* @param {string} name - Provider name.
|
|
1513
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1514
|
+
* @param {string} username - Textmagic username.
|
|
1515
|
+
* @param {string} apiKey - Textmagic apiKey.
|
|
1516
|
+
* @param {string} from - Sender number.
|
|
414
1517
|
* @throws {AppwriteException}
|
|
415
1518
|
* @returns {Promise<Models.Provider>}
|
|
1519
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
416
1520
|
*/
|
|
417
1521
|
updateTextmagicProvider(providerId: string, name?: string, enabled?: boolean, username?: string, apiKey?: string, from?: string): Promise<Models.Provider>;
|
|
418
1522
|
/**
|
|
419
1523
|
* Create a new Twilio provider.
|
|
420
1524
|
*
|
|
421
|
-
* @param {string} providerId
|
|
422
|
-
* @param {string} name
|
|
423
|
-
* @param {string} from
|
|
424
|
-
* @param {string} accountSid
|
|
425
|
-
* @param {string} authToken
|
|
426
|
-
* @param {boolean} enabled
|
|
1525
|
+
* @param {string} params.providerId - Provider 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.
|
|
1526
|
+
* @param {string} params.name - Provider name.
|
|
1527
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1528
|
+
* @param {string} params.accountSid - Twilio account secret ID.
|
|
1529
|
+
* @param {string} params.authToken - Twilio authentication token.
|
|
1530
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
427
1531
|
* @throws {AppwriteException}
|
|
428
1532
|
* @returns {Promise<Models.Provider>}
|
|
429
1533
|
*/
|
|
1534
|
+
createTwilioProvider(params: {
|
|
1535
|
+
providerId: string;
|
|
1536
|
+
name: string;
|
|
1537
|
+
from?: string;
|
|
1538
|
+
accountSid?: string;
|
|
1539
|
+
authToken?: string;
|
|
1540
|
+
enabled?: boolean;
|
|
1541
|
+
}): Promise<Models.Provider>;
|
|
1542
|
+
/**
|
|
1543
|
+
* Create a new Twilio provider.
|
|
1544
|
+
*
|
|
1545
|
+
* @param {string} providerId - Provider 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.
|
|
1546
|
+
* @param {string} name - Provider name.
|
|
1547
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1548
|
+
* @param {string} accountSid - Twilio account secret ID.
|
|
1549
|
+
* @param {string} authToken - Twilio authentication token.
|
|
1550
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1551
|
+
* @throws {AppwriteException}
|
|
1552
|
+
* @returns {Promise<Models.Provider>}
|
|
1553
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1554
|
+
*/
|
|
430
1555
|
createTwilioProvider(providerId: string, name: string, from?: string, accountSid?: string, authToken?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
431
1556
|
/**
|
|
432
1557
|
* Update a Twilio provider by its unique ID.
|
|
433
1558
|
*
|
|
434
|
-
* @param {string} providerId
|
|
435
|
-
* @param {string} name
|
|
436
|
-
* @param {boolean} enabled
|
|
437
|
-
* @param {string} accountSid
|
|
438
|
-
* @param {string} authToken
|
|
439
|
-
* @param {string} from
|
|
1559
|
+
* @param {string} params.providerId - Provider ID.
|
|
1560
|
+
* @param {string} params.name - Provider name.
|
|
1561
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1562
|
+
* @param {string} params.accountSid - Twilio account secret ID.
|
|
1563
|
+
* @param {string} params.authToken - Twilio authentication token.
|
|
1564
|
+
* @param {string} params.from - Sender number.
|
|
1565
|
+
* @throws {AppwriteException}
|
|
1566
|
+
* @returns {Promise<Models.Provider>}
|
|
1567
|
+
*/
|
|
1568
|
+
updateTwilioProvider(params: {
|
|
1569
|
+
providerId: string;
|
|
1570
|
+
name?: string;
|
|
1571
|
+
enabled?: boolean;
|
|
1572
|
+
accountSid?: string;
|
|
1573
|
+
authToken?: string;
|
|
1574
|
+
from?: string;
|
|
1575
|
+
}): Promise<Models.Provider>;
|
|
1576
|
+
/**
|
|
1577
|
+
* Update a Twilio provider by its unique ID.
|
|
1578
|
+
*
|
|
1579
|
+
* @param {string} providerId - Provider ID.
|
|
1580
|
+
* @param {string} name - Provider name.
|
|
1581
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1582
|
+
* @param {string} accountSid - Twilio account secret ID.
|
|
1583
|
+
* @param {string} authToken - Twilio authentication token.
|
|
1584
|
+
* @param {string} from - Sender number.
|
|
440
1585
|
* @throws {AppwriteException}
|
|
441
1586
|
* @returns {Promise<Models.Provider>}
|
|
1587
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
442
1588
|
*/
|
|
443
1589
|
updateTwilioProvider(providerId: string, name?: string, enabled?: boolean, accountSid?: string, authToken?: string, from?: string): Promise<Models.Provider>;
|
|
444
1590
|
/**
|
|
445
1591
|
* Create a new Vonage provider.
|
|
446
1592
|
*
|
|
447
|
-
* @param {string} providerId
|
|
448
|
-
* @param {string} name
|
|
449
|
-
* @param {string} from
|
|
450
|
-
* @param {string} apiKey
|
|
451
|
-
* @param {string} apiSecret
|
|
452
|
-
* @param {boolean} enabled
|
|
1593
|
+
* @param {string} params.providerId - Provider 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.
|
|
1594
|
+
* @param {string} params.name - Provider name.
|
|
1595
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1596
|
+
* @param {string} params.apiKey - Vonage API key.
|
|
1597
|
+
* @param {string} params.apiSecret - Vonage API secret.
|
|
1598
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
453
1599
|
* @throws {AppwriteException}
|
|
454
1600
|
* @returns {Promise<Models.Provider>}
|
|
455
1601
|
*/
|
|
1602
|
+
createVonageProvider(params: {
|
|
1603
|
+
providerId: string;
|
|
1604
|
+
name: string;
|
|
1605
|
+
from?: string;
|
|
1606
|
+
apiKey?: string;
|
|
1607
|
+
apiSecret?: string;
|
|
1608
|
+
enabled?: boolean;
|
|
1609
|
+
}): Promise<Models.Provider>;
|
|
1610
|
+
/**
|
|
1611
|
+
* Create a new Vonage provider.
|
|
1612
|
+
*
|
|
1613
|
+
* @param {string} providerId - Provider 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.
|
|
1614
|
+
* @param {string} name - Provider name.
|
|
1615
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1616
|
+
* @param {string} apiKey - Vonage API key.
|
|
1617
|
+
* @param {string} apiSecret - Vonage API secret.
|
|
1618
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1619
|
+
* @throws {AppwriteException}
|
|
1620
|
+
* @returns {Promise<Models.Provider>}
|
|
1621
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1622
|
+
*/
|
|
456
1623
|
createVonageProvider(providerId: string, name: string, from?: string, apiKey?: string, apiSecret?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
457
1624
|
/**
|
|
458
1625
|
* Update a Vonage provider by its unique ID.
|
|
459
1626
|
*
|
|
460
|
-
* @param {string} providerId
|
|
461
|
-
* @param {string} name
|
|
462
|
-
* @param {boolean} enabled
|
|
463
|
-
* @param {string} apiKey
|
|
464
|
-
* @param {string} apiSecret
|
|
465
|
-
* @param {string} from
|
|
1627
|
+
* @param {string} params.providerId - Provider ID.
|
|
1628
|
+
* @param {string} params.name - Provider name.
|
|
1629
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1630
|
+
* @param {string} params.apiKey - Vonage API key.
|
|
1631
|
+
* @param {string} params.apiSecret - Vonage API secret.
|
|
1632
|
+
* @param {string} params.from - Sender number.
|
|
466
1633
|
* @throws {AppwriteException}
|
|
467
1634
|
* @returns {Promise<Models.Provider>}
|
|
468
1635
|
*/
|
|
1636
|
+
updateVonageProvider(params: {
|
|
1637
|
+
providerId: string;
|
|
1638
|
+
name?: string;
|
|
1639
|
+
enabled?: boolean;
|
|
1640
|
+
apiKey?: string;
|
|
1641
|
+
apiSecret?: string;
|
|
1642
|
+
from?: string;
|
|
1643
|
+
}): Promise<Models.Provider>;
|
|
1644
|
+
/**
|
|
1645
|
+
* Update a Vonage provider by its unique ID.
|
|
1646
|
+
*
|
|
1647
|
+
* @param {string} providerId - Provider ID.
|
|
1648
|
+
* @param {string} name - Provider name.
|
|
1649
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1650
|
+
* @param {string} apiKey - Vonage API key.
|
|
1651
|
+
* @param {string} apiSecret - Vonage API secret.
|
|
1652
|
+
* @param {string} from - Sender number.
|
|
1653
|
+
* @throws {AppwriteException}
|
|
1654
|
+
* @returns {Promise<Models.Provider>}
|
|
1655
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1656
|
+
*/
|
|
469
1657
|
updateVonageProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, apiSecret?: string, from?: string): Promise<Models.Provider>;
|
|
470
1658
|
/**
|
|
471
1659
|
* Get a provider by its unique ID.
|
|
472
1660
|
*
|
|
473
1661
|
*
|
|
474
|
-
* @param {string} providerId
|
|
1662
|
+
* @param {string} params.providerId - Provider ID.
|
|
475
1663
|
* @throws {AppwriteException}
|
|
476
1664
|
* @returns {Promise<Models.Provider>}
|
|
477
1665
|
*/
|
|
1666
|
+
getProvider(params: {
|
|
1667
|
+
providerId: string;
|
|
1668
|
+
}): Promise<Models.Provider>;
|
|
1669
|
+
/**
|
|
1670
|
+
* Get a provider by its unique ID.
|
|
1671
|
+
*
|
|
1672
|
+
*
|
|
1673
|
+
* @param {string} providerId - Provider ID.
|
|
1674
|
+
* @throws {AppwriteException}
|
|
1675
|
+
* @returns {Promise<Models.Provider>}
|
|
1676
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1677
|
+
*/
|
|
478
1678
|
getProvider(providerId: string): Promise<Models.Provider>;
|
|
479
1679
|
/**
|
|
480
1680
|
* Delete a provider by its unique ID.
|
|
481
1681
|
*
|
|
482
|
-
* @param {string} providerId
|
|
1682
|
+
* @param {string} params.providerId - Provider ID.
|
|
1683
|
+
* @throws {AppwriteException}
|
|
1684
|
+
* @returns {Promise<{}>}
|
|
1685
|
+
*/
|
|
1686
|
+
deleteProvider(params: {
|
|
1687
|
+
providerId: string;
|
|
1688
|
+
}): Promise<{}>;
|
|
1689
|
+
/**
|
|
1690
|
+
* Delete a provider by its unique ID.
|
|
1691
|
+
*
|
|
1692
|
+
* @param {string} providerId - Provider ID.
|
|
483
1693
|
* @throws {AppwriteException}
|
|
484
1694
|
* @returns {Promise<{}>}
|
|
1695
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
485
1696
|
*/
|
|
486
1697
|
deleteProvider(providerId: string): Promise<{}>;
|
|
487
1698
|
/**
|
|
488
1699
|
* Get the provider activity logs listed by its unique ID.
|
|
489
1700
|
*
|
|
490
|
-
* @param {string} providerId
|
|
491
|
-
* @param {string[]} queries
|
|
1701
|
+
* @param {string} params.providerId - Provider ID.
|
|
1702
|
+
* @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
|
|
1703
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
492
1704
|
* @throws {AppwriteException}
|
|
493
1705
|
* @returns {Promise<Models.LogList>}
|
|
494
1706
|
*/
|
|
495
|
-
listProviderLogs(
|
|
1707
|
+
listProviderLogs(params: {
|
|
1708
|
+
providerId: string;
|
|
1709
|
+
queries?: string[];
|
|
1710
|
+
total?: boolean;
|
|
1711
|
+
}): Promise<Models.LogList>;
|
|
1712
|
+
/**
|
|
1713
|
+
* Get the provider activity logs listed by its unique ID.
|
|
1714
|
+
*
|
|
1715
|
+
* @param {string} providerId - Provider ID.
|
|
1716
|
+
* @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
|
|
1717
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1718
|
+
* @throws {AppwriteException}
|
|
1719
|
+
* @returns {Promise<Models.LogList>}
|
|
1720
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1721
|
+
*/
|
|
1722
|
+
listProviderLogs(providerId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
|
|
496
1723
|
/**
|
|
497
1724
|
* Get the subscriber activity logs listed by its unique ID.
|
|
498
1725
|
*
|
|
499
|
-
* @param {string} subscriberId
|
|
500
|
-
* @param {string[]} queries
|
|
1726
|
+
* @param {string} params.subscriberId - Subscriber ID.
|
|
1727
|
+
* @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
|
|
1728
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
501
1729
|
* @throws {AppwriteException}
|
|
502
1730
|
* @returns {Promise<Models.LogList>}
|
|
503
1731
|
*/
|
|
504
|
-
listSubscriberLogs(
|
|
1732
|
+
listSubscriberLogs(params: {
|
|
1733
|
+
subscriberId: string;
|
|
1734
|
+
queries?: string[];
|
|
1735
|
+
total?: boolean;
|
|
1736
|
+
}): Promise<Models.LogList>;
|
|
1737
|
+
/**
|
|
1738
|
+
* Get the subscriber activity logs listed by its unique ID.
|
|
1739
|
+
*
|
|
1740
|
+
* @param {string} subscriberId - Subscriber ID.
|
|
1741
|
+
* @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
|
|
1742
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1743
|
+
* @throws {AppwriteException}
|
|
1744
|
+
* @returns {Promise<Models.LogList>}
|
|
1745
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1746
|
+
*/
|
|
1747
|
+
listSubscriberLogs(subscriberId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
|
|
505
1748
|
/**
|
|
506
1749
|
* Get a list of all topics from the current Appwrite project.
|
|
507
1750
|
*
|
|
508
|
-
* @param {string[]} queries
|
|
509
|
-
* @param {string} search
|
|
1751
|
+
* @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, description, emailTotal, smsTotal, pushTotal
|
|
1752
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
1753
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
510
1754
|
* @throws {AppwriteException}
|
|
511
1755
|
* @returns {Promise<Models.TopicList>}
|
|
512
1756
|
*/
|
|
513
|
-
listTopics(
|
|
1757
|
+
listTopics(params?: {
|
|
1758
|
+
queries?: string[];
|
|
1759
|
+
search?: string;
|
|
1760
|
+
total?: boolean;
|
|
1761
|
+
}): Promise<Models.TopicList>;
|
|
1762
|
+
/**
|
|
1763
|
+
* Get a list of all topics from the current Appwrite project.
|
|
1764
|
+
*
|
|
1765
|
+
* @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, description, emailTotal, smsTotal, pushTotal
|
|
1766
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
1767
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1768
|
+
* @throws {AppwriteException}
|
|
1769
|
+
* @returns {Promise<Models.TopicList>}
|
|
1770
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1771
|
+
*/
|
|
1772
|
+
listTopics(queries?: string[], search?: string, total?: boolean): Promise<Models.TopicList>;
|
|
1773
|
+
/**
|
|
1774
|
+
* Create a new topic.
|
|
1775
|
+
*
|
|
1776
|
+
* @param {string} params.topicId - Topic ID. Choose a custom Topic ID or a new Topic ID.
|
|
1777
|
+
* @param {string} params.name - Topic Name.
|
|
1778
|
+
* @param {string[]} params.subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
1779
|
+
* @throws {AppwriteException}
|
|
1780
|
+
* @returns {Promise<Models.Topic>}
|
|
1781
|
+
*/
|
|
1782
|
+
createTopic(params: {
|
|
1783
|
+
topicId: string;
|
|
1784
|
+
name: string;
|
|
1785
|
+
subscribe?: string[];
|
|
1786
|
+
}): Promise<Models.Topic>;
|
|
514
1787
|
/**
|
|
515
1788
|
* Create a new topic.
|
|
516
1789
|
*
|
|
517
|
-
* @param {string} topicId
|
|
518
|
-
* @param {string} name
|
|
519
|
-
* @param {string[]} subscribe
|
|
1790
|
+
* @param {string} topicId - Topic ID. Choose a custom Topic ID or a new Topic ID.
|
|
1791
|
+
* @param {string} name - Topic Name.
|
|
1792
|
+
* @param {string[]} subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
520
1793
|
* @throws {AppwriteException}
|
|
521
1794
|
* @returns {Promise<Models.Topic>}
|
|
1795
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
522
1796
|
*/
|
|
523
1797
|
createTopic(topicId: string, name: string, subscribe?: string[]): Promise<Models.Topic>;
|
|
524
1798
|
/**
|
|
525
1799
|
* Get a topic by its unique ID.
|
|
526
1800
|
*
|
|
527
1801
|
*
|
|
528
|
-
* @param {string} topicId
|
|
1802
|
+
* @param {string} params.topicId - Topic ID.
|
|
1803
|
+
* @throws {AppwriteException}
|
|
1804
|
+
* @returns {Promise<Models.Topic>}
|
|
1805
|
+
*/
|
|
1806
|
+
getTopic(params: {
|
|
1807
|
+
topicId: string;
|
|
1808
|
+
}): Promise<Models.Topic>;
|
|
1809
|
+
/**
|
|
1810
|
+
* Get a topic by its unique ID.
|
|
1811
|
+
*
|
|
1812
|
+
*
|
|
1813
|
+
* @param {string} topicId - Topic ID.
|
|
529
1814
|
* @throws {AppwriteException}
|
|
530
1815
|
* @returns {Promise<Models.Topic>}
|
|
1816
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
531
1817
|
*/
|
|
532
1818
|
getTopic(topicId: string): Promise<Models.Topic>;
|
|
533
1819
|
/**
|
|
534
1820
|
* Update a topic by its unique ID.
|
|
535
1821
|
*
|
|
536
1822
|
*
|
|
537
|
-
* @param {string} topicId
|
|
538
|
-
* @param {string} name
|
|
539
|
-
* @param {string[]} subscribe
|
|
1823
|
+
* @param {string} params.topicId - Topic ID.
|
|
1824
|
+
* @param {string} params.name - Topic Name.
|
|
1825
|
+
* @param {string[]} params.subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
1826
|
+
* @throws {AppwriteException}
|
|
1827
|
+
* @returns {Promise<Models.Topic>}
|
|
1828
|
+
*/
|
|
1829
|
+
updateTopic(params: {
|
|
1830
|
+
topicId: string;
|
|
1831
|
+
name?: string;
|
|
1832
|
+
subscribe?: string[];
|
|
1833
|
+
}): Promise<Models.Topic>;
|
|
1834
|
+
/**
|
|
1835
|
+
* Update a topic by its unique ID.
|
|
1836
|
+
*
|
|
1837
|
+
*
|
|
1838
|
+
* @param {string} topicId - Topic ID.
|
|
1839
|
+
* @param {string} name - Topic Name.
|
|
1840
|
+
* @param {string[]} subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
540
1841
|
* @throws {AppwriteException}
|
|
541
1842
|
* @returns {Promise<Models.Topic>}
|
|
1843
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
542
1844
|
*/
|
|
543
1845
|
updateTopic(topicId: string, name?: string, subscribe?: string[]): Promise<Models.Topic>;
|
|
544
1846
|
/**
|
|
545
1847
|
* Delete a topic by its unique ID.
|
|
546
1848
|
*
|
|
547
|
-
* @param {string} topicId
|
|
1849
|
+
* @param {string} params.topicId - Topic ID.
|
|
548
1850
|
* @throws {AppwriteException}
|
|
549
1851
|
* @returns {Promise<{}>}
|
|
550
1852
|
*/
|
|
1853
|
+
deleteTopic(params: {
|
|
1854
|
+
topicId: string;
|
|
1855
|
+
}): Promise<{}>;
|
|
1856
|
+
/**
|
|
1857
|
+
* Delete a topic by its unique ID.
|
|
1858
|
+
*
|
|
1859
|
+
* @param {string} topicId - Topic ID.
|
|
1860
|
+
* @throws {AppwriteException}
|
|
1861
|
+
* @returns {Promise<{}>}
|
|
1862
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1863
|
+
*/
|
|
551
1864
|
deleteTopic(topicId: string): Promise<{}>;
|
|
552
1865
|
/**
|
|
553
1866
|
* Get the topic activity logs listed by its unique ID.
|
|
554
1867
|
*
|
|
555
|
-
* @param {string} topicId
|
|
556
|
-
* @param {string[]} queries
|
|
1868
|
+
* @param {string} params.topicId - Topic ID.
|
|
1869
|
+
* @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
|
|
1870
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1871
|
+
* @throws {AppwriteException}
|
|
1872
|
+
* @returns {Promise<Models.LogList>}
|
|
1873
|
+
*/
|
|
1874
|
+
listTopicLogs(params: {
|
|
1875
|
+
topicId: string;
|
|
1876
|
+
queries?: string[];
|
|
1877
|
+
total?: boolean;
|
|
1878
|
+
}): Promise<Models.LogList>;
|
|
1879
|
+
/**
|
|
1880
|
+
* Get the topic activity logs listed by its unique ID.
|
|
1881
|
+
*
|
|
1882
|
+
* @param {string} topicId - Topic ID.
|
|
1883
|
+
* @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
|
|
1884
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
557
1885
|
* @throws {AppwriteException}
|
|
558
1886
|
* @returns {Promise<Models.LogList>}
|
|
1887
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
559
1888
|
*/
|
|
560
|
-
listTopicLogs(topicId: string, queries?: string[]): Promise<Models.LogList>;
|
|
1889
|
+
listTopicLogs(topicId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
|
|
561
1890
|
/**
|
|
562
1891
|
* Get a list of all subscribers from the current Appwrite project.
|
|
563
1892
|
*
|
|
564
|
-
* @param {string} topicId
|
|
565
|
-
* @param {string[]} queries
|
|
566
|
-
* @param {string} search
|
|
1893
|
+
* @param {string} params.topicId - Topic ID. The topic ID subscribed to.
|
|
1894
|
+
* @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, provider, type, enabled
|
|
1895
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
1896
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
567
1897
|
* @throws {AppwriteException}
|
|
568
1898
|
* @returns {Promise<Models.SubscriberList>}
|
|
569
1899
|
*/
|
|
570
|
-
listSubscribers(
|
|
1900
|
+
listSubscribers(params: {
|
|
1901
|
+
topicId: string;
|
|
1902
|
+
queries?: string[];
|
|
1903
|
+
search?: string;
|
|
1904
|
+
total?: boolean;
|
|
1905
|
+
}): Promise<Models.SubscriberList>;
|
|
1906
|
+
/**
|
|
1907
|
+
* Get a list of all subscribers from the current Appwrite project.
|
|
1908
|
+
*
|
|
1909
|
+
* @param {string} topicId - Topic ID. The topic ID subscribed to.
|
|
1910
|
+
* @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, provider, type, enabled
|
|
1911
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
1912
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1913
|
+
* @throws {AppwriteException}
|
|
1914
|
+
* @returns {Promise<Models.SubscriberList>}
|
|
1915
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1916
|
+
*/
|
|
1917
|
+
listSubscribers(topicId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.SubscriberList>;
|
|
571
1918
|
/**
|
|
572
1919
|
* Create a new subscriber.
|
|
573
1920
|
*
|
|
574
|
-
* @param {string} topicId
|
|
575
|
-
* @param {string} subscriberId
|
|
576
|
-
* @param {string} targetId
|
|
1921
|
+
* @param {string} params.topicId - Topic ID. The topic ID to subscribe to.
|
|
1922
|
+
* @param {string} params.subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.
|
|
1923
|
+
* @param {string} params.targetId - Target ID. The target ID to link to the specified Topic ID.
|
|
577
1924
|
* @throws {AppwriteException}
|
|
578
1925
|
* @returns {Promise<Models.Subscriber>}
|
|
579
1926
|
*/
|
|
1927
|
+
createSubscriber(params: {
|
|
1928
|
+
topicId: string;
|
|
1929
|
+
subscriberId: string;
|
|
1930
|
+
targetId: string;
|
|
1931
|
+
}): Promise<Models.Subscriber>;
|
|
1932
|
+
/**
|
|
1933
|
+
* Create a new subscriber.
|
|
1934
|
+
*
|
|
1935
|
+
* @param {string} topicId - Topic ID. The topic ID to subscribe to.
|
|
1936
|
+
* @param {string} subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.
|
|
1937
|
+
* @param {string} targetId - Target ID. The target ID to link to the specified Topic ID.
|
|
1938
|
+
* @throws {AppwriteException}
|
|
1939
|
+
* @returns {Promise<Models.Subscriber>}
|
|
1940
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1941
|
+
*/
|
|
580
1942
|
createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
|
|
581
1943
|
/**
|
|
582
1944
|
* Get a subscriber by its unique ID.
|
|
583
1945
|
*
|
|
584
1946
|
*
|
|
585
|
-
* @param {string} topicId
|
|
586
|
-
* @param {string} subscriberId
|
|
1947
|
+
* @param {string} params.topicId - Topic ID. The topic ID subscribed to.
|
|
1948
|
+
* @param {string} params.subscriberId - Subscriber ID.
|
|
587
1949
|
* @throws {AppwriteException}
|
|
588
1950
|
* @returns {Promise<Models.Subscriber>}
|
|
589
1951
|
*/
|
|
1952
|
+
getSubscriber(params: {
|
|
1953
|
+
topicId: string;
|
|
1954
|
+
subscriberId: string;
|
|
1955
|
+
}): Promise<Models.Subscriber>;
|
|
1956
|
+
/**
|
|
1957
|
+
* Get a subscriber by its unique ID.
|
|
1958
|
+
*
|
|
1959
|
+
*
|
|
1960
|
+
* @param {string} topicId - Topic ID. The topic ID subscribed to.
|
|
1961
|
+
* @param {string} subscriberId - Subscriber ID.
|
|
1962
|
+
* @throws {AppwriteException}
|
|
1963
|
+
* @returns {Promise<Models.Subscriber>}
|
|
1964
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1965
|
+
*/
|
|
590
1966
|
getSubscriber(topicId: string, subscriberId: string): Promise<Models.Subscriber>;
|
|
591
1967
|
/**
|
|
592
1968
|
* Delete a subscriber by its unique ID.
|
|
593
1969
|
*
|
|
594
|
-
* @param {string} topicId
|
|
595
|
-
* @param {string} subscriberId
|
|
1970
|
+
* @param {string} params.topicId - Topic ID. The topic ID subscribed to.
|
|
1971
|
+
* @param {string} params.subscriberId - Subscriber ID.
|
|
1972
|
+
* @throws {AppwriteException}
|
|
1973
|
+
* @returns {Promise<{}>}
|
|
1974
|
+
*/
|
|
1975
|
+
deleteSubscriber(params: {
|
|
1976
|
+
topicId: string;
|
|
1977
|
+
subscriberId: string;
|
|
1978
|
+
}): Promise<{}>;
|
|
1979
|
+
/**
|
|
1980
|
+
* Delete a subscriber by its unique ID.
|
|
1981
|
+
*
|
|
1982
|
+
* @param {string} topicId - Topic ID. The topic ID subscribed to.
|
|
1983
|
+
* @param {string} subscriberId - Subscriber ID.
|
|
596
1984
|
* @throws {AppwriteException}
|
|
597
1985
|
* @returns {Promise<{}>}
|
|
1986
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
598
1987
|
*/
|
|
599
1988
|
deleteSubscriber(topicId: string, subscriberId: string): Promise<{}>;
|
|
600
1989
|
}
|