@appconda/nextjs 1.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/autoclose.yml +11 -0
- package/.github/workflows/publish.yml +42 -0
- package/.travis.yml +32 -0
- package/CHANGELOG.md +1 -0
- package/LICENSE +12 -0
- package/README.md +0 -0
- package/dist/cjs/sdk.js +10608 -0
- package/dist/cjs/sdk.js.map +1 -0
- package/dist/esm/sdk.js +10589 -0
- package/dist/esm/sdk.js.map +1 -0
- package/dist/iife/sdk.js +10609 -0
- package/docs/examples/account/create-anonymous-session.md +11 -0
- package/docs/examples/account/create-email-password-session.md +14 -0
- package/docs/examples/account/create-email-token.md +15 -0
- package/docs/examples/account/create-j-w-t.md +11 -0
- package/docs/examples/account/create-magic-u-r-l-token.md +16 -0
- package/docs/examples/account/create-mfa-authenticator.md +13 -0
- package/docs/examples/account/create-mfa-challenge.md +13 -0
- package/docs/examples/account/create-mfa-recovery-codes.md +11 -0
- package/docs/examples/account/create-o-auth2session.md +15 -0
- package/docs/examples/account/create-o-auth2token.md +15 -0
- package/docs/examples/account/create-phone-token.md +14 -0
- package/docs/examples/account/create-phone-verification.md +11 -0
- package/docs/examples/account/create-push-target.md +15 -0
- package/docs/examples/account/create-recovery.md +14 -0
- package/docs/examples/account/create-session.md +14 -0
- package/docs/examples/account/create-verification.md +13 -0
- package/docs/examples/account/create.md +16 -0
- package/docs/examples/account/delete-identity.md +13 -0
- package/docs/examples/account/delete-mfa-authenticator.md +13 -0
- package/docs/examples/account/delete-push-target.md +13 -0
- package/docs/examples/account/delete-session.md +13 -0
- package/docs/examples/account/delete-sessions.md +11 -0
- package/docs/examples/account/delete.md +11 -0
- package/docs/examples/account/get-mfa-recovery-codes.md +11 -0
- package/docs/examples/account/get-prefs.md +11 -0
- package/docs/examples/account/get-session.md +13 -0
- package/docs/examples/account/get.md +11 -0
- package/docs/examples/account/list-identities.md +13 -0
- package/docs/examples/account/list-logs.md +13 -0
- package/docs/examples/account/list-mfa-factors.md +11 -0
- package/docs/examples/account/list-sessions.md +11 -0
- package/docs/examples/account/update-email.md +14 -0
- package/docs/examples/account/update-m-f-a.md +13 -0
- package/docs/examples/account/update-magic-u-r-l-session.md +14 -0
- package/docs/examples/account/update-mfa-authenticator.md +14 -0
- package/docs/examples/account/update-mfa-challenge.md +14 -0
- package/docs/examples/account/update-mfa-recovery-codes.md +11 -0
- package/docs/examples/account/update-name.md +13 -0
- package/docs/examples/account/update-password.md +14 -0
- package/docs/examples/account/update-phone-session.md +14 -0
- package/docs/examples/account/update-phone-verification.md +14 -0
- package/docs/examples/account/update-phone.md +14 -0
- package/docs/examples/account/update-prefs.md +13 -0
- package/docs/examples/account/update-push-target.md +14 -0
- package/docs/examples/account/update-recovery.md +15 -0
- package/docs/examples/account/update-session.md +13 -0
- package/docs/examples/account/update-status.md +11 -0
- package/docs/examples/account/update-verification.md +14 -0
- package/docs/examples/assistant/chat.md +13 -0
- package/docs/examples/avatars/get-browser.md +16 -0
- package/docs/examples/avatars/get-credit-card.md +16 -0
- package/docs/examples/avatars/get-favicon.md +13 -0
- package/docs/examples/avatars/get-flag.md +16 -0
- package/docs/examples/avatars/get-image.md +15 -0
- package/docs/examples/avatars/get-initials.md +16 -0
- package/docs/examples/avatars/get-q-r.md +16 -0
- package/docs/examples/console/variables.md +11 -0
- package/docs/examples/databases/create-boolean-attribute.md +18 -0
- package/docs/examples/databases/create-collection.md +18 -0
- package/docs/examples/databases/create-datetime-attribute.md +18 -0
- package/docs/examples/databases/create-document.md +17 -0
- package/docs/examples/databases/create-email-attribute.md +18 -0
- package/docs/examples/databases/create-enum-attribute.md +19 -0
- package/docs/examples/databases/create-float-attribute.md +20 -0
- package/docs/examples/databases/create-index.md +18 -0
- package/docs/examples/databases/create-integer-attribute.md +20 -0
- package/docs/examples/databases/create-ip-attribute.md +18 -0
- package/docs/examples/databases/create-relationship-attribute.md +20 -0
- package/docs/examples/databases/create-string-attribute.md +20 -0
- package/docs/examples/databases/create-url-attribute.md +18 -0
- package/docs/examples/databases/create.md +15 -0
- package/docs/examples/databases/delete-attribute.md +15 -0
- package/docs/examples/databases/delete-collection.md +14 -0
- package/docs/examples/databases/delete-document.md +15 -0
- package/docs/examples/databases/delete-index.md +15 -0
- package/docs/examples/databases/delete.md +13 -0
- package/docs/examples/databases/get-attribute.md +15 -0
- package/docs/examples/databases/get-collection-usage.md +15 -0
- package/docs/examples/databases/get-collection.md +14 -0
- package/docs/examples/databases/get-database-usage.md +14 -0
- package/docs/examples/databases/get-document.md +16 -0
- package/docs/examples/databases/get-index.md +15 -0
- package/docs/examples/databases/get-usage.md +13 -0
- package/docs/examples/databases/get.md +13 -0
- package/docs/examples/databases/list-attributes.md +15 -0
- package/docs/examples/databases/list-collection-logs.md +15 -0
- package/docs/examples/databases/list-collections.md +15 -0
- package/docs/examples/databases/list-document-logs.md +16 -0
- package/docs/examples/databases/list-documents.md +15 -0
- package/docs/examples/databases/list-indexes.md +15 -0
- package/docs/examples/databases/list-logs.md +14 -0
- package/docs/examples/databases/list.md +14 -0
- package/docs/examples/databases/update-boolean-attribute.md +17 -0
- package/docs/examples/databases/update-collection.md +18 -0
- package/docs/examples/databases/update-datetime-attribute.md +17 -0
- package/docs/examples/databases/update-document.md +17 -0
- package/docs/examples/databases/update-email-attribute.md +17 -0
- package/docs/examples/databases/update-enum-attribute.md +18 -0
- package/docs/examples/databases/update-float-attribute.md +19 -0
- package/docs/examples/databases/update-integer-attribute.md +19 -0
- package/docs/examples/databases/update-ip-attribute.md +17 -0
- package/docs/examples/databases/update-relationship-attribute.md +16 -0
- package/docs/examples/databases/update-string-attribute.md +17 -0
- package/docs/examples/databases/update-url-attribute.md +17 -0
- package/docs/examples/databases/update.md +15 -0
- package/docs/examples/functions/create-build.md +15 -0
- package/docs/examples/functions/create-deployment.md +17 -0
- package/docs/examples/functions/create-execution.md +19 -0
- package/docs/examples/functions/create-variable.md +15 -0
- package/docs/examples/functions/create.md +34 -0
- package/docs/examples/functions/delete-deployment.md +14 -0
- package/docs/examples/functions/delete-execution.md +14 -0
- package/docs/examples/functions/delete-variable.md +14 -0
- package/docs/examples/functions/delete.md +13 -0
- package/docs/examples/functions/get-deployment-download.md +14 -0
- package/docs/examples/functions/get-deployment.md +14 -0
- package/docs/examples/functions/get-execution.md +14 -0
- package/docs/examples/functions/get-function-usage.md +14 -0
- package/docs/examples/functions/get-template.md +13 -0
- package/docs/examples/functions/get-usage.md +13 -0
- package/docs/examples/functions/get-variable.md +14 -0
- package/docs/examples/functions/get.md +13 -0
- package/docs/examples/functions/list-deployments.md +15 -0
- package/docs/examples/functions/list-executions.md +15 -0
- package/docs/examples/functions/list-runtimes.md +11 -0
- package/docs/examples/functions/list-specifications.md +11 -0
- package/docs/examples/functions/list-templates.md +16 -0
- package/docs/examples/functions/list-variables.md +13 -0
- package/docs/examples/functions/list.md +14 -0
- package/docs/examples/functions/update-deployment-build.md +14 -0
- package/docs/examples/functions/update-deployment.md +14 -0
- package/docs/examples/functions/update-variable.md +16 -0
- package/docs/examples/functions/update.md +30 -0
- package/docs/examples/graphql/mutation.md +13 -0
- package/docs/examples/graphql/query.md +13 -0
- package/docs/examples/health/get-antivirus.md +11 -0
- package/docs/examples/health/get-cache.md +11 -0
- package/docs/examples/health/get-certificate.md +13 -0
- package/docs/examples/health/get-d-b.md +11 -0
- package/docs/examples/health/get-failed-jobs.md +14 -0
- package/docs/examples/health/get-pub-sub.md +11 -0
- package/docs/examples/health/get-queue-builds.md +13 -0
- package/docs/examples/health/get-queue-certificates.md +13 -0
- package/docs/examples/health/get-queue-databases.md +14 -0
- package/docs/examples/health/get-queue-deletes.md +13 -0
- package/docs/examples/health/get-queue-functions.md +13 -0
- package/docs/examples/health/get-queue-logs.md +13 -0
- package/docs/examples/health/get-queue-mails.md +13 -0
- package/docs/examples/health/get-queue-messaging.md +13 -0
- package/docs/examples/health/get-queue-migrations.md +13 -0
- package/docs/examples/health/get-queue-usage-dump.md +13 -0
- package/docs/examples/health/get-queue-usage.md +13 -0
- package/docs/examples/health/get-queue-webhooks.md +13 -0
- package/docs/examples/health/get-queue.md +11 -0
- package/docs/examples/health/get-storage-local.md +11 -0
- package/docs/examples/health/get-storage.md +11 -0
- package/docs/examples/health/get-time.md +11 -0
- package/docs/examples/health/get.md +11 -0
- package/docs/examples/locale/get.md +11 -0
- package/docs/examples/locale/list-codes.md +11 -0
- package/docs/examples/locale/list-continents.md +11 -0
- package/docs/examples/locale/list-countries-e-u.md +11 -0
- package/docs/examples/locale/list-countries-phones.md +11 -0
- package/docs/examples/locale/list-countries.md +11 -0
- package/docs/examples/locale/list-currencies.md +11 -0
- package/docs/examples/locale/list-languages.md +11 -0
- package/docs/examples/messaging/create-apns-provider.md +20 -0
- package/docs/examples/messaging/create-email.md +24 -0
- package/docs/examples/messaging/create-fcm-provider.md +16 -0
- package/docs/examples/messaging/create-mailgun-provider.md +22 -0
- package/docs/examples/messaging/create-msg91provider.md +18 -0
- package/docs/examples/messaging/create-push.md +28 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +20 -0
- package/docs/examples/messaging/create-sms.md +19 -0
- package/docs/examples/messaging/create-smtp-provider.md +26 -0
- package/docs/examples/messaging/create-subscriber.md +15 -0
- package/docs/examples/messaging/create-telesign-provider.md +18 -0
- package/docs/examples/messaging/create-textmagic-provider.md +18 -0
- package/docs/examples/messaging/create-topic.md +15 -0
- package/docs/examples/messaging/create-twilio-provider.md +18 -0
- package/docs/examples/messaging/create-vonage-provider.md +18 -0
- package/docs/examples/messaging/delete-provider.md +13 -0
- package/docs/examples/messaging/delete-subscriber.md +14 -0
- package/docs/examples/messaging/delete-topic.md +13 -0
- package/docs/examples/messaging/delete.md +13 -0
- package/docs/examples/messaging/get-message.md +13 -0
- package/docs/examples/messaging/get-provider.md +13 -0
- package/docs/examples/messaging/get-subscriber.md +14 -0
- package/docs/examples/messaging/get-topic.md +13 -0
- package/docs/examples/messaging/list-message-logs.md +14 -0
- package/docs/examples/messaging/list-messages.md +14 -0
- package/docs/examples/messaging/list-provider-logs.md +14 -0
- package/docs/examples/messaging/list-providers.md +14 -0
- package/docs/examples/messaging/list-subscriber-logs.md +14 -0
- package/docs/examples/messaging/list-subscribers.md +15 -0
- package/docs/examples/messaging/list-targets.md +14 -0
- package/docs/examples/messaging/list-topic-logs.md +14 -0
- package/docs/examples/messaging/list-topics.md +14 -0
- package/docs/examples/messaging/update-apns-provider.md +20 -0
- package/docs/examples/messaging/update-email.md +24 -0
- package/docs/examples/messaging/update-fcm-provider.md +16 -0
- package/docs/examples/messaging/update-mailgun-provider.md +22 -0
- package/docs/examples/messaging/update-msg91provider.md +18 -0
- package/docs/examples/messaging/update-push.md +28 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +20 -0
- package/docs/examples/messaging/update-sms.md +19 -0
- package/docs/examples/messaging/update-smtp-provider.md +26 -0
- package/docs/examples/messaging/update-telesign-provider.md +18 -0
- package/docs/examples/messaging/update-textmagic-provider.md +18 -0
- package/docs/examples/messaging/update-topic.md +15 -0
- package/docs/examples/messaging/update-twilio-provider.md +18 -0
- package/docs/examples/messaging/update-vonage-provider.md +18 -0
- package/docs/examples/migrations/create-appwrite-migration.md +16 -0
- package/docs/examples/migrations/create-firebase-migration.md +14 -0
- package/docs/examples/migrations/create-firebase-o-auth-migration.md +14 -0
- package/docs/examples/migrations/create-n-host-migration.md +20 -0
- package/docs/examples/migrations/create-supabase-migration.md +19 -0
- package/docs/examples/migrations/delete-firebase-auth.md +11 -0
- package/docs/examples/migrations/delete.md +13 -0
- package/docs/examples/migrations/get-appwrite-report.md +16 -0
- package/docs/examples/migrations/get-firebase-report-o-auth.md +14 -0
- package/docs/examples/migrations/get-firebase-report.md +14 -0
- package/docs/examples/migrations/get-n-host-report.md +20 -0
- package/docs/examples/migrations/get-supabase-report.md +19 -0
- package/docs/examples/migrations/get.md +13 -0
- package/docs/examples/migrations/list-firebase-projects.md +11 -0
- package/docs/examples/migrations/list.md +14 -0
- package/docs/examples/migrations/retry.md +13 -0
- package/docs/examples/project/create-variable.md +14 -0
- package/docs/examples/project/delete-variable.md +13 -0
- package/docs/examples/project/get-usage.md +15 -0
- package/docs/examples/project/get-variable.md +13 -0
- package/docs/examples/project/list-variables.md +11 -0
- package/docs/examples/project/update-variable.md +15 -0
- package/docs/examples/projects/create-j-w-t.md +15 -0
- package/docs/examples/projects/create-key.md +16 -0
- package/docs/examples/projects/create-platform.md +18 -0
- package/docs/examples/projects/create-smtp-test.md +22 -0
- package/docs/examples/projects/create-webhook.md +20 -0
- package/docs/examples/projects/create.md +25 -0
- package/docs/examples/projects/delete-email-template.md +15 -0
- package/docs/examples/projects/delete-key.md +14 -0
- package/docs/examples/projects/delete-platform.md +14 -0
- package/docs/examples/projects/delete-sms-template.md +15 -0
- package/docs/examples/projects/delete-webhook.md +14 -0
- package/docs/examples/projects/delete.md +13 -0
- package/docs/examples/projects/get-email-template.md +15 -0
- package/docs/examples/projects/get-key.md +14 -0
- package/docs/examples/projects/get-platform.md +14 -0
- package/docs/examples/projects/get-sms-template.md +15 -0
- package/docs/examples/projects/get-webhook.md +14 -0
- package/docs/examples/projects/get.md +13 -0
- package/docs/examples/projects/list-keys.md +13 -0
- package/docs/examples/projects/list-platforms.md +13 -0
- package/docs/examples/projects/list-webhooks.md +13 -0
- package/docs/examples/projects/list.md +14 -0
- package/docs/examples/projects/update-api-status-all.md +14 -0
- package/docs/examples/projects/update-api-status.md +15 -0
- package/docs/examples/projects/update-auth-duration.md +14 -0
- package/docs/examples/projects/update-auth-limit.md +14 -0
- package/docs/examples/projects/update-auth-password-dictionary.md +14 -0
- package/docs/examples/projects/update-auth-password-history.md +14 -0
- package/docs/examples/projects/update-auth-sessions-limit.md +14 -0
- package/docs/examples/projects/update-auth-status.md +15 -0
- package/docs/examples/projects/update-email-template.md +20 -0
- package/docs/examples/projects/update-key.md +17 -0
- package/docs/examples/projects/update-mock-numbers.md +14 -0
- package/docs/examples/projects/update-o-auth2.md +17 -0
- package/docs/examples/projects/update-personal-data-check.md +14 -0
- package/docs/examples/projects/update-platform.md +18 -0
- package/docs/examples/projects/update-service-status-all.md +14 -0
- package/docs/examples/projects/update-service-status.md +15 -0
- package/docs/examples/projects/update-session-alerts.md +14 -0
- package/docs/examples/projects/update-sms-template.md +16 -0
- package/docs/examples/projects/update-smtp.md +22 -0
- package/docs/examples/projects/update-team.md +14 -0
- package/docs/examples/projects/update-webhook-signature.md +14 -0
- package/docs/examples/projects/update-webhook.md +21 -0
- package/docs/examples/projects/update.md +23 -0
- package/docs/examples/proxy/create-rule.md +15 -0
- package/docs/examples/proxy/delete-rule.md +13 -0
- package/docs/examples/proxy/get-rule.md +13 -0
- package/docs/examples/proxy/list-rules.md +14 -0
- package/docs/examples/proxy/update-rule-verification.md +13 -0
- package/docs/examples/storage/create-bucket.md +22 -0
- package/docs/examples/storage/create-file.md +16 -0
- package/docs/examples/storage/delete-bucket.md +13 -0
- package/docs/examples/storage/delete-file.md +14 -0
- package/docs/examples/storage/get-bucket-usage.md +14 -0
- package/docs/examples/storage/get-bucket.md +13 -0
- package/docs/examples/storage/get-file-download.md +14 -0
- package/docs/examples/storage/get-file-preview.md +25 -0
- package/docs/examples/storage/get-file-view.md +14 -0
- package/docs/examples/storage/get-file.md +14 -0
- package/docs/examples/storage/get-usage.md +13 -0
- package/docs/examples/storage/list-buckets.md +14 -0
- package/docs/examples/storage/list-files.md +15 -0
- package/docs/examples/storage/update-bucket.md +22 -0
- package/docs/examples/storage/update-file.md +16 -0
- package/docs/examples/teams/create-membership.md +19 -0
- package/docs/examples/teams/create.md +15 -0
- package/docs/examples/teams/delete-membership.md +14 -0
- package/docs/examples/teams/delete.md +13 -0
- package/docs/examples/teams/get-membership.md +14 -0
- package/docs/examples/teams/get-prefs.md +13 -0
- package/docs/examples/teams/get.md +13 -0
- package/docs/examples/teams/list-logs.md +14 -0
- package/docs/examples/teams/list-memberships.md +15 -0
- package/docs/examples/teams/list.md +14 -0
- package/docs/examples/teams/update-membership-status.md +16 -0
- package/docs/examples/teams/update-membership.md +15 -0
- package/docs/examples/teams/update-name.md +14 -0
- package/docs/examples/teams/update-prefs.md +14 -0
- package/docs/examples/users/create-argon2user.md +16 -0
- package/docs/examples/users/create-bcrypt-user.md +16 -0
- package/docs/examples/users/create-j-w-t.md +15 -0
- package/docs/examples/users/create-m-d5user.md +16 -0
- package/docs/examples/users/create-mfa-recovery-codes.md +13 -0
- package/docs/examples/users/create-p-h-pass-user.md +16 -0
- package/docs/examples/users/create-s-h-a-user.md +17 -0
- package/docs/examples/users/create-scrypt-modified-user.md +19 -0
- package/docs/examples/users/create-scrypt-user.md +21 -0
- package/docs/examples/users/create-session.md +13 -0
- package/docs/examples/users/create-target.md +18 -0
- package/docs/examples/users/create-token.md +15 -0
- package/docs/examples/users/create.md +17 -0
- package/docs/examples/users/delete-identity.md +13 -0
- package/docs/examples/users/delete-mfa-authenticator.md +14 -0
- package/docs/examples/users/delete-session.md +14 -0
- package/docs/examples/users/delete-sessions.md +13 -0
- package/docs/examples/users/delete-target.md +14 -0
- package/docs/examples/users/delete.md +13 -0
- package/docs/examples/users/get-mfa-recovery-codes.md +13 -0
- package/docs/examples/users/get-prefs.md +13 -0
- package/docs/examples/users/get-target.md +14 -0
- package/docs/examples/users/get-usage.md +13 -0
- package/docs/examples/users/get.md +13 -0
- package/docs/examples/users/list-identities.md +14 -0
- package/docs/examples/users/list-logs.md +14 -0
- package/docs/examples/users/list-memberships.md +13 -0
- package/docs/examples/users/list-mfa-factors.md +13 -0
- package/docs/examples/users/list-sessions.md +13 -0
- package/docs/examples/users/list-targets.md +14 -0
- package/docs/examples/users/list.md +14 -0
- package/docs/examples/users/update-email-verification.md +14 -0
- package/docs/examples/users/update-email.md +14 -0
- package/docs/examples/users/update-labels.md +14 -0
- package/docs/examples/users/update-mfa-recovery-codes.md +13 -0
- package/docs/examples/users/update-mfa.md +14 -0
- package/docs/examples/users/update-name.md +14 -0
- package/docs/examples/users/update-password.md +14 -0
- package/docs/examples/users/update-phone-verification.md +14 -0
- package/docs/examples/users/update-phone.md +14 -0
- package/docs/examples/users/update-prefs.md +14 -0
- package/docs/examples/users/update-status.md +14 -0
- package/docs/examples/users/update-target.md +17 -0
- package/docs/examples/vcs/create-repository-detection.md +15 -0
- package/docs/examples/vcs/create-repository.md +15 -0
- package/docs/examples/vcs/delete-installation.md +13 -0
- package/docs/examples/vcs/get-installation.md +13 -0
- package/docs/examples/vcs/get-repository-contents.md +15 -0
- package/docs/examples/vcs/get-repository.md +14 -0
- package/docs/examples/vcs/list-installations.md +14 -0
- package/docs/examples/vcs/list-repositories.md +14 -0
- package/docs/examples/vcs/list-repository-branches.md +14 -0
- package/docs/examples/vcs/update-external-deployments.md +15 -0
- package/package.json +42 -0
- package/publish.sh +4 -0
- package/rollup.config.js +27 -0
- package/src/Cache/Adapter.ts +11 -0
- package/src/Cache/Adapters/Filesystem.ts +126 -0
- package/src/Cache/Adapters/Memory.ts +57 -0
- package/src/Cache/Adapters/None.ts +36 -0
- package/src/Cache/Adapters/Redis.ts +106 -0
- package/src/Cache/Adapters/Sharding.ts +87 -0
- package/src/Cache/Cache.ts +75 -0
- package/src/Cache/index.ts +5 -0
- package/src/Cache/test.ts +0 -0
- package/src/Services.ts +41 -0
- package/src/client.ts +397 -0
- package/src/decorators/Cache.ts +102 -0
- package/src/decorators/CacheKey.ts +9 -0
- package/src/decorators/Invalidate.ts +68 -0
- package/src/enums/api-service.ts +13 -0
- package/src/enums/api.ts +5 -0
- package/src/enums/auth-method.ts +9 -0
- package/src/enums/authentication-factor.ts +6 -0
- package/src/enums/authenticator-type.ts +3 -0
- package/src/enums/browser.ts +16 -0
- package/src/enums/compression.ts +5 -0
- package/src/enums/credit-card.ts +18 -0
- package/src/enums/database-usage-range.ts +5 -0
- package/src/enums/email-template-locale.ts +133 -0
- package/src/enums/email-template-type.ts +9 -0
- package/src/enums/entities/EntityLimitType.ts +4 -0
- package/src/enums/entities/PropertyAttributeName.ts +27 -0
- package/src/enums/entities/PropertyCondition.ts +8 -0
- package/src/enums/entities/PropertyType.ts +16 -0
- package/src/enums/entities/PropertyValueType.ts +6 -0
- package/src/enums/entities/RowAccess.ts +2 -0
- package/src/enums/entities/ViewFilterCondition.ts +12 -0
- package/src/enums/execution-method.ts +8 -0
- package/src/enums/flag.ts +197 -0
- package/src/enums/function-usage-range.ts +5 -0
- package/src/enums/image-format.ts +7 -0
- package/src/enums/image-gravity.ts +11 -0
- package/src/enums/index-type.ts +5 -0
- package/src/enums/messaging-provider-type.ts +5 -0
- package/src/enums/name.ts +14 -0
- package/src/enums/o-auth-provider copy.ts +41 -0
- package/src/enums/o-auth-provider.ts +41 -0
- package/src/enums/password-hash.ts +13 -0
- package/src/enums/platform-type.ts +17 -0
- package/src/enums/project-usage-range.ts +4 -0
- package/src/enums/region.ts +4 -0
- package/src/enums/relation-mutate.ts +5 -0
- package/src/enums/relationship-type.ts +6 -0
- package/src/enums/resource-type.ts +4 -0
- package/src/enums/runtime.ts +48 -0
- package/src/enums/s-m-t-p-secure.ts +3 -0
- package/src/enums/shared/ApplicationLayout.ts +4 -0
- package/src/enums/shared/Colors.ts +24 -0
- package/src/enums/shared/InputType.ts +6 -0
- package/src/enums/shared/Periodicity.ts +7 -0
- package/src/enums/shared/SvgIcon.ts +37 -0
- package/src/enums/shared/Theme.ts +4 -0
- package/src/enums/sms-template-locale.ts +133 -0
- package/src/enums/sms-template-type.ts +6 -0
- package/src/enums/smtp-encryption.ts +5 -0
- package/src/enums/storage-usage-range.ts +5 -0
- package/src/enums/subscriptions/PricingModel.ts +14 -0
- package/src/enums/subscriptions/SubscriptionBillingPeriod.ts +15 -0
- package/src/enums/subscriptions/SubscriptionFeatureLimitType.ts +16 -0
- package/src/enums/subscriptions/SubscriptionPriceType.ts +10 -0
- package/src/enums/tenants/LinkedAccountStatus.ts +5 -0
- package/src/enums/tenants/TenantUserJoined.ts +6 -0
- package/src/enums/tenants/TenantUserStatus.ts +6 -0
- package/src/enums/tenants/TenantUserType.ts +5 -0
- package/src/enums/user-usage-range.ts +5 -0
- package/src/id.ts +47 -0
- package/src/index.ts +36 -0
- package/src/inputFile.ts +23 -0
- package/src/lib/Registry/Registry.ts +66 -0
- package/src/lib/Registry/index.ts +1 -0
- package/src/models.ts +3339 -0
- package/src/permission.ts +57 -0
- package/src/query.ts +261 -0
- package/src/role.ts +100 -0
- package/src/service-client.ts +29 -0
- package/src/service.ts +30 -0
- package/src/services/account.ts +1643 -0
- package/src/services/applets.ts +75 -0
- package/src/services/avatars.ts +314 -0
- package/src/services/community.ts +102 -0
- package/src/services/configuration.ts +15 -0
- package/src/services/databases.ts +2037 -0
- package/src/services/functions.ts +986 -0
- package/src/services/graphql.ts +75 -0
- package/src/services/health.ts +629 -0
- package/src/services/locale.ts +205 -0
- package/src/services/messaging.ts +2247 -0
- package/src/services/node.ts +15 -0
- package/src/services/permissions.ts +131 -0
- package/src/services/pricing.ts +30 -0
- package/src/services/projects.ts +1901 -0
- package/src/services/roles.ts +101 -0
- package/src/services/schema.ts +65 -0
- package/src/services/storage.ts +576 -0
- package/src/services/subscription.ts +40 -0
- package/src/services/teams.ts +490 -0
- package/src/services/tenant-subscription.ts +93 -0
- package/src/services/tenant.ts +194 -0
- package/src/services/users.ts +1584 -0
- package/tsconfig.json +29 -0
- package/types/Cache/Adapter.d.ts +10 -0
- package/types/Cache/Adapters/Filesystem.d.ts +16 -0
- package/types/Cache/Adapters/Memory.d.ts +18 -0
- package/types/Cache/Adapters/None.d.ts +12 -0
- package/types/Cache/Adapters/Redis.d.ts +14 -0
- package/types/Cache/Adapters/Sharding.d.ts +17 -0
- package/types/Cache/Cache.d.ts +16 -0
- package/types/Cache/index.d.ts +5 -0
- package/types/Cache/test.d.ts +0 -0
- package/types/Services.d.ts +6 -0
- package/types/client.d.ts +141 -0
- package/types/decorators/Cache.d.ts +1 -0
- package/types/decorators/CacheKey.d.ts +1 -0
- package/types/decorators/Invalidate.d.ts +1 -0
- package/types/enums/api-service.d.ts +13 -0
- package/types/enums/api.d.ts +5 -0
- package/types/enums/auth-method.d.ts +9 -0
- package/types/enums/authentication-factor.d.ts +6 -0
- package/types/enums/authenticator-type.d.ts +3 -0
- package/types/enums/browser.d.ts +16 -0
- package/types/enums/compression.d.ts +5 -0
- package/types/enums/credit-card.d.ts +18 -0
- package/types/enums/database-usage-range.d.ts +5 -0
- package/types/enums/email-template-locale.d.ts +133 -0
- package/types/enums/email-template-type.d.ts +9 -0
- package/types/enums/entities/EntityLimitType.d.ts +4 -0
- package/types/enums/entities/PropertyAttributeName.d.ts +27 -0
- package/types/enums/entities/PropertyCondition.d.ts +7 -0
- package/types/enums/entities/PropertyType.d.ts +12 -0
- package/types/enums/entities/PropertyValueType.d.ts +6 -0
- package/types/enums/entities/RowAccess.d.ts +2 -0
- package/types/enums/entities/ViewFilterCondition.d.ts +12 -0
- package/types/enums/execution-method.d.ts +8 -0
- package/types/enums/flag.d.ts +197 -0
- package/types/enums/function-usage-range.d.ts +5 -0
- package/types/enums/image-format.d.ts +7 -0
- package/types/enums/image-gravity.d.ts +11 -0
- package/types/enums/index-type.d.ts +5 -0
- package/types/enums/messaging-provider-type.d.ts +5 -0
- package/types/enums/name.d.ts +14 -0
- package/types/enums/o-auth-provider copy.d.ts +41 -0
- package/types/enums/o-auth-provider.d.ts +41 -0
- package/types/enums/password-hash.d.ts +13 -0
- package/types/enums/platform-type.d.ts +17 -0
- package/types/enums/project-usage-range.d.ts +4 -0
- package/types/enums/region.d.ts +4 -0
- package/types/enums/relation-mutate.d.ts +5 -0
- package/types/enums/relationship-type.d.ts +6 -0
- package/types/enums/resource-type.d.ts +4 -0
- package/types/enums/runtime.d.ts +48 -0
- package/types/enums/s-m-t-p-secure.d.ts +3 -0
- package/types/enums/shared/ApplicationLayout.d.ts +4 -0
- package/types/enums/shared/Colors.d.ts +24 -0
- package/types/enums/shared/InputType.d.ts +6 -0
- package/types/enums/shared/Periodicity.d.ts +7 -0
- package/types/enums/shared/SvgIcon.d.ts +37 -0
- package/types/enums/shared/Theme.d.ts +4 -0
- package/types/enums/sms-template-locale.d.ts +133 -0
- package/types/enums/sms-template-type.d.ts +6 -0
- package/types/enums/smtp-encryption.d.ts +5 -0
- package/types/enums/storage-usage-range.d.ts +5 -0
- package/types/enums/subscriptions/PricingModel.d.ts +11 -0
- package/types/enums/subscriptions/SubscriptionBillingPeriod.d.ts +10 -0
- package/types/enums/subscriptions/SubscriptionFeatureLimitType.d.ts +10 -0
- package/types/enums/subscriptions/SubscriptionPriceType.d.ts +7 -0
- package/types/enums/tenants/LinkedAccountStatus.d.ts +5 -0
- package/types/enums/tenants/TenantUserJoined.d.ts +6 -0
- package/types/enums/tenants/TenantUserStatus.d.ts +6 -0
- package/types/enums/tenants/TenantUserType.d.ts +5 -0
- package/types/enums/user-usage-range.d.ts +5 -0
- package/types/id.d.ts +20 -0
- package/types/index.d.ts +36 -0
- package/types/inputFile.d.ts +6 -0
- package/types/lib/Registry/Registry.d.ts +38 -0
- package/types/lib/Registry/index.d.ts +1 -0
- package/types/models.d.ts +3272 -0
- package/types/permission.d.ts +43 -0
- package/types/query.d.ts +194 -0
- package/types/role.d.ts +70 -0
- package/types/service-client.d.ts +7 -0
- package/types/service.d.ts +11 -0
- package/types/services/account.d.ts +530 -0
- package/types/services/acl.d.ts +28 -0
- package/types/services/applets.d.ts +9 -0
- package/types/services/assistant.d.ts +14 -0
- package/types/services/avatars.d.ts +115 -0
- package/types/services/community.d.ts +19 -0
- package/types/services/configuration.d.ts +5 -0
- package/types/services/console.d.ts +15 -0
- package/types/services/databases.d.ts +613 -0
- package/types/services/functions.d.ts +319 -0
- package/types/services/graphql.d.ts +25 -0
- package/types/services/health.d.ts +231 -0
- package/types/services/locale.d.ts +80 -0
- package/types/services/messaging.d.ts +685 -0
- package/types/services/migrations.d.ts +185 -0
- package/types/services/node.d.ts +5 -0
- package/types/services/permissions.d.ts +20 -0
- package/types/services/pricing.d.ts +15 -0
- package/types/services/project.d.ts +70 -0
- package/types/services/projects.d.ts +542 -0
- package/types/services/proxy.d.ts +59 -0
- package/types/services/roles.d.ts +19 -0
- package/types/services/schema.d.ts +17 -0
- package/types/services/storage.d.ts +189 -0
- package/types/services/subscription-product.d.ts +77 -0
- package/types/services/subscription.d.ts +15 -0
- package/types/services/teams.d.ts +167 -0
- package/types/services/tenant-subscription.d.ts +12 -0
- package/types/services/tenant.d.ts +32 -0
- package/types/services/users.d.ts +499 -0
- package/types/services/vcs.d.ts +108 -0
@@ -0,0 +1,613 @@
|
|
1
|
+
import { Client } from '../client';
|
2
|
+
import type { Models } from '../models';
|
3
|
+
import { RelationshipType } from '../enums/relationship-type';
|
4
|
+
import { RelationMutate } from '../enums/relation-mutate';
|
5
|
+
import { IndexType } from '../enums/index-type';
|
6
|
+
export declare class Databases {
|
7
|
+
client: Client;
|
8
|
+
constructor(client: Client);
|
9
|
+
/**
|
10
|
+
* List databases
|
11
|
+
*
|
12
|
+
* Get a list of all databases from the current Appconda project. You can use the search parameter to filter your results.
|
13
|
+
*
|
14
|
+
* @param {string[]} queries
|
15
|
+
* @param {string} search
|
16
|
+
* @throws {AppcondaException}
|
17
|
+
* @returns {Promise<Models.DatabaseList>}
|
18
|
+
*/
|
19
|
+
list(queries?: string[], search?: string): Promise<Models.DatabaseList>;
|
20
|
+
/**
|
21
|
+
* Create database
|
22
|
+
*
|
23
|
+
* Create a new Database.
|
24
|
+
|
25
|
+
*
|
26
|
+
* @param {string} databaseId
|
27
|
+
* @param {string} name
|
28
|
+
* @param {boolean} enabled
|
29
|
+
* @throws {AppcondaException}
|
30
|
+
* @returns {Promise<Models.Database>}
|
31
|
+
*/
|
32
|
+
create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
|
33
|
+
/**
|
34
|
+
* Get database
|
35
|
+
*
|
36
|
+
* Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.
|
37
|
+
*
|
38
|
+
* @param {string} databaseId
|
39
|
+
* @throws {AppcondaException}
|
40
|
+
* @returns {Promise<Models.Database>}
|
41
|
+
*/
|
42
|
+
get(databaseId: string): Promise<Models.Database>;
|
43
|
+
/**
|
44
|
+
* Update database
|
45
|
+
*
|
46
|
+
* Update a database by its unique ID.
|
47
|
+
*
|
48
|
+
* @param {string} databaseId
|
49
|
+
* @param {string} name
|
50
|
+
* @param {boolean} enabled
|
51
|
+
* @throws {AppcondaException}
|
52
|
+
* @returns {Promise<Models.Database>}
|
53
|
+
*/
|
54
|
+
update(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
|
55
|
+
/**
|
56
|
+
* Delete database
|
57
|
+
*
|
58
|
+
* Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
|
59
|
+
*
|
60
|
+
* @param {string} databaseId
|
61
|
+
* @throws {AppcondaException}
|
62
|
+
* @returns {Promise<{}>}
|
63
|
+
*/
|
64
|
+
delete(databaseId: string): Promise<{}>;
|
65
|
+
/**
|
66
|
+
* List collections
|
67
|
+
*
|
68
|
+
* Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.
|
69
|
+
*
|
70
|
+
* @param {string} databaseId
|
71
|
+
* @param {string[]} queries
|
72
|
+
* @param {string} search
|
73
|
+
* @throws {AppcondaException}
|
74
|
+
* @returns {Promise<Models.CollectionList>}
|
75
|
+
*/
|
76
|
+
listCollections(databaseId: string, queries?: string[], search?: string): Promise<Models.CollectionList>;
|
77
|
+
/**
|
78
|
+
* Create collection
|
79
|
+
*
|
80
|
+
* Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https://appconda.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
|
81
|
+
*
|
82
|
+
* @param {string} databaseId
|
83
|
+
* @param {string} collectionId
|
84
|
+
* @param {string} name
|
85
|
+
* @param {string[]} permissions
|
86
|
+
* @param {boolean} documentSecurity
|
87
|
+
* @param {boolean} enabled
|
88
|
+
* @throws {AppcondaException}
|
89
|
+
* @returns {Promise<Models.Collection>}
|
90
|
+
*/
|
91
|
+
createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
|
92
|
+
/**
|
93
|
+
* Get collection
|
94
|
+
*
|
95
|
+
* Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.
|
96
|
+
*
|
97
|
+
* @param {string} databaseId
|
98
|
+
* @param {string} collectionId
|
99
|
+
* @throws {AppcondaException}
|
100
|
+
* @returns {Promise<Models.Collection>}
|
101
|
+
*/
|
102
|
+
getCollection(databaseId: string, collectionId: string): Promise<Models.Collection>;
|
103
|
+
/**
|
104
|
+
* Update collection
|
105
|
+
*
|
106
|
+
* Update a collection by its unique ID.
|
107
|
+
*
|
108
|
+
* @param {string} databaseId
|
109
|
+
* @param {string} collectionId
|
110
|
+
* @param {string} name
|
111
|
+
* @param {string[]} permissions
|
112
|
+
* @param {boolean} documentSecurity
|
113
|
+
* @param {boolean} enabled
|
114
|
+
* @throws {AppcondaException}
|
115
|
+
* @returns {Promise<Models.Collection>}
|
116
|
+
*/
|
117
|
+
updateCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
|
118
|
+
/**
|
119
|
+
* Delete collection
|
120
|
+
*
|
121
|
+
* Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.
|
122
|
+
*
|
123
|
+
* @param {string} databaseId
|
124
|
+
* @param {string} collectionId
|
125
|
+
* @throws {AppcondaException}
|
126
|
+
* @returns {Promise<{}>}
|
127
|
+
*/
|
128
|
+
deleteCollection(databaseId: string, collectionId: string): Promise<{}>;
|
129
|
+
/**
|
130
|
+
* List attributes
|
131
|
+
*
|
132
|
+
* List attributes in the collection.
|
133
|
+
*
|
134
|
+
* @param {string} databaseId
|
135
|
+
* @param {string} collectionId
|
136
|
+
* @param {string[]} queries
|
137
|
+
* @throws {AppcondaException}
|
138
|
+
* @returns {Promise<Models.AttributeList>}
|
139
|
+
*/
|
140
|
+
listAttributes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.AttributeList>;
|
141
|
+
/**
|
142
|
+
* Create boolean attribute
|
143
|
+
*
|
144
|
+
* Create a boolean attribute.
|
145
|
+
|
146
|
+
*
|
147
|
+
* @param {string} databaseId
|
148
|
+
* @param {string} collectionId
|
149
|
+
* @param {string} key
|
150
|
+
* @param {boolean} required
|
151
|
+
* @param {boolean} xdefault
|
152
|
+
* @param {boolean} array
|
153
|
+
* @throws {AppcondaException}
|
154
|
+
* @returns {Promise<Models.AttributeBoolean>}
|
155
|
+
*/
|
156
|
+
createBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, array?: boolean): Promise<Models.AttributeBoolean>;
|
157
|
+
/**
|
158
|
+
* Update boolean attribute
|
159
|
+
*
|
160
|
+
* Update a boolean attribute. Changing the `default` value will not update already existing documents.
|
161
|
+
*
|
162
|
+
* @param {string} databaseId
|
163
|
+
* @param {string} collectionId
|
164
|
+
* @param {string} key
|
165
|
+
* @param {boolean} required
|
166
|
+
* @param {boolean} xdefault
|
167
|
+
* @param {string} newKey
|
168
|
+
* @throws {AppcondaException}
|
169
|
+
* @returns {Promise<Models.AttributeBoolean>}
|
170
|
+
*/
|
171
|
+
updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, newKey?: string): Promise<Models.AttributeBoolean>;
|
172
|
+
/**
|
173
|
+
* Create datetime attribute
|
174
|
+
*
|
175
|
+
* Create a date time attribute according to the ISO 8601 standard.
|
176
|
+
*
|
177
|
+
* @param {string} databaseId
|
178
|
+
* @param {string} collectionId
|
179
|
+
* @param {string} key
|
180
|
+
* @param {boolean} required
|
181
|
+
* @param {string} xdefault
|
182
|
+
* @param {boolean} array
|
183
|
+
* @throws {AppcondaException}
|
184
|
+
* @returns {Promise<Models.AttributeDatetime>}
|
185
|
+
*/
|
186
|
+
createDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeDatetime>;
|
187
|
+
/**
|
188
|
+
* Update dateTime attribute
|
189
|
+
*
|
190
|
+
* Update a date time attribute. Changing the `default` value will not update already existing documents.
|
191
|
+
*
|
192
|
+
* @param {string} databaseId
|
193
|
+
* @param {string} collectionId
|
194
|
+
* @param {string} key
|
195
|
+
* @param {boolean} required
|
196
|
+
* @param {string} xdefault
|
197
|
+
* @param {string} newKey
|
198
|
+
* @throws {AppcondaException}
|
199
|
+
* @returns {Promise<Models.AttributeDatetime>}
|
200
|
+
*/
|
201
|
+
updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeDatetime>;
|
202
|
+
/**
|
203
|
+
* Create email attribute
|
204
|
+
*
|
205
|
+
* Create an email attribute.
|
206
|
+
|
207
|
+
*
|
208
|
+
* @param {string} databaseId
|
209
|
+
* @param {string} collectionId
|
210
|
+
* @param {string} key
|
211
|
+
* @param {boolean} required
|
212
|
+
* @param {string} xdefault
|
213
|
+
* @param {boolean} array
|
214
|
+
* @throws {AppcondaException}
|
215
|
+
* @returns {Promise<Models.AttributeEmail>}
|
216
|
+
*/
|
217
|
+
createEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEmail>;
|
218
|
+
/**
|
219
|
+
* Update email attribute
|
220
|
+
*
|
221
|
+
* Update an email attribute. Changing the `default` value will not update already existing documents.
|
222
|
+
|
223
|
+
*
|
224
|
+
* @param {string} databaseId
|
225
|
+
* @param {string} collectionId
|
226
|
+
* @param {string} key
|
227
|
+
* @param {boolean} required
|
228
|
+
* @param {string} xdefault
|
229
|
+
* @param {string} newKey
|
230
|
+
* @throws {AppcondaException}
|
231
|
+
* @returns {Promise<Models.AttributeEmail>}
|
232
|
+
*/
|
233
|
+
updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeEmail>;
|
234
|
+
/**
|
235
|
+
* Create enum attribute
|
236
|
+
*
|
237
|
+
* Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute.
|
238
|
+
|
239
|
+
*
|
240
|
+
* @param {string} databaseId
|
241
|
+
* @param {string} collectionId
|
242
|
+
* @param {string} key
|
243
|
+
* @param {string[]} elements
|
244
|
+
* @param {boolean} required
|
245
|
+
* @param {string} xdefault
|
246
|
+
* @param {boolean} array
|
247
|
+
* @throws {AppcondaException}
|
248
|
+
* @returns {Promise<Models.AttributeEnum>}
|
249
|
+
*/
|
250
|
+
createEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEnum>;
|
251
|
+
/**
|
252
|
+
* Update enum attribute
|
253
|
+
*
|
254
|
+
* Update an enum attribute. Changing the `default` value will not update already existing documents.
|
255
|
+
|
256
|
+
*
|
257
|
+
* @param {string} databaseId
|
258
|
+
* @param {string} collectionId
|
259
|
+
* @param {string} key
|
260
|
+
* @param {string[]} elements
|
261
|
+
* @param {boolean} required
|
262
|
+
* @param {string} xdefault
|
263
|
+
* @param {string} newKey
|
264
|
+
* @throws {AppcondaException}
|
265
|
+
* @returns {Promise<Models.AttributeEnum>}
|
266
|
+
*/
|
267
|
+
updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeEnum>;
|
268
|
+
/**
|
269
|
+
* Create float attribute
|
270
|
+
*
|
271
|
+
* Create a float attribute. Optionally, minimum and maximum values can be provided.
|
272
|
+
|
273
|
+
*
|
274
|
+
* @param {string} databaseId
|
275
|
+
* @param {string} collectionId
|
276
|
+
* @param {string} key
|
277
|
+
* @param {boolean} required
|
278
|
+
* @param {number} min
|
279
|
+
* @param {number} max
|
280
|
+
* @param {number} xdefault
|
281
|
+
* @param {boolean} array
|
282
|
+
* @throws {AppcondaException}
|
283
|
+
* @returns {Promise<Models.AttributeFloat>}
|
284
|
+
*/
|
285
|
+
createFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeFloat>;
|
286
|
+
/**
|
287
|
+
* Update float attribute
|
288
|
+
*
|
289
|
+
* Update a float attribute. Changing the `default` value will not update already existing documents.
|
290
|
+
|
291
|
+
*
|
292
|
+
* @param {string} databaseId
|
293
|
+
* @param {string} collectionId
|
294
|
+
* @param {string} key
|
295
|
+
* @param {boolean} required
|
296
|
+
* @param {number} min
|
297
|
+
* @param {number} max
|
298
|
+
* @param {number} xdefault
|
299
|
+
* @param {string} newKey
|
300
|
+
* @throws {AppcondaException}
|
301
|
+
* @returns {Promise<Models.AttributeFloat>}
|
302
|
+
*/
|
303
|
+
updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number, newKey?: string): Promise<Models.AttributeFloat>;
|
304
|
+
/**
|
305
|
+
* Create integer attribute
|
306
|
+
*
|
307
|
+
* Create an integer attribute. Optionally, minimum and maximum values can be provided.
|
308
|
+
|
309
|
+
*
|
310
|
+
* @param {string} databaseId
|
311
|
+
* @param {string} collectionId
|
312
|
+
* @param {string} key
|
313
|
+
* @param {boolean} required
|
314
|
+
* @param {number} min
|
315
|
+
* @param {number} max
|
316
|
+
* @param {number} xdefault
|
317
|
+
* @param {boolean} array
|
318
|
+
* @throws {AppcondaException}
|
319
|
+
* @returns {Promise<Models.AttributeInteger>}
|
320
|
+
*/
|
321
|
+
createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeInteger>;
|
322
|
+
/**
|
323
|
+
* Update integer attribute
|
324
|
+
*
|
325
|
+
* Update an integer attribute. Changing the `default` value will not update already existing documents.
|
326
|
+
|
327
|
+
*
|
328
|
+
* @param {string} databaseId
|
329
|
+
* @param {string} collectionId
|
330
|
+
* @param {string} key
|
331
|
+
* @param {boolean} required
|
332
|
+
* @param {number} min
|
333
|
+
* @param {number} max
|
334
|
+
* @param {number} xdefault
|
335
|
+
* @param {string} newKey
|
336
|
+
* @throws {AppcondaException}
|
337
|
+
* @returns {Promise<Models.AttributeInteger>}
|
338
|
+
*/
|
339
|
+
updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number, newKey?: string): Promise<Models.AttributeInteger>;
|
340
|
+
/**
|
341
|
+
* Create IP address attribute
|
342
|
+
*
|
343
|
+
* Create IP address attribute.
|
344
|
+
|
345
|
+
*
|
346
|
+
* @param {string} databaseId
|
347
|
+
* @param {string} collectionId
|
348
|
+
* @param {string} key
|
349
|
+
* @param {boolean} required
|
350
|
+
* @param {string} xdefault
|
351
|
+
* @param {boolean} array
|
352
|
+
* @throws {AppcondaException}
|
353
|
+
* @returns {Promise<Models.AttributeIp>}
|
354
|
+
*/
|
355
|
+
createIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeIp>;
|
356
|
+
/**
|
357
|
+
* Update IP address attribute
|
358
|
+
*
|
359
|
+
* Update an ip attribute. Changing the `default` value will not update already existing documents.
|
360
|
+
|
361
|
+
*
|
362
|
+
* @param {string} databaseId
|
363
|
+
* @param {string} collectionId
|
364
|
+
* @param {string} key
|
365
|
+
* @param {boolean} required
|
366
|
+
* @param {string} xdefault
|
367
|
+
* @param {string} newKey
|
368
|
+
* @throws {AppcondaException}
|
369
|
+
* @returns {Promise<Models.AttributeIp>}
|
370
|
+
*/
|
371
|
+
updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeIp>;
|
372
|
+
/**
|
373
|
+
* Create relationship attribute
|
374
|
+
*
|
375
|
+
* Create relationship attribute. [Learn more about relationship attributes](https://appconda.io/docs/databases-relationships#relationship-attributes).
|
376
|
+
|
377
|
+
*
|
378
|
+
* @param {string} databaseId
|
379
|
+
* @param {string} collectionId
|
380
|
+
* @param {string} relatedCollectionId
|
381
|
+
* @param {RelationshipType} type
|
382
|
+
* @param {boolean} twoWay
|
383
|
+
* @param {string} key
|
384
|
+
* @param {string} twoWayKey
|
385
|
+
* @param {RelationMutate} onDelete
|
386
|
+
* @throws {AppcondaException}
|
387
|
+
* @returns {Promise<Models.AttributeRelationship>}
|
388
|
+
*/
|
389
|
+
createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: RelationshipType, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
|
390
|
+
/**
|
391
|
+
* Create string attribute
|
392
|
+
*
|
393
|
+
* Create a string attribute.
|
394
|
+
|
395
|
+
*
|
396
|
+
* @param {string} databaseId
|
397
|
+
* @param {string} collectionId
|
398
|
+
* @param {string} key
|
399
|
+
* @param {number} size
|
400
|
+
* @param {boolean} required
|
401
|
+
* @param {string} xdefault
|
402
|
+
* @param {boolean} array
|
403
|
+
* @param {boolean} encrypt
|
404
|
+
* @throws {AppcondaException}
|
405
|
+
* @returns {Promise<Models.AttributeString>}
|
406
|
+
*/
|
407
|
+
createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeString>;
|
408
|
+
/**
|
409
|
+
* Update string attribute
|
410
|
+
*
|
411
|
+
* Update a string attribute. Changing the `default` value will not update already existing documents.
|
412
|
+
|
413
|
+
*
|
414
|
+
* @param {string} databaseId
|
415
|
+
* @param {string} collectionId
|
416
|
+
* @param {string} key
|
417
|
+
* @param {boolean} required
|
418
|
+
* @param {string} xdefault
|
419
|
+
* @param {number} size
|
420
|
+
* @param {string} newKey
|
421
|
+
* @throws {AppcondaException}
|
422
|
+
* @returns {Promise<Models.AttributeString>}
|
423
|
+
*/
|
424
|
+
updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.AttributeString>;
|
425
|
+
/**
|
426
|
+
* Create URL attribute
|
427
|
+
*
|
428
|
+
* Create a URL attribute.
|
429
|
+
|
430
|
+
*
|
431
|
+
* @param {string} databaseId
|
432
|
+
* @param {string} collectionId
|
433
|
+
* @param {string} key
|
434
|
+
* @param {boolean} required
|
435
|
+
* @param {string} xdefault
|
436
|
+
* @param {boolean} array
|
437
|
+
* @throws {AppcondaException}
|
438
|
+
* @returns {Promise<Models.AttributeUrl>}
|
439
|
+
*/
|
440
|
+
createUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeUrl>;
|
441
|
+
/**
|
442
|
+
* Update URL attribute
|
443
|
+
*
|
444
|
+
* Update an url attribute. Changing the `default` value will not update already existing documents.
|
445
|
+
|
446
|
+
*
|
447
|
+
* @param {string} databaseId
|
448
|
+
* @param {string} collectionId
|
449
|
+
* @param {string} key
|
450
|
+
* @param {boolean} required
|
451
|
+
* @param {string} xdefault
|
452
|
+
* @param {string} newKey
|
453
|
+
* @throws {AppcondaException}
|
454
|
+
* @returns {Promise<Models.AttributeUrl>}
|
455
|
+
*/
|
456
|
+
updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeUrl>;
|
457
|
+
/**
|
458
|
+
* Get attribute
|
459
|
+
*
|
460
|
+
* Get attribute by ID.
|
461
|
+
*
|
462
|
+
* @param {string} databaseId
|
463
|
+
* @param {string} collectionId
|
464
|
+
* @param {string} key
|
465
|
+
* @throws {AppcondaException}
|
466
|
+
* @returns {Promise<{}>}
|
467
|
+
*/
|
468
|
+
getAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
|
469
|
+
/**
|
470
|
+
* Delete attribute
|
471
|
+
*
|
472
|
+
* Deletes an attribute.
|
473
|
+
*
|
474
|
+
* @param {string} databaseId
|
475
|
+
* @param {string} collectionId
|
476
|
+
* @param {string} key
|
477
|
+
* @throws {AppcondaException}
|
478
|
+
* @returns {Promise<{}>}
|
479
|
+
*/
|
480
|
+
deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
|
481
|
+
/**
|
482
|
+
* Update relationship attribute
|
483
|
+
*
|
484
|
+
* Update relationship attribute. [Learn more about relationship attributes](https://appconda.io/docs/databases-relationships#relationship-attributes).
|
485
|
+
|
486
|
+
*
|
487
|
+
* @param {string} databaseId
|
488
|
+
* @param {string} collectionId
|
489
|
+
* @param {string} key
|
490
|
+
* @param {RelationMutate} onDelete
|
491
|
+
* @param {string} newKey
|
492
|
+
* @throws {AppcondaException}
|
493
|
+
* @returns {Promise<Models.AttributeRelationship>}
|
494
|
+
*/
|
495
|
+
updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string): Promise<Models.AttributeRelationship>;
|
496
|
+
/**
|
497
|
+
* List documents
|
498
|
+
*
|
499
|
+
* Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
|
500
|
+
*
|
501
|
+
* @param {string} databaseId
|
502
|
+
* @param {string} collectionId
|
503
|
+
* @param {string[]} queries
|
504
|
+
* @throws {AppcondaException}
|
505
|
+
* @returns {Promise<Models.DocumentList<Document>>}
|
506
|
+
*/
|
507
|
+
listDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.DocumentList<Document>>;
|
508
|
+
/**
|
509
|
+
* Create document
|
510
|
+
*
|
511
|
+
* Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appconda.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
|
512
|
+
*
|
513
|
+
* @param {string} databaseId
|
514
|
+
* @param {string} collectionId
|
515
|
+
* @param {string} documentId
|
516
|
+
* @param {Omit<Document, keyof Models.Document>} data
|
517
|
+
* @param {string[]} permissions
|
518
|
+
* @throws {AppcondaException}
|
519
|
+
* @returns {Promise<Document>}
|
520
|
+
*/
|
521
|
+
createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document>;
|
522
|
+
/**
|
523
|
+
* Get document
|
524
|
+
*
|
525
|
+
* Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
|
526
|
+
*
|
527
|
+
* @param {string} databaseId
|
528
|
+
* @param {string} collectionId
|
529
|
+
* @param {string} documentId
|
530
|
+
* @param {string[]} queries
|
531
|
+
* @throws {AppcondaException}
|
532
|
+
* @returns {Promise<Document>}
|
533
|
+
*/
|
534
|
+
getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
|
535
|
+
/**
|
536
|
+
* Update document
|
537
|
+
*
|
538
|
+
* Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
|
539
|
+
*
|
540
|
+
* @param {string} databaseId
|
541
|
+
* @param {string} collectionId
|
542
|
+
* @param {string} documentId
|
543
|
+
* @param {Partial<Omit<Document, keyof Models.Document>>} data
|
544
|
+
* @param {string[]} permissions
|
545
|
+
* @throws {AppcondaException}
|
546
|
+
* @returns {Promise<Document>}
|
547
|
+
*/
|
548
|
+
updateDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data?: Partial<Omit<Document, keyof Models.Document>>, permissions?: string[]): Promise<Document>;
|
549
|
+
/**
|
550
|
+
* Delete document
|
551
|
+
*
|
552
|
+
* Delete a document by its unique ID.
|
553
|
+
*
|
554
|
+
* @param {string} databaseId
|
555
|
+
* @param {string} collectionId
|
556
|
+
* @param {string} documentId
|
557
|
+
* @throws {AppcondaException}
|
558
|
+
* @returns {Promise<{}>}
|
559
|
+
*/
|
560
|
+
deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<{}>;
|
561
|
+
/**
|
562
|
+
* List indexes
|
563
|
+
*
|
564
|
+
* List indexes in the collection.
|
565
|
+
*
|
566
|
+
* @param {string} databaseId
|
567
|
+
* @param {string} collectionId
|
568
|
+
* @param {string[]} queries
|
569
|
+
* @throws {AppcondaException}
|
570
|
+
* @returns {Promise<Models.IndexList>}
|
571
|
+
*/
|
572
|
+
listIndexes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.IndexList>;
|
573
|
+
/**
|
574
|
+
* Create index
|
575
|
+
*
|
576
|
+
* Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.
|
577
|
+
Attributes can be `key`, `fulltext`, and `unique`.
|
578
|
+
*
|
579
|
+
* @param {string} databaseId
|
580
|
+
* @param {string} collectionId
|
581
|
+
* @param {string} key
|
582
|
+
* @param {IndexType} type
|
583
|
+
* @param {string[]} attributes
|
584
|
+
* @param {string[]} orders
|
585
|
+
* @throws {AppcondaException}
|
586
|
+
* @returns {Promise<Models.Index>}
|
587
|
+
*/
|
588
|
+
createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: string[]): Promise<Models.Index>;
|
589
|
+
/**
|
590
|
+
* Get index
|
591
|
+
*
|
592
|
+
* Get index by ID.
|
593
|
+
*
|
594
|
+
* @param {string} databaseId
|
595
|
+
* @param {string} collectionId
|
596
|
+
* @param {string} key
|
597
|
+
* @throws {AppcondaException}
|
598
|
+
* @returns {Promise<Models.Index>}
|
599
|
+
*/
|
600
|
+
getIndex(databaseId: string, collectionId: string, key: string): Promise<Models.Index>;
|
601
|
+
/**
|
602
|
+
* Delete index
|
603
|
+
*
|
604
|
+
* Delete an index.
|
605
|
+
*
|
606
|
+
* @param {string} databaseId
|
607
|
+
* @param {string} collectionId
|
608
|
+
* @param {string} key
|
609
|
+
* @throws {AppcondaException}
|
610
|
+
* @returns {Promise<{}>}
|
611
|
+
*/
|
612
|
+
deleteIndex(databaseId: string, collectionId: string, key: string): Promise<{}>;
|
613
|
+
}
|