├── .github └── workflows │ ├── autoclose.yml │ └── publish.yml ├── CHANGELOG.md ├── LICENSE ├── README.md ├── dist ├── cjs │ └── package.json └── esm │ └── package.json ├── docs └── examples │ ├── account │ ├── create-anonymous-session.md │ ├── create-billing-address.md │ ├── create-email-password-session.md │ ├── create-email-token.md │ ├── create-j-w-t.md │ ├── create-magic-u-r-l-token.md │ ├── create-mfa-authenticator.md │ ├── create-mfa-challenge.md │ ├── create-mfa-recovery-codes.md │ ├── create-o-auth2session.md │ ├── create-o-auth2token.md │ ├── create-payment-method.md │ ├── create-phone-token.md │ ├── create-phone-verification.md │ ├── create-push-target.md │ ├── create-recovery.md │ ├── create-session.md │ ├── create-verification.md │ ├── create.md │ ├── delete-billing-address.md │ ├── delete-identity.md │ ├── delete-mfa-authenticator.md │ ├── delete-payment-method.md │ ├── delete-push-target.md │ ├── delete-session.md │ ├── delete-sessions.md │ ├── delete.md │ ├── get-billing-address.md │ ├── get-coupon.md │ ├── get-mfa-recovery-codes.md │ ├── get-payment-method.md │ ├── get-prefs.md │ ├── get-session.md │ ├── get.md │ ├── list-billing-addresses.md │ ├── list-identities.md │ ├── list-invoices.md │ ├── list-logs.md │ ├── list-mfa-factors.md │ ├── list-payment-methods.md │ ├── list-sessions.md │ ├── update-billing-address.md │ ├── update-email.md │ ├── update-m-f-a.md │ ├── update-magic-u-r-l-session.md │ ├── update-mfa-authenticator.md │ ├── update-mfa-challenge.md │ ├── update-mfa-recovery-codes.md │ ├── update-name.md │ ├── update-password.md │ ├── update-payment-method-mandate-options.md │ ├── update-payment-method-provider.md │ ├── update-payment-method.md │ ├── update-phone-session.md │ ├── update-phone-verification.md │ ├── update-phone.md │ ├── update-prefs.md │ ├── update-push-target.md │ ├── update-recovery.md │ ├── update-session.md │ ├── update-status.md │ └── update-verification.md │ ├── assistant │ └── chat.md │ ├── avatars │ ├── get-browser.md │ ├── get-credit-card.md │ ├── get-favicon.md │ ├── get-flag.md │ ├── get-image.md │ ├── get-initials.md │ └── get-q-r.md │ ├── backups │ ├── create-archive.md │ ├── create-policy.md │ ├── create-restoration.md │ ├── delete-archive.md │ ├── delete-policy.md │ ├── get-archive.md │ ├── get-policy.md │ ├── get-restoration.md │ ├── list-archives.md │ ├── list-policies.md │ ├── list-restorations.md │ └── update-policy.md │ ├── console │ ├── create-program-membership.md │ ├── create-source.md │ ├── get-campaign.md │ ├── get-coupon.md │ ├── get-resource.md │ ├── plans.md │ ├── regions.md │ └── variables.md │ ├── databases │ ├── create-boolean-attribute.md │ ├── create-collection.md │ ├── create-datetime-attribute.md │ ├── create-document.md │ ├── create-documents.md │ ├── create-email-attribute.md │ ├── create-enum-attribute.md │ ├── create-float-attribute.md │ ├── create-index.md │ ├── create-integer-attribute.md │ ├── create-ip-attribute.md │ ├── create-relationship-attribute.md │ ├── create-string-attribute.md │ ├── create-url-attribute.md │ ├── create.md │ ├── delete-attribute.md │ ├── delete-collection.md │ ├── delete-document.md │ ├── delete-documents.md │ ├── delete-index.md │ ├── delete.md │ ├── get-attribute.md │ ├── get-collection-usage.md │ ├── get-collection.md │ ├── get-database-usage.md │ ├── get-document.md │ ├── get-index.md │ ├── get-usage.md │ ├── get.md │ ├── list-attributes.md │ ├── list-collection-logs.md │ ├── list-collections.md │ ├── list-document-logs.md │ ├── list-documents.md │ ├── list-indexes.md │ ├── list-logs.md │ ├── list.md │ ├── update-boolean-attribute.md │ ├── update-collection.md │ ├── update-datetime-attribute.md │ ├── update-document.md │ ├── update-documents.md │ ├── update-email-attribute.md │ ├── update-enum-attribute.md │ ├── update-float-attribute.md │ ├── update-integer-attribute.md │ ├── update-ip-attribute.md │ ├── update-relationship-attribute.md │ ├── update-string-attribute.md │ ├── update-url-attribute.md │ ├── update.md │ ├── upsert-document.md │ └── upsert-documents.md │ ├── domains │ ├── create-preset-google-workspace.md │ ├── create-preset-i-cloud.md │ ├── create-preset-mailgun.md │ ├── create-preset-outlook.md │ ├── create-preset-proton-mail.md │ ├── create-preset-zoho.md │ ├── create-record-a-a-a-a.md │ ├── create-record-a.md │ ├── create-record-alias.md │ ├── create-record-c-a-a.md │ ├── create-record-c-n-a-m-e.md │ ├── create-record-h-t-t-p-s.md │ ├── create-record-m-x.md │ ├── create-record-n-s.md │ ├── create-record-s-r-v.md │ ├── create-record-t-x-t.md │ ├── create.md │ ├── delete-record.md │ ├── delete.md │ ├── get-preset-google-workspace.md │ ├── get-preset-i-cloud.md │ ├── get-preset-mailgun.md │ ├── get-preset-outlook.md │ ├── get-preset-proton-mail.md │ ├── get-preset-zoho.md │ ├── get-record.md │ ├── get-zone.md │ ├── get.md │ ├── list-records.md │ ├── list.md │ ├── update-nameservers.md │ ├── update-record-a-a-a-a.md │ ├── update-record-a.md │ ├── update-record-alias.md │ ├── update-record-c-a-a.md │ ├── update-record-c-n-a-m-e.md │ ├── update-record-h-t-t-p-s.md │ ├── update-record-m-x.md │ ├── update-record-n-s.md │ ├── update-record-s-r-v.md │ ├── update-record-t-x-t.md │ ├── update-team.md │ └── update-zone.md │ ├── functions │ ├── create-build.md │ ├── create-deployment.md │ ├── create-duplicate-deployment.md │ ├── create-execution.md │ ├── create-template-deployment.md │ ├── create-variable.md │ ├── create-vcs-deployment.md │ ├── create.md │ ├── delete-deployment.md │ ├── delete-execution.md │ ├── delete-variable.md │ ├── delete.md │ ├── get-deployment-download.md │ ├── get-deployment.md │ ├── get-execution.md │ ├── get-function-usage.md │ ├── get-template.md │ ├── get-usage.md │ ├── get-variable.md │ ├── get.md │ ├── list-deployments.md │ ├── list-executions.md │ ├── list-runtimes.md │ ├── list-specifications.md │ ├── list-templates.md │ ├── list-usage.md │ ├── list-variables.md │ ├── list.md │ ├── update-deployment-build.md │ ├── update-deployment-status.md │ ├── update-deployment.md │ ├── update-function-deployment.md │ ├── update-variable.md │ └── update.md │ ├── graphql │ ├── mutation.md │ └── query.md │ ├── health │ ├── get-antivirus.md │ ├── get-cache.md │ ├── get-certificate.md │ ├── get-d-b.md │ ├── get-failed-jobs.md │ ├── get-pub-sub.md │ ├── get-queue-billing-aggregation.md │ ├── get-queue-builds.md │ ├── get-queue-certificates.md │ ├── get-queue-databases.md │ ├── get-queue-deletes.md │ ├── get-queue-functions.md │ ├── get-queue-logs.md │ ├── get-queue-mails.md │ ├── get-queue-messaging.md │ ├── get-queue-migrations.md │ ├── get-queue-priority-builds.md │ ├── get-queue-region-manager.md │ ├── get-queue-stats-resources.md │ ├── get-queue-stats-usage-dump.md │ ├── get-queue-usage.md │ ├── get-queue-webhooks.md │ ├── get-storage-local.md │ ├── get-storage.md │ ├── get-time.md │ └── get.md │ ├── locale │ ├── get.md │ ├── list-codes.md │ ├── list-continents.md │ ├── list-countries-e-u.md │ ├── list-countries-phones.md │ ├── list-countries.md │ ├── list-currencies.md │ └── list-languages.md │ ├── messaging │ ├── create-apns-provider.md │ ├── create-email.md │ ├── create-fcm-provider.md │ ├── create-mailgun-provider.md │ ├── create-msg91provider.md │ ├── create-push.md │ ├── create-sendgrid-provider.md │ ├── create-sms.md │ ├── create-smtp-provider.md │ ├── create-subscriber.md │ ├── create-telesign-provider.md │ ├── create-textmagic-provider.md │ ├── create-topic.md │ ├── create-twilio-provider.md │ ├── create-vonage-provider.md │ ├── delete-provider.md │ ├── delete-subscriber.md │ ├── delete-topic.md │ ├── delete.md │ ├── get-message.md │ ├── get-provider.md │ ├── get-subscriber.md │ ├── get-topic.md │ ├── list-message-logs.md │ ├── list-messages.md │ ├── list-provider-logs.md │ ├── list-providers.md │ ├── list-subscriber-logs.md │ ├── list-subscribers.md │ ├── list-targets.md │ ├── list-topic-logs.md │ ├── list-topics.md │ ├── update-apns-provider.md │ ├── update-email.md │ ├── update-fcm-provider.md │ ├── update-mailgun-provider.md │ ├── update-msg91provider.md │ ├── update-push.md │ ├── update-sendgrid-provider.md │ ├── update-sms.md │ ├── update-smtp-provider.md │ ├── update-telesign-provider.md │ ├── update-textmagic-provider.md │ ├── update-topic.md │ ├── update-twilio-provider.md │ └── update-vonage-provider.md │ ├── migrations │ ├── create-appwrite-migration.md │ ├── create-csv-migration.md │ ├── create-firebase-migration.md │ ├── create-n-host-migration.md │ ├── create-supabase-migration.md │ ├── delete.md │ ├── get-appwrite-report.md │ ├── get-firebase-report.md │ ├── get-n-host-report.md │ ├── get-supabase-report.md │ ├── get.md │ ├── list.md │ └── retry.md │ ├── organizations │ ├── add-credit.md │ ├── create-invoice-payment.md │ ├── create.md │ ├── delete-backup-payment-method.md │ ├── delete-billing-address.md │ ├── delete-default-payment-method.md │ ├── delete.md │ ├── get-aggregation.md │ ├── get-billing-address.md │ ├── get-credit.md │ ├── get-invoice-download.md │ ├── get-invoice-view.md │ ├── get-invoice.md │ ├── get-payment-method.md │ ├── get-plan.md │ ├── get-scopes.md │ ├── get-usage.md │ ├── list-aggregations.md │ ├── list-credits.md │ ├── list-invoices.md │ ├── list.md │ ├── set-backup-payment-method.md │ ├── set-billing-address.md │ ├── set-billing-email.md │ ├── set-billing-tax-id.md │ ├── set-default-payment-method.md │ ├── update-budget.md │ ├── update-plan.md │ └── validate-invoice.md │ ├── project │ ├── create-variable.md │ ├── delete-variable.md │ ├── get-usage.md │ ├── get-variable.md │ ├── list-variables.md │ └── update-variable.md │ ├── projects │ ├── create-dev-key.md │ ├── create-j-w-t.md │ ├── create-key.md │ ├── create-platform.md │ ├── create-smtp-test.md │ ├── create-webhook.md │ ├── create.md │ ├── delete-dev-key.md │ ├── delete-email-template.md │ ├── delete-key.md │ ├── delete-platform.md │ ├── delete-sms-template.md │ ├── delete-webhook.md │ ├── delete.md │ ├── get-dev-key.md │ ├── get-email-template.md │ ├── get-key.md │ ├── get-platform.md │ ├── get-sms-template.md │ ├── get-webhook.md │ ├── get.md │ ├── list-dev-keys.md │ ├── list-keys.md │ ├── list-platforms.md │ ├── list-webhooks.md │ ├── list.md │ ├── update-api-status-all.md │ ├── update-api-status.md │ ├── update-auth-duration.md │ ├── update-auth-limit.md │ ├── update-auth-password-dictionary.md │ ├── update-auth-password-history.md │ ├── update-auth-sessions-limit.md │ ├── update-auth-status.md │ ├── update-dev-key.md │ ├── update-email-template.md │ ├── update-key.md │ ├── update-memberships-privacy.md │ ├── update-mock-numbers.md │ ├── update-o-auth2.md │ ├── update-personal-data-check.md │ ├── update-platform.md │ ├── update-service-status-all.md │ ├── update-service-status.md │ ├── update-session-alerts.md │ ├── update-sms-template.md │ ├── update-smtp.md │ ├── update-team.md │ ├── update-webhook-signature.md │ ├── update-webhook.md │ └── update.md │ ├── proxy │ ├── create-a-p-i-rule.md │ ├── create-function-rule.md │ ├── create-redirect-rule.md │ ├── create-rule.md │ ├── create-site-rule.md │ ├── delete-rule.md │ ├── get-rule.md │ ├── list-rules.md │ └── update-rule-verification.md │ ├── sites │ ├── create-deployment.md │ ├── create-duplicate-deployment.md │ ├── create-template-deployment.md │ ├── create-variable.md │ ├── create-vcs-deployment.md │ ├── create.md │ ├── delete-deployment.md │ ├── delete-log.md │ ├── delete-variable.md │ ├── delete.md │ ├── get-deployment-download.md │ ├── get-deployment.md │ ├── get-log.md │ ├── get-template.md │ ├── get-usage.md │ ├── get-variable.md │ ├── get.md │ ├── list-deployments.md │ ├── list-frameworks.md │ ├── list-logs.md │ ├── list-specifications.md │ ├── list-templates.md │ ├── list-usage.md │ ├── list-variables.md │ ├── list.md │ ├── update-deployment-status.md │ ├── update-site-deployment.md │ ├── update-variable.md │ └── update.md │ ├── storage │ ├── create-bucket.md │ ├── create-file.md │ ├── delete-bucket.md │ ├── delete-file.md │ ├── get-bucket-usage.md │ ├── get-bucket.md │ ├── get-file-download.md │ ├── get-file-preview.md │ ├── get-file-view.md │ ├── get-file.md │ ├── get-usage.md │ ├── list-buckets.md │ ├── list-files.md │ ├── update-bucket.md │ └── update-file.md │ ├── teams │ ├── create-membership.md │ ├── create.md │ ├── delete-membership.md │ ├── delete.md │ ├── get-membership.md │ ├── get-prefs.md │ ├── get.md │ ├── list-logs.md │ ├── list-memberships.md │ ├── list.md │ ├── update-membership-status.md │ ├── update-membership.md │ ├── update-name.md │ └── update-prefs.md │ ├── tokens │ ├── create-file-token.md │ ├── delete.md │ ├── get.md │ ├── list.md │ └── update.md │ ├── users │ ├── create-argon2user.md │ ├── create-bcrypt-user.md │ ├── create-j-w-t.md │ ├── create-m-d5user.md │ ├── create-mfa-recovery-codes.md │ ├── create-p-h-pass-user.md │ ├── create-s-h-a-user.md │ ├── create-scrypt-modified-user.md │ ├── create-scrypt-user.md │ ├── create-session.md │ ├── create-target.md │ ├── create-token.md │ ├── create.md │ ├── delete-identity.md │ ├── delete-mfa-authenticator.md │ ├── delete-session.md │ ├── delete-sessions.md │ ├── delete-target.md │ ├── delete.md │ ├── get-mfa-recovery-codes.md │ ├── get-prefs.md │ ├── get-target.md │ ├── get-usage.md │ ├── get.md │ ├── list-identities.md │ ├── list-logs.md │ ├── list-memberships.md │ ├── list-mfa-factors.md │ ├── list-sessions.md │ ├── list-targets.md │ ├── list.md │ ├── update-email-verification.md │ ├── update-email.md │ ├── update-labels.md │ ├── update-mfa-recovery-codes.md │ ├── update-mfa.md │ ├── update-name.md │ ├── update-password.md │ ├── update-phone-verification.md │ ├── update-phone.md │ ├── update-prefs.md │ ├── update-status.md │ └── update-target.md │ └── vcs │ ├── create-repository-detection.md │ ├── create-repository.md │ ├── delete-installation.md │ ├── get-installation.md │ ├── get-repository-contents.md │ ├── get-repository.md │ ├── list-installations.md │ ├── list-repositories.md │ ├── list-repository-branches.md │ └── update-external-deployments.md ├── package.json ├── rollup.config.js ├── src ├── client.ts ├── enums │ ├── adapter.ts │ ├── api-service.ts │ ├── api.ts │ ├── auth-method.ts │ ├── authentication-factor.ts │ ├── authenticator-type.ts │ ├── billing-plan.ts │ ├── browser.ts │ ├── build-runtime.ts │ ├── compression.ts │ ├── console-resource-type.ts │ ├── credit-card.ts │ ├── database-usage-range.ts │ ├── deployment-download-type.ts │ ├── email-template-locale.ts │ ├── email-template-type.ts │ ├── execution-method.ts │ ├── flag.ts │ ├── framework.ts │ ├── function-usage-range.ts │ ├── image-format.ts │ ├── image-gravity.ts │ ├── index-type.ts │ ├── message-priority.ts │ ├── messaging-provider-type.ts │ ├── name.ts │ ├── o-auth-provider.ts │ ├── password-hash.ts │ ├── platform-type.ts │ ├── project-usage-range.ts │ ├── region.ts │ ├── relation-mutate.ts │ ├── relationship-type.ts │ ├── resource-type.ts │ ├── runtime.ts │ ├── s-m-t-p-secure.ts │ ├── site-usage-range.ts │ ├── sms-template-locale.ts │ ├── sms-template-type.ts │ ├── smtp-encryption.ts │ ├── status-code.ts │ ├── storage-usage-range.ts │ ├── user-usage-range.ts │ ├── v-c-s-deployment-type.ts │ └── v-c-s-detection-type.ts ├── id.ts ├── index.ts ├── models.ts ├── permission.ts ├── query.ts ├── role.ts ├── service.ts └── services │ ├── account.ts │ ├── assistant.ts │ ├── avatars.ts │ ├── backups.ts │ ├── console.ts │ ├── databases.ts │ ├── domains.ts │ ├── functions.ts │ ├── graphql.ts │ ├── health.ts │ ├── locale.ts │ ├── messaging.ts │ ├── migrations.ts │ ├── organizations.ts │ ├── project.ts │ ├── projects.ts │ ├── proxy.ts │ ├── sites.ts │ ├── storage.ts │ ├── teams.ts │ ├── tokens.ts │ ├── users.ts │ └── vcs.ts └── tsconfig.json /.github/workflows/autoclose.yml: -------------------------------------------------------------------------------- 1 | name: Auto-close External Pull Requests 2 | 3 | on: 4 | pull_request_target: 5 | types: [opened, reopened] 6 | 7 | jobs: 8 | auto_close: 9 | uses: appwrite/.github/.github/workflows/autoclose.yml@main 10 | secrets: 11 | GH_AUTO_CLOSE_PR_TOKEN: ${{ secrets.GH_AUTO_CLOSE_PR_TOKEN }} -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | ## 18.0.0 4 | 5 | * Add `<REGION>` to doc examples due to the new multi region endpoints 6 | * Remove `Gif` from ImageFormat enum 7 | * Remove `search` param from `listExecutions` method 8 | * Add `token` param to `getFilePreview` and `getFileView` for File tokens usage 9 | * Improve CORS error catching in `client.call` method -------------------------------------------------------------------------------- /dist/cjs/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "commonjs" 3 | } -------------------------------------------------------------------------------- /dist/esm/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "module" 3 | } -------------------------------------------------------------------------------- /docs/examples/account/create-anonymous-session.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createAnonymousSession(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/create-email-password-session.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createEmailPasswordSession( 10 | 'email@example.com', // email 11 | 'password' // password 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/create-email-token.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createEmailToken( 10 | '', // userId 11 | 'email@example.com', // email 12 | false // phrase (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/account/create-j-w-t.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createJWT(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/create-mfa-authenticator.md: -------------------------------------------------------------------------------- 1 | import { Client, Account, AuthenticatorType } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createMfaAuthenticator( 10 | AuthenticatorType.Totp // type 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/create-mfa-challenge.md: -------------------------------------------------------------------------------- 1 | import { Client, Account, AuthenticationFactor } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createMfaChallenge( 10 | AuthenticationFactor.Email // factor 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/create-mfa-recovery-codes.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createMfaRecoveryCodes(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/create-payment-method.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createPaymentMethod(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/create-phone-token.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createPhoneToken( 10 | '', // userId 11 | '+12065550100' // phone 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/create-phone-verification.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createPhoneVerification(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/create-push-target.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createPushTarget( 10 | '', // targetId 11 | '', // identifier 12 | '' // providerId (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/account/create-recovery.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createRecovery( 10 | 'email@example.com', // email 11 | 'https://example.com' // url 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/create-session.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createSession( 10 | '', // userId 11 | '' // secret 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/create-verification.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.createVerification( 10 | 'https://example.com' // url 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/create.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.create( 10 | '', // userId 11 | 'email@example.com', // email 12 | '', // password 13 | '' // name (optional) 14 | ); 15 | 16 | console.log(result); 17 | -------------------------------------------------------------------------------- /docs/examples/account/delete-billing-address.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.deleteBillingAddress( 10 | '' // billingAddressId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/delete-identity.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.deleteIdentity( 10 | '' // identityId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/delete-mfa-authenticator.md: -------------------------------------------------------------------------------- 1 | import { Client, Account, AuthenticatorType } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.deleteMfaAuthenticator( 10 | AuthenticatorType.Totp // type 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/delete-payment-method.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.deletePaymentMethod( 10 | '' // paymentMethodId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/delete-push-target.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.deletePushTarget( 10 | '' // targetId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/delete-session.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.deleteSession( 10 | '' // sessionId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/delete-sessions.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.deleteSessions(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.delete(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/get-billing-address.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.getBillingAddress( 10 | '' // billingAddressId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/get-coupon.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.getCoupon( 10 | '' // couponId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/get-mfa-recovery-codes.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.getMfaRecoveryCodes(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/get-payment-method.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.getPaymentMethod( 10 | '' // paymentMethodId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/get-prefs.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.getPrefs(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/get-session.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.getSession( 10 | '' // sessionId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.get(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/list-billing-addresses.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.listBillingAddresses( 10 | [] // queries (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/list-identities.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.listIdentities( 10 | [] // queries (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/list-invoices.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.listInvoices( 10 | [] // queries (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/list-logs.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.listLogs( 10 | [] // queries (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/list-mfa-factors.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.listMfaFactors(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/list-payment-methods.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.listPaymentMethods( 10 | [] // queries (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/list-sessions.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.listSessions(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/update-email.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updateEmail( 10 | 'email@example.com', // email 11 | 'password' // password 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/update-m-f-a.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updateMFA( 10 | false // mfa 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/update-magic-u-r-l-session.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updateMagicURLSession( 10 | '', // userId 11 | '' // secret 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/update-mfa-authenticator.md: -------------------------------------------------------------------------------- 1 | import { Client, Account, AuthenticatorType } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updateMfaAuthenticator( 10 | AuthenticatorType.Totp, // type 11 | '' // otp 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/update-mfa-challenge.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updateMfaChallenge( 10 | '', // challengeId 11 | '' // otp 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/update-mfa-recovery-codes.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updateMfaRecoveryCodes(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/update-name.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updateName( 10 | '' // name 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/update-password.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updatePassword( 10 | '', // password 11 | 'password' // oldPassword (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/update-payment-method-mandate-options.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updatePaymentMethodMandateOptions( 10 | '' // paymentMethodId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/update-payment-method.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updatePaymentMethod( 10 | '', // paymentMethodId 11 | 1, // expiryMonth 12 | 2025 // expiryYear 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/account/update-phone-session.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updatePhoneSession( 10 | '', // userId 11 | '' // secret 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/update-phone-verification.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updatePhoneVerification( 10 | '', // userId 11 | '' // secret 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/update-phone.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updatePhone( 10 | '+12065550100', // phone 11 | 'password' // password 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/update-prefs.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updatePrefs( 10 | {} // prefs 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/update-push-target.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updatePushTarget( 10 | '', // targetId 11 | '' // identifier 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/account/update-recovery.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updateRecovery( 10 | '', // userId 11 | '', // secret 12 | '' // password 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/account/update-session.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updateSession( 10 | '' // sessionId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/account/update-status.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updateStatus(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/account/update-verification.md: -------------------------------------------------------------------------------- 1 | import { Client, Account } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const account = new Account(client); 8 | 9 | const result = await account.updateVerification( 10 | '', // userId 11 | '' // secret 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/assistant/chat.md: -------------------------------------------------------------------------------- 1 | import { Client, Assistant } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const assistant = new Assistant(client); 8 | 9 | const result = await assistant.chat( 10 | '' // prompt 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/avatars/get-favicon.md: -------------------------------------------------------------------------------- 1 | import { Client, Avatars } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const avatars = new Avatars(client); 8 | 9 | const result = avatars.getFavicon( 10 | 'https://example.com' // url 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/avatars/get-flag.md: -------------------------------------------------------------------------------- 1 | import { Client, Avatars, Flag } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const avatars = new Avatars(client); 8 | 9 | const result = avatars.getFlag( 10 | Flag.Afghanistan, // code 11 | 0, // width (optional) 12 | 0, // height (optional) 13 | -1 // quality (optional) 14 | ); 15 | 16 | console.log(result); 17 | -------------------------------------------------------------------------------- /docs/examples/avatars/get-image.md: -------------------------------------------------------------------------------- 1 | import { Client, Avatars } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const avatars = new Avatars(client); 8 | 9 | const result = avatars.getImage( 10 | 'https://example.com', // url 11 | 0, // width (optional) 12 | 0 // height (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/avatars/get-initials.md: -------------------------------------------------------------------------------- 1 | import { Client, Avatars } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const avatars = new Avatars(client); 8 | 9 | const result = avatars.getInitials( 10 | '', // name (optional) 11 | 0, // width (optional) 12 | 0, // height (optional) 13 | '' // background (optional) 14 | ); 15 | 16 | console.log(result); 17 | -------------------------------------------------------------------------------- /docs/examples/avatars/get-q-r.md: -------------------------------------------------------------------------------- 1 | import { Client, Avatars } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const avatars = new Avatars(client); 8 | 9 | const result = avatars.getQR( 10 | '', // text 11 | 1, // size (optional) 12 | 0, // margin (optional) 13 | false // download (optional) 14 | ); 15 | 16 | console.log(result); 17 | -------------------------------------------------------------------------------- /docs/examples/backups/create-archive.md: -------------------------------------------------------------------------------- 1 | import { Client, Backups } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const backups = new Backups(client); 8 | 9 | const result = await backups.createArchive( 10 | [], // services 11 | '' // resourceId (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/backups/delete-archive.md: -------------------------------------------------------------------------------- 1 | import { Client, Backups } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const backups = new Backups(client); 8 | 9 | const result = await backups.deleteArchive( 10 | '' // archiveId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/backups/delete-policy.md: -------------------------------------------------------------------------------- 1 | import { Client, Backups } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const backups = new Backups(client); 8 | 9 | const result = await backups.deletePolicy( 10 | '' // policyId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/backups/get-archive.md: -------------------------------------------------------------------------------- 1 | import { Client, Backups } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const backups = new Backups(client); 8 | 9 | const result = await backups.getArchive( 10 | '' // archiveId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/backups/get-policy.md: -------------------------------------------------------------------------------- 1 | import { Client, Backups } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const backups = new Backups(client); 8 | 9 | const result = await backups.getPolicy( 10 | '' // policyId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/backups/get-restoration.md: -------------------------------------------------------------------------------- 1 | import { Client, Backups } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const backups = new Backups(client); 8 | 9 | const result = await backups.getRestoration( 10 | '' // restorationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/backups/list-archives.md: -------------------------------------------------------------------------------- 1 | import { Client, Backups } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const backups = new Backups(client); 8 | 9 | const result = await backups.listArchives( 10 | [] // queries (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/backups/list-policies.md: -------------------------------------------------------------------------------- 1 | import { Client, Backups } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const backups = new Backups(client); 8 | 9 | const result = await backups.listPolicies( 10 | [] // queries (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/backups/list-restorations.md: -------------------------------------------------------------------------------- 1 | import { Client, Backups } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const backups = new Backups(client); 8 | 9 | const result = await backups.listRestorations( 10 | [] // queries (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/console/create-program-membership.md: -------------------------------------------------------------------------------- 1 | import { Client, Console } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const console = new Console(client); 8 | 9 | const result = await console.createProgramMembership( 10 | '' // programId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/console/get-campaign.md: -------------------------------------------------------------------------------- 1 | import { Client, Console } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const console = new Console(client); 8 | 9 | const result = await console.getCampaign( 10 | '' // campaignId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/console/get-coupon.md: -------------------------------------------------------------------------------- 1 | import { Client, Console } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const console = new Console(client); 8 | 9 | const result = await console.getCoupon( 10 | '' // couponId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/console/get-resource.md: -------------------------------------------------------------------------------- 1 | import { Client, Console, ConsoleResourceType } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const console = new Console(client); 8 | 9 | const result = await console.getResource( 10 | '', // value 11 | ConsoleResourceType.Rules // type 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/console/plans.md: -------------------------------------------------------------------------------- 1 | import { Client, Console } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const console = new Console(client); 8 | 9 | const result = await console.plans(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/console/regions.md: -------------------------------------------------------------------------------- 1 | import { Client, Console } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const console = new Console(client); 8 | 9 | const result = await console.regions(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/console/variables.md: -------------------------------------------------------------------------------- 1 | import { Client, Console } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const console = new Console(client); 8 | 9 | const result = await console.variables(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/databases/create-documents.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setKey(''); // Your secret API key 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.createDocuments( 10 | '', // databaseId 11 | '', // collectionId 12 | [] // documents 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/databases/create.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.create( 10 | '', // databaseId 11 | '', // name 12 | false // enabled (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/databases/delete-attribute.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.deleteAttribute( 10 | '', // databaseId 11 | '', // collectionId 12 | '' // key 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/databases/delete-collection.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.deleteCollection( 10 | '', // databaseId 11 | '' // collectionId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/databases/delete-documents.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.deleteDocuments( 10 | '', // databaseId 11 | '', // collectionId 12 | [] // queries (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/databases/delete-index.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.deleteIndex( 10 | '', // databaseId 11 | '', // collectionId 12 | '' // key 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/databases/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.delete( 10 | '' // databaseId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/databases/get-attribute.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.getAttribute( 10 | '', // databaseId 11 | '', // collectionId 12 | '' // key 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/databases/get-collection.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.getCollection( 10 | '', // databaseId 11 | '' // collectionId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/databases/get-index.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.getIndex( 10 | '', // databaseId 11 | '', // collectionId 12 | '' // key 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/databases/get-usage.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases, DatabaseUsageRange } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.getUsage( 10 | DatabaseUsageRange.TwentyFourHours // range (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/databases/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.get( 10 | '' // databaseId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/databases/list-documents.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.listDocuments( 10 | '', // databaseId 11 | '', // collectionId 12 | [] // queries (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/databases/list-indexes.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.listIndexes( 10 | '', // databaseId 11 | '', // collectionId 12 | [] // queries (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/databases/list-logs.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.listLogs( 10 | '', // databaseId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/databases/list.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.list( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/databases/update.md: -------------------------------------------------------------------------------- 1 | import { Client, Databases } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const databases = new Databases(client); 8 | 9 | const result = await databases.update( 10 | '', // databaseId 11 | '', // name 12 | false // enabled (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/domains/create-preset-google-workspace.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.createPresetGoogleWorkspace( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/create-preset-i-cloud.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.createPresetICloud( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/create-preset-mailgun.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.createPresetMailgun( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/create-preset-outlook.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.createPresetOutlook( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/create-preset-proton-mail.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.createPresetProtonMail( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/create-preset-zoho.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.createPresetZoho( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/create.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.create( 10 | '', // teamId 11 | '' // domain 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/domains/delete-record.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.deleteRecord( 10 | '', // domainId 11 | '' // recordId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/domains/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.delete( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/get-preset-google-workspace.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.getPresetGoogleWorkspace( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/get-preset-i-cloud.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.getPresetICloud( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/get-preset-mailgun.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.getPresetMailgun( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/get-preset-outlook.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.getPresetOutlook( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/get-preset-proton-mail.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.getPresetProtonMail( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/get-preset-zoho.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.getPresetZoho( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/get-record.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.getRecord( 10 | '', // domainId 11 | '' // recordId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/domains/get-zone.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.getZone( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.get( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/list-records.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.listRecords( 10 | '', // domainId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/domains/list.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.list( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/domains/update-nameservers.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.updateNameservers( 10 | '' // domainId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/domains/update-team.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.updateTeam( 10 | '', // domainId 11 | '' // teamId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/domains/update-zone.md: -------------------------------------------------------------------------------- 1 | import { Client, Domains } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const domains = new Domains(client); 8 | 9 | const result = await domains.updateZone( 10 | '', // domainId 11 | '' // content 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/create-build.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.createBuild( 10 | '', // functionId 11 | '', // deploymentId 12 | '' // buildId (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/functions/delete-deployment.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.deleteDeployment( 10 | '', // functionId 11 | '' // deploymentId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/delete-execution.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.deleteExecution( 10 | '', // functionId 11 | '' // executionId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/delete-variable.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.deleteVariable( 10 | '', // functionId 11 | '' // variableId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.delete( 10 | '' // functionId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/functions/get-deployment.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.getDeployment( 10 | '', // functionId 11 | '' // deploymentId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/get-execution.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.getExecution( 10 | '', // functionId 11 | '' // executionId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/get-template.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.getTemplate( 10 | '' // templateId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/functions/get-usage.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions, FunctionUsageRange } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.getUsage( 10 | '', // functionId 11 | FunctionUsageRange.TwentyFourHours // range (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/get-variable.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.getVariable( 10 | '', // functionId 11 | '' // variableId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.get( 10 | '' // functionId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/functions/list-executions.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.listExecutions( 10 | '', // functionId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/list-runtimes.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.listRuntimes(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/functions/list-specifications.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.listSpecifications(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/functions/list-usage.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions, FunctionUsageRange } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.listUsage( 10 | FunctionUsageRange.TwentyFourHours // range (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/functions/list-variables.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.listVariables( 10 | '' // functionId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/functions/list.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.list( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/update-deployment-build.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.updateDeploymentBuild( 10 | '', // functionId 11 | '' // deploymentId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/update-deployment-status.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.updateDeploymentStatus( 10 | '', // functionId 11 | '' // deploymentId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/update-deployment.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.updateDeployment( 10 | '', // functionId 11 | '' // deploymentId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/functions/update-function-deployment.md: -------------------------------------------------------------------------------- 1 | import { Client, Functions } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const functions = new Functions(client); 8 | 9 | const result = await functions.updateFunctionDeployment( 10 | '', // functionId 11 | '' // deploymentId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/graphql/mutation.md: -------------------------------------------------------------------------------- 1 | import { Client, Graphql } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const graphql = new Graphql(client); 8 | 9 | const result = await graphql.mutation( 10 | {} // query 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/graphql/query.md: -------------------------------------------------------------------------------- 1 | import { Client, Graphql } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const graphql = new Graphql(client); 8 | 9 | const result = await graphql.query( 10 | {} // query 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-antivirus.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getAntivirus(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/health/get-cache.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getCache(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/health/get-certificate.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getCertificate( 10 | '' // domain (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-d-b.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getDB(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/health/get-failed-jobs.md: -------------------------------------------------------------------------------- 1 | import { Client, Health, } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getFailedJobs( 10 | .V1Database, // name 11 | null // threshold (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/health/get-pub-sub.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getPubSub(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-billing-aggregation.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueBillingAggregation( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-builds.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueBuilds( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-certificates.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueCertificates( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-databases.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueDatabases( 10 | '', // name (optional) 11 | null // threshold (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-deletes.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueDeletes( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-functions.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueFunctions( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-logs.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueLogs( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-mails.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueMails( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-messaging.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueMessaging( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-migrations.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueMigrations( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-priority-builds.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueuePriorityBuilds( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-region-manager.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueRegionManager( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-stats-resources.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueStatsResources( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-stats-usage-dump.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueStatsUsageDump( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-usage.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueUsage( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-queue-webhooks.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getQueueWebhooks( 10 | null // threshold (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/health/get-storage-local.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getStorageLocal(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/health/get-storage.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getStorage(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/health/get-time.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.getTime(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/health/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Health } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const health = new Health(client); 8 | 9 | const result = await health.get(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/locale/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Locale } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const locale = new Locale(client); 8 | 9 | const result = await locale.get(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/locale/list-codes.md: -------------------------------------------------------------------------------- 1 | import { Client, Locale } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const locale = new Locale(client); 8 | 9 | const result = await locale.listCodes(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/locale/list-continents.md: -------------------------------------------------------------------------------- 1 | import { Client, Locale } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const locale = new Locale(client); 8 | 9 | const result = await locale.listContinents(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/locale/list-countries-e-u.md: -------------------------------------------------------------------------------- 1 | import { Client, Locale } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const locale = new Locale(client); 8 | 9 | const result = await locale.listCountriesEU(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/locale/list-countries-phones.md: -------------------------------------------------------------------------------- 1 | import { Client, Locale } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const locale = new Locale(client); 8 | 9 | const result = await locale.listCountriesPhones(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/locale/list-countries.md: -------------------------------------------------------------------------------- 1 | import { Client, Locale } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const locale = new Locale(client); 8 | 9 | const result = await locale.listCountries(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/locale/list-currencies.md: -------------------------------------------------------------------------------- 1 | import { Client, Locale } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const locale = new Locale(client); 8 | 9 | const result = await locale.listCurrencies(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/locale/list-languages.md: -------------------------------------------------------------------------------- 1 | import { Client, Locale } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const locale = new Locale(client); 8 | 9 | const result = await locale.listLanguages(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/messaging/create-subscriber.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.createSubscriber( 10 | '', // topicId 11 | '', // subscriberId 12 | '' // targetId 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/messaging/create-topic.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.createTopic( 10 | '', // topicId 11 | '', // name 12 | ["any"] // subscribe (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/messaging/delete-provider.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.deleteProvider( 10 | '' // providerId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/messaging/delete-subscriber.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.deleteSubscriber( 10 | '', // topicId 11 | '' // subscriberId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/messaging/delete-topic.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.deleteTopic( 10 | '' // topicId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/messaging/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.delete( 10 | '' // messageId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/messaging/get-message.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.getMessage( 10 | '' // messageId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/messaging/get-provider.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.getProvider( 10 | '' // providerId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/messaging/get-subscriber.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.getSubscriber( 10 | '', // topicId 11 | '' // subscriberId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/messaging/get-topic.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.getTopic( 10 | '' // topicId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/messaging/list-message-logs.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.listMessageLogs( 10 | '', // messageId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/messaging/list-messages.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.listMessages( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/messaging/list-provider-logs.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.listProviderLogs( 10 | '', // providerId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/messaging/list-providers.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.listProviders( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/messaging/list-subscriber-logs.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.listSubscriberLogs( 10 | '', // subscriberId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/messaging/list-subscribers.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.listSubscribers( 10 | '', // topicId 11 | [], // queries (optional) 12 | '' // search (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/messaging/list-targets.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.listTargets( 10 | '', // messageId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/messaging/list-topic-logs.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.listTopicLogs( 10 | '', // topicId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/messaging/list-topics.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.listTopics( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/messaging/update-topic.md: -------------------------------------------------------------------------------- 1 | import { Client, Messaging } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const messaging = new Messaging(client); 8 | 9 | const result = await messaging.updateTopic( 10 | '', // topicId 11 | '', // name (optional) 12 | ["any"] // subscribe (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/migrations/create-csv-migration.md: -------------------------------------------------------------------------------- 1 | import { Client, Migrations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const migrations = new Migrations(client); 8 | 9 | const result = await migrations.createCsvMigration( 10 | '', // bucketId 11 | '', // fileId 12 | '[ID1:ID2]' // resourceId 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/migrations/create-firebase-migration.md: -------------------------------------------------------------------------------- 1 | import { Client, Migrations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const migrations = new Migrations(client); 8 | 9 | const result = await migrations.createFirebaseMigration( 10 | [], // resources 11 | '' // serviceAccount 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/migrations/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Migrations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const migrations = new Migrations(client); 8 | 9 | const result = await migrations.delete( 10 | '' // migrationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/migrations/get-firebase-report.md: -------------------------------------------------------------------------------- 1 | import { Client, Migrations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const migrations = new Migrations(client); 8 | 9 | const result = await migrations.getFirebaseReport( 10 | [], // resources 11 | '' // serviceAccount 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/migrations/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Migrations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const migrations = new Migrations(client); 8 | 9 | const result = await migrations.get( 10 | '' // migrationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/migrations/list.md: -------------------------------------------------------------------------------- 1 | import { Client, Migrations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const migrations = new Migrations(client); 8 | 9 | const result = await migrations.list( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/migrations/retry.md: -------------------------------------------------------------------------------- 1 | import { Client, Migrations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const migrations = new Migrations(client); 8 | 9 | const result = await migrations.retry( 10 | '' // migrationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/organizations/add-credit.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.addCredit( 10 | '', // organizationId 11 | '' // couponId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/delete-backup-payment-method.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.deleteBackupPaymentMethod( 10 | '' // organizationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/organizations/delete-billing-address.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.deleteBillingAddress( 10 | '' // organizationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/organizations/delete-default-payment-method.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.deleteDefaultPaymentMethod( 10 | '' // organizationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/organizations/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.delete( 10 | '' // organizationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/organizations/get-aggregation.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.getAggregation( 10 | '', // organizationId 11 | '' // aggregationId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/get-credit.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.getCredit( 10 | '', // organizationId 11 | '' // creditId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/get-invoice-download.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.getInvoiceDownload( 10 | '', // organizationId 11 | '' // invoiceId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/get-invoice-view.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.getInvoiceView( 10 | '', // organizationId 11 | '' // invoiceId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/get-invoice.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.getInvoice( 10 | '', // organizationId 11 | '' // invoiceId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/get-plan.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.getPlan( 10 | '' // organizationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/organizations/get-scopes.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.getScopes( 10 | '' // organizationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/organizations/list-aggregations.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.listAggregations( 10 | '', // organizationId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/list-credits.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.listCredits( 10 | '', // organizationId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/list-invoices.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.listInvoices( 10 | '', // organizationId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/list.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.list( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/set-billing-email.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.setBillingEmail( 10 | '', // organizationId 11 | 'email@example.com' // billingEmail 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/set-billing-tax-id.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.setBillingTaxId( 10 | '', // organizationId 11 | '' // taxId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/organizations/validate-invoice.md: -------------------------------------------------------------------------------- 1 | import { Client, Organizations } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const organizations = new Organizations(client); 8 | 9 | const result = await organizations.validateInvoice( 10 | '', // organizationId 11 | '' // invoiceId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/project/create-variable.md: -------------------------------------------------------------------------------- 1 | import { Client, Project } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const project = new Project(client); 8 | 9 | const result = await project.createVariable( 10 | '', // key 11 | '', // value 12 | false // secret (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/project/delete-variable.md: -------------------------------------------------------------------------------- 1 | import { Client, Project } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const project = new Project(client); 8 | 9 | const result = await project.deleteVariable( 10 | '' // variableId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/project/get-usage.md: -------------------------------------------------------------------------------- 1 | import { Client, Project, ProjectUsageRange } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const project = new Project(client); 8 | 9 | const result = await project.getUsage( 10 | '', // startDate 11 | '', // endDate 12 | ProjectUsageRange.OneHour // period (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/project/get-variable.md: -------------------------------------------------------------------------------- 1 | import { Client, Project } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const project = new Project(client); 8 | 9 | const result = await project.getVariable( 10 | '' // variableId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/project/list-variables.md: -------------------------------------------------------------------------------- 1 | import { Client, Project } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const project = new Project(client); 8 | 9 | const result = await project.listVariables(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/projects/create-dev-key.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.createDevKey( 10 | '', // projectId 11 | '', // name 12 | '' // expire 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/projects/create-j-w-t.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.createJWT( 10 | '', // projectId 11 | [], // scopes 12 | 0 // duration (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/projects/create-key.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.createKey( 10 | '', // projectId 11 | '', // name 12 | [], // scopes 13 | '' // expire (optional) 14 | ); 15 | 16 | console.log(result); 17 | -------------------------------------------------------------------------------- /docs/examples/projects/delete-dev-key.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.deleteDevKey( 10 | '', // projectId 11 | '' // keyId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/delete-key.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.deleteKey( 10 | '', // projectId 11 | '' // keyId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/delete-platform.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.deletePlatform( 10 | '', // projectId 11 | '' // platformId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/delete-webhook.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.deleteWebhook( 10 | '', // projectId 11 | '' // webhookId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.delete( 10 | '' // projectId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/projects/get-dev-key.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.getDevKey( 10 | '', // projectId 11 | '' // keyId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/get-key.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.getKey( 10 | '', // projectId 11 | '' // keyId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/get-platform.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.getPlatform( 10 | '', // projectId 11 | '' // platformId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/get-webhook.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.getWebhook( 10 | '', // projectId 11 | '' // webhookId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.get( 10 | '' // projectId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/projects/list-dev-keys.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.listDevKeys( 10 | '', // projectId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/list-keys.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.listKeys( 10 | '' // projectId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/projects/list-platforms.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.listPlatforms( 10 | '' // projectId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/projects/list-webhooks.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.listWebhooks( 10 | '' // projectId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/projects/list.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.list( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-api-status-all.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateApiStatusAll( 10 | '', // projectId 11 | false // status 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-api-status.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects, } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateApiStatus( 10 | '', // projectId 11 | .Rest, // api 12 | false // status 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/projects/update-auth-duration.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateAuthDuration( 10 | '', // projectId 11 | 0 // duration 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-auth-limit.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateAuthLimit( 10 | '', // projectId 11 | 0 // limit 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-auth-password-dictionary.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateAuthPasswordDictionary( 10 | '', // projectId 11 | false // enabled 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-auth-password-history.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateAuthPasswordHistory( 10 | '', // projectId 11 | 0 // limit 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-auth-sessions-limit.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateAuthSessionsLimit( 10 | '', // projectId 11 | 1 // limit 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-dev-key.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateDevKey( 10 | '', // projectId 11 | '', // keyId 12 | '', // name 13 | '' // expire 14 | ); 15 | 16 | console.log(result); 17 | -------------------------------------------------------------------------------- /docs/examples/projects/update-mock-numbers.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateMockNumbers( 10 | '', // projectId 11 | [] // numbers 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-personal-data-check.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updatePersonalDataCheck( 10 | '', // projectId 11 | false // enabled 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-service-status-all.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateServiceStatusAll( 10 | '', // projectId 11 | false // status 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-session-alerts.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateSessionAlerts( 10 | '', // projectId 11 | false // alerts 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-team.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateTeam( 10 | '', // projectId 11 | '' // teamId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/projects/update-webhook-signature.md: -------------------------------------------------------------------------------- 1 | import { Client, Projects } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const projects = new Projects(client); 8 | 9 | const result = await projects.updateWebhookSignature( 10 | '', // projectId 11 | '' // webhookId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/proxy/create-a-p-i-rule.md: -------------------------------------------------------------------------------- 1 | import { Client, Proxy } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const proxy = new Proxy(client); 8 | 9 | const result = await proxy.createAPIRule( 10 | '' // domain 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/proxy/create-function-rule.md: -------------------------------------------------------------------------------- 1 | import { Client, Proxy } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const proxy = new Proxy(client); 8 | 9 | const result = await proxy.createFunctionRule( 10 | '', // domain 11 | '', // functionId 12 | '' // branch (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/proxy/create-redirect-rule.md: -------------------------------------------------------------------------------- 1 | import { Client, Proxy, } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const proxy = new Proxy(client); 8 | 9 | const result = await proxy.createRedirectRule( 10 | '', // domain 11 | 'https://example.com', // url 12 | .MovedPermanently301 // statusCode 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/proxy/create-rule.md: -------------------------------------------------------------------------------- 1 | import { Client, Proxy, } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const proxy = new Proxy(client); 8 | 9 | const result = await proxy.createRule( 10 | '', // domain 11 | .Api, // resourceType 12 | '' // resourceId (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/proxy/create-site-rule.md: -------------------------------------------------------------------------------- 1 | import { Client, Proxy } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const proxy = new Proxy(client); 8 | 9 | const result = await proxy.createSiteRule( 10 | '', // domain 11 | '', // siteId 12 | '' // branch (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/proxy/delete-rule.md: -------------------------------------------------------------------------------- 1 | import { Client, Proxy } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const proxy = new Proxy(client); 8 | 9 | const result = await proxy.deleteRule( 10 | '' // ruleId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/proxy/get-rule.md: -------------------------------------------------------------------------------- 1 | import { Client, Proxy } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const proxy = new Proxy(client); 8 | 9 | const result = await proxy.getRule( 10 | '' // ruleId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/proxy/list-rules.md: -------------------------------------------------------------------------------- 1 | import { Client, Proxy } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const proxy = new Proxy(client); 8 | 9 | const result = await proxy.listRules( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/proxy/update-rule-verification.md: -------------------------------------------------------------------------------- 1 | import { Client, Proxy } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const proxy = new Proxy(client); 8 | 9 | const result = await proxy.updateRuleVerification( 10 | '' // ruleId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/sites/create-duplicate-deployment.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.createDuplicateDeployment( 10 | '', // siteId 11 | '' // deploymentId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/sites/create-variable.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.createVariable( 10 | '', // siteId 11 | '', // key 12 | '', // value 13 | false // secret (optional) 14 | ); 15 | 16 | console.log(result); 17 | -------------------------------------------------------------------------------- /docs/examples/sites/delete-deployment.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.deleteDeployment( 10 | '', // siteId 11 | '' // deploymentId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/sites/delete-log.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.deleteLog( 10 | '', // siteId 11 | '' // logId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/sites/delete-variable.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.deleteVariable( 10 | '', // siteId 11 | '' // variableId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/sites/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.delete( 10 | '' // siteId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/sites/get-deployment.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.getDeployment( 10 | '', // siteId 11 | '' // deploymentId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/sites/get-log.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.getLog( 10 | '', // siteId 11 | '' // logId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/sites/get-template.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.getTemplate( 10 | '' // templateId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/sites/get-usage.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites, SiteUsageRange } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.getUsage( 10 | '', // siteId 11 | SiteUsageRange.TwentyFourHours // range (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/sites/get-variable.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.getVariable( 10 | '', // siteId 11 | '' // variableId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/sites/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.get( 10 | '' // siteId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/sites/list-deployments.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.listDeployments( 10 | '', // siteId 11 | [], // queries (optional) 12 | '' // search (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/sites/list-frameworks.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.listFrameworks(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/sites/list-logs.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.listLogs( 10 | '', // siteId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/sites/list-specifications.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.listSpecifications(); 10 | 11 | console.log(result); 12 | -------------------------------------------------------------------------------- /docs/examples/sites/list-templates.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.listTemplates( 10 | [], // frameworks (optional) 11 | [], // useCases (optional) 12 | 1, // limit (optional) 13 | 0 // offset (optional) 14 | ); 15 | 16 | console.log(result); 17 | -------------------------------------------------------------------------------- /docs/examples/sites/list-usage.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites, SiteUsageRange } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.listUsage( 10 | SiteUsageRange.TwentyFourHours // range (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/sites/list-variables.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.listVariables( 10 | '' // siteId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/sites/list.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.list( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/sites/update-deployment-status.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.updateDeploymentStatus( 10 | '', // siteId 11 | '' // deploymentId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/sites/update-site-deployment.md: -------------------------------------------------------------------------------- 1 | import { Client, Sites } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const sites = new Sites(client); 8 | 9 | const result = await sites.updateSiteDeployment( 10 | '', // siteId 11 | '' // deploymentId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/storage/delete-bucket.md: -------------------------------------------------------------------------------- 1 | import { Client, Storage } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const storage = new Storage(client); 8 | 9 | const result = await storage.deleteBucket( 10 | '' // bucketId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/storage/delete-file.md: -------------------------------------------------------------------------------- 1 | import { Client, Storage } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const storage = new Storage(client); 8 | 9 | const result = await storage.deleteFile( 10 | '', // bucketId 11 | '' // fileId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/storage/get-bucket-usage.md: -------------------------------------------------------------------------------- 1 | import { Client, Storage, StorageUsageRange } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const storage = new Storage(client); 8 | 9 | const result = await storage.getBucketUsage( 10 | '', // bucketId 11 | StorageUsageRange.TwentyFourHours // range (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/storage/get-bucket.md: -------------------------------------------------------------------------------- 1 | import { Client, Storage } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const storage = new Storage(client); 8 | 9 | const result = await storage.getBucket( 10 | '' // bucketId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/storage/get-file-download.md: -------------------------------------------------------------------------------- 1 | import { Client, Storage } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const storage = new Storage(client); 8 | 9 | const result = storage.getFileDownload( 10 | '', // bucketId 11 | '', // fileId 12 | '' // token (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/storage/get-file-view.md: -------------------------------------------------------------------------------- 1 | import { Client, Storage } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const storage = new Storage(client); 8 | 9 | const result = storage.getFileView( 10 | '', // bucketId 11 | '', // fileId 12 | '' // token (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/storage/get-file.md: -------------------------------------------------------------------------------- 1 | import { Client, Storage } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const storage = new Storage(client); 8 | 9 | const result = await storage.getFile( 10 | '', // bucketId 11 | '' // fileId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/storage/get-usage.md: -------------------------------------------------------------------------------- 1 | import { Client, Storage, StorageUsageRange } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const storage = new Storage(client); 8 | 9 | const result = await storage.getUsage( 10 | StorageUsageRange.TwentyFourHours // range (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/storage/list-buckets.md: -------------------------------------------------------------------------------- 1 | import { Client, Storage } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const storage = new Storage(client); 8 | 9 | const result = await storage.listBuckets( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/storage/list-files.md: -------------------------------------------------------------------------------- 1 | import { Client, Storage } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const storage = new Storage(client); 8 | 9 | const result = await storage.listFiles( 10 | '', // bucketId 11 | [], // queries (optional) 12 | '' // search (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/teams/create.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.create( 10 | '', // teamId 11 | '', // name 12 | [] // roles (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/teams/delete-membership.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.deleteMembership( 10 | '', // teamId 11 | '' // membershipId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/teams/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.delete( 10 | '' // teamId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/teams/get-membership.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.getMembership( 10 | '', // teamId 11 | '' // membershipId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/teams/get-prefs.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.getPrefs( 10 | '' // teamId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/teams/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.get( 10 | '' // teamId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/teams/list-logs.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.listLogs( 10 | '', // teamId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/teams/list-memberships.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.listMemberships( 10 | '', // teamId 11 | [], // queries (optional) 12 | '' // search (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/teams/list.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.list( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/teams/update-membership.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.updateMembership( 10 | '', // teamId 11 | '', // membershipId 12 | [] // roles 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/teams/update-name.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.updateName( 10 | '', // teamId 11 | '' // name 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/teams/update-prefs.md: -------------------------------------------------------------------------------- 1 | import { Client, Teams } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const teams = new Teams(client); 8 | 9 | const result = await teams.updatePrefs( 10 | '', // teamId 11 | {} // prefs 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/tokens/create-file-token.md: -------------------------------------------------------------------------------- 1 | import { Client, Tokens } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const tokens = new Tokens(client); 8 | 9 | const result = await tokens.createFileToken( 10 | '', // bucketId 11 | '', // fileId 12 | '' // expire (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/tokens/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Tokens } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const tokens = new Tokens(client); 8 | 9 | const result = await tokens.delete( 10 | '' // tokenId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/tokens/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Tokens } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const tokens = new Tokens(client); 8 | 9 | const result = await tokens.get( 10 | '' // tokenId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/tokens/list.md: -------------------------------------------------------------------------------- 1 | import { Client, Tokens } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const tokens = new Tokens(client); 8 | 9 | const result = await tokens.list( 10 | '', // bucketId 11 | '', // fileId 12 | [] // queries (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/tokens/update.md: -------------------------------------------------------------------------------- 1 | import { Client, Tokens } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const tokens = new Tokens(client); 8 | 9 | const result = await tokens.update( 10 | '', // tokenId 11 | '' // expire (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/create-j-w-t.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.createJWT( 10 | '', // userId 11 | '', // sessionId (optional) 12 | 0 // duration (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/users/create-mfa-recovery-codes.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.createMfaRecoveryCodes( 10 | '' // userId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/create-session.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.createSession( 10 | '' // userId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/create-token.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.createToken( 10 | '', // userId 11 | 4, // length (optional) 12 | 60 // expire (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/users/delete-identity.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.deleteIdentity( 10 | '' // identityId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/delete-mfa-authenticator.md: -------------------------------------------------------------------------------- 1 | import { Client, Users, AuthenticatorType } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.deleteMfaAuthenticator( 10 | '', // userId 11 | AuthenticatorType.Totp // type 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/delete-session.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.deleteSession( 10 | '', // userId 11 | '' // sessionId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/delete-sessions.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.deleteSessions( 10 | '' // userId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/delete-target.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.deleteTarget( 10 | '', // userId 11 | '' // targetId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/delete.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.delete( 10 | '' // userId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/get-mfa-recovery-codes.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.getMfaRecoveryCodes( 10 | '' // userId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/get-prefs.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.getPrefs( 10 | '' // userId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/get-target.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.getTarget( 10 | '', // userId 11 | '' // targetId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/get-usage.md: -------------------------------------------------------------------------------- 1 | import { Client, Users, UserUsageRange } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.getUsage( 10 | UserUsageRange.TwentyFourHours // range (optional) 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/get.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.get( 10 | '' // userId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/list-identities.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.listIdentities( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/list-logs.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.listLogs( 10 | '', // userId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/list-memberships.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.listMemberships( 10 | '', // userId 11 | [], // queries (optional) 12 | '' // search (optional) 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/users/list-mfa-factors.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.listMfaFactors( 10 | '' // userId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/list-sessions.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.listSessions( 10 | '' // userId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/list-targets.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.listTargets( 10 | '', // userId 11 | [] // queries (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/list.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.list( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/update-email-verification.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.updateEmailVerification( 10 | '', // userId 11 | false // emailVerification 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/update-email.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.updateEmail( 10 | '', // userId 11 | 'email@example.com' // email 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/update-labels.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.updateLabels( 10 | '', // userId 11 | [] // labels 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/update-mfa-recovery-codes.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.updateMfaRecoveryCodes( 10 | '' // userId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/users/update-mfa.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.updateMfa( 10 | '', // userId 11 | false // mfa 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/update-name.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.updateName( 10 | '', // userId 11 | '' // name 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/update-password.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.updatePassword( 10 | '', // userId 11 | '' // password 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/update-phone-verification.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.updatePhoneVerification( 10 | '', // userId 11 | false // phoneVerification 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/update-phone.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.updatePhone( 10 | '', // userId 11 | '+12065550100' // number 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/update-prefs.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.updatePrefs( 10 | '', // userId 11 | {} // prefs 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/users/update-status.md: -------------------------------------------------------------------------------- 1 | import { Client, Users } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const users = new Users(client); 8 | 9 | const result = await users.updateStatus( 10 | '', // userId 11 | false // status 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/vcs/create-repository.md: -------------------------------------------------------------------------------- 1 | import { Client, Vcs } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const vcs = new Vcs(client); 8 | 9 | const result = await vcs.createRepository( 10 | '', // installationId 11 | '', // name 12 | false // private 13 | ); 14 | 15 | console.log(result); 16 | -------------------------------------------------------------------------------- /docs/examples/vcs/delete-installation.md: -------------------------------------------------------------------------------- 1 | import { Client, Vcs } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const vcs = new Vcs(client); 8 | 9 | const result = await vcs.deleteInstallation( 10 | '' // installationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/vcs/get-installation.md: -------------------------------------------------------------------------------- 1 | import { Client, Vcs } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const vcs = new Vcs(client); 8 | 9 | const result = await vcs.getInstallation( 10 | '' // installationId 11 | ); 12 | 13 | console.log(result); 14 | -------------------------------------------------------------------------------- /docs/examples/vcs/get-repository.md: -------------------------------------------------------------------------------- 1 | import { Client, Vcs } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const vcs = new Vcs(client); 8 | 9 | const result = await vcs.getRepository( 10 | '', // installationId 11 | '' // providerRepositoryId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/vcs/list-installations.md: -------------------------------------------------------------------------------- 1 | import { Client, Vcs } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const vcs = new Vcs(client); 8 | 9 | const result = await vcs.listInstallations( 10 | [], // queries (optional) 11 | '' // search (optional) 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /docs/examples/vcs/list-repository-branches.md: -------------------------------------------------------------------------------- 1 | import { Client, Vcs } from "@appwrite.io/console"; 2 | 3 | const client = new Client() 4 | .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint 5 | .setProject(''); // Your project ID 6 | 7 | const vcs = new Vcs(client); 8 | 9 | const result = await vcs.listRepositoryBranches( 10 | '', // installationId 11 | '' // providerRepositoryId 12 | ); 13 | 14 | console.log(result); 15 | -------------------------------------------------------------------------------- /src/enums/adapter.ts: -------------------------------------------------------------------------------- 1 | export enum Adapter { 2 | Static = 'static', 3 | Ssr = 'ssr', 4 | } -------------------------------------------------------------------------------- /src/enums/api-service.ts: -------------------------------------------------------------------------------- 1 | export enum ApiService { 2 | Account = 'account', 3 | Avatars = 'avatars', 4 | Databases = 'databases', 5 | Locale = 'locale', 6 | Health = 'health', 7 | Storage = 'storage', 8 | Teams = 'teams', 9 | Users = 'users', 10 | Sites = 'sites', 11 | Functions = 'functions', 12 | Graphql = 'graphql', 13 | Messaging = 'messaging', 14 | } -------------------------------------------------------------------------------- /src/enums/api.ts: -------------------------------------------------------------------------------- 1 | export enum Api { 2 | Rest = 'rest', 3 | Graphql = 'graphql', 4 | Realtime = 'realtime', 5 | } -------------------------------------------------------------------------------- /src/enums/auth-method.ts: -------------------------------------------------------------------------------- 1 | export enum AuthMethod { 2 | Emailpassword = 'email-password', 3 | Magicurl = 'magic-url', 4 | Emailotp = 'email-otp', 5 | Anonymous = 'anonymous', 6 | Invites = 'invites', 7 | Jwt = 'jwt', 8 | Phone = 'phone', 9 | } -------------------------------------------------------------------------------- /src/enums/authentication-factor.ts: -------------------------------------------------------------------------------- 1 | export enum AuthenticationFactor { 2 | Email = 'email', 3 | Phone = 'phone', 4 | Totp = 'totp', 5 | Recoverycode = 'recoverycode', 6 | } -------------------------------------------------------------------------------- /src/enums/authenticator-type.ts: -------------------------------------------------------------------------------- 1 | export enum AuthenticatorType { 2 | Totp = 'totp', 3 | } -------------------------------------------------------------------------------- /src/enums/billing-plan.ts: -------------------------------------------------------------------------------- 1 | export enum BillingPlan { 2 | Tier0 = 'tier-0', 3 | Tier1 = 'tier-1', 4 | Tier2 = 'tier-2', 5 | } -------------------------------------------------------------------------------- /src/enums/browser.ts: -------------------------------------------------------------------------------- 1 | export enum Browser { 2 | AvantBrowser = 'aa', 3 | AndroidWebViewBeta = 'an', 4 | GoogleChrome = 'ch', 5 | GoogleChromeIOS = 'ci', 6 | GoogleChromeMobile = 'cm', 7 | Chromium = 'cr', 8 | MozillaFirefox = 'ff', 9 | Safari = 'sf', 10 | MobileSafari = 'mf', 11 | MicrosoftEdge = 'ps', 12 | MicrosoftEdgeIOS = 'oi', 13 | OperaMini = 'om', 14 | Opera = 'op', 15 | OperaNext = 'on', 16 | } -------------------------------------------------------------------------------- /src/enums/compression.ts: -------------------------------------------------------------------------------- 1 | export enum Compression { 2 | None = 'none', 3 | Gzip = 'gzip', 4 | Zstd = 'zstd', 5 | } -------------------------------------------------------------------------------- /src/enums/console-resource-type.ts: -------------------------------------------------------------------------------- 1 | export enum ConsoleResourceType { 2 | Rules = 'rules', 3 | } -------------------------------------------------------------------------------- /src/enums/database-usage-range.ts: -------------------------------------------------------------------------------- 1 | export enum DatabaseUsageRange { 2 | TwentyFourHours = '24h', 3 | ThirtyDays = '30d', 4 | NinetyDays = '90d', 5 | } -------------------------------------------------------------------------------- /src/enums/deployment-download-type.ts: -------------------------------------------------------------------------------- 1 | export enum DeploymentDownloadType { 2 | Source = 'source', 3 | Output = 'output', 4 | } -------------------------------------------------------------------------------- /src/enums/email-template-type.ts: -------------------------------------------------------------------------------- 1 | export enum EmailTemplateType { 2 | Verification = 'verification', 3 | Magicsession = 'magicsession', 4 | Recovery = 'recovery', 5 | Invitation = 'invitation', 6 | Mfachallenge = 'mfachallenge', 7 | Sessionalert = 'sessionalert', 8 | Otpsession = 'otpsession', 9 | } -------------------------------------------------------------------------------- /src/enums/execution-method.ts: -------------------------------------------------------------------------------- 1 | export enum ExecutionMethod { 2 | GET = 'GET', 3 | POST = 'POST', 4 | PUT = 'PUT', 5 | PATCH = 'PATCH', 6 | DELETE = 'DELETE', 7 | OPTIONS = 'OPTIONS', 8 | } -------------------------------------------------------------------------------- /src/enums/framework.ts: -------------------------------------------------------------------------------- 1 | export enum Framework { 2 | Analog = 'analog', 3 | Angular = 'angular', 4 | Nextjs = 'nextjs', 5 | React = 'react', 6 | Nuxt = 'nuxt', 7 | Vue = 'vue', 8 | Sveltekit = 'sveltekit', 9 | Astro = 'astro', 10 | Remix = 'remix', 11 | Lynx = 'lynx', 12 | Flutter = 'flutter', 13 | Reactnative = 'react-native', 14 | Vite = 'vite', 15 | Other = 'other', 16 | } -------------------------------------------------------------------------------- /src/enums/function-usage-range.ts: -------------------------------------------------------------------------------- 1 | export enum FunctionUsageRange { 2 | TwentyFourHours = '24h', 3 | ThirtyDays = '30d', 4 | NinetyDays = '90d', 5 | } -------------------------------------------------------------------------------- /src/enums/image-format.ts: -------------------------------------------------------------------------------- 1 | export enum ImageFormat { 2 | Jpg = 'jpg', 3 | Jpeg = 'jpeg', 4 | Png = 'png', 5 | Webp = 'webp', 6 | Heic = 'heic', 7 | Avif = 'avif', 8 | } -------------------------------------------------------------------------------- /src/enums/image-gravity.ts: -------------------------------------------------------------------------------- 1 | export enum ImageGravity { 2 | Center = 'center', 3 | Topleft = 'top-left', 4 | Top = 'top', 5 | Topright = 'top-right', 6 | Left = 'left', 7 | Right = 'right', 8 | Bottomleft = 'bottom-left', 9 | Bottom = 'bottom', 10 | Bottomright = 'bottom-right', 11 | } -------------------------------------------------------------------------------- /src/enums/index-type.ts: -------------------------------------------------------------------------------- 1 | export enum IndexType { 2 | Key = 'key', 3 | Fulltext = 'fulltext', 4 | Unique = 'unique', 5 | } -------------------------------------------------------------------------------- /src/enums/message-priority.ts: -------------------------------------------------------------------------------- 1 | export enum MessagePriority { 2 | Normal = 'normal', 3 | High = 'high', 4 | } -------------------------------------------------------------------------------- /src/enums/messaging-provider-type.ts: -------------------------------------------------------------------------------- 1 | export enum MessagingProviderType { 2 | Email = 'email', 3 | Sms = 'sms', 4 | Push = 'push', 5 | } -------------------------------------------------------------------------------- /src/enums/name.ts: -------------------------------------------------------------------------------- 1 | export enum Name { 2 | V1database = 'v1-database', 3 | V1deletes = 'v1-deletes', 4 | V1audits = 'v1-audits', 5 | V1mails = 'v1-mails', 6 | V1functions = 'v1-functions', 7 | V1statsresources = 'v1-stats-resources', 8 | V1statsusage = 'v1-stats-usage', 9 | V1webhooks = 'v1-webhooks', 10 | V1certificates = 'v1-certificates', 11 | V1builds = 'v1-builds', 12 | V1messaging = 'v1-messaging', 13 | V1migrations = 'v1-migrations', 14 | } -------------------------------------------------------------------------------- /src/enums/password-hash.ts: -------------------------------------------------------------------------------- 1 | export enum PasswordHash { 2 | Sha1 = 'sha1', 3 | Sha224 = 'sha224', 4 | Sha256 = 'sha256', 5 | Sha384 = 'sha384', 6 | Sha512224 = 'sha512/224', 7 | Sha512256 = 'sha512/256', 8 | Sha512 = 'sha512', 9 | Sha3224 = 'sha3-224', 10 | Sha3256 = 'sha3-256', 11 | Sha3384 = 'sha3-384', 12 | Sha3512 = 'sha3-512', 13 | } -------------------------------------------------------------------------------- /src/enums/project-usage-range.ts: -------------------------------------------------------------------------------- 1 | export enum ProjectUsageRange { 2 | OneHour = '1h', 3 | OneDay = '1d', 4 | } -------------------------------------------------------------------------------- /src/enums/region.ts: -------------------------------------------------------------------------------- 1 | export enum Region { 2 | Fra = 'fra', 3 | Nyc = 'nyc', 4 | Syd = 'syd', 5 | } -------------------------------------------------------------------------------- /src/enums/relation-mutate.ts: -------------------------------------------------------------------------------- 1 | export enum RelationMutate { 2 | Cascade = 'cascade', 3 | Restrict = 'restrict', 4 | SetNull = 'setNull', 5 | } -------------------------------------------------------------------------------- /src/enums/relationship-type.ts: -------------------------------------------------------------------------------- 1 | export enum RelationshipType { 2 | OneToOne = 'oneToOne', 3 | ManyToOne = 'manyToOne', 4 | ManyToMany = 'manyToMany', 5 | OneToMany = 'oneToMany', 6 | } -------------------------------------------------------------------------------- /src/enums/resource-type.ts: -------------------------------------------------------------------------------- 1 | export enum ResourceType { 2 | Api = 'api', 3 | Function = 'function', 4 | } -------------------------------------------------------------------------------- /src/enums/s-m-t-p-secure.ts: -------------------------------------------------------------------------------- 1 | export enum SMTPSecure { 2 | Tls = 'tls', 3 | Ssl = 'ssl', 4 | } -------------------------------------------------------------------------------- /src/enums/site-usage-range.ts: -------------------------------------------------------------------------------- 1 | export enum SiteUsageRange { 2 | TwentyFourHours = '24h', 3 | ThirtyDays = '30d', 4 | NinetyDays = '90d', 5 | } -------------------------------------------------------------------------------- /src/enums/sms-template-type.ts: -------------------------------------------------------------------------------- 1 | export enum SmsTemplateType { 2 | Verification = 'verification', 3 | Login = 'login', 4 | Invitation = 'invitation', 5 | Mfachallenge = 'mfachallenge', 6 | } -------------------------------------------------------------------------------- /src/enums/smtp-encryption.ts: -------------------------------------------------------------------------------- 1 | export enum SmtpEncryption { 2 | None = 'none', 3 | Ssl = 'ssl', 4 | Tls = 'tls', 5 | } -------------------------------------------------------------------------------- /src/enums/status-code.ts: -------------------------------------------------------------------------------- 1 | export enum StatusCode { 2 | MovedPermanently301 = '301', 3 | Found302 = '302', 4 | TemporaryRedirect307 = '307', 5 | PermanentRedirect308 = '308', 6 | } -------------------------------------------------------------------------------- /src/enums/storage-usage-range.ts: -------------------------------------------------------------------------------- 1 | export enum StorageUsageRange { 2 | TwentyFourHours = '24h', 3 | ThirtyDays = '30d', 4 | NinetyDays = '90d', 5 | } -------------------------------------------------------------------------------- /src/enums/user-usage-range.ts: -------------------------------------------------------------------------------- 1 | export enum UserUsageRange { 2 | TwentyFourHours = '24h', 3 | ThirtyDays = '30d', 4 | NinetyDays = '90d', 5 | } -------------------------------------------------------------------------------- /src/enums/v-c-s-deployment-type.ts: -------------------------------------------------------------------------------- 1 | export enum VCSDeploymentType { 2 | Branch = 'branch', 3 | Commit = 'commit', 4 | Tag = 'tag', 5 | } -------------------------------------------------------------------------------- /src/enums/v-c-s-detection-type.ts: -------------------------------------------------------------------------------- 1 | export enum VCSDetectionType { 2 | Runtime = 'runtime', 3 | Framework = 'framework', 4 | } --------------------------------------------------------------------------------