@appwrite.io/console 1.10.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yml +9 -8
- package/CHANGELOG.md +10 -0
- package/LICENSE +1 -1
- package/README.md +4 -4
- package/dist/cjs/sdk.js +15258 -6062
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +15256 -6063
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +15258 -6062
- package/docs/examples/account/create-billing-address.md +8 -8
- package/docs/examples/account/create-email-password-session.md +4 -4
- package/docs/examples/account/create-email-token.md +5 -5
- package/docs/examples/account/{update-magic-u-r-l-session.md → create-email-verification.md} +3 -4
- package/docs/examples/account/{update-m-f-a.md → create-jwt.md} +3 -3
- package/docs/examples/account/{create-magic-u-r-l-token.md → create-magic-url-token.md} +6 -6
- package/docs/examples/account/create-mfa-authenticator.md +3 -3
- package/docs/examples/account/create-mfa-challenge.md +3 -3
- package/docs/examples/account/create-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-o-auth2token.md → create-o-auth-2-session.md} +6 -6
- package/docs/examples/account/{create-o-auth2session.md → create-o-auth-2-token.md} +6 -6
- package/docs/examples/account/create-phone-token.md +4 -4
- package/docs/examples/account/create-push-target.md +5 -5
- package/docs/examples/account/create-recovery.md +4 -4
- package/docs/examples/account/create-session.md +4 -4
- package/docs/examples/account/create-verification.md +3 -3
- package/docs/examples/account/create.md +6 -6
- package/docs/examples/account/delete-billing-address.md +3 -3
- package/docs/examples/account/delete-identity.md +3 -3
- package/docs/examples/account/delete-mfa-authenticator.md +3 -3
- package/docs/examples/account/delete-payment-method.md +3 -3
- package/docs/examples/account/delete-push-target.md +3 -3
- package/docs/examples/account/delete-session.md +3 -3
- package/docs/examples/account/get-billing-address.md +3 -3
- package/docs/examples/account/get-coupon.md +3 -3
- package/docs/examples/account/get-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/get-payment-method.md +3 -3
- package/docs/examples/account/get-session.md +3 -3
- package/docs/examples/account/list-billing-addresses.md +3 -3
- package/docs/examples/account/list-identities.md +4 -3
- package/docs/examples/account/list-invoices.md +3 -3
- package/docs/examples/account/list-logs.md +4 -3
- package/docs/examples/account/list-mfa-factors.md +1 -1
- package/docs/examples/account/list-payment-methods.md +3 -3
- package/docs/examples/account/update-billing-address.md +9 -9
- package/docs/examples/account/update-email-verification.md +14 -0
- package/docs/examples/account/update-email.md +4 -4
- package/docs/examples/account/update-magic-url-session.md +14 -0
- package/docs/examples/account/update-mfa-authenticator.md +4 -4
- package/docs/examples/account/update-mfa-challenge.md +4 -4
- package/docs/examples/account/update-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-j-w-t.md → update-mfa.md} +3 -1
- package/docs/examples/account/update-name.md +3 -3
- package/docs/examples/account/update-password.md +4 -4
- package/docs/examples/account/update-payment-method-mandate-options.md +3 -3
- package/docs/examples/account/update-payment-method-provider.md +6 -5
- package/docs/examples/account/update-payment-method.md +6 -5
- package/docs/examples/account/update-phone-session.md +4 -4
- package/docs/examples/account/update-phone-verification.md +4 -4
- package/docs/examples/account/update-phone.md +4 -4
- package/docs/examples/account/update-prefs.md +7 -3
- package/docs/examples/account/update-push-target.md +4 -4
- package/docs/examples/account/update-recovery.md +5 -5
- package/docs/examples/account/update-session.md +3 -3
- package/docs/examples/account/update-verification.md +4 -4
- package/docs/examples/assistant/chat.md +3 -3
- package/docs/examples/avatars/get-browser.md +6 -6
- package/docs/examples/avatars/get-credit-card.md +6 -6
- package/docs/examples/avatars/get-favicon.md +3 -3
- package/docs/examples/avatars/get-flag.md +6 -6
- package/docs/examples/avatars/get-image.md +5 -5
- package/docs/examples/avatars/get-initials.md +6 -6
- package/docs/examples/avatars/{get-q-r.md → get-qr.md} +6 -6
- package/docs/examples/avatars/get-screenshot.md +35 -0
- package/docs/examples/backups/create-archive.md +4 -4
- package/docs/examples/backups/create-policy.md +9 -9
- package/docs/examples/backups/create-restoration.md +6 -6
- package/docs/examples/backups/delete-archive.md +3 -3
- package/docs/examples/backups/delete-policy.md +3 -3
- package/docs/examples/backups/get-archive.md +3 -3
- package/docs/examples/backups/get-policy.md +3 -3
- package/docs/examples/backups/get-restoration.md +3 -3
- package/docs/examples/backups/list-archives.md +3 -3
- package/docs/examples/backups/list-policies.md +3 -3
- package/docs/examples/backups/list-restorations.md +3 -3
- package/docs/examples/backups/update-policy.md +7 -7
- package/docs/examples/console/create-program-membership.md +3 -3
- package/docs/examples/console/create-source.md +7 -7
- package/docs/examples/console/get-campaign.md +3 -3
- package/docs/examples/console/get-coupon.md +3 -3
- package/docs/examples/console/{plans.md → get-plan.md} +3 -1
- package/docs/examples/console/get-plans.md +13 -0
- package/docs/examples/console/{regions.md → get-program.md} +3 -1
- package/docs/examples/console/get-regions.md +13 -0
- package/docs/examples/console/get-resource.md +4 -4
- package/docs/examples/console/suggest-columns.md +17 -0
- package/docs/examples/console/suggest-indexes.md +16 -0
- package/docs/examples/databases/create-boolean-attribute.md +8 -8
- package/docs/examples/databases/create-collection.md +11 -9
- package/docs/examples/databases/create-datetime-attribute.md +8 -8
- package/docs/examples/databases/create-document.md +15 -8
- package/docs/examples/databases/create-documents.md +6 -5
- package/docs/examples/databases/create-email-attribute.md +8 -8
- package/docs/examples/databases/create-enum-attribute.md +9 -9
- package/docs/examples/databases/create-float-attribute.md +10 -10
- package/docs/examples/databases/create-index.md +9 -9
- package/docs/examples/databases/create-integer-attribute.md +10 -10
- package/docs/examples/databases/create-ip-attribute.md +8 -8
- package/docs/examples/databases/create-line-attribute.md +17 -0
- package/docs/examples/databases/create-operations.md +24 -0
- package/docs/examples/databases/create-point-attribute.md +17 -0
- package/docs/examples/databases/create-polygon-attribute.md +17 -0
- package/docs/examples/databases/create-relationship-attribute.md +10 -10
- package/docs/examples/databases/create-string-attribute.md +10 -10
- package/docs/examples/databases/create-transaction.md +13 -0
- package/docs/examples/databases/create-url-attribute.md +8 -8
- package/docs/examples/databases/create.md +5 -5
- package/docs/examples/databases/decrement-document-attribute.md +9 -8
- package/docs/examples/databases/delete-attribute.md +5 -5
- package/docs/examples/databases/delete-collection.md +4 -4
- package/docs/examples/databases/delete-document.md +6 -5
- package/docs/examples/databases/delete-documents.md +6 -5
- package/docs/examples/databases/delete-index.md +5 -5
- package/docs/examples/databases/{get-database-usage.md → delete-transaction.md} +4 -5
- package/docs/examples/databases/delete.md +3 -3
- package/docs/examples/databases/get-attribute.md +5 -5
- package/docs/examples/databases/get-collection-usage.md +6 -6
- package/docs/examples/databases/get-collection.md +4 -4
- package/docs/examples/databases/get-document.md +7 -6
- package/docs/examples/databases/get-index.md +5 -5
- package/docs/examples/databases/get-transaction.md +13 -0
- package/docs/examples/databases/get-usage.md +5 -4
- package/docs/examples/databases/get.md +3 -3
- package/docs/examples/databases/increment-document-attribute.md +9 -8
- package/docs/examples/databases/list-attributes.md +6 -5
- package/docs/examples/databases/list-collection-logs.md +5 -5
- package/docs/examples/databases/list-collections.md +6 -5
- package/docs/examples/databases/list-document-logs.md +6 -6
- package/docs/examples/databases/list-documents.md +7 -5
- package/docs/examples/databases/list-indexes.md +6 -5
- package/docs/examples/databases/list-logs.md +4 -4
- package/docs/examples/databases/list-transactions.md +13 -0
- package/docs/examples/databases/list-usage.md +13 -0
- package/docs/examples/databases/list.md +5 -4
- package/docs/examples/databases/update-boolean-attribute.md +8 -8
- package/docs/examples/databases/update-collection.md +9 -9
- package/docs/examples/databases/update-datetime-attribute.md +8 -8
- package/docs/examples/databases/update-document.md +15 -8
- package/docs/examples/databases/update-documents.md +13 -6
- package/docs/examples/databases/update-email-attribute.md +8 -8
- package/docs/examples/databases/update-enum-attribute.md +9 -9
- package/docs/examples/databases/update-float-attribute.md +10 -10
- package/docs/examples/databases/update-integer-attribute.md +10 -10
- package/docs/examples/databases/update-ip-attribute.md +8 -8
- package/docs/examples/databases/update-line-attribute.md +18 -0
- package/docs/examples/databases/update-point-attribute.md +18 -0
- package/docs/examples/databases/update-polygon-attribute.md +18 -0
- package/docs/examples/databases/update-relationship-attribute.md +7 -7
- package/docs/examples/databases/update-string-attribute.md +9 -9
- package/docs/examples/databases/update-transaction.md +15 -0
- package/docs/examples/databases/update-url-attribute.md +8 -8
- package/docs/examples/databases/update.md +5 -5
- package/docs/examples/databases/upsert-document.md +15 -8
- package/docs/examples/databases/upsert-documents.md +6 -5
- package/docs/examples/domains/create-preset-google-workspace.md +3 -3
- package/docs/examples/domains/create-preset-i-cloud.md +3 -3
- package/docs/examples/domains/create-preset-mailgun.md +3 -3
- package/docs/examples/domains/create-preset-outlook.md +3 -3
- package/docs/examples/domains/create-preset-proton-mail.md +3 -3
- package/docs/examples/domains/create-preset-zoho.md +3 -3
- package/docs/examples/domains/create-record-a.md +7 -7
- package/docs/examples/domains/{create-record-a-a-a-a.md → create-record-aaaa.md} +7 -7
- package/docs/examples/domains/create-record-alias.md +7 -7
- package/docs/examples/domains/{create-record-n-s.md → create-record-caa.md} +7 -7
- package/docs/examples/domains/{create-record-c-a-a.md → create-record-cname.md} +7 -7
- package/docs/examples/domains/{create-record-h-t-t-p-s.md → create-record-https.md} +7 -7
- package/docs/examples/domains/create-record-mx.md +18 -0
- package/docs/examples/domains/create-record-ns.md +17 -0
- package/docs/examples/domains/create-record-srv.md +20 -0
- package/docs/examples/domains/{create-record-c-n-a-m-e.md → create-record-txt.md} +7 -7
- package/docs/examples/domains/create.md +4 -4
- package/docs/examples/domains/delete-record.md +4 -4
- package/docs/examples/domains/delete.md +3 -3
- package/docs/examples/domains/get-preset-google-workspace.md +3 -3
- package/docs/examples/domains/get-preset-i-cloud.md +3 -3
- package/docs/examples/domains/get-preset-mailgun.md +3 -3
- package/docs/examples/domains/get-preset-outlook.md +3 -3
- package/docs/examples/domains/get-preset-proton-mail.md +3 -3
- package/docs/examples/domains/get-preset-zoho.md +3 -3
- package/docs/examples/domains/get-record.md +4 -4
- package/docs/examples/domains/get-zone.md +3 -3
- package/docs/examples/domains/get.md +3 -3
- package/docs/examples/domains/list-records.md +4 -4
- package/docs/examples/domains/list.md +4 -4
- package/docs/examples/domains/update-nameservers.md +3 -3
- package/docs/examples/domains/update-record-a.md +8 -8
- package/docs/examples/domains/update-record-aaaa.md +18 -0
- package/docs/examples/domains/update-record-alias.md +8 -8
- package/docs/examples/domains/update-record-caa.md +18 -0
- package/docs/examples/domains/update-record-cname.md +18 -0
- package/docs/examples/domains/update-record-https.md +18 -0
- package/docs/examples/domains/update-record-mx.md +19 -0
- package/docs/examples/domains/update-record-ns.md +18 -0
- package/docs/examples/domains/update-record-srv.md +21 -0
- package/docs/examples/domains/update-record-txt.md +18 -0
- package/docs/examples/domains/update-team.md +4 -4
- package/docs/examples/domains/update-zone.md +4 -4
- package/docs/examples/functions/create-deployment.md +7 -7
- package/docs/examples/functions/create-duplicate-deployment.md +5 -5
- package/docs/examples/functions/create-execution.md +9 -9
- package/docs/examples/functions/create-template-deployment.md +10 -9
- package/docs/examples/functions/create-variable.md +6 -6
- package/docs/examples/functions/create-vcs-deployment.md +7 -7
- package/docs/examples/functions/create.md +21 -21
- package/docs/examples/functions/delete-deployment.md +4 -4
- package/docs/examples/functions/delete-execution.md +4 -4
- package/docs/examples/functions/delete-variable.md +4 -4
- package/docs/examples/functions/delete.md +3 -3
- package/docs/examples/functions/get-deployment-download.md +5 -5
- package/docs/examples/functions/get-deployment.md +4 -4
- package/docs/examples/functions/get-execution.md +4 -4
- package/docs/examples/functions/get-template.md +3 -3
- package/docs/examples/functions/get-usage.md +5 -5
- package/docs/examples/functions/get-variable.md +4 -4
- package/docs/examples/functions/get.md +3 -3
- package/docs/examples/functions/list-deployments.md +6 -5
- package/docs/examples/functions/list-executions.md +5 -4
- package/docs/examples/functions/list-templates.md +7 -6
- package/docs/examples/functions/list-usage.md +4 -4
- package/docs/examples/functions/list-variables.md +3 -3
- package/docs/examples/functions/list.md +5 -4
- package/docs/examples/functions/update-deployment-status.md +4 -4
- package/docs/examples/functions/update-function-deployment.md +4 -4
- package/docs/examples/functions/update-variable.md +7 -7
- package/docs/examples/functions/update.md +21 -21
- package/docs/examples/graphql/mutation.md +3 -3
- package/docs/examples/graphql/query.md +3 -3
- package/docs/examples/health/get-certificate.md +3 -3
- package/docs/examples/health/get-failed-jobs.md +5 -5
- package/docs/examples/health/get-queue-billing-project-aggregation.md +3 -3
- package/docs/examples/health/get-queue-billing-team-aggregation.md +3 -3
- package/docs/examples/health/get-queue-builds.md +3 -3
- package/docs/examples/health/get-queue-certificates.md +3 -3
- package/docs/examples/health/get-queue-databases.md +4 -4
- package/docs/examples/health/get-queue-deletes.md +3 -3
- package/docs/examples/health/get-queue-functions.md +3 -3
- package/docs/examples/health/get-queue-logs.md +3 -3
- package/docs/examples/health/get-queue-mails.md +3 -3
- package/docs/examples/health/get-queue-messaging.md +3 -3
- package/docs/examples/health/get-queue-migrations.md +3 -3
- package/docs/examples/health/get-queue-priority-builds.md +3 -3
- package/docs/examples/health/get-queue-region-manager.md +3 -3
- package/docs/examples/health/get-queue-stats-resources.md +3 -3
- package/docs/examples/health/get-queue-threats.md +13 -0
- package/docs/examples/health/get-queue-usage.md +3 -3
- package/docs/examples/health/get-queue-webhooks.md +3 -3
- package/docs/examples/messaging/create-apns-provider.md +10 -10
- package/docs/examples/messaging/create-email.md +14 -14
- package/docs/examples/messaging/create-fcm-provider.md +6 -6
- package/docs/examples/messaging/create-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{create-msg91provider.md → create-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/create-push.md +21 -21
- package/docs/examples/messaging/create-resend-provider.md +20 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/create-sms.md +9 -9
- package/docs/examples/messaging/create-smtp-provider.md +16 -16
- package/docs/examples/messaging/create-subscriber.md +5 -5
- package/docs/examples/messaging/create-telesign-provider.md +8 -8
- package/docs/examples/messaging/create-textmagic-provider.md +8 -8
- package/docs/examples/messaging/create-topic.md +5 -5
- package/docs/examples/messaging/create-twilio-provider.md +8 -8
- package/docs/examples/messaging/create-vonage-provider.md +8 -8
- package/docs/examples/messaging/delete-provider.md +3 -3
- package/docs/examples/messaging/delete-subscriber.md +4 -4
- package/docs/examples/messaging/delete-topic.md +3 -3
- package/docs/examples/messaging/delete.md +3 -3
- package/docs/examples/messaging/get-message.md +3 -3
- package/docs/examples/messaging/get-provider.md +3 -3
- package/docs/examples/messaging/get-subscriber.md +4 -4
- package/docs/examples/messaging/get-topic.md +3 -3
- package/docs/examples/messaging/list-message-logs.md +5 -4
- package/docs/examples/messaging/list-messages.md +5 -4
- package/docs/examples/messaging/list-provider-logs.md +5 -4
- package/docs/examples/messaging/list-providers.md +5 -4
- package/docs/examples/messaging/list-subscriber-logs.md +5 -4
- package/docs/examples/messaging/list-subscribers.md +6 -5
- package/docs/examples/messaging/list-targets.md +5 -4
- package/docs/examples/messaging/list-topic-logs.md +5 -4
- package/docs/examples/messaging/list-topics.md +5 -4
- package/docs/examples/messaging/update-apns-provider.md +10 -10
- package/docs/examples/messaging/update-email.md +14 -14
- package/docs/examples/messaging/update-fcm-provider.md +6 -6
- package/docs/examples/messaging/update-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{update-msg91provider.md → update-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/update-push.md +21 -21
- package/docs/examples/messaging/update-resend-provider.md +20 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/update-sms.md +9 -9
- package/docs/examples/messaging/update-smtp-provider.md +16 -16
- package/docs/examples/messaging/update-telesign-provider.md +8 -8
- package/docs/examples/messaging/update-textmagic-provider.md +8 -8
- package/docs/examples/messaging/update-topic.md +5 -5
- package/docs/examples/messaging/update-twilio-provider.md +8 -8
- package/docs/examples/messaging/update-vonage-provider.md +8 -8
- package/docs/examples/migrations/create-appwrite-migration.md +6 -6
- package/docs/examples/migrations/create-csv-export.md +21 -0
- package/docs/examples/migrations/{create-csv-migration.md → create-csv-import.md} +6 -5
- package/docs/examples/migrations/create-firebase-migration.md +4 -4
- package/docs/examples/migrations/create-n-host-migration.md +10 -10
- package/docs/examples/migrations/create-supabase-migration.md +9 -9
- package/docs/examples/migrations/delete.md +3 -3
- package/docs/examples/migrations/get-appwrite-report.md +6 -6
- package/docs/examples/migrations/get-firebase-report.md +4 -4
- package/docs/examples/migrations/get-n-host-report.md +10 -10
- package/docs/examples/migrations/get-supabase-report.md +9 -9
- package/docs/examples/migrations/get.md +3 -3
- package/docs/examples/migrations/list.md +5 -4
- package/docs/examples/migrations/retry.md +3 -3
- package/docs/examples/organizations/add-credit.md +4 -4
- package/docs/examples/organizations/cancel-downgrade.md +3 -3
- package/docs/examples/organizations/create-downgrade-feedback.md +17 -0
- package/docs/examples/organizations/create-invoice-payment.md +5 -5
- package/docs/examples/organizations/create.md +13 -12
- package/docs/examples/organizations/delete-backup-payment-method.md +3 -3
- package/docs/examples/organizations/delete-billing-address.md +3 -3
- package/docs/examples/organizations/delete-default-payment-method.md +3 -3
- package/docs/examples/organizations/delete.md +3 -3
- package/docs/examples/organizations/estimation-create-organization.md +8 -7
- package/docs/examples/organizations/estimation-delete-organization.md +3 -3
- package/docs/examples/organizations/estimation-update-plan.md +7 -7
- package/docs/examples/organizations/get-aggregation.md +6 -4
- package/docs/examples/organizations/get-available-credits.md +3 -3
- package/docs/examples/organizations/get-billing-address.md +4 -4
- package/docs/examples/organizations/get-credit.md +4 -4
- package/docs/examples/organizations/get-invoice-download.md +4 -4
- package/docs/examples/organizations/get-invoice-view.md +4 -4
- package/docs/examples/organizations/get-invoice.md +4 -4
- package/docs/examples/organizations/get-payment-method.md +4 -4
- package/docs/examples/organizations/get-plan.md +3 -3
- package/docs/examples/organizations/get-scopes.md +3 -3
- package/docs/examples/organizations/get-usage.md +5 -5
- package/docs/examples/organizations/list-aggregations.md +4 -4
- package/docs/examples/organizations/list-credits.md +4 -4
- package/docs/examples/organizations/list-invoices.md +4 -4
- package/docs/examples/organizations/list.md +4 -4
- package/docs/examples/organizations/set-backup-payment-method.md +4 -4
- package/docs/examples/organizations/set-billing-address.md +4 -4
- package/docs/examples/organizations/set-billing-email.md +4 -4
- package/docs/examples/organizations/set-billing-tax-id.md +4 -4
- package/docs/examples/organizations/set-default-payment-method.md +4 -4
- package/docs/examples/organizations/update-budget.md +5 -5
- package/docs/examples/organizations/update-plan.md +11 -11
- package/docs/examples/organizations/update-projects.md +4 -4
- package/docs/examples/organizations/validate-invoice.md +4 -4
- package/docs/examples/organizations/validate-payment.md +4 -4
- package/docs/examples/project/create-variable.md +5 -5
- package/docs/examples/project/delete-variable.md +3 -3
- package/docs/examples/project/get-usage.md +5 -5
- package/docs/examples/project/get-variable.md +3 -3
- package/docs/examples/project/update-variable.md +6 -6
- package/docs/examples/projects/create-dev-key.md +5 -5
- package/docs/examples/projects/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/projects/create-key.md +6 -6
- package/docs/examples/projects/create-platform.md +8 -8
- package/docs/examples/projects/create-smtp-test.md +12 -12
- package/docs/examples/projects/create-webhook.md +10 -10
- package/docs/examples/projects/create.md +16 -16
- package/docs/examples/projects/delete-dev-key.md +4 -4
- package/docs/examples/projects/delete-email-template.md +5 -5
- package/docs/examples/projects/delete-key.md +4 -4
- package/docs/examples/projects/delete-platform.md +4 -4
- package/docs/examples/projects/delete-sms-template.md +5 -5
- package/docs/examples/projects/delete-webhook.md +4 -4
- package/docs/examples/projects/delete.md +3 -3
- package/docs/examples/projects/get-dev-key.md +4 -4
- package/docs/examples/projects/get-email-template.md +5 -5
- package/docs/examples/projects/get-key.md +4 -4
- package/docs/examples/projects/get-platform.md +4 -4
- package/docs/examples/projects/get-sms-template.md +5 -5
- package/docs/examples/projects/get-webhook.md +4 -4
- package/docs/examples/projects/get.md +3 -3
- package/docs/examples/projects/list-dev-keys.md +4 -4
- package/docs/examples/projects/list-keys.md +4 -3
- package/docs/examples/projects/list-platforms.md +4 -3
- package/docs/examples/projects/list-webhooks.md +4 -3
- package/docs/examples/projects/list.md +5 -4
- package/docs/examples/projects/update-api-status-all.md +4 -4
- package/docs/examples/projects/update-api-status.md +6 -6
- package/docs/examples/projects/update-auth-duration.md +4 -4
- package/docs/examples/projects/update-auth-limit.md +4 -4
- package/docs/examples/projects/update-auth-password-dictionary.md +4 -4
- package/docs/examples/projects/update-auth-password-history.md +4 -4
- package/docs/examples/projects/update-auth-sessions-limit.md +4 -4
- package/docs/examples/projects/update-auth-status.md +5 -5
- package/docs/examples/projects/update-dev-key.md +6 -6
- package/docs/examples/projects/update-email-template.md +10 -10
- package/docs/examples/projects/update-key.md +7 -7
- package/docs/examples/projects/update-memberships-privacy.md +6 -6
- package/docs/examples/projects/update-mock-numbers.md +4 -4
- package/docs/examples/projects/{update-o-auth2.md → update-o-auth-2.md} +7 -7
- package/docs/examples/projects/update-personal-data-check.md +4 -4
- package/docs/examples/projects/update-platform.md +8 -8
- package/docs/examples/projects/update-service-status-all.md +4 -4
- package/docs/examples/projects/update-service-status.md +5 -5
- package/docs/examples/projects/update-session-alerts.md +4 -4
- package/docs/examples/projects/update-session-invalidation.md +14 -0
- package/docs/examples/projects/update-sms-template.md +6 -6
- package/docs/examples/projects/update-smtp.md +12 -12
- package/docs/examples/projects/update-status.md +14 -0
- package/docs/examples/projects/update-team.md +4 -4
- package/docs/examples/projects/update-webhook-signature.md +4 -4
- package/docs/examples/projects/update-webhook.md +11 -11
- package/docs/examples/projects/update.md +13 -13
- package/docs/examples/proxy/{create-a-p-i-rule.md → create-api-rule.md} +3 -3
- package/docs/examples/proxy/create-function-rule.md +5 -5
- package/docs/examples/proxy/create-redirect-rule.md +8 -8
- package/docs/examples/proxy/create-site-rule.md +5 -5
- package/docs/examples/proxy/delete-rule.md +3 -3
- package/docs/examples/proxy/get-rule.md +3 -3
- package/docs/examples/proxy/list-rules.md +5 -4
- package/docs/examples/proxy/update-rule-verification.md +3 -3
- package/docs/examples/sites/create-deployment.md +8 -8
- package/docs/examples/sites/create-duplicate-deployment.md +4 -4
- package/docs/examples/sites/create-template-deployment.md +10 -9
- package/docs/examples/sites/create-variable.md +6 -6
- package/docs/examples/sites/create-vcs-deployment.md +7 -7
- package/docs/examples/sites/create.md +21 -21
- package/docs/examples/sites/delete-deployment.md +4 -4
- package/docs/examples/sites/delete-log.md +4 -4
- package/docs/examples/sites/delete-variable.md +4 -4
- package/docs/examples/sites/delete.md +3 -3
- package/docs/examples/sites/get-deployment-download.md +5 -5
- package/docs/examples/sites/get-deployment.md +4 -4
- package/docs/examples/sites/get-log.md +4 -4
- package/docs/examples/sites/get-template.md +3 -3
- package/docs/examples/sites/get-usage.md +5 -5
- package/docs/examples/sites/get-variable.md +4 -4
- package/docs/examples/sites/get.md +3 -3
- package/docs/examples/sites/list-deployments.md +6 -5
- package/docs/examples/sites/list-logs.md +5 -4
- package/docs/examples/sites/list-templates.md +6 -6
- package/docs/examples/sites/list-usage.md +4 -4
- package/docs/examples/sites/list-variables.md +3 -3
- package/docs/examples/sites/list.md +5 -4
- package/docs/examples/sites/update-deployment-status.md +4 -4
- package/docs/examples/sites/update-site-deployment.md +4 -4
- package/docs/examples/sites/update-variable.md +7 -7
- package/docs/examples/sites/update.md +21 -21
- package/docs/examples/storage/create-bucket.md +14 -13
- package/docs/examples/storage/create-file.md +7 -7
- package/docs/examples/storage/delete-bucket.md +3 -3
- package/docs/examples/storage/delete-file.md +4 -4
- package/docs/examples/storage/get-bucket-usage.md +5 -5
- package/docs/examples/storage/get-bucket.md +3 -3
- package/docs/examples/storage/get-file-download.md +5 -5
- package/docs/examples/storage/get-file-preview.md +16 -16
- package/docs/examples/storage/get-file-view.md +5 -5
- package/docs/examples/storage/get-file.md +4 -4
- package/docs/examples/storage/get-usage.md +4 -4
- package/docs/examples/storage/list-buckets.md +5 -4
- package/docs/examples/storage/list-files.md +6 -5
- package/docs/examples/storage/update-bucket.md +14 -13
- package/docs/examples/storage/update-file.md +7 -7
- package/docs/examples/tablesdb/create-boolean-column.md +18 -0
- package/docs/examples/tablesdb/create-datetime-column.md +18 -0
- package/docs/examples/tablesdb/create-email-column.md +18 -0
- package/docs/examples/tablesdb/create-enum-column.md +19 -0
- package/docs/examples/tablesdb/create-float-column.md +20 -0
- package/docs/examples/tablesdb/create-index.md +19 -0
- package/docs/examples/tablesdb/create-integer-column.md +20 -0
- package/docs/examples/tablesdb/create-ip-column.md +18 -0
- package/docs/examples/tablesdb/create-line-column.md +17 -0
- package/docs/examples/tablesdb/create-operations.md +24 -0
- package/docs/examples/tablesdb/create-point-column.md +17 -0
- package/docs/examples/tablesdb/create-polygon-column.md +17 -0
- package/docs/examples/tablesdb/create-relationship-column.md +20 -0
- package/docs/examples/tablesdb/create-row.md +24 -0
- package/docs/examples/tablesdb/create-rows.md +16 -0
- package/docs/examples/tablesdb/create-string-column.md +20 -0
- package/docs/examples/tablesdb/create-table.md +20 -0
- package/docs/examples/tablesdb/create-transaction.md +13 -0
- package/docs/examples/tablesdb/create-url-column.md +18 -0
- package/docs/examples/tablesdb/create.md +15 -0
- package/docs/examples/tablesdb/decrement-row-column.md +19 -0
- package/docs/examples/tablesdb/delete-column.md +15 -0
- package/docs/examples/tablesdb/delete-index.md +15 -0
- package/docs/examples/tablesdb/delete-row.md +16 -0
- package/docs/examples/tablesdb/delete-rows.md +16 -0
- package/docs/examples/tablesdb/delete-table.md +14 -0
- package/docs/examples/tablesdb/delete-transaction.md +13 -0
- package/docs/examples/tablesdb/delete.md +13 -0
- package/docs/examples/tablesdb/get-column.md +15 -0
- package/docs/examples/tablesdb/get-index.md +15 -0
- package/docs/examples/tablesdb/get-row.md +17 -0
- package/docs/examples/tablesdb/get-table-usage.md +15 -0
- package/docs/examples/tablesdb/get-table.md +14 -0
- package/docs/examples/tablesdb/get-transaction.md +13 -0
- package/docs/examples/tablesdb/get-usage.md +14 -0
- package/docs/examples/tablesdb/get.md +13 -0
- package/docs/examples/tablesdb/increment-row-column.md +19 -0
- package/docs/examples/tablesdb/list-columns.md +16 -0
- package/docs/examples/tablesdb/list-indexes.md +16 -0
- package/docs/examples/tablesdb/list-row-logs.md +16 -0
- package/docs/examples/tablesdb/list-rows.md +17 -0
- package/docs/examples/tablesdb/list-table-logs.md +15 -0
- package/docs/examples/tablesdb/list-tables.md +16 -0
- package/docs/examples/tablesdb/list-transactions.md +13 -0
- package/docs/examples/tablesdb/list-usage.md +13 -0
- package/docs/examples/tablesdb/list.md +15 -0
- package/docs/examples/tablesdb/update-boolean-column.md +18 -0
- package/docs/examples/tablesdb/update-datetime-column.md +18 -0
- package/docs/examples/tablesdb/update-email-column.md +18 -0
- package/docs/examples/tablesdb/update-enum-column.md +19 -0
- package/docs/examples/tablesdb/update-float-column.md +20 -0
- package/docs/examples/tablesdb/update-integer-column.md +20 -0
- package/docs/examples/tablesdb/update-ip-column.md +18 -0
- package/docs/examples/tablesdb/update-line-column.md +18 -0
- package/docs/examples/tablesdb/update-point-column.md +18 -0
- package/docs/examples/tablesdb/update-polygon-column.md +18 -0
- package/docs/examples/tablesdb/update-relationship-column.md +17 -0
- package/docs/examples/tablesdb/update-row.md +24 -0
- package/docs/examples/tablesdb/update-rows.md +23 -0
- package/docs/examples/tablesdb/update-string-column.md +19 -0
- package/docs/examples/tablesdb/update-table.md +18 -0
- package/docs/examples/tablesdb/update-transaction.md +15 -0
- package/docs/examples/tablesdb/update-url-column.md +18 -0
- package/docs/examples/tablesdb/update.md +15 -0
- package/docs/examples/tablesdb/upsert-row.md +24 -0
- package/docs/examples/tablesdb/upsert-rows.md +16 -0
- package/docs/examples/teams/create-membership.md +9 -9
- package/docs/examples/teams/create.md +5 -5
- package/docs/examples/teams/delete-membership.md +4 -4
- package/docs/examples/teams/delete.md +3 -3
- package/docs/examples/teams/get-membership.md +4 -4
- package/docs/examples/teams/get-prefs.md +3 -3
- package/docs/examples/teams/get.md +3 -3
- package/docs/examples/teams/list-logs.md +5 -4
- package/docs/examples/teams/list-memberships.md +6 -5
- package/docs/examples/teams/list.md +5 -4
- package/docs/examples/teams/update-membership-status.md +6 -6
- package/docs/examples/teams/update-membership.md +5 -5
- package/docs/examples/teams/update-name.md +4 -4
- package/docs/examples/teams/update-prefs.md +4 -4
- package/docs/examples/tokens/create-file-token.md +5 -5
- package/docs/examples/tokens/delete.md +3 -3
- package/docs/examples/tokens/get.md +3 -3
- package/docs/examples/tokens/list.md +6 -5
- package/docs/examples/tokens/update.md +4 -4
- package/docs/examples/users/{create-m-d5user.md → create-argon-2-user.md} +6 -6
- package/docs/examples/users/create-bcrypt-user.md +6 -6
- package/docs/examples/users/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/users/{create-argon2user.md → create-md-5-user.md} +6 -6
- package/docs/examples/users/create-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/{create-p-h-pass-user.md → create-ph-pass-user.md} +6 -6
- package/docs/examples/users/create-scrypt-modified-user.md +9 -9
- package/docs/examples/users/create-scrypt-user.md +11 -11
- package/docs/examples/users/create-session.md +3 -3
- package/docs/examples/users/{create-s-h-a-user.md → create-sha-user.md} +7 -7
- package/docs/examples/users/create-target.md +8 -8
- package/docs/examples/users/create-token.md +5 -5
- package/docs/examples/users/create.md +7 -7
- package/docs/examples/users/delete-identity.md +3 -3
- package/docs/examples/users/delete-mfa-authenticator.md +4 -4
- package/docs/examples/users/delete-session.md +4 -4
- package/docs/examples/users/delete-sessions.md +3 -3
- package/docs/examples/users/delete-target.md +4 -4
- package/docs/examples/users/delete.md +3 -3
- package/docs/examples/users/get-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/get-prefs.md +3 -3
- package/docs/examples/users/get-target.md +4 -4
- package/docs/examples/users/get-usage.md +4 -4
- package/docs/examples/users/get.md +3 -3
- package/docs/examples/users/list-identities.md +5 -4
- package/docs/examples/users/list-logs.md +5 -4
- package/docs/examples/users/list-memberships.md +6 -5
- package/docs/examples/users/list-mfa-factors.md +3 -3
- package/docs/examples/users/list-sessions.md +4 -3
- package/docs/examples/users/list-targets.md +5 -4
- package/docs/examples/users/list.md +5 -4
- package/docs/examples/users/update-email-verification.md +4 -4
- package/docs/examples/users/update-email.md +4 -4
- package/docs/examples/users/update-labels.md +4 -4
- package/docs/examples/users/update-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/update-mfa.md +4 -4
- package/docs/examples/users/update-name.md +4 -4
- package/docs/examples/users/update-password.md +4 -4
- package/docs/examples/users/update-phone-verification.md +4 -4
- package/docs/examples/users/update-phone.md +4 -4
- package/docs/examples/users/update-prefs.md +4 -4
- package/docs/examples/users/update-status.md +4 -4
- package/docs/examples/users/update-target.md +7 -7
- package/docs/examples/vcs/create-repository-detection.md +6 -6
- package/docs/examples/vcs/create-repository.md +5 -5
- package/docs/examples/vcs/delete-installation.md +3 -3
- package/docs/examples/vcs/get-installation.md +3 -3
- package/docs/examples/vcs/get-repository-contents.md +6 -6
- package/docs/examples/vcs/get-repository.md +4 -4
- package/docs/examples/vcs/list-installations.md +5 -4
- package/docs/examples/vcs/list-repositories.md +6 -5
- package/docs/examples/vcs/list-repository-branches.md +4 -4
- package/docs/examples/vcs/update-external-deployments.md +5 -5
- package/package.json +4 -4
- package/src/client.ts +71 -7
- package/src/enums/api-service.ts +1 -0
- package/src/enums/attribute-status.ts +7 -0
- package/src/enums/billing-plan-group.ts +5 -0
- package/src/enums/build-runtime.ts +2 -0
- package/src/enums/column-status.ts +7 -0
- package/src/enums/credit-card.ts +1 -1
- package/src/enums/database-type.ts +4 -0
- package/src/enums/deployment-status.ts +7 -0
- package/src/enums/execution-method.ts +1 -0
- package/src/enums/execution-status.ts +7 -0
- package/src/enums/execution-trigger.ts +5 -0
- package/src/enums/framework.ts +1 -0
- package/src/enums/health-antivirus-status.ts +5 -0
- package/src/enums/health-check-status.ts +4 -0
- package/src/enums/index-status.ts +7 -0
- package/src/enums/index-type.ts +1 -0
- package/src/enums/message-status.ts +7 -0
- package/src/enums/o-auth-provider.ts +3 -0
- package/src/enums/platform.ts +4 -0
- package/src/enums/proxy-rule-deployment-resource-type.ts +4 -0
- package/src/enums/proxy-rule-status.ts +6 -0
- package/src/enums/region.ts +3 -0
- package/src/enums/runtime.ts +2 -0
- package/src/enums/status.ts +4 -0
- package/src/enums/template-reference-type.ts +5 -0
- package/src/enums/theme.ts +4 -0
- package/src/enums/timezone.ts +421 -0
- package/src/enums/{user-usage-range.ts → usage-range.ts} +1 -1
- package/src/enums/{v-c-s-deployment-type.ts → vcs-reference-type.ts} +1 -1
- package/src/index.ts +27 -11
- package/src/models.ts +1692 -238
- package/src/operator.ts +308 -0
- package/src/query.ts +246 -2
- package/src/services/account.ts +2205 -223
- package/src/services/assistant.ts +29 -3
- package/src/services/avatars.ts +486 -33
- package/src/services/backups.ts +389 -42
- package/src/services/console.ts +492 -19
- package/src/services/databases.ts +3521 -431
- package/src/services/domains.ts +1684 -197
- package/src/services/functions.ts +1162 -149
- package/src/services/graphql.ts +55 -4
- package/src/services/health.ts +560 -41
- package/src/services/locale.ts +9 -0
- package/src/services/messaging.ts +3367 -380
- package/src/services/migrations.ts +641 -65
- package/src/services/organizations.ts +1323 -128
- package/src/services/project.ts +168 -17
- package/src/services/projects.ts +2742 -266
- package/src/services/proxy.ts +265 -26
- package/src/services/realtime.ts +437 -0
- package/src/services/sites.ts +1098 -140
- package/src/services/storage.ts +651 -82
- package/src/services/tables-db.ts +5439 -0
- package/src/services/teams.ts +512 -55
- package/src/services/tokens.ts +167 -16
- package/src/services/users.ts +1873 -181
- package/src/services/vcs.ts +359 -39
- package/types/client.d.ts +33 -5
- package/types/enums/api-service.d.ts +1 -0
- package/types/enums/attribute-status.d.ts +7 -0
- package/types/enums/billing-plan-group.d.ts +5 -0
- package/types/enums/build-runtime.d.ts +3 -1
- package/types/enums/column-status.d.ts +7 -0
- package/types/enums/credit-card.d.ts +1 -1
- package/types/enums/database-type.d.ts +4 -0
- package/types/enums/deployment-status.d.ts +7 -0
- package/types/enums/execution-method.d.ts +2 -1
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/framework.d.ts +1 -0
- package/types/enums/health-antivirus-status.d.ts +5 -0
- package/types/enums/health-check-status.d.ts +4 -0
- package/types/enums/index-status.d.ts +7 -0
- package/types/enums/index-type.d.ts +2 -1
- package/types/enums/message-status.d.ts +7 -0
- package/types/enums/o-auth-provider.d.ts +4 -1
- package/types/enums/platform.d.ts +4 -0
- package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
- package/types/enums/proxy-rule-status.d.ts +6 -0
- package/types/enums/region.d.ts +4 -1
- package/types/enums/runtime.d.ts +3 -1
- package/types/enums/status.d.ts +4 -0
- package/types/enums/template-reference-type.d.ts +5 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +421 -0
- package/types/enums/{site-usage-range.d.ts → usage-range.d.ts} +1 -1
- package/types/enums/{v-c-s-deployment-type.d.ts → vcs-reference-type.d.ts} +1 -1
- package/types/index.d.ts +27 -11
- package/types/models.d.ts +1664 -245
- package/types/operator.d.ts +180 -0
- package/types/query.d.ts +198 -2
- package/types/services/account.d.ts +985 -123
- package/types/services/assistant.d.ts +13 -2
- package/types/services/avatars.d.ts +244 -26
- package/types/services/backups.d.ts +190 -30
- package/types/services/console.d.ts +201 -14
- package/types/services/databases.d.ts +1731 -284
- package/types/services/domains.d.ts +904 -152
- package/types/services/functions.d.ts +616 -125
- package/types/services/graphql.d.ts +24 -2
- package/types/services/health.d.ts +245 -23
- package/types/services/messaging.d.ts +1660 -271
- package/types/services/migrations.d.ts +319 -53
- package/types/services/organizations.d.ts +635 -97
- package/types/services/project.d.ts +81 -12
- package/types/services/projects.d.ts +1308 -202
- package/types/services/proxy.d.ts +128 -19
- package/types/services/realtime.d.ts +118 -0
- package/types/services/sites.d.ts +577 -116
- package/types/services/storage.d.ts +354 -73
- package/types/services/tables-db.d.ts +2040 -0
- package/types/services/teams.d.ts +260 -44
- package/types/services/tokens.d.ts +80 -12
- package/types/services/users.d.ts +881 -124
- package/types/services/vcs.d.ts +179 -31
- package/docs/examples/domains/create-record-m-x.md +0 -18
- package/docs/examples/domains/create-record-s-r-v.md +0 -20
- package/docs/examples/domains/create-record-t-x-t.md +0 -17
- package/docs/examples/domains/update-record-a-a-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-n-a-m-e.md +0 -18
- package/docs/examples/domains/update-record-h-t-t-p-s.md +0 -18
- package/docs/examples/domains/update-record-m-x.md +0 -19
- package/docs/examples/domains/update-record-n-s.md +0 -18
- package/docs/examples/domains/update-record-s-r-v.md +0 -21
- package/docs/examples/domains/update-record-t-x-t.md +0 -18
- package/src/enums/billing-plan.ts +0 -5
- package/src/enums/database-usage-range.ts +0 -5
- package/src/enums/function-usage-range.ts +0 -5
- package/src/enums/site-usage-range.ts +0 -5
- package/src/enums/storage-usage-range.ts +0 -5
- package/types/enums/billing-plan.d.ts +0 -5
- package/types/enums/database-usage-range.d.ts +0 -5
- package/types/enums/function-usage-range.d.ts +0 -5
- package/types/enums/storage-usage-range.d.ts +0 -5
- package/types/enums/user-usage-range.d.ts +0 -5
- /package/docs/examples/health/{get-d-b.md → get-db.md} +0 -0
- /package/docs/examples/locale/{list-countries-e-u.md → list-countries-eu.md} +0 -0
- /package/src/enums/{s-m-t-p-secure.ts → smtp-secure.ts} +0 -0
- /package/src/enums/{v-c-s-detection-type.ts → vcs-detection-type.ts} +0 -0
- /package/types/enums/{s-m-t-p-secure.d.ts → smtp-secure.d.ts} +0 -0
- /package/types/enums/{v-c-s-detection-type.d.ts → vcs-detection-type.d.ts} +0 -0
package/types/models.d.ts
CHANGED
|
@@ -1,14 +1,41 @@
|
|
|
1
|
+
import { DatabaseType } from "./enums/database-type";
|
|
2
|
+
import { AttributeStatus } from "./enums/attribute-status";
|
|
3
|
+
import { ColumnStatus } from "./enums/column-status";
|
|
4
|
+
import { IndexStatus } from "./enums/index-status";
|
|
5
|
+
import { DeploymentStatus } from "./enums/deployment-status";
|
|
6
|
+
import { ExecutionTrigger } from "./enums/execution-trigger";
|
|
7
|
+
import { ExecutionStatus } from "./enums/execution-status";
|
|
8
|
+
import { PlatformType } from "./enums/platform-type";
|
|
9
|
+
import { HealthAntivirusStatus } from "./enums/health-antivirus-status";
|
|
10
|
+
import { HealthCheckStatus } from "./enums/health-check-status";
|
|
11
|
+
import { ProxyRuleDeploymentResourceType } from "./enums/proxy-rule-deployment-resource-type";
|
|
12
|
+
import { ProxyRuleStatus } from "./enums/proxy-rule-status";
|
|
13
|
+
import { MessageStatus } from "./enums/message-status";
|
|
14
|
+
import { BillingPlanGroup } from "./enums/billing-plan-group";
|
|
1
15
|
/**
|
|
2
16
|
* Appwrite Models
|
|
3
17
|
*/
|
|
4
18
|
export declare namespace Models {
|
|
5
19
|
const __default: unique symbol;
|
|
20
|
+
/**
|
|
21
|
+
* Rows List
|
|
22
|
+
*/
|
|
23
|
+
export type RowList<Row extends Models.Row = Models.DefaultRow> = {
|
|
24
|
+
/**
|
|
25
|
+
* Total number of rows that matched your query.
|
|
26
|
+
*/
|
|
27
|
+
total: number;
|
|
28
|
+
/**
|
|
29
|
+
* List of rows.
|
|
30
|
+
*/
|
|
31
|
+
rows: Row[];
|
|
32
|
+
};
|
|
6
33
|
/**
|
|
7
34
|
* Documents List
|
|
8
35
|
*/
|
|
9
36
|
export type DocumentList<Document extends Models.Document = Models.DefaultDocument> = {
|
|
10
37
|
/**
|
|
11
|
-
* Total number of documents
|
|
38
|
+
* Total number of documents that matched your query.
|
|
12
39
|
*/
|
|
13
40
|
total: number;
|
|
14
41
|
/**
|
|
@@ -16,12 +43,25 @@ export declare namespace Models {
|
|
|
16
43
|
*/
|
|
17
44
|
documents: Document[];
|
|
18
45
|
};
|
|
46
|
+
/**
|
|
47
|
+
* Tables List
|
|
48
|
+
*/
|
|
49
|
+
export type TableList = {
|
|
50
|
+
/**
|
|
51
|
+
* Total number of tables that matched your query.
|
|
52
|
+
*/
|
|
53
|
+
total: number;
|
|
54
|
+
/**
|
|
55
|
+
* List of tables.
|
|
56
|
+
*/
|
|
57
|
+
tables: Table[];
|
|
58
|
+
};
|
|
19
59
|
/**
|
|
20
60
|
* Collections List
|
|
21
61
|
*/
|
|
22
62
|
export type CollectionList = {
|
|
23
63
|
/**
|
|
24
|
-
* Total number of collections
|
|
64
|
+
* Total number of collections that matched your query.
|
|
25
65
|
*/
|
|
26
66
|
total: number;
|
|
27
67
|
/**
|
|
@@ -34,7 +74,7 @@ export declare namespace Models {
|
|
|
34
74
|
*/
|
|
35
75
|
export type DatabaseList = {
|
|
36
76
|
/**
|
|
37
|
-
* Total number of databases
|
|
77
|
+
* Total number of databases that matched your query.
|
|
38
78
|
*/
|
|
39
79
|
total: number;
|
|
40
80
|
/**
|
|
@@ -47,7 +87,7 @@ export declare namespace Models {
|
|
|
47
87
|
*/
|
|
48
88
|
export type IndexList = {
|
|
49
89
|
/**
|
|
50
|
-
* Total number of indexes
|
|
90
|
+
* Total number of indexes that matched your query.
|
|
51
91
|
*/
|
|
52
92
|
total: number;
|
|
53
93
|
/**
|
|
@@ -55,12 +95,25 @@ export declare namespace Models {
|
|
|
55
95
|
*/
|
|
56
96
|
indexes: Index[];
|
|
57
97
|
};
|
|
98
|
+
/**
|
|
99
|
+
* Column Indexes List
|
|
100
|
+
*/
|
|
101
|
+
export type ColumnIndexList = {
|
|
102
|
+
/**
|
|
103
|
+
* Total number of indexes that matched your query.
|
|
104
|
+
*/
|
|
105
|
+
total: number;
|
|
106
|
+
/**
|
|
107
|
+
* List of indexes.
|
|
108
|
+
*/
|
|
109
|
+
indexes: ColumnIndex[];
|
|
110
|
+
};
|
|
58
111
|
/**
|
|
59
112
|
* Users List
|
|
60
113
|
*/
|
|
61
114
|
export type UserList<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
|
|
62
115
|
/**
|
|
63
|
-
* Total number of users
|
|
116
|
+
* Total number of users that matched your query.
|
|
64
117
|
*/
|
|
65
118
|
total: number;
|
|
66
119
|
/**
|
|
@@ -73,7 +126,7 @@ export declare namespace Models {
|
|
|
73
126
|
*/
|
|
74
127
|
export type SessionList = {
|
|
75
128
|
/**
|
|
76
|
-
* Total number of sessions
|
|
129
|
+
* Total number of sessions that matched your query.
|
|
77
130
|
*/
|
|
78
131
|
total: number;
|
|
79
132
|
/**
|
|
@@ -86,7 +139,7 @@ export declare namespace Models {
|
|
|
86
139
|
*/
|
|
87
140
|
export type IdentityList = {
|
|
88
141
|
/**
|
|
89
|
-
* Total number of identities
|
|
142
|
+
* Total number of identities that matched your query.
|
|
90
143
|
*/
|
|
91
144
|
total: number;
|
|
92
145
|
/**
|
|
@@ -99,7 +152,7 @@ export declare namespace Models {
|
|
|
99
152
|
*/
|
|
100
153
|
export type LogList = {
|
|
101
154
|
/**
|
|
102
|
-
* Total number of logs
|
|
155
|
+
* Total number of logs that matched your query.
|
|
103
156
|
*/
|
|
104
157
|
total: number;
|
|
105
158
|
/**
|
|
@@ -112,7 +165,7 @@ export declare namespace Models {
|
|
|
112
165
|
*/
|
|
113
166
|
export type FileList = {
|
|
114
167
|
/**
|
|
115
|
-
* Total number of files
|
|
168
|
+
* Total number of files that matched your query.
|
|
116
169
|
*/
|
|
117
170
|
total: number;
|
|
118
171
|
/**
|
|
@@ -125,7 +178,7 @@ export declare namespace Models {
|
|
|
125
178
|
*/
|
|
126
179
|
export type BucketList = {
|
|
127
180
|
/**
|
|
128
|
-
* Total number of buckets
|
|
181
|
+
* Total number of buckets that matched your query.
|
|
129
182
|
*/
|
|
130
183
|
total: number;
|
|
131
184
|
/**
|
|
@@ -138,7 +191,7 @@ export declare namespace Models {
|
|
|
138
191
|
*/
|
|
139
192
|
export type ResourceTokenList = {
|
|
140
193
|
/**
|
|
141
|
-
* Total number of tokens
|
|
194
|
+
* Total number of tokens that matched your query.
|
|
142
195
|
*/
|
|
143
196
|
total: number;
|
|
144
197
|
/**
|
|
@@ -151,7 +204,7 @@ export declare namespace Models {
|
|
|
151
204
|
*/
|
|
152
205
|
export type TeamList<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
|
|
153
206
|
/**
|
|
154
|
-
* Total number of teams
|
|
207
|
+
* Total number of teams that matched your query.
|
|
155
208
|
*/
|
|
156
209
|
total: number;
|
|
157
210
|
/**
|
|
@@ -164,7 +217,7 @@ export declare namespace Models {
|
|
|
164
217
|
*/
|
|
165
218
|
export type MembershipList = {
|
|
166
219
|
/**
|
|
167
|
-
* Total number of memberships
|
|
220
|
+
* Total number of memberships that matched your query.
|
|
168
221
|
*/
|
|
169
222
|
total: number;
|
|
170
223
|
/**
|
|
@@ -177,7 +230,7 @@ export declare namespace Models {
|
|
|
177
230
|
*/
|
|
178
231
|
export type SiteList = {
|
|
179
232
|
/**
|
|
180
|
-
* Total number of sites
|
|
233
|
+
* Total number of sites that matched your query.
|
|
181
234
|
*/
|
|
182
235
|
total: number;
|
|
183
236
|
/**
|
|
@@ -190,7 +243,7 @@ export declare namespace Models {
|
|
|
190
243
|
*/
|
|
191
244
|
export type TemplateSiteList = {
|
|
192
245
|
/**
|
|
193
|
-
* Total number of templates
|
|
246
|
+
* Total number of templates that matched your query.
|
|
194
247
|
*/
|
|
195
248
|
total: number;
|
|
196
249
|
/**
|
|
@@ -203,7 +256,7 @@ export declare namespace Models {
|
|
|
203
256
|
*/
|
|
204
257
|
export type FunctionList = {
|
|
205
258
|
/**
|
|
206
|
-
* Total number of functions
|
|
259
|
+
* Total number of functions that matched your query.
|
|
207
260
|
*/
|
|
208
261
|
total: number;
|
|
209
262
|
/**
|
|
@@ -216,7 +269,7 @@ export declare namespace Models {
|
|
|
216
269
|
*/
|
|
217
270
|
export type TemplateFunctionList = {
|
|
218
271
|
/**
|
|
219
|
-
* Total number of templates
|
|
272
|
+
* Total number of templates that matched your query.
|
|
220
273
|
*/
|
|
221
274
|
total: number;
|
|
222
275
|
/**
|
|
@@ -229,7 +282,7 @@ export declare namespace Models {
|
|
|
229
282
|
*/
|
|
230
283
|
export type InstallationList = {
|
|
231
284
|
/**
|
|
232
|
-
* Total number of installations
|
|
285
|
+
* Total number of installations that matched your query.
|
|
233
286
|
*/
|
|
234
287
|
total: number;
|
|
235
288
|
/**
|
|
@@ -242,7 +295,7 @@ export declare namespace Models {
|
|
|
242
295
|
*/
|
|
243
296
|
export type ProviderRepositoryFrameworkList = {
|
|
244
297
|
/**
|
|
245
|
-
* Total number of frameworkProviderRepositories
|
|
298
|
+
* Total number of frameworkProviderRepositories that matched your query.
|
|
246
299
|
*/
|
|
247
300
|
total: number;
|
|
248
301
|
/**
|
|
@@ -255,7 +308,7 @@ export declare namespace Models {
|
|
|
255
308
|
*/
|
|
256
309
|
export type ProviderRepositoryRuntimeList = {
|
|
257
310
|
/**
|
|
258
|
-
* Total number of runtimeProviderRepositories
|
|
311
|
+
* Total number of runtimeProviderRepositories that matched your query.
|
|
259
312
|
*/
|
|
260
313
|
total: number;
|
|
261
314
|
/**
|
|
@@ -268,7 +321,7 @@ export declare namespace Models {
|
|
|
268
321
|
*/
|
|
269
322
|
export type BranchList = {
|
|
270
323
|
/**
|
|
271
|
-
* Total number of branches
|
|
324
|
+
* Total number of branches that matched your query.
|
|
272
325
|
*/
|
|
273
326
|
total: number;
|
|
274
327
|
/**
|
|
@@ -281,7 +334,7 @@ export declare namespace Models {
|
|
|
281
334
|
*/
|
|
282
335
|
export type FrameworkList = {
|
|
283
336
|
/**
|
|
284
|
-
* Total number of frameworks
|
|
337
|
+
* Total number of frameworks that matched your query.
|
|
285
338
|
*/
|
|
286
339
|
total: number;
|
|
287
340
|
/**
|
|
@@ -294,7 +347,7 @@ export declare namespace Models {
|
|
|
294
347
|
*/
|
|
295
348
|
export type RuntimeList = {
|
|
296
349
|
/**
|
|
297
|
-
* Total number of runtimes
|
|
350
|
+
* Total number of runtimes that matched your query.
|
|
298
351
|
*/
|
|
299
352
|
total: number;
|
|
300
353
|
/**
|
|
@@ -307,7 +360,7 @@ export declare namespace Models {
|
|
|
307
360
|
*/
|
|
308
361
|
export type DeploymentList = {
|
|
309
362
|
/**
|
|
310
|
-
* Total number of deployments
|
|
363
|
+
* Total number of deployments that matched your query.
|
|
311
364
|
*/
|
|
312
365
|
total: number;
|
|
313
366
|
/**
|
|
@@ -320,7 +373,7 @@ export declare namespace Models {
|
|
|
320
373
|
*/
|
|
321
374
|
export type ExecutionList = {
|
|
322
375
|
/**
|
|
323
|
-
* Total number of executions
|
|
376
|
+
* Total number of executions that matched your query.
|
|
324
377
|
*/
|
|
325
378
|
total: number;
|
|
326
379
|
/**
|
|
@@ -333,7 +386,7 @@ export declare namespace Models {
|
|
|
333
386
|
*/
|
|
334
387
|
export type ProjectList = {
|
|
335
388
|
/**
|
|
336
|
-
* Total number of projects
|
|
389
|
+
* Total number of projects that matched your query.
|
|
337
390
|
*/
|
|
338
391
|
total: number;
|
|
339
392
|
/**
|
|
@@ -346,7 +399,7 @@ export declare namespace Models {
|
|
|
346
399
|
*/
|
|
347
400
|
export type WebhookList = {
|
|
348
401
|
/**
|
|
349
|
-
* Total number of webhooks
|
|
402
|
+
* Total number of webhooks that matched your query.
|
|
350
403
|
*/
|
|
351
404
|
total: number;
|
|
352
405
|
/**
|
|
@@ -359,7 +412,7 @@ export declare namespace Models {
|
|
|
359
412
|
*/
|
|
360
413
|
export type KeyList = {
|
|
361
414
|
/**
|
|
362
|
-
* Total number of keys
|
|
415
|
+
* Total number of keys that matched your query.
|
|
363
416
|
*/
|
|
364
417
|
total: number;
|
|
365
418
|
/**
|
|
@@ -372,7 +425,7 @@ export declare namespace Models {
|
|
|
372
425
|
*/
|
|
373
426
|
export type DevKeyList = {
|
|
374
427
|
/**
|
|
375
|
-
* Total number of devKeys
|
|
428
|
+
* Total number of devKeys that matched your query.
|
|
376
429
|
*/
|
|
377
430
|
total: number;
|
|
378
431
|
/**
|
|
@@ -385,7 +438,7 @@ export declare namespace Models {
|
|
|
385
438
|
*/
|
|
386
439
|
export type PlatformList = {
|
|
387
440
|
/**
|
|
388
|
-
* Total number of platforms
|
|
441
|
+
* Total number of platforms that matched your query.
|
|
389
442
|
*/
|
|
390
443
|
total: number;
|
|
391
444
|
/**
|
|
@@ -398,7 +451,7 @@ export declare namespace Models {
|
|
|
398
451
|
*/
|
|
399
452
|
export type CountryList = {
|
|
400
453
|
/**
|
|
401
|
-
* Total number of countries
|
|
454
|
+
* Total number of countries that matched your query.
|
|
402
455
|
*/
|
|
403
456
|
total: number;
|
|
404
457
|
/**
|
|
@@ -411,7 +464,7 @@ export declare namespace Models {
|
|
|
411
464
|
*/
|
|
412
465
|
export type ContinentList = {
|
|
413
466
|
/**
|
|
414
|
-
* Total number of continents
|
|
467
|
+
* Total number of continents that matched your query.
|
|
415
468
|
*/
|
|
416
469
|
total: number;
|
|
417
470
|
/**
|
|
@@ -424,7 +477,7 @@ export declare namespace Models {
|
|
|
424
477
|
*/
|
|
425
478
|
export type LanguageList = {
|
|
426
479
|
/**
|
|
427
|
-
* Total number of languages
|
|
480
|
+
* Total number of languages that matched your query.
|
|
428
481
|
*/
|
|
429
482
|
total: number;
|
|
430
483
|
/**
|
|
@@ -437,7 +490,7 @@ export declare namespace Models {
|
|
|
437
490
|
*/
|
|
438
491
|
export type CurrencyList = {
|
|
439
492
|
/**
|
|
440
|
-
* Total number of currencies
|
|
493
|
+
* Total number of currencies that matched your query.
|
|
441
494
|
*/
|
|
442
495
|
total: number;
|
|
443
496
|
/**
|
|
@@ -450,7 +503,7 @@ export declare namespace Models {
|
|
|
450
503
|
*/
|
|
451
504
|
export type PhoneList = {
|
|
452
505
|
/**
|
|
453
|
-
* Total number of phones
|
|
506
|
+
* Total number of phones that matched your query.
|
|
454
507
|
*/
|
|
455
508
|
total: number;
|
|
456
509
|
/**
|
|
@@ -463,7 +516,7 @@ export declare namespace Models {
|
|
|
463
516
|
*/
|
|
464
517
|
export type VariableList = {
|
|
465
518
|
/**
|
|
466
|
-
* Total number of variables
|
|
519
|
+
* Total number of variables that matched your query.
|
|
467
520
|
*/
|
|
468
521
|
total: number;
|
|
469
522
|
/**
|
|
@@ -476,7 +529,7 @@ export declare namespace Models {
|
|
|
476
529
|
*/
|
|
477
530
|
export type ProxyRuleList = {
|
|
478
531
|
/**
|
|
479
|
-
* Total number of rules
|
|
532
|
+
* Total number of rules that matched your query.
|
|
480
533
|
*/
|
|
481
534
|
total: number;
|
|
482
535
|
/**
|
|
@@ -489,7 +542,7 @@ export declare namespace Models {
|
|
|
489
542
|
*/
|
|
490
543
|
export type LocaleCodeList = {
|
|
491
544
|
/**
|
|
492
|
-
* Total number of localeCodes
|
|
545
|
+
* Total number of localeCodes that matched your query.
|
|
493
546
|
*/
|
|
494
547
|
total: number;
|
|
495
548
|
/**
|
|
@@ -502,7 +555,7 @@ export declare namespace Models {
|
|
|
502
555
|
*/
|
|
503
556
|
export type ProviderList = {
|
|
504
557
|
/**
|
|
505
|
-
* Total number of providers
|
|
558
|
+
* Total number of providers that matched your query.
|
|
506
559
|
*/
|
|
507
560
|
total: number;
|
|
508
561
|
/**
|
|
@@ -515,7 +568,7 @@ export declare namespace Models {
|
|
|
515
568
|
*/
|
|
516
569
|
export type MessageList = {
|
|
517
570
|
/**
|
|
518
|
-
* Total number of messages
|
|
571
|
+
* Total number of messages that matched your query.
|
|
519
572
|
*/
|
|
520
573
|
total: number;
|
|
521
574
|
/**
|
|
@@ -528,7 +581,7 @@ export declare namespace Models {
|
|
|
528
581
|
*/
|
|
529
582
|
export type TopicList = {
|
|
530
583
|
/**
|
|
531
|
-
* Total number of topics
|
|
584
|
+
* Total number of topics that matched your query.
|
|
532
585
|
*/
|
|
533
586
|
total: number;
|
|
534
587
|
/**
|
|
@@ -541,7 +594,7 @@ export declare namespace Models {
|
|
|
541
594
|
*/
|
|
542
595
|
export type SubscriberList = {
|
|
543
596
|
/**
|
|
544
|
-
* Total number of subscribers
|
|
597
|
+
* Total number of subscribers that matched your query.
|
|
545
598
|
*/
|
|
546
599
|
total: number;
|
|
547
600
|
/**
|
|
@@ -554,7 +607,7 @@ export declare namespace Models {
|
|
|
554
607
|
*/
|
|
555
608
|
export type TargetList = {
|
|
556
609
|
/**
|
|
557
|
-
* Total number of targets
|
|
610
|
+
* Total number of targets that matched your query.
|
|
558
611
|
*/
|
|
559
612
|
total: number;
|
|
560
613
|
/**
|
|
@@ -562,12 +615,25 @@ export declare namespace Models {
|
|
|
562
615
|
*/
|
|
563
616
|
targets: Target[];
|
|
564
617
|
};
|
|
618
|
+
/**
|
|
619
|
+
* Transaction List
|
|
620
|
+
*/
|
|
621
|
+
export type TransactionList = {
|
|
622
|
+
/**
|
|
623
|
+
* Total number of transactions that matched your query.
|
|
624
|
+
*/
|
|
625
|
+
total: number;
|
|
626
|
+
/**
|
|
627
|
+
* List of transactions.
|
|
628
|
+
*/
|
|
629
|
+
transactions: Transaction[];
|
|
630
|
+
};
|
|
565
631
|
/**
|
|
566
632
|
* Migrations List
|
|
567
633
|
*/
|
|
568
634
|
export type MigrationList = {
|
|
569
635
|
/**
|
|
570
|
-
* Total number of migrations
|
|
636
|
+
* Total number of migrations that matched your query.
|
|
571
637
|
*/
|
|
572
638
|
total: number;
|
|
573
639
|
/**
|
|
@@ -580,7 +646,7 @@ export declare namespace Models {
|
|
|
580
646
|
*/
|
|
581
647
|
export type SpecificationList = {
|
|
582
648
|
/**
|
|
583
|
-
* Total number of specifications
|
|
649
|
+
* Total number of specifications that matched your query.
|
|
584
650
|
*/
|
|
585
651
|
total: number;
|
|
586
652
|
/**
|
|
@@ -593,7 +659,7 @@ export declare namespace Models {
|
|
|
593
659
|
*/
|
|
594
660
|
export type VcsContentList = {
|
|
595
661
|
/**
|
|
596
|
-
* Total number of contents
|
|
662
|
+
* Total number of contents that matched your query.
|
|
597
663
|
*/
|
|
598
664
|
total: number;
|
|
599
665
|
/**
|
|
@@ -622,9 +688,13 @@ export declare namespace Models {
|
|
|
622
688
|
*/
|
|
623
689
|
$updatedAt: string;
|
|
624
690
|
/**
|
|
625
|
-
* If database is enabled. Can be
|
|
691
|
+
* If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.
|
|
626
692
|
*/
|
|
627
693
|
enabled: boolean;
|
|
694
|
+
/**
|
|
695
|
+
* Database type.
|
|
696
|
+
*/
|
|
697
|
+
type: DatabaseType;
|
|
628
698
|
/**
|
|
629
699
|
* Database backup policies.
|
|
630
700
|
*/
|
|
@@ -663,7 +733,7 @@ export declare namespace Models {
|
|
|
663
733
|
*/
|
|
664
734
|
name: string;
|
|
665
735
|
/**
|
|
666
|
-
* Collection enabled. Can be
|
|
736
|
+
* Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.
|
|
667
737
|
*/
|
|
668
738
|
enabled: boolean;
|
|
669
739
|
/**
|
|
@@ -673,7 +743,7 @@ export declare namespace Models {
|
|
|
673
743
|
/**
|
|
674
744
|
* Collection attributes.
|
|
675
745
|
*/
|
|
676
|
-
attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributeString)[];
|
|
746
|
+
attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeString)[];
|
|
677
747
|
/**
|
|
678
748
|
* Collection indexes.
|
|
679
749
|
*/
|
|
@@ -690,7 +760,7 @@ export declare namespace Models {
|
|
|
690
760
|
/**
|
|
691
761
|
* List of attributes.
|
|
692
762
|
*/
|
|
693
|
-
attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributeString)[];
|
|
763
|
+
attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeString)[];
|
|
694
764
|
};
|
|
695
765
|
/**
|
|
696
766
|
* AttributeString
|
|
@@ -707,7 +777,7 @@ export declare namespace Models {
|
|
|
707
777
|
/**
|
|
708
778
|
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
709
779
|
*/
|
|
710
|
-
status:
|
|
780
|
+
status: AttributeStatus;
|
|
711
781
|
/**
|
|
712
782
|
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
713
783
|
*/
|
|
@@ -756,7 +826,7 @@ export declare namespace Models {
|
|
|
756
826
|
/**
|
|
757
827
|
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
758
828
|
*/
|
|
759
|
-
status:
|
|
829
|
+
status: AttributeStatus;
|
|
760
830
|
/**
|
|
761
831
|
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
762
832
|
*/
|
|
@@ -805,7 +875,7 @@ export declare namespace Models {
|
|
|
805
875
|
/**
|
|
806
876
|
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
807
877
|
*/
|
|
808
|
-
status:
|
|
878
|
+
status: AttributeStatus;
|
|
809
879
|
/**
|
|
810
880
|
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
811
881
|
*/
|
|
@@ -854,66 +924,864 @@ export declare namespace Models {
|
|
|
854
924
|
/**
|
|
855
925
|
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
856
926
|
*/
|
|
857
|
-
status:
|
|
927
|
+
status: AttributeStatus;
|
|
928
|
+
/**
|
|
929
|
+
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
930
|
+
*/
|
|
931
|
+
error: string;
|
|
932
|
+
/**
|
|
933
|
+
* Is attribute required?
|
|
934
|
+
*/
|
|
935
|
+
required: boolean;
|
|
936
|
+
/**
|
|
937
|
+
* Is attribute an array?
|
|
938
|
+
*/
|
|
939
|
+
array?: boolean;
|
|
940
|
+
/**
|
|
941
|
+
* Attribute creation date in ISO 8601 format.
|
|
942
|
+
*/
|
|
943
|
+
$createdAt: string;
|
|
944
|
+
/**
|
|
945
|
+
* Attribute update date in ISO 8601 format.
|
|
946
|
+
*/
|
|
947
|
+
$updatedAt: string;
|
|
948
|
+
/**
|
|
949
|
+
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
950
|
+
*/
|
|
951
|
+
default?: boolean;
|
|
952
|
+
};
|
|
953
|
+
/**
|
|
954
|
+
* AttributeEmail
|
|
955
|
+
*/
|
|
956
|
+
export type AttributeEmail = {
|
|
957
|
+
/**
|
|
958
|
+
* Attribute Key.
|
|
959
|
+
*/
|
|
960
|
+
key: string;
|
|
961
|
+
/**
|
|
962
|
+
* Attribute type.
|
|
963
|
+
*/
|
|
964
|
+
type: string;
|
|
965
|
+
/**
|
|
966
|
+
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
967
|
+
*/
|
|
968
|
+
status: AttributeStatus;
|
|
969
|
+
/**
|
|
970
|
+
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
971
|
+
*/
|
|
972
|
+
error: string;
|
|
973
|
+
/**
|
|
974
|
+
* Is attribute required?
|
|
975
|
+
*/
|
|
976
|
+
required: boolean;
|
|
977
|
+
/**
|
|
978
|
+
* Is attribute an array?
|
|
979
|
+
*/
|
|
980
|
+
array?: boolean;
|
|
981
|
+
/**
|
|
982
|
+
* Attribute creation date in ISO 8601 format.
|
|
983
|
+
*/
|
|
984
|
+
$createdAt: string;
|
|
985
|
+
/**
|
|
986
|
+
* Attribute update date in ISO 8601 format.
|
|
987
|
+
*/
|
|
988
|
+
$updatedAt: string;
|
|
989
|
+
/**
|
|
990
|
+
* String format.
|
|
991
|
+
*/
|
|
992
|
+
format: string;
|
|
993
|
+
/**
|
|
994
|
+
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
995
|
+
*/
|
|
996
|
+
default?: string;
|
|
997
|
+
};
|
|
998
|
+
/**
|
|
999
|
+
* AttributeEnum
|
|
1000
|
+
*/
|
|
1001
|
+
export type AttributeEnum = {
|
|
1002
|
+
/**
|
|
1003
|
+
* Attribute Key.
|
|
1004
|
+
*/
|
|
1005
|
+
key: string;
|
|
1006
|
+
/**
|
|
1007
|
+
* Attribute type.
|
|
1008
|
+
*/
|
|
1009
|
+
type: string;
|
|
1010
|
+
/**
|
|
1011
|
+
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1012
|
+
*/
|
|
1013
|
+
status: AttributeStatus;
|
|
1014
|
+
/**
|
|
1015
|
+
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
1016
|
+
*/
|
|
1017
|
+
error: string;
|
|
1018
|
+
/**
|
|
1019
|
+
* Is attribute required?
|
|
1020
|
+
*/
|
|
1021
|
+
required: boolean;
|
|
1022
|
+
/**
|
|
1023
|
+
* Is attribute an array?
|
|
1024
|
+
*/
|
|
1025
|
+
array?: boolean;
|
|
1026
|
+
/**
|
|
1027
|
+
* Attribute creation date in ISO 8601 format.
|
|
1028
|
+
*/
|
|
1029
|
+
$createdAt: string;
|
|
1030
|
+
/**
|
|
1031
|
+
* Attribute update date in ISO 8601 format.
|
|
1032
|
+
*/
|
|
1033
|
+
$updatedAt: string;
|
|
1034
|
+
/**
|
|
1035
|
+
* Array of elements in enumerated type.
|
|
1036
|
+
*/
|
|
1037
|
+
elements: string[];
|
|
1038
|
+
/**
|
|
1039
|
+
* String format.
|
|
1040
|
+
*/
|
|
1041
|
+
format: string;
|
|
1042
|
+
/**
|
|
1043
|
+
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1044
|
+
*/
|
|
1045
|
+
default?: string;
|
|
1046
|
+
};
|
|
1047
|
+
/**
|
|
1048
|
+
* AttributeIP
|
|
1049
|
+
*/
|
|
1050
|
+
export type AttributeIp = {
|
|
1051
|
+
/**
|
|
1052
|
+
* Attribute Key.
|
|
1053
|
+
*/
|
|
1054
|
+
key: string;
|
|
1055
|
+
/**
|
|
1056
|
+
* Attribute type.
|
|
1057
|
+
*/
|
|
1058
|
+
type: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1061
|
+
*/
|
|
1062
|
+
status: AttributeStatus;
|
|
1063
|
+
/**
|
|
1064
|
+
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
1065
|
+
*/
|
|
1066
|
+
error: string;
|
|
1067
|
+
/**
|
|
1068
|
+
* Is attribute required?
|
|
1069
|
+
*/
|
|
1070
|
+
required: boolean;
|
|
1071
|
+
/**
|
|
1072
|
+
* Is attribute an array?
|
|
1073
|
+
*/
|
|
1074
|
+
array?: boolean;
|
|
1075
|
+
/**
|
|
1076
|
+
* Attribute creation date in ISO 8601 format.
|
|
1077
|
+
*/
|
|
1078
|
+
$createdAt: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* Attribute update date in ISO 8601 format.
|
|
1081
|
+
*/
|
|
1082
|
+
$updatedAt: string;
|
|
1083
|
+
/**
|
|
1084
|
+
* String format.
|
|
1085
|
+
*/
|
|
1086
|
+
format: string;
|
|
1087
|
+
/**
|
|
1088
|
+
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1089
|
+
*/
|
|
1090
|
+
default?: string;
|
|
1091
|
+
};
|
|
1092
|
+
/**
|
|
1093
|
+
* AttributeURL
|
|
1094
|
+
*/
|
|
1095
|
+
export type AttributeUrl = {
|
|
1096
|
+
/**
|
|
1097
|
+
* Attribute Key.
|
|
1098
|
+
*/
|
|
1099
|
+
key: string;
|
|
1100
|
+
/**
|
|
1101
|
+
* Attribute type.
|
|
1102
|
+
*/
|
|
1103
|
+
type: string;
|
|
1104
|
+
/**
|
|
1105
|
+
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1106
|
+
*/
|
|
1107
|
+
status: AttributeStatus;
|
|
858
1108
|
/**
|
|
859
1109
|
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
860
1110
|
*/
|
|
861
1111
|
error: string;
|
|
862
1112
|
/**
|
|
863
|
-
* Is attribute required?
|
|
1113
|
+
* Is attribute required?
|
|
1114
|
+
*/
|
|
1115
|
+
required: boolean;
|
|
1116
|
+
/**
|
|
1117
|
+
* Is attribute an array?
|
|
1118
|
+
*/
|
|
1119
|
+
array?: boolean;
|
|
1120
|
+
/**
|
|
1121
|
+
* Attribute creation date in ISO 8601 format.
|
|
1122
|
+
*/
|
|
1123
|
+
$createdAt: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* Attribute update date in ISO 8601 format.
|
|
1126
|
+
*/
|
|
1127
|
+
$updatedAt: string;
|
|
1128
|
+
/**
|
|
1129
|
+
* String format.
|
|
1130
|
+
*/
|
|
1131
|
+
format: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1134
|
+
*/
|
|
1135
|
+
default?: string;
|
|
1136
|
+
};
|
|
1137
|
+
/**
|
|
1138
|
+
* AttributeDatetime
|
|
1139
|
+
*/
|
|
1140
|
+
export type AttributeDatetime = {
|
|
1141
|
+
/**
|
|
1142
|
+
* Attribute Key.
|
|
1143
|
+
*/
|
|
1144
|
+
key: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* Attribute type.
|
|
1147
|
+
*/
|
|
1148
|
+
type: string;
|
|
1149
|
+
/**
|
|
1150
|
+
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1151
|
+
*/
|
|
1152
|
+
status: AttributeStatus;
|
|
1153
|
+
/**
|
|
1154
|
+
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
1155
|
+
*/
|
|
1156
|
+
error: string;
|
|
1157
|
+
/**
|
|
1158
|
+
* Is attribute required?
|
|
1159
|
+
*/
|
|
1160
|
+
required: boolean;
|
|
1161
|
+
/**
|
|
1162
|
+
* Is attribute an array?
|
|
1163
|
+
*/
|
|
1164
|
+
array?: boolean;
|
|
1165
|
+
/**
|
|
1166
|
+
* Attribute creation date in ISO 8601 format.
|
|
1167
|
+
*/
|
|
1168
|
+
$createdAt: string;
|
|
1169
|
+
/**
|
|
1170
|
+
* Attribute update date in ISO 8601 format.
|
|
1171
|
+
*/
|
|
1172
|
+
$updatedAt: string;
|
|
1173
|
+
/**
|
|
1174
|
+
* ISO 8601 format.
|
|
1175
|
+
*/
|
|
1176
|
+
format: string;
|
|
1177
|
+
/**
|
|
1178
|
+
* Default value for attribute when not provided. Only null is optional
|
|
1179
|
+
*/
|
|
1180
|
+
default?: string;
|
|
1181
|
+
};
|
|
1182
|
+
/**
|
|
1183
|
+
* AttributeRelationship
|
|
1184
|
+
*/
|
|
1185
|
+
export type AttributeRelationship = {
|
|
1186
|
+
/**
|
|
1187
|
+
* Attribute Key.
|
|
1188
|
+
*/
|
|
1189
|
+
key: string;
|
|
1190
|
+
/**
|
|
1191
|
+
* Attribute type.
|
|
1192
|
+
*/
|
|
1193
|
+
type: string;
|
|
1194
|
+
/**
|
|
1195
|
+
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1196
|
+
*/
|
|
1197
|
+
status: AttributeStatus;
|
|
1198
|
+
/**
|
|
1199
|
+
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
1200
|
+
*/
|
|
1201
|
+
error: string;
|
|
1202
|
+
/**
|
|
1203
|
+
* Is attribute required?
|
|
1204
|
+
*/
|
|
1205
|
+
required: boolean;
|
|
1206
|
+
/**
|
|
1207
|
+
* Is attribute an array?
|
|
1208
|
+
*/
|
|
1209
|
+
array?: boolean;
|
|
1210
|
+
/**
|
|
1211
|
+
* Attribute creation date in ISO 8601 format.
|
|
1212
|
+
*/
|
|
1213
|
+
$createdAt: string;
|
|
1214
|
+
/**
|
|
1215
|
+
* Attribute update date in ISO 8601 format.
|
|
1216
|
+
*/
|
|
1217
|
+
$updatedAt: string;
|
|
1218
|
+
/**
|
|
1219
|
+
* The ID of the related collection.
|
|
1220
|
+
*/
|
|
1221
|
+
relatedCollection: string;
|
|
1222
|
+
/**
|
|
1223
|
+
* The type of the relationship.
|
|
1224
|
+
*/
|
|
1225
|
+
relationType: string;
|
|
1226
|
+
/**
|
|
1227
|
+
* Is the relationship two-way?
|
|
1228
|
+
*/
|
|
1229
|
+
twoWay: boolean;
|
|
1230
|
+
/**
|
|
1231
|
+
* The key of the two-way relationship.
|
|
1232
|
+
*/
|
|
1233
|
+
twoWayKey: string;
|
|
1234
|
+
/**
|
|
1235
|
+
* How deleting the parent document will propagate to child documents.
|
|
1236
|
+
*/
|
|
1237
|
+
onDelete: string;
|
|
1238
|
+
/**
|
|
1239
|
+
* Whether this is the parent or child side of the relationship
|
|
1240
|
+
*/
|
|
1241
|
+
side: string;
|
|
1242
|
+
};
|
|
1243
|
+
/**
|
|
1244
|
+
* AttributePoint
|
|
1245
|
+
*/
|
|
1246
|
+
export type AttributePoint = {
|
|
1247
|
+
/**
|
|
1248
|
+
* Attribute Key.
|
|
1249
|
+
*/
|
|
1250
|
+
key: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* Attribute type.
|
|
1253
|
+
*/
|
|
1254
|
+
type: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1257
|
+
*/
|
|
1258
|
+
status: AttributeStatus;
|
|
1259
|
+
/**
|
|
1260
|
+
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
1261
|
+
*/
|
|
1262
|
+
error: string;
|
|
1263
|
+
/**
|
|
1264
|
+
* Is attribute required?
|
|
1265
|
+
*/
|
|
1266
|
+
required: boolean;
|
|
1267
|
+
/**
|
|
1268
|
+
* Is attribute an array?
|
|
1269
|
+
*/
|
|
1270
|
+
array?: boolean;
|
|
1271
|
+
/**
|
|
1272
|
+
* Attribute creation date in ISO 8601 format.
|
|
1273
|
+
*/
|
|
1274
|
+
$createdAt: string;
|
|
1275
|
+
/**
|
|
1276
|
+
* Attribute update date in ISO 8601 format.
|
|
1277
|
+
*/
|
|
1278
|
+
$updatedAt: string;
|
|
1279
|
+
/**
|
|
1280
|
+
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1281
|
+
*/
|
|
1282
|
+
default?: any[];
|
|
1283
|
+
};
|
|
1284
|
+
/**
|
|
1285
|
+
* AttributeLine
|
|
1286
|
+
*/
|
|
1287
|
+
export type AttributeLine = {
|
|
1288
|
+
/**
|
|
1289
|
+
* Attribute Key.
|
|
1290
|
+
*/
|
|
1291
|
+
key: string;
|
|
1292
|
+
/**
|
|
1293
|
+
* Attribute type.
|
|
1294
|
+
*/
|
|
1295
|
+
type: string;
|
|
1296
|
+
/**
|
|
1297
|
+
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1298
|
+
*/
|
|
1299
|
+
status: AttributeStatus;
|
|
1300
|
+
/**
|
|
1301
|
+
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
1302
|
+
*/
|
|
1303
|
+
error: string;
|
|
1304
|
+
/**
|
|
1305
|
+
* Is attribute required?
|
|
1306
|
+
*/
|
|
1307
|
+
required: boolean;
|
|
1308
|
+
/**
|
|
1309
|
+
* Is attribute an array?
|
|
1310
|
+
*/
|
|
1311
|
+
array?: boolean;
|
|
1312
|
+
/**
|
|
1313
|
+
* Attribute creation date in ISO 8601 format.
|
|
1314
|
+
*/
|
|
1315
|
+
$createdAt: string;
|
|
1316
|
+
/**
|
|
1317
|
+
* Attribute update date in ISO 8601 format.
|
|
1318
|
+
*/
|
|
1319
|
+
$updatedAt: string;
|
|
1320
|
+
/**
|
|
1321
|
+
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1322
|
+
*/
|
|
1323
|
+
default?: any[];
|
|
1324
|
+
};
|
|
1325
|
+
/**
|
|
1326
|
+
* AttributePolygon
|
|
1327
|
+
*/
|
|
1328
|
+
export type AttributePolygon = {
|
|
1329
|
+
/**
|
|
1330
|
+
* Attribute Key.
|
|
1331
|
+
*/
|
|
1332
|
+
key: string;
|
|
1333
|
+
/**
|
|
1334
|
+
* Attribute type.
|
|
1335
|
+
*/
|
|
1336
|
+
type: string;
|
|
1337
|
+
/**
|
|
1338
|
+
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1339
|
+
*/
|
|
1340
|
+
status: AttributeStatus;
|
|
1341
|
+
/**
|
|
1342
|
+
* Error message. Displays error generated on failure of creating or deleting an attribute.
|
|
1343
|
+
*/
|
|
1344
|
+
error: string;
|
|
1345
|
+
/**
|
|
1346
|
+
* Is attribute required?
|
|
1347
|
+
*/
|
|
1348
|
+
required: boolean;
|
|
1349
|
+
/**
|
|
1350
|
+
* Is attribute an array?
|
|
1351
|
+
*/
|
|
1352
|
+
array?: boolean;
|
|
1353
|
+
/**
|
|
1354
|
+
* Attribute creation date in ISO 8601 format.
|
|
1355
|
+
*/
|
|
1356
|
+
$createdAt: string;
|
|
1357
|
+
/**
|
|
1358
|
+
* Attribute update date in ISO 8601 format.
|
|
1359
|
+
*/
|
|
1360
|
+
$updatedAt: string;
|
|
1361
|
+
/**
|
|
1362
|
+
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1363
|
+
*/
|
|
1364
|
+
default?: any[];
|
|
1365
|
+
};
|
|
1366
|
+
/**
|
|
1367
|
+
* Table
|
|
1368
|
+
*/
|
|
1369
|
+
export type Table = {
|
|
1370
|
+
/**
|
|
1371
|
+
* Table ID.
|
|
1372
|
+
*/
|
|
1373
|
+
$id: string;
|
|
1374
|
+
/**
|
|
1375
|
+
* Table creation date in ISO 8601 format.
|
|
1376
|
+
*/
|
|
1377
|
+
$createdAt: string;
|
|
1378
|
+
/**
|
|
1379
|
+
* Table update date in ISO 8601 format.
|
|
1380
|
+
*/
|
|
1381
|
+
$updatedAt: string;
|
|
1382
|
+
/**
|
|
1383
|
+
* Table permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
1384
|
+
*/
|
|
1385
|
+
$permissions: string[];
|
|
1386
|
+
/**
|
|
1387
|
+
* Database ID.
|
|
1388
|
+
*/
|
|
1389
|
+
databaseId: string;
|
|
1390
|
+
/**
|
|
1391
|
+
* Table name.
|
|
1392
|
+
*/
|
|
1393
|
+
name: string;
|
|
1394
|
+
/**
|
|
1395
|
+
* Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.
|
|
1396
|
+
*/
|
|
1397
|
+
enabled: boolean;
|
|
1398
|
+
/**
|
|
1399
|
+
* Whether row-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
1400
|
+
*/
|
|
1401
|
+
rowSecurity: boolean;
|
|
1402
|
+
/**
|
|
1403
|
+
* Table columns.
|
|
1404
|
+
*/
|
|
1405
|
+
columns: (Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnPoint | Models.ColumnLine | Models.ColumnPolygon | Models.ColumnString)[];
|
|
1406
|
+
/**
|
|
1407
|
+
* Table indexes.
|
|
1408
|
+
*/
|
|
1409
|
+
indexes: ColumnIndex[];
|
|
1410
|
+
};
|
|
1411
|
+
/**
|
|
1412
|
+
* Columns List
|
|
1413
|
+
*/
|
|
1414
|
+
export type ColumnList = {
|
|
1415
|
+
/**
|
|
1416
|
+
* Total number of columns in the given table.
|
|
1417
|
+
*/
|
|
1418
|
+
total: number;
|
|
1419
|
+
/**
|
|
1420
|
+
* List of columns.
|
|
1421
|
+
*/
|
|
1422
|
+
columns: (Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnPoint | Models.ColumnLine | Models.ColumnPolygon | Models.ColumnString)[];
|
|
1423
|
+
};
|
|
1424
|
+
/**
|
|
1425
|
+
* ColumnString
|
|
1426
|
+
*/
|
|
1427
|
+
export type ColumnString = {
|
|
1428
|
+
/**
|
|
1429
|
+
* Column Key.
|
|
1430
|
+
*/
|
|
1431
|
+
key: string;
|
|
1432
|
+
/**
|
|
1433
|
+
* Column type.
|
|
1434
|
+
*/
|
|
1435
|
+
type: string;
|
|
1436
|
+
/**
|
|
1437
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1438
|
+
*/
|
|
1439
|
+
status: ColumnStatus;
|
|
1440
|
+
/**
|
|
1441
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
1442
|
+
*/
|
|
1443
|
+
error: string;
|
|
1444
|
+
/**
|
|
1445
|
+
* Is column required?
|
|
1446
|
+
*/
|
|
1447
|
+
required: boolean;
|
|
1448
|
+
/**
|
|
1449
|
+
* Is column an array?
|
|
1450
|
+
*/
|
|
1451
|
+
array?: boolean;
|
|
1452
|
+
/**
|
|
1453
|
+
* Column creation date in ISO 8601 format.
|
|
1454
|
+
*/
|
|
1455
|
+
$createdAt: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* Column update date in ISO 8601 format.
|
|
1458
|
+
*/
|
|
1459
|
+
$updatedAt: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* Column size.
|
|
1462
|
+
*/
|
|
1463
|
+
size: number;
|
|
1464
|
+
/**
|
|
1465
|
+
* Default value for column when not provided. Cannot be set when column is required.
|
|
1466
|
+
*/
|
|
1467
|
+
default?: string;
|
|
1468
|
+
/**
|
|
1469
|
+
* Defines whether this column is encrypted or not.
|
|
1470
|
+
*/
|
|
1471
|
+
encrypt?: boolean;
|
|
1472
|
+
};
|
|
1473
|
+
/**
|
|
1474
|
+
* ColumnInteger
|
|
1475
|
+
*/
|
|
1476
|
+
export type ColumnInteger = {
|
|
1477
|
+
/**
|
|
1478
|
+
* Column Key.
|
|
1479
|
+
*/
|
|
1480
|
+
key: string;
|
|
1481
|
+
/**
|
|
1482
|
+
* Column type.
|
|
1483
|
+
*/
|
|
1484
|
+
type: string;
|
|
1485
|
+
/**
|
|
1486
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1487
|
+
*/
|
|
1488
|
+
status: ColumnStatus;
|
|
1489
|
+
/**
|
|
1490
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
1491
|
+
*/
|
|
1492
|
+
error: string;
|
|
1493
|
+
/**
|
|
1494
|
+
* Is column required?
|
|
1495
|
+
*/
|
|
1496
|
+
required: boolean;
|
|
1497
|
+
/**
|
|
1498
|
+
* Is column an array?
|
|
1499
|
+
*/
|
|
1500
|
+
array?: boolean;
|
|
1501
|
+
/**
|
|
1502
|
+
* Column creation date in ISO 8601 format.
|
|
1503
|
+
*/
|
|
1504
|
+
$createdAt: string;
|
|
1505
|
+
/**
|
|
1506
|
+
* Column update date in ISO 8601 format.
|
|
1507
|
+
*/
|
|
1508
|
+
$updatedAt: string;
|
|
1509
|
+
/**
|
|
1510
|
+
* Minimum value to enforce for new documents.
|
|
1511
|
+
*/
|
|
1512
|
+
min?: number;
|
|
1513
|
+
/**
|
|
1514
|
+
* Maximum value to enforce for new documents.
|
|
1515
|
+
*/
|
|
1516
|
+
max?: number;
|
|
1517
|
+
/**
|
|
1518
|
+
* Default value for column when not provided. Cannot be set when column is required.
|
|
1519
|
+
*/
|
|
1520
|
+
default?: number;
|
|
1521
|
+
};
|
|
1522
|
+
/**
|
|
1523
|
+
* ColumnFloat
|
|
1524
|
+
*/
|
|
1525
|
+
export type ColumnFloat = {
|
|
1526
|
+
/**
|
|
1527
|
+
* Column Key.
|
|
1528
|
+
*/
|
|
1529
|
+
key: string;
|
|
1530
|
+
/**
|
|
1531
|
+
* Column type.
|
|
1532
|
+
*/
|
|
1533
|
+
type: string;
|
|
1534
|
+
/**
|
|
1535
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1536
|
+
*/
|
|
1537
|
+
status: ColumnStatus;
|
|
1538
|
+
/**
|
|
1539
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
1540
|
+
*/
|
|
1541
|
+
error: string;
|
|
1542
|
+
/**
|
|
1543
|
+
* Is column required?
|
|
1544
|
+
*/
|
|
1545
|
+
required: boolean;
|
|
1546
|
+
/**
|
|
1547
|
+
* Is column an array?
|
|
1548
|
+
*/
|
|
1549
|
+
array?: boolean;
|
|
1550
|
+
/**
|
|
1551
|
+
* Column creation date in ISO 8601 format.
|
|
1552
|
+
*/
|
|
1553
|
+
$createdAt: string;
|
|
1554
|
+
/**
|
|
1555
|
+
* Column update date in ISO 8601 format.
|
|
1556
|
+
*/
|
|
1557
|
+
$updatedAt: string;
|
|
1558
|
+
/**
|
|
1559
|
+
* Minimum value to enforce for new documents.
|
|
1560
|
+
*/
|
|
1561
|
+
min?: number;
|
|
1562
|
+
/**
|
|
1563
|
+
* Maximum value to enforce for new documents.
|
|
1564
|
+
*/
|
|
1565
|
+
max?: number;
|
|
1566
|
+
/**
|
|
1567
|
+
* Default value for column when not provided. Cannot be set when column is required.
|
|
1568
|
+
*/
|
|
1569
|
+
default?: number;
|
|
1570
|
+
};
|
|
1571
|
+
/**
|
|
1572
|
+
* ColumnBoolean
|
|
1573
|
+
*/
|
|
1574
|
+
export type ColumnBoolean = {
|
|
1575
|
+
/**
|
|
1576
|
+
* Column Key.
|
|
1577
|
+
*/
|
|
1578
|
+
key: string;
|
|
1579
|
+
/**
|
|
1580
|
+
* Column type.
|
|
1581
|
+
*/
|
|
1582
|
+
type: string;
|
|
1583
|
+
/**
|
|
1584
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1585
|
+
*/
|
|
1586
|
+
status: ColumnStatus;
|
|
1587
|
+
/**
|
|
1588
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
1589
|
+
*/
|
|
1590
|
+
error: string;
|
|
1591
|
+
/**
|
|
1592
|
+
* Is column required?
|
|
1593
|
+
*/
|
|
1594
|
+
required: boolean;
|
|
1595
|
+
/**
|
|
1596
|
+
* Is column an array?
|
|
1597
|
+
*/
|
|
1598
|
+
array?: boolean;
|
|
1599
|
+
/**
|
|
1600
|
+
* Column creation date in ISO 8601 format.
|
|
1601
|
+
*/
|
|
1602
|
+
$createdAt: string;
|
|
1603
|
+
/**
|
|
1604
|
+
* Column update date in ISO 8601 format.
|
|
1605
|
+
*/
|
|
1606
|
+
$updatedAt: string;
|
|
1607
|
+
/**
|
|
1608
|
+
* Default value for column when not provided. Cannot be set when column is required.
|
|
1609
|
+
*/
|
|
1610
|
+
default?: boolean;
|
|
1611
|
+
};
|
|
1612
|
+
/**
|
|
1613
|
+
* ColumnEmail
|
|
1614
|
+
*/
|
|
1615
|
+
export type ColumnEmail = {
|
|
1616
|
+
/**
|
|
1617
|
+
* Column Key.
|
|
1618
|
+
*/
|
|
1619
|
+
key: string;
|
|
1620
|
+
/**
|
|
1621
|
+
* Column type.
|
|
1622
|
+
*/
|
|
1623
|
+
type: string;
|
|
1624
|
+
/**
|
|
1625
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1626
|
+
*/
|
|
1627
|
+
status: ColumnStatus;
|
|
1628
|
+
/**
|
|
1629
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
1630
|
+
*/
|
|
1631
|
+
error: string;
|
|
1632
|
+
/**
|
|
1633
|
+
* Is column required?
|
|
1634
|
+
*/
|
|
1635
|
+
required: boolean;
|
|
1636
|
+
/**
|
|
1637
|
+
* Is column an array?
|
|
1638
|
+
*/
|
|
1639
|
+
array?: boolean;
|
|
1640
|
+
/**
|
|
1641
|
+
* Column creation date in ISO 8601 format.
|
|
1642
|
+
*/
|
|
1643
|
+
$createdAt: string;
|
|
1644
|
+
/**
|
|
1645
|
+
* Column update date in ISO 8601 format.
|
|
1646
|
+
*/
|
|
1647
|
+
$updatedAt: string;
|
|
1648
|
+
/**
|
|
1649
|
+
* String format.
|
|
1650
|
+
*/
|
|
1651
|
+
format: string;
|
|
1652
|
+
/**
|
|
1653
|
+
* Default value for column when not provided. Cannot be set when column is required.
|
|
1654
|
+
*/
|
|
1655
|
+
default?: string;
|
|
1656
|
+
};
|
|
1657
|
+
/**
|
|
1658
|
+
* ColumnEnum
|
|
1659
|
+
*/
|
|
1660
|
+
export type ColumnEnum = {
|
|
1661
|
+
/**
|
|
1662
|
+
* Column Key.
|
|
1663
|
+
*/
|
|
1664
|
+
key: string;
|
|
1665
|
+
/**
|
|
1666
|
+
* Column type.
|
|
1667
|
+
*/
|
|
1668
|
+
type: string;
|
|
1669
|
+
/**
|
|
1670
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1671
|
+
*/
|
|
1672
|
+
status: ColumnStatus;
|
|
1673
|
+
/**
|
|
1674
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
1675
|
+
*/
|
|
1676
|
+
error: string;
|
|
1677
|
+
/**
|
|
1678
|
+
* Is column required?
|
|
1679
|
+
*/
|
|
1680
|
+
required: boolean;
|
|
1681
|
+
/**
|
|
1682
|
+
* Is column an array?
|
|
1683
|
+
*/
|
|
1684
|
+
array?: boolean;
|
|
1685
|
+
/**
|
|
1686
|
+
* Column creation date in ISO 8601 format.
|
|
1687
|
+
*/
|
|
1688
|
+
$createdAt: string;
|
|
1689
|
+
/**
|
|
1690
|
+
* Column update date in ISO 8601 format.
|
|
1691
|
+
*/
|
|
1692
|
+
$updatedAt: string;
|
|
1693
|
+
/**
|
|
1694
|
+
* Array of elements in enumerated type.
|
|
1695
|
+
*/
|
|
1696
|
+
elements: string[];
|
|
1697
|
+
/**
|
|
1698
|
+
* String format.
|
|
1699
|
+
*/
|
|
1700
|
+
format: string;
|
|
1701
|
+
/**
|
|
1702
|
+
* Default value for column when not provided. Cannot be set when column is required.
|
|
1703
|
+
*/
|
|
1704
|
+
default?: string;
|
|
1705
|
+
};
|
|
1706
|
+
/**
|
|
1707
|
+
* ColumnIP
|
|
1708
|
+
*/
|
|
1709
|
+
export type ColumnIp = {
|
|
1710
|
+
/**
|
|
1711
|
+
* Column Key.
|
|
1712
|
+
*/
|
|
1713
|
+
key: string;
|
|
1714
|
+
/**
|
|
1715
|
+
* Column type.
|
|
1716
|
+
*/
|
|
1717
|
+
type: string;
|
|
1718
|
+
/**
|
|
1719
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1720
|
+
*/
|
|
1721
|
+
status: ColumnStatus;
|
|
1722
|
+
/**
|
|
1723
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
1724
|
+
*/
|
|
1725
|
+
error: string;
|
|
1726
|
+
/**
|
|
1727
|
+
* Is column required?
|
|
864
1728
|
*/
|
|
865
1729
|
required: boolean;
|
|
866
1730
|
/**
|
|
867
|
-
* Is
|
|
1731
|
+
* Is column an array?
|
|
868
1732
|
*/
|
|
869
1733
|
array?: boolean;
|
|
870
1734
|
/**
|
|
871
|
-
*
|
|
1735
|
+
* Column creation date in ISO 8601 format.
|
|
872
1736
|
*/
|
|
873
1737
|
$createdAt: string;
|
|
874
1738
|
/**
|
|
875
|
-
*
|
|
1739
|
+
* Column update date in ISO 8601 format.
|
|
876
1740
|
*/
|
|
877
1741
|
$updatedAt: string;
|
|
878
1742
|
/**
|
|
879
|
-
*
|
|
1743
|
+
* String format.
|
|
880
1744
|
*/
|
|
881
|
-
|
|
1745
|
+
format: string;
|
|
1746
|
+
/**
|
|
1747
|
+
* Default value for column when not provided. Cannot be set when column is required.
|
|
1748
|
+
*/
|
|
1749
|
+
default?: string;
|
|
882
1750
|
};
|
|
883
1751
|
/**
|
|
884
|
-
*
|
|
1752
|
+
* ColumnURL
|
|
885
1753
|
*/
|
|
886
|
-
export type
|
|
1754
|
+
export type ColumnUrl = {
|
|
887
1755
|
/**
|
|
888
|
-
*
|
|
1756
|
+
* Column Key.
|
|
889
1757
|
*/
|
|
890
1758
|
key: string;
|
|
891
1759
|
/**
|
|
892
|
-
*
|
|
1760
|
+
* Column type.
|
|
893
1761
|
*/
|
|
894
1762
|
type: string;
|
|
895
1763
|
/**
|
|
896
|
-
*
|
|
1764
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
897
1765
|
*/
|
|
898
|
-
status:
|
|
1766
|
+
status: ColumnStatus;
|
|
899
1767
|
/**
|
|
900
|
-
* Error message. Displays error generated on failure of creating or deleting an
|
|
1768
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
901
1769
|
*/
|
|
902
1770
|
error: string;
|
|
903
1771
|
/**
|
|
904
|
-
* Is
|
|
1772
|
+
* Is column required?
|
|
905
1773
|
*/
|
|
906
1774
|
required: boolean;
|
|
907
1775
|
/**
|
|
908
|
-
* Is
|
|
1776
|
+
* Is column an array?
|
|
909
1777
|
*/
|
|
910
1778
|
array?: boolean;
|
|
911
1779
|
/**
|
|
912
|
-
*
|
|
1780
|
+
* Column creation date in ISO 8601 format.
|
|
913
1781
|
*/
|
|
914
1782
|
$createdAt: string;
|
|
915
1783
|
/**
|
|
916
|
-
*
|
|
1784
|
+
* Column update date in ISO 8601 format.
|
|
917
1785
|
*/
|
|
918
1786
|
$updatedAt: string;
|
|
919
1787
|
/**
|
|
@@ -921,259 +1789,300 @@ export declare namespace Models {
|
|
|
921
1789
|
*/
|
|
922
1790
|
format: string;
|
|
923
1791
|
/**
|
|
924
|
-
* Default value for
|
|
1792
|
+
* Default value for column when not provided. Cannot be set when column is required.
|
|
925
1793
|
*/
|
|
926
1794
|
default?: string;
|
|
927
1795
|
};
|
|
928
1796
|
/**
|
|
929
|
-
*
|
|
1797
|
+
* ColumnDatetime
|
|
930
1798
|
*/
|
|
931
|
-
export type
|
|
1799
|
+
export type ColumnDatetime = {
|
|
932
1800
|
/**
|
|
933
|
-
*
|
|
1801
|
+
* Column Key.
|
|
934
1802
|
*/
|
|
935
1803
|
key: string;
|
|
936
1804
|
/**
|
|
937
|
-
*
|
|
1805
|
+
* Column type.
|
|
938
1806
|
*/
|
|
939
1807
|
type: string;
|
|
940
1808
|
/**
|
|
941
|
-
*
|
|
1809
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
942
1810
|
*/
|
|
943
|
-
status:
|
|
1811
|
+
status: ColumnStatus;
|
|
944
1812
|
/**
|
|
945
|
-
* Error message. Displays error generated on failure of creating or deleting an
|
|
1813
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
946
1814
|
*/
|
|
947
1815
|
error: string;
|
|
948
1816
|
/**
|
|
949
|
-
* Is
|
|
1817
|
+
* Is column required?
|
|
950
1818
|
*/
|
|
951
1819
|
required: boolean;
|
|
952
1820
|
/**
|
|
953
|
-
* Is
|
|
1821
|
+
* Is column an array?
|
|
954
1822
|
*/
|
|
955
1823
|
array?: boolean;
|
|
956
1824
|
/**
|
|
957
|
-
*
|
|
1825
|
+
* Column creation date in ISO 8601 format.
|
|
958
1826
|
*/
|
|
959
1827
|
$createdAt: string;
|
|
960
1828
|
/**
|
|
961
|
-
*
|
|
1829
|
+
* Column update date in ISO 8601 format.
|
|
962
1830
|
*/
|
|
963
1831
|
$updatedAt: string;
|
|
964
1832
|
/**
|
|
965
|
-
*
|
|
966
|
-
*/
|
|
967
|
-
elements: string[];
|
|
968
|
-
/**
|
|
969
|
-
* String format.
|
|
1833
|
+
* ISO 8601 format.
|
|
970
1834
|
*/
|
|
971
1835
|
format: string;
|
|
972
1836
|
/**
|
|
973
|
-
* Default value for
|
|
1837
|
+
* Default value for column when not provided. Only null is optional
|
|
974
1838
|
*/
|
|
975
1839
|
default?: string;
|
|
976
1840
|
};
|
|
977
1841
|
/**
|
|
978
|
-
*
|
|
1842
|
+
* ColumnRelationship
|
|
979
1843
|
*/
|
|
980
|
-
export type
|
|
1844
|
+
export type ColumnRelationship = {
|
|
981
1845
|
/**
|
|
982
|
-
*
|
|
1846
|
+
* Column Key.
|
|
983
1847
|
*/
|
|
984
1848
|
key: string;
|
|
985
1849
|
/**
|
|
986
|
-
*
|
|
1850
|
+
* Column type.
|
|
987
1851
|
*/
|
|
988
1852
|
type: string;
|
|
989
1853
|
/**
|
|
990
|
-
*
|
|
1854
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
991
1855
|
*/
|
|
992
|
-
status:
|
|
1856
|
+
status: ColumnStatus;
|
|
993
1857
|
/**
|
|
994
|
-
* Error message. Displays error generated on failure of creating or deleting an
|
|
1858
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
995
1859
|
*/
|
|
996
1860
|
error: string;
|
|
997
1861
|
/**
|
|
998
|
-
* Is
|
|
1862
|
+
* Is column required?
|
|
999
1863
|
*/
|
|
1000
1864
|
required: boolean;
|
|
1001
1865
|
/**
|
|
1002
|
-
* Is
|
|
1866
|
+
* Is column an array?
|
|
1003
1867
|
*/
|
|
1004
1868
|
array?: boolean;
|
|
1005
1869
|
/**
|
|
1006
|
-
*
|
|
1870
|
+
* Column creation date in ISO 8601 format.
|
|
1007
1871
|
*/
|
|
1008
1872
|
$createdAt: string;
|
|
1009
1873
|
/**
|
|
1010
|
-
*
|
|
1874
|
+
* Column update date in ISO 8601 format.
|
|
1011
1875
|
*/
|
|
1012
1876
|
$updatedAt: string;
|
|
1013
1877
|
/**
|
|
1014
|
-
*
|
|
1878
|
+
* The ID of the related table.
|
|
1015
1879
|
*/
|
|
1016
|
-
|
|
1880
|
+
relatedTable: string;
|
|
1017
1881
|
/**
|
|
1018
|
-
*
|
|
1882
|
+
* The type of the relationship.
|
|
1019
1883
|
*/
|
|
1020
|
-
|
|
1884
|
+
relationType: string;
|
|
1885
|
+
/**
|
|
1886
|
+
* Is the relationship two-way?
|
|
1887
|
+
*/
|
|
1888
|
+
twoWay: boolean;
|
|
1889
|
+
/**
|
|
1890
|
+
* The key of the two-way relationship.
|
|
1891
|
+
*/
|
|
1892
|
+
twoWayKey: string;
|
|
1893
|
+
/**
|
|
1894
|
+
* How deleting the parent document will propagate to child documents.
|
|
1895
|
+
*/
|
|
1896
|
+
onDelete: string;
|
|
1897
|
+
/**
|
|
1898
|
+
* Whether this is the parent or child side of the relationship
|
|
1899
|
+
*/
|
|
1900
|
+
side: string;
|
|
1021
1901
|
};
|
|
1022
1902
|
/**
|
|
1023
|
-
*
|
|
1903
|
+
* ColumnPoint
|
|
1024
1904
|
*/
|
|
1025
|
-
export type
|
|
1905
|
+
export type ColumnPoint = {
|
|
1026
1906
|
/**
|
|
1027
|
-
*
|
|
1907
|
+
* Column Key.
|
|
1028
1908
|
*/
|
|
1029
1909
|
key: string;
|
|
1030
1910
|
/**
|
|
1031
|
-
*
|
|
1911
|
+
* Column type.
|
|
1032
1912
|
*/
|
|
1033
1913
|
type: string;
|
|
1034
1914
|
/**
|
|
1035
|
-
*
|
|
1915
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1036
1916
|
*/
|
|
1037
|
-
status:
|
|
1917
|
+
status: ColumnStatus;
|
|
1038
1918
|
/**
|
|
1039
|
-
* Error message. Displays error generated on failure of creating or deleting an
|
|
1919
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
1040
1920
|
*/
|
|
1041
1921
|
error: string;
|
|
1042
1922
|
/**
|
|
1043
|
-
* Is
|
|
1923
|
+
* Is column required?
|
|
1044
1924
|
*/
|
|
1045
1925
|
required: boolean;
|
|
1046
1926
|
/**
|
|
1047
|
-
* Is
|
|
1927
|
+
* Is column an array?
|
|
1048
1928
|
*/
|
|
1049
1929
|
array?: boolean;
|
|
1050
1930
|
/**
|
|
1051
|
-
*
|
|
1931
|
+
* Column creation date in ISO 8601 format.
|
|
1052
1932
|
*/
|
|
1053
1933
|
$createdAt: string;
|
|
1054
1934
|
/**
|
|
1055
|
-
*
|
|
1935
|
+
* Column update date in ISO 8601 format.
|
|
1056
1936
|
*/
|
|
1057
1937
|
$updatedAt: string;
|
|
1058
1938
|
/**
|
|
1059
|
-
*
|
|
1060
|
-
*/
|
|
1061
|
-
format: string;
|
|
1062
|
-
/**
|
|
1063
|
-
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1939
|
+
* Default value for column when not provided. Cannot be set when column is required.
|
|
1064
1940
|
*/
|
|
1065
|
-
default?:
|
|
1941
|
+
default?: any[];
|
|
1066
1942
|
};
|
|
1067
1943
|
/**
|
|
1068
|
-
*
|
|
1944
|
+
* ColumnLine
|
|
1069
1945
|
*/
|
|
1070
|
-
export type
|
|
1946
|
+
export type ColumnLine = {
|
|
1071
1947
|
/**
|
|
1072
|
-
*
|
|
1948
|
+
* Column Key.
|
|
1073
1949
|
*/
|
|
1074
1950
|
key: string;
|
|
1075
1951
|
/**
|
|
1076
|
-
*
|
|
1952
|
+
* Column type.
|
|
1077
1953
|
*/
|
|
1078
1954
|
type: string;
|
|
1079
1955
|
/**
|
|
1080
|
-
*
|
|
1956
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1081
1957
|
*/
|
|
1082
|
-
status:
|
|
1958
|
+
status: ColumnStatus;
|
|
1083
1959
|
/**
|
|
1084
|
-
* Error message. Displays error generated on failure of creating or deleting an
|
|
1960
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
1085
1961
|
*/
|
|
1086
1962
|
error: string;
|
|
1087
1963
|
/**
|
|
1088
|
-
* Is
|
|
1964
|
+
* Is column required?
|
|
1089
1965
|
*/
|
|
1090
1966
|
required: boolean;
|
|
1091
1967
|
/**
|
|
1092
|
-
* Is
|
|
1968
|
+
* Is column an array?
|
|
1093
1969
|
*/
|
|
1094
1970
|
array?: boolean;
|
|
1095
1971
|
/**
|
|
1096
|
-
*
|
|
1972
|
+
* Column creation date in ISO 8601 format.
|
|
1097
1973
|
*/
|
|
1098
1974
|
$createdAt: string;
|
|
1099
1975
|
/**
|
|
1100
|
-
*
|
|
1976
|
+
* Column update date in ISO 8601 format.
|
|
1101
1977
|
*/
|
|
1102
1978
|
$updatedAt: string;
|
|
1103
1979
|
/**
|
|
1104
|
-
*
|
|
1105
|
-
*/
|
|
1106
|
-
format: string;
|
|
1107
|
-
/**
|
|
1108
|
-
* Default value for attribute when not provided. Only null is optional
|
|
1980
|
+
* Default value for column when not provided. Cannot be set when column is required.
|
|
1109
1981
|
*/
|
|
1110
|
-
default?:
|
|
1982
|
+
default?: any[];
|
|
1111
1983
|
};
|
|
1112
1984
|
/**
|
|
1113
|
-
*
|
|
1985
|
+
* ColumnPolygon
|
|
1114
1986
|
*/
|
|
1115
|
-
export type
|
|
1987
|
+
export type ColumnPolygon = {
|
|
1116
1988
|
/**
|
|
1117
|
-
*
|
|
1989
|
+
* Column Key.
|
|
1118
1990
|
*/
|
|
1119
1991
|
key: string;
|
|
1120
1992
|
/**
|
|
1121
|
-
*
|
|
1993
|
+
* Column type.
|
|
1122
1994
|
*/
|
|
1123
1995
|
type: string;
|
|
1124
1996
|
/**
|
|
1125
|
-
*
|
|
1997
|
+
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
1126
1998
|
*/
|
|
1127
|
-
status:
|
|
1999
|
+
status: ColumnStatus;
|
|
1128
2000
|
/**
|
|
1129
|
-
* Error message. Displays error generated on failure of creating or deleting an
|
|
2001
|
+
* Error message. Displays error generated on failure of creating or deleting an column.
|
|
1130
2002
|
*/
|
|
1131
2003
|
error: string;
|
|
1132
2004
|
/**
|
|
1133
|
-
* Is
|
|
2005
|
+
* Is column required?
|
|
1134
2006
|
*/
|
|
1135
2007
|
required: boolean;
|
|
1136
2008
|
/**
|
|
1137
|
-
* Is
|
|
2009
|
+
* Is column an array?
|
|
1138
2010
|
*/
|
|
1139
2011
|
array?: boolean;
|
|
1140
2012
|
/**
|
|
1141
|
-
*
|
|
2013
|
+
* Column creation date in ISO 8601 format.
|
|
1142
2014
|
*/
|
|
1143
2015
|
$createdAt: string;
|
|
1144
2016
|
/**
|
|
1145
|
-
*
|
|
2017
|
+
* Column update date in ISO 8601 format.
|
|
1146
2018
|
*/
|
|
1147
2019
|
$updatedAt: string;
|
|
1148
2020
|
/**
|
|
1149
|
-
*
|
|
2021
|
+
* Default value for column when not provided. Cannot be set when column is required.
|
|
1150
2022
|
*/
|
|
1151
|
-
|
|
2023
|
+
default?: any[];
|
|
2024
|
+
};
|
|
2025
|
+
/**
|
|
2026
|
+
* Index
|
|
2027
|
+
*/
|
|
2028
|
+
export type Index = {
|
|
1152
2029
|
/**
|
|
1153
|
-
*
|
|
2030
|
+
* Index ID.
|
|
1154
2031
|
*/
|
|
1155
|
-
|
|
2032
|
+
$id: string;
|
|
1156
2033
|
/**
|
|
1157
|
-
*
|
|
2034
|
+
* Index creation date in ISO 8601 format.
|
|
1158
2035
|
*/
|
|
1159
|
-
|
|
2036
|
+
$createdAt: string;
|
|
1160
2037
|
/**
|
|
1161
|
-
*
|
|
2038
|
+
* Index update date in ISO 8601 format.
|
|
1162
2039
|
*/
|
|
1163
|
-
|
|
2040
|
+
$updatedAt: string;
|
|
1164
2041
|
/**
|
|
1165
|
-
*
|
|
2042
|
+
* Index key.
|
|
1166
2043
|
*/
|
|
1167
|
-
|
|
2044
|
+
key: string;
|
|
1168
2045
|
/**
|
|
1169
|
-
*
|
|
2046
|
+
* Index type.
|
|
1170
2047
|
*/
|
|
1171
|
-
|
|
2048
|
+
type: string;
|
|
2049
|
+
/**
|
|
2050
|
+
* Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
|
|
2051
|
+
*/
|
|
2052
|
+
status: IndexStatus;
|
|
2053
|
+
/**
|
|
2054
|
+
* Error message. Displays error generated on failure of creating or deleting an index.
|
|
2055
|
+
*/
|
|
2056
|
+
error: string;
|
|
2057
|
+
/**
|
|
2058
|
+
* Index attributes.
|
|
2059
|
+
*/
|
|
2060
|
+
attributes: string[];
|
|
2061
|
+
/**
|
|
2062
|
+
* Index attributes length.
|
|
2063
|
+
*/
|
|
2064
|
+
lengths: number[];
|
|
2065
|
+
/**
|
|
2066
|
+
* Index orders.
|
|
2067
|
+
*/
|
|
2068
|
+
orders?: string[];
|
|
1172
2069
|
};
|
|
1173
2070
|
/**
|
|
1174
2071
|
* Index
|
|
1175
2072
|
*/
|
|
1176
|
-
export type
|
|
2073
|
+
export type ColumnIndex = {
|
|
2074
|
+
/**
|
|
2075
|
+
* Index ID.
|
|
2076
|
+
*/
|
|
2077
|
+
$id: string;
|
|
2078
|
+
/**
|
|
2079
|
+
* Index creation date in ISO 8601 format.
|
|
2080
|
+
*/
|
|
2081
|
+
$createdAt: string;
|
|
2082
|
+
/**
|
|
2083
|
+
* Index update date in ISO 8601 format.
|
|
2084
|
+
*/
|
|
2085
|
+
$updatedAt: string;
|
|
1177
2086
|
/**
|
|
1178
2087
|
* Index Key.
|
|
1179
2088
|
*/
|
|
@@ -1191,25 +2100,54 @@ export declare namespace Models {
|
|
|
1191
2100
|
*/
|
|
1192
2101
|
error: string;
|
|
1193
2102
|
/**
|
|
1194
|
-
* Index
|
|
2103
|
+
* Index columns.
|
|
1195
2104
|
*/
|
|
1196
|
-
|
|
2105
|
+
columns: string[];
|
|
1197
2106
|
/**
|
|
1198
|
-
* Index
|
|
2107
|
+
* Index columns length.
|
|
1199
2108
|
*/
|
|
1200
2109
|
lengths: number[];
|
|
1201
2110
|
/**
|
|
1202
2111
|
* Index orders.
|
|
1203
2112
|
*/
|
|
1204
2113
|
orders?: string[];
|
|
2114
|
+
};
|
|
2115
|
+
/**
|
|
2116
|
+
* Row
|
|
2117
|
+
*/
|
|
2118
|
+
export type Row = {
|
|
1205
2119
|
/**
|
|
1206
|
-
*
|
|
2120
|
+
* Row ID.
|
|
2121
|
+
*/
|
|
2122
|
+
$id: string;
|
|
2123
|
+
/**
|
|
2124
|
+
* Row automatically incrementing ID.
|
|
2125
|
+
*/
|
|
2126
|
+
$sequence: number;
|
|
2127
|
+
/**
|
|
2128
|
+
* Table ID.
|
|
2129
|
+
*/
|
|
2130
|
+
$tableId: string;
|
|
2131
|
+
/**
|
|
2132
|
+
* Database ID.
|
|
2133
|
+
*/
|
|
2134
|
+
$databaseId: string;
|
|
2135
|
+
/**
|
|
2136
|
+
* Row creation date in ISO 8601 format.
|
|
1207
2137
|
*/
|
|
1208
2138
|
$createdAt: string;
|
|
1209
2139
|
/**
|
|
1210
|
-
*
|
|
2140
|
+
* Row update date in ISO 8601 format.
|
|
1211
2141
|
*/
|
|
1212
2142
|
$updatedAt: string;
|
|
2143
|
+
/**
|
|
2144
|
+
* Row permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
2145
|
+
*/
|
|
2146
|
+
$permissions: string[];
|
|
2147
|
+
};
|
|
2148
|
+
export type DefaultRow = Row & {
|
|
2149
|
+
[key: string]: any;
|
|
2150
|
+
[__default]: true;
|
|
1213
2151
|
};
|
|
1214
2152
|
/**
|
|
1215
2153
|
* Document
|
|
@@ -1750,7 +2688,7 @@ export declare namespace Models {
|
|
|
1750
2688
|
*/
|
|
1751
2689
|
country: string;
|
|
1752
2690
|
/**
|
|
1753
|
-
* Continent code. A two character continent code
|
|
2691
|
+
* Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America.
|
|
1754
2692
|
*/
|
|
1755
2693
|
continentCode: string;
|
|
1756
2694
|
/**
|
|
@@ -1880,6 +2818,10 @@ export declare namespace Models {
|
|
|
1880
2818
|
* Virus scanning is enabled.
|
|
1881
2819
|
*/
|
|
1882
2820
|
antivirus: boolean;
|
|
2821
|
+
/**
|
|
2822
|
+
* Image transformations are enabled.
|
|
2823
|
+
*/
|
|
2824
|
+
transformations: boolean;
|
|
1883
2825
|
};
|
|
1884
2826
|
/**
|
|
1885
2827
|
* ResourceToken
|
|
@@ -2025,7 +2967,7 @@ export declare namespace Models {
|
|
|
2025
2967
|
*/
|
|
2026
2968
|
enabled: boolean;
|
|
2027
2969
|
/**
|
|
2028
|
-
* Is the site deployed with the latest configuration? This is set to false if you
|
|
2970
|
+
* Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.
|
|
2029
2971
|
*/
|
|
2030
2972
|
live: boolean;
|
|
2031
2973
|
/**
|
|
@@ -2037,7 +2979,7 @@ export declare namespace Models {
|
|
|
2037
2979
|
*/
|
|
2038
2980
|
framework: string;
|
|
2039
2981
|
/**
|
|
2040
|
-
* Site
|
|
2982
|
+
* Site's active deployment ID.
|
|
2041
2983
|
*/
|
|
2042
2984
|
deploymentId: string;
|
|
2043
2985
|
/**
|
|
@@ -2053,7 +2995,7 @@ export declare namespace Models {
|
|
|
2053
2995
|
*/
|
|
2054
2996
|
deploymentScreenshotDark: string;
|
|
2055
2997
|
/**
|
|
2056
|
-
* Site
|
|
2998
|
+
* Site's latest deployment ID.
|
|
2057
2999
|
*/
|
|
2058
3000
|
latestDeploymentId: string;
|
|
2059
3001
|
/**
|
|
@@ -2061,7 +3003,7 @@ export declare namespace Models {
|
|
|
2061
3003
|
*/
|
|
2062
3004
|
latestDeploymentCreatedAt: string;
|
|
2063
3005
|
/**
|
|
2064
|
-
* Status of latest deployment. Possible values are
|
|
3006
|
+
* Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed".
|
|
2065
3007
|
*/
|
|
2066
3008
|
latestDeploymentStatus: string;
|
|
2067
3009
|
/**
|
|
@@ -2248,7 +3190,7 @@ export declare namespace Models {
|
|
|
2248
3190
|
*/
|
|
2249
3191
|
enabled: boolean;
|
|
2250
3192
|
/**
|
|
2251
|
-
* Is the function deployed with the latest configuration? This is set to false if you
|
|
3193
|
+
* Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.
|
|
2252
3194
|
*/
|
|
2253
3195
|
live: boolean;
|
|
2254
3196
|
/**
|
|
@@ -2260,7 +3202,7 @@ export declare namespace Models {
|
|
|
2260
3202
|
*/
|
|
2261
3203
|
runtime: string;
|
|
2262
3204
|
/**
|
|
2263
|
-
* Function
|
|
3205
|
+
* Function's active deployment ID.
|
|
2264
3206
|
*/
|
|
2265
3207
|
deploymentId: string;
|
|
2266
3208
|
/**
|
|
@@ -2268,7 +3210,7 @@ export declare namespace Models {
|
|
|
2268
3210
|
*/
|
|
2269
3211
|
deploymentCreatedAt: string;
|
|
2270
3212
|
/**
|
|
2271
|
-
* Function
|
|
3213
|
+
* Function's latest deployment ID.
|
|
2272
3214
|
*/
|
|
2273
3215
|
latestDeploymentId: string;
|
|
2274
3216
|
/**
|
|
@@ -2276,7 +3218,7 @@ export declare namespace Models {
|
|
|
2276
3218
|
*/
|
|
2277
3219
|
latestDeploymentCreatedAt: string;
|
|
2278
3220
|
/**
|
|
2279
|
-
* Status of latest deployment. Possible values are
|
|
3221
|
+
* Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed".
|
|
2280
3222
|
*/
|
|
2281
3223
|
latestDeploymentStatus: string;
|
|
2282
3224
|
/**
|
|
@@ -2517,13 +3459,17 @@ export declare namespace Models {
|
|
|
2517
3459
|
*/
|
|
2518
3460
|
private: boolean;
|
|
2519
3461
|
/**
|
|
2520
|
-
* VCS (Version Control System) repository
|
|
3462
|
+
* VCS (Version Control System) repository's default branch name.
|
|
2521
3463
|
*/
|
|
2522
3464
|
defaultBranch: string;
|
|
2523
3465
|
/**
|
|
2524
3466
|
* Last commit date in ISO 8601 format.
|
|
2525
3467
|
*/
|
|
2526
3468
|
pushedAt: string;
|
|
3469
|
+
/**
|
|
3470
|
+
* Environment variables found in .env files
|
|
3471
|
+
*/
|
|
3472
|
+
variables: string[];
|
|
2527
3473
|
};
|
|
2528
3474
|
/**
|
|
2529
3475
|
* ProviderRepositoryFramework
|
|
@@ -2550,7 +3496,7 @@ export declare namespace Models {
|
|
|
2550
3496
|
*/
|
|
2551
3497
|
private: boolean;
|
|
2552
3498
|
/**
|
|
2553
|
-
* VCS (Version Control System) repository
|
|
3499
|
+
* VCS (Version Control System) repository's default branch name.
|
|
2554
3500
|
*/
|
|
2555
3501
|
defaultBranch: string;
|
|
2556
3502
|
/**
|
|
@@ -2558,7 +3504,11 @@ export declare namespace Models {
|
|
|
2558
3504
|
*/
|
|
2559
3505
|
pushedAt: string;
|
|
2560
3506
|
/**
|
|
2561
|
-
*
|
|
3507
|
+
* Environment variables found in .env files
|
|
3508
|
+
*/
|
|
3509
|
+
variables: string[];
|
|
3510
|
+
/**
|
|
3511
|
+
* Auto-detected framework. Empty if type is not "framework".
|
|
2562
3512
|
*/
|
|
2563
3513
|
framework: string;
|
|
2564
3514
|
};
|
|
@@ -2587,7 +3537,7 @@ export declare namespace Models {
|
|
|
2587
3537
|
*/
|
|
2588
3538
|
private: boolean;
|
|
2589
3539
|
/**
|
|
2590
|
-
* VCS (Version Control System) repository
|
|
3540
|
+
* VCS (Version Control System) repository's default branch name.
|
|
2591
3541
|
*/
|
|
2592
3542
|
defaultBranch: string;
|
|
2593
3543
|
/**
|
|
@@ -2595,7 +3545,11 @@ export declare namespace Models {
|
|
|
2595
3545
|
*/
|
|
2596
3546
|
pushedAt: string;
|
|
2597
3547
|
/**
|
|
2598
|
-
*
|
|
3548
|
+
* Environment variables found in .env files
|
|
3549
|
+
*/
|
|
3550
|
+
variables: string[];
|
|
3551
|
+
/**
|
|
3552
|
+
* Auto-detected runtime. Empty if type is not "runtime".
|
|
2599
3553
|
*/
|
|
2600
3554
|
runtime: string;
|
|
2601
3555
|
};
|
|
@@ -2603,6 +3557,10 @@ export declare namespace Models {
|
|
|
2603
3557
|
* DetectionFramework
|
|
2604
3558
|
*/
|
|
2605
3559
|
export type DetectionFramework = {
|
|
3560
|
+
/**
|
|
3561
|
+
* Environment variables found in .env files
|
|
3562
|
+
*/
|
|
3563
|
+
variables?: DetectionVariable[];
|
|
2606
3564
|
/**
|
|
2607
3565
|
* Framework
|
|
2608
3566
|
*/
|
|
@@ -2624,6 +3582,10 @@ export declare namespace Models {
|
|
|
2624
3582
|
* DetectionRuntime
|
|
2625
3583
|
*/
|
|
2626
3584
|
export type DetectionRuntime = {
|
|
3585
|
+
/**
|
|
3586
|
+
* Environment variables found in .env files
|
|
3587
|
+
*/
|
|
3588
|
+
variables?: DetectionVariable[];
|
|
2627
3589
|
/**
|
|
2628
3590
|
* Runtime
|
|
2629
3591
|
*/
|
|
@@ -2637,6 +3599,19 @@ export declare namespace Models {
|
|
|
2637
3599
|
*/
|
|
2638
3600
|
commands: string;
|
|
2639
3601
|
};
|
|
3602
|
+
/**
|
|
3603
|
+
* DetectionVariable
|
|
3604
|
+
*/
|
|
3605
|
+
export type DetectionVariable = {
|
|
3606
|
+
/**
|
|
3607
|
+
* Name of environment variable
|
|
3608
|
+
*/
|
|
3609
|
+
name: string;
|
|
3610
|
+
/**
|
|
3611
|
+
* Value of environment variable
|
|
3612
|
+
*/
|
|
3613
|
+
value: string;
|
|
3614
|
+
};
|
|
2640
3615
|
/**
|
|
2641
3616
|
* VcsContents
|
|
2642
3617
|
*/
|
|
@@ -2811,9 +3786,9 @@ export declare namespace Models {
|
|
|
2811
3786
|
*/
|
|
2812
3787
|
screenshotDark: string;
|
|
2813
3788
|
/**
|
|
2814
|
-
* The deployment status. Possible values are
|
|
3789
|
+
* The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed".
|
|
2815
3790
|
*/
|
|
2816
|
-
status:
|
|
3791
|
+
status: DeploymentStatus;
|
|
2817
3792
|
/**
|
|
2818
3793
|
* The build logs.
|
|
2819
3794
|
*/
|
|
@@ -2834,10 +3809,6 @@ export declare namespace Models {
|
|
|
2834
3809
|
* The url of the vcs provider repository
|
|
2835
3810
|
*/
|
|
2836
3811
|
providerRepositoryUrl: string;
|
|
2837
|
-
/**
|
|
2838
|
-
* The branch of the vcs repository
|
|
2839
|
-
*/
|
|
2840
|
-
providerBranch: string;
|
|
2841
3812
|
/**
|
|
2842
3813
|
* The commit hash of the vcs commit
|
|
2843
3814
|
*/
|
|
@@ -2858,6 +3829,10 @@ export declare namespace Models {
|
|
|
2858
3829
|
* The url of the vcs commit
|
|
2859
3830
|
*/
|
|
2860
3831
|
providerCommitUrl: string;
|
|
3832
|
+
/**
|
|
3833
|
+
* The branch of the vcs repository
|
|
3834
|
+
*/
|
|
3835
|
+
providerBranch: string;
|
|
2861
3836
|
/**
|
|
2862
3837
|
* The branch of the vcs repository
|
|
2863
3838
|
*/
|
|
@@ -2876,7 +3851,7 @@ export declare namespace Models {
|
|
|
2876
3851
|
*/
|
|
2877
3852
|
$createdAt: string;
|
|
2878
3853
|
/**
|
|
2879
|
-
* Execution
|
|
3854
|
+
* Execution update date in ISO 8601 format.
|
|
2880
3855
|
*/
|
|
2881
3856
|
$updatedAt: string;
|
|
2882
3857
|
/**
|
|
@@ -2887,14 +3862,18 @@ export declare namespace Models {
|
|
|
2887
3862
|
* Function ID.
|
|
2888
3863
|
*/
|
|
2889
3864
|
functionId: string;
|
|
3865
|
+
/**
|
|
3866
|
+
* Function's deployment ID used to create the execution.
|
|
3867
|
+
*/
|
|
3868
|
+
deploymentId: string;
|
|
2890
3869
|
/**
|
|
2891
3870
|
* The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.
|
|
2892
3871
|
*/
|
|
2893
|
-
trigger:
|
|
3872
|
+
trigger: ExecutionTrigger;
|
|
2894
3873
|
/**
|
|
2895
|
-
* The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `
|
|
3874
|
+
* The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.
|
|
2896
3875
|
*/
|
|
2897
|
-
status:
|
|
3876
|
+
status: ExecutionStatus;
|
|
2898
3877
|
/**
|
|
2899
3878
|
* HTTP request method type.
|
|
2900
3879
|
*/
|
|
@@ -2904,7 +3883,7 @@ export declare namespace Models {
|
|
|
2904
3883
|
*/
|
|
2905
3884
|
requestPath: string;
|
|
2906
3885
|
/**
|
|
2907
|
-
* HTTP
|
|
3886
|
+
* HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.
|
|
2908
3887
|
*/
|
|
2909
3888
|
requestHeaders: Headers[];
|
|
2910
3889
|
/**
|
|
@@ -3013,7 +3992,7 @@ export declare namespace Models {
|
|
|
3013
3992
|
*/
|
|
3014
3993
|
authPasswordHistory: number;
|
|
3015
3994
|
/**
|
|
3016
|
-
* Whether or not to check user
|
|
3995
|
+
* Whether or not to check user's password against most commonly used passwords.
|
|
3017
3996
|
*/
|
|
3018
3997
|
authPasswordDictionary: boolean;
|
|
3019
3998
|
/**
|
|
@@ -3040,6 +4019,10 @@ export declare namespace Models {
|
|
|
3040
4019
|
* Whether or not to show user MFA status in the teams membership response.
|
|
3041
4020
|
*/
|
|
3042
4021
|
authMembershipsMfa: boolean;
|
|
4022
|
+
/**
|
|
4023
|
+
* Whether or not all existing sessions should be invalidated on password change
|
|
4024
|
+
*/
|
|
4025
|
+
authInvalidateSessions: boolean;
|
|
3043
4026
|
/**
|
|
3044
4027
|
* List of Auth Providers.
|
|
3045
4028
|
*/
|
|
@@ -3141,9 +4124,13 @@ export declare namespace Models {
|
|
|
3141
4124
|
*/
|
|
3142
4125
|
serviceStatusForAvatars: boolean;
|
|
3143
4126
|
/**
|
|
3144
|
-
* Databases service status
|
|
4127
|
+
* Databases (legacy) service status
|
|
3145
4128
|
*/
|
|
3146
4129
|
serviceStatusForDatabases: boolean;
|
|
4130
|
+
/**
|
|
4131
|
+
* TablesDB service status
|
|
4132
|
+
*/
|
|
4133
|
+
serviceStatusForTablesdb: boolean;
|
|
3147
4134
|
/**
|
|
3148
4135
|
* Locale service status
|
|
3149
4136
|
*/
|
|
@@ -3184,6 +4171,18 @@ export declare namespace Models {
|
|
|
3184
4171
|
* Project region
|
|
3185
4172
|
*/
|
|
3186
4173
|
region: string;
|
|
4174
|
+
/**
|
|
4175
|
+
* Project status
|
|
4176
|
+
*/
|
|
4177
|
+
status: string;
|
|
4178
|
+
/**
|
|
4179
|
+
* Billing limits reached
|
|
4180
|
+
*/
|
|
4181
|
+
billingLimits: BillingLimits;
|
|
4182
|
+
/**
|
|
4183
|
+
* Project blocks information
|
|
4184
|
+
*/
|
|
4185
|
+
blocks: Block[];
|
|
3187
4186
|
};
|
|
3188
4187
|
/**
|
|
3189
4188
|
* Webhook
|
|
@@ -3379,9 +4378,9 @@ export declare namespace Models {
|
|
|
3379
4378
|
*/
|
|
3380
4379
|
name: string;
|
|
3381
4380
|
/**
|
|
3382
|
-
* Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, ios, android,
|
|
4381
|
+
* Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.
|
|
3383
4382
|
*/
|
|
3384
|
-
type:
|
|
4383
|
+
type: PlatformType;
|
|
3385
4384
|
/**
|
|
3386
4385
|
* Platform Key. iOS bundle ID or Android package name. Empty string for other platforms.
|
|
3387
4386
|
*/
|
|
@@ -3432,11 +4431,11 @@ export declare namespace Models {
|
|
|
3432
4431
|
*/
|
|
3433
4432
|
secret: boolean;
|
|
3434
4433
|
/**
|
|
3435
|
-
* Service to which the variable belongs. Possible values are
|
|
4434
|
+
* Service to which the variable belongs. Possible values are "project", "function"
|
|
3436
4435
|
*/
|
|
3437
4436
|
resourceType: string;
|
|
3438
4437
|
/**
|
|
3439
|
-
* ID of resource to which the variable belongs. If resourceType is
|
|
4438
|
+
* ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function.
|
|
3440
4439
|
*/
|
|
3441
4440
|
resourceId: string;
|
|
3442
4441
|
};
|
|
@@ -3542,9 +4541,9 @@ export declare namespace Models {
|
|
|
3542
4541
|
*/
|
|
3543
4542
|
version: string;
|
|
3544
4543
|
/**
|
|
3545
|
-
* Antivirus status. Possible values
|
|
4544
|
+
* Antivirus status. Possible values are: `disabled`, `offline`, `online`
|
|
3546
4545
|
*/
|
|
3547
|
-
status:
|
|
4546
|
+
status: HealthAntivirusStatus;
|
|
3548
4547
|
};
|
|
3549
4548
|
/**
|
|
3550
4549
|
* Health Queue
|
|
@@ -3568,9 +4567,9 @@ export declare namespace Models {
|
|
|
3568
4567
|
*/
|
|
3569
4568
|
ping: number;
|
|
3570
4569
|
/**
|
|
3571
|
-
* Service status. Possible values
|
|
4570
|
+
* Service status. Possible values are: `pass`, `fail`
|
|
3572
4571
|
*/
|
|
3573
|
-
status:
|
|
4572
|
+
status: HealthCheckStatus;
|
|
3574
4573
|
};
|
|
3575
4574
|
/**
|
|
3576
4575
|
* Health Certificate
|
|
@@ -3667,11 +4666,19 @@ export declare namespace Models {
|
|
|
3667
4666
|
/**
|
|
3668
4667
|
* Total aggregated number of collections.
|
|
3669
4668
|
*/
|
|
3670
|
-
collectionsTotal: number;
|
|
4669
|
+
collectionsTotal: number;
|
|
4670
|
+
/**
|
|
4671
|
+
* Total aggregated number of tables.
|
|
4672
|
+
*/
|
|
4673
|
+
tablesTotal: number;
|
|
3671
4674
|
/**
|
|
3672
4675
|
* Total aggregated number of documents.
|
|
3673
4676
|
*/
|
|
3674
4677
|
documentsTotal: number;
|
|
4678
|
+
/**
|
|
4679
|
+
* Total aggregated number of rows.
|
|
4680
|
+
*/
|
|
4681
|
+
rowsTotal: number;
|
|
3675
4682
|
/**
|
|
3676
4683
|
* Total aggregated number of total databases storage in bytes.
|
|
3677
4684
|
*/
|
|
@@ -3692,10 +4699,18 @@ export declare namespace Models {
|
|
|
3692
4699
|
* Aggregated number of collections per period.
|
|
3693
4700
|
*/
|
|
3694
4701
|
collections: Metric[];
|
|
4702
|
+
/**
|
|
4703
|
+
* Aggregated number of tables per period.
|
|
4704
|
+
*/
|
|
4705
|
+
tables: Metric[];
|
|
3695
4706
|
/**
|
|
3696
4707
|
* Aggregated number of documents per period.
|
|
3697
4708
|
*/
|
|
3698
4709
|
documents: Metric[];
|
|
4710
|
+
/**
|
|
4711
|
+
* Aggregated number of rows per period.
|
|
4712
|
+
*/
|
|
4713
|
+
rows: Metric[];
|
|
3699
4714
|
/**
|
|
3700
4715
|
* An array of the aggregated number of databases storage in bytes per period.
|
|
3701
4716
|
*/
|
|
@@ -3721,10 +4736,18 @@ export declare namespace Models {
|
|
|
3721
4736
|
* Total aggregated number of collections.
|
|
3722
4737
|
*/
|
|
3723
4738
|
collectionsTotal: number;
|
|
4739
|
+
/**
|
|
4740
|
+
* Total aggregated number of tables.
|
|
4741
|
+
*/
|
|
4742
|
+
tablesTotal: number;
|
|
3724
4743
|
/**
|
|
3725
4744
|
* Total aggregated number of documents.
|
|
3726
4745
|
*/
|
|
3727
4746
|
documentsTotal: number;
|
|
4747
|
+
/**
|
|
4748
|
+
* Total aggregated number of rows.
|
|
4749
|
+
*/
|
|
4750
|
+
rowsTotal: number;
|
|
3728
4751
|
/**
|
|
3729
4752
|
* Total aggregated number of total storage used in bytes.
|
|
3730
4753
|
*/
|
|
@@ -3741,10 +4764,18 @@ export declare namespace Models {
|
|
|
3741
4764
|
* Aggregated number of collections per period.
|
|
3742
4765
|
*/
|
|
3743
4766
|
collections: Metric[];
|
|
4767
|
+
/**
|
|
4768
|
+
* Aggregated number of tables per period.
|
|
4769
|
+
*/
|
|
4770
|
+
tables: Metric[];
|
|
3744
4771
|
/**
|
|
3745
4772
|
* Aggregated number of documents per period.
|
|
3746
4773
|
*/
|
|
3747
4774
|
documents: Metric[];
|
|
4775
|
+
/**
|
|
4776
|
+
* Aggregated number of rows per period.
|
|
4777
|
+
*/
|
|
4778
|
+
rows: Metric[];
|
|
3748
4779
|
/**
|
|
3749
4780
|
* Aggregated storage used in bytes per period.
|
|
3750
4781
|
*/
|
|
@@ -3758,6 +4789,23 @@ export declare namespace Models {
|
|
|
3758
4789
|
*/
|
|
3759
4790
|
databaseWrites: Metric[];
|
|
3760
4791
|
};
|
|
4792
|
+
/**
|
|
4793
|
+
* UsageTable
|
|
4794
|
+
*/
|
|
4795
|
+
export type UsageTable = {
|
|
4796
|
+
/**
|
|
4797
|
+
* Time range of the usage stats.
|
|
4798
|
+
*/
|
|
4799
|
+
range: string;
|
|
4800
|
+
/**
|
|
4801
|
+
* Total aggregated number of of rows.
|
|
4802
|
+
*/
|
|
4803
|
+
rowsTotal: number;
|
|
4804
|
+
/**
|
|
4805
|
+
* Aggregated number of rows per period.
|
|
4806
|
+
*/
|
|
4807
|
+
rows: Metric[];
|
|
4808
|
+
};
|
|
3761
4809
|
/**
|
|
3762
4810
|
* UsageCollection
|
|
3763
4811
|
*/
|
|
@@ -4338,6 +5386,10 @@ export declare namespace Models {
|
|
|
4338
5386
|
* Total aggregated number of documents.
|
|
4339
5387
|
*/
|
|
4340
5388
|
documentsTotal: number;
|
|
5389
|
+
/**
|
|
5390
|
+
* Total aggregated number of rows.
|
|
5391
|
+
*/
|
|
5392
|
+
rowsTotal: number;
|
|
4341
5393
|
/**
|
|
4342
5394
|
* Total aggregated number of databases.
|
|
4343
5395
|
*/
|
|
@@ -4462,6 +5514,22 @@ export declare namespace Models {
|
|
|
4462
5514
|
* Aggregated stats for total backups storage.
|
|
4463
5515
|
*/
|
|
4464
5516
|
backupsStorageTotal: number;
|
|
5517
|
+
/**
|
|
5518
|
+
* An array of aggregated number of screenshots generated.
|
|
5519
|
+
*/
|
|
5520
|
+
screenshotsGenerated: Metric[];
|
|
5521
|
+
/**
|
|
5522
|
+
* Total aggregated number of screenshots generated.
|
|
5523
|
+
*/
|
|
5524
|
+
screenshotsGeneratedTotal: number;
|
|
5525
|
+
/**
|
|
5526
|
+
* An array of aggregated number of Imagine credits in the given period.
|
|
5527
|
+
*/
|
|
5528
|
+
imagineCredits: Metric[];
|
|
5529
|
+
/**
|
|
5530
|
+
* Total aggregated number of Imagine credits.
|
|
5531
|
+
*/
|
|
5532
|
+
imagineCreditsTotal: number;
|
|
4465
5533
|
};
|
|
4466
5534
|
/**
|
|
4467
5535
|
* Headers
|
|
@@ -4518,43 +5586,43 @@ export declare namespace Models {
|
|
|
4518
5586
|
*/
|
|
4519
5587
|
domain: string;
|
|
4520
5588
|
/**
|
|
4521
|
-
* Action definition for the rule. Possible values are
|
|
5589
|
+
* Action definition for the rule. Possible values are "api", "deployment", or "redirect"
|
|
4522
5590
|
*/
|
|
4523
5591
|
type: string;
|
|
4524
5592
|
/**
|
|
4525
|
-
* Defines how the rule was created. Possible values are
|
|
5593
|
+
* Defines how the rule was created. Possible values are "manual" or "deployment"
|
|
4526
5594
|
*/
|
|
4527
5595
|
trigger: string;
|
|
4528
5596
|
/**
|
|
4529
|
-
* URL to redirect to. Used if type is
|
|
5597
|
+
* URL to redirect to. Used if type is "redirect"
|
|
4530
5598
|
*/
|
|
4531
5599
|
redirectUrl: string;
|
|
4532
5600
|
/**
|
|
4533
|
-
* Status code to apply during redirect. Used if type is
|
|
5601
|
+
* Status code to apply during redirect. Used if type is "redirect"
|
|
4534
5602
|
*/
|
|
4535
5603
|
redirectStatusCode: number;
|
|
4536
5604
|
/**
|
|
4537
|
-
* ID of deployment. Used if type is
|
|
5605
|
+
* ID of deployment. Used if type is "deployment"
|
|
4538
5606
|
*/
|
|
4539
5607
|
deploymentId: string;
|
|
4540
5608
|
/**
|
|
4541
|
-
* Type of deployment. Possible values are
|
|
5609
|
+
* Type of deployment. Possible values are "function", "site". Used if rule's type is "deployment".
|
|
4542
5610
|
*/
|
|
4543
|
-
deploymentResourceType:
|
|
5611
|
+
deploymentResourceType: ProxyRuleDeploymentResourceType;
|
|
4544
5612
|
/**
|
|
4545
|
-
* ID deployment
|
|
5613
|
+
* ID deployment's resource. Used if type is "deployment"
|
|
4546
5614
|
*/
|
|
4547
5615
|
deploymentResourceId: string;
|
|
4548
5616
|
/**
|
|
4549
|
-
* Name of Git branch that updates rule. Used if type is
|
|
5617
|
+
* Name of Git branch that updates rule. Used if type is "deployment"
|
|
4550
5618
|
*/
|
|
4551
5619
|
deploymentVcsProviderBranch: string;
|
|
4552
5620
|
/**
|
|
4553
|
-
* Domain verification status. Possible values are
|
|
5621
|
+
* Domain verification status. Possible values are "created", "verifying", "verified" and "unverified"
|
|
4554
5622
|
*/
|
|
4555
|
-
status:
|
|
5623
|
+
status: ProxyRuleStatus;
|
|
4556
5624
|
/**
|
|
4557
|
-
*
|
|
5625
|
+
* Logs from rule verification or certificate generation. Certificate generation logs are prioritized if both are available.
|
|
4558
5626
|
*/
|
|
4559
5627
|
logs: string;
|
|
4560
5628
|
/**
|
|
@@ -4624,10 +5692,18 @@ export declare namespace Models {
|
|
|
4624
5692
|
* A target for your Appwrite custom domains.
|
|
4625
5693
|
*/
|
|
4626
5694
|
_APP_DOMAIN_TARGET_A: string;
|
|
5695
|
+
/**
|
|
5696
|
+
* Maximum build timeout in seconds.
|
|
5697
|
+
*/
|
|
5698
|
+
_APP_COMPUTE_BUILD_TIMEOUT: number;
|
|
4627
5699
|
/**
|
|
4628
5700
|
* AAAA target for your Appwrite custom domains.
|
|
4629
5701
|
*/
|
|
4630
5702
|
_APP_DOMAIN_TARGET_AAAA: string;
|
|
5703
|
+
/**
|
|
5704
|
+
* CAA target for your Appwrite custom domains.
|
|
5705
|
+
*/
|
|
5706
|
+
_APP_DOMAIN_TARGET_CAA: string;
|
|
4631
5707
|
/**
|
|
4632
5708
|
* Maximum file size allowed for file upload in bytes.
|
|
4633
5709
|
*/
|
|
@@ -4637,7 +5713,7 @@ export declare namespace Models {
|
|
|
4637
5713
|
*/
|
|
4638
5714
|
_APP_COMPUTE_SIZE_LIMIT: number;
|
|
4639
5715
|
/**
|
|
4640
|
-
* Defines if usage stats are enabled. This value is set to
|
|
5716
|
+
* Defines if usage stats are enabled. This value is set to 'enabled' by default, to disable the usage stats set the value to 'disabled'.
|
|
4641
5717
|
*/
|
|
4642
5718
|
_APP_USAGE_STATS: string;
|
|
4643
5719
|
/**
|
|
@@ -4829,7 +5905,7 @@ export declare namespace Models {
|
|
|
4829
5905
|
/**
|
|
4830
5906
|
* Status of delivery.
|
|
4831
5907
|
*/
|
|
4832
|
-
status:
|
|
5908
|
+
status: MessageStatus;
|
|
4833
5909
|
};
|
|
4834
5910
|
/**
|
|
4835
5911
|
* Topic
|
|
@@ -4868,6 +5944,35 @@ export declare namespace Models {
|
|
|
4868
5944
|
*/
|
|
4869
5945
|
subscribe: string[];
|
|
4870
5946
|
};
|
|
5947
|
+
/**
|
|
5948
|
+
* Transaction
|
|
5949
|
+
*/
|
|
5950
|
+
export type Transaction = {
|
|
5951
|
+
/**
|
|
5952
|
+
* Transaction ID.
|
|
5953
|
+
*/
|
|
5954
|
+
$id: string;
|
|
5955
|
+
/**
|
|
5956
|
+
* Transaction creation time in ISO 8601 format.
|
|
5957
|
+
*/
|
|
5958
|
+
$createdAt: string;
|
|
5959
|
+
/**
|
|
5960
|
+
* Transaction update date in ISO 8601 format.
|
|
5961
|
+
*/
|
|
5962
|
+
$updatedAt: string;
|
|
5963
|
+
/**
|
|
5964
|
+
* Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.
|
|
5965
|
+
*/
|
|
5966
|
+
status: string;
|
|
5967
|
+
/**
|
|
5968
|
+
* Number of operations in the transaction.
|
|
5969
|
+
*/
|
|
5970
|
+
operations: number;
|
|
5971
|
+
/**
|
|
5972
|
+
* Expiration time in ISO 8601 format.
|
|
5973
|
+
*/
|
|
5974
|
+
expiresAt: string;
|
|
5975
|
+
};
|
|
4871
5976
|
/**
|
|
4872
5977
|
* Subscriber
|
|
4873
5978
|
*/
|
|
@@ -5002,6 +6107,10 @@ export declare namespace Models {
|
|
|
5002
6107
|
* All errors that occurred during the migration process.
|
|
5003
6108
|
*/
|
|
5004
6109
|
errors: string[];
|
|
6110
|
+
/**
|
|
6111
|
+
* Migration options used during the migration process.
|
|
6112
|
+
*/
|
|
6113
|
+
options: object;
|
|
5005
6114
|
};
|
|
5006
6115
|
/**
|
|
5007
6116
|
* Migration Report
|
|
@@ -5020,9 +6129,9 @@ export declare namespace Models {
|
|
|
5020
6129
|
*/
|
|
5021
6130
|
database: number;
|
|
5022
6131
|
/**
|
|
5023
|
-
* Number of
|
|
6132
|
+
* Number of rows to be migrated.
|
|
5024
6133
|
*/
|
|
5025
|
-
|
|
6134
|
+
row: number;
|
|
5026
6135
|
/**
|
|
5027
6136
|
* Number of files to be migrated.
|
|
5028
6137
|
*/
|
|
@@ -5048,6 +6157,10 @@ export declare namespace Models {
|
|
|
5048
6157
|
* AdditionalResource
|
|
5049
6158
|
*/
|
|
5050
6159
|
export type AdditionalResource = {
|
|
6160
|
+
/**
|
|
6161
|
+
* Resource name
|
|
6162
|
+
*/
|
|
6163
|
+
name: string;
|
|
5051
6164
|
/**
|
|
5052
6165
|
* Resource unit
|
|
5053
6166
|
*/
|
|
@@ -5064,6 +6177,10 @@ export declare namespace Models {
|
|
|
5064
6177
|
* Resource value
|
|
5065
6178
|
*/
|
|
5066
6179
|
value: number;
|
|
6180
|
+
/**
|
|
6181
|
+
* Description on invoice
|
|
6182
|
+
*/
|
|
6183
|
+
invoiceDesc: string;
|
|
5067
6184
|
};
|
|
5068
6185
|
/**
|
|
5069
6186
|
* AggregationTeam
|
|
@@ -5169,6 +6286,39 @@ export declare namespace Models {
|
|
|
5169
6286
|
* Aggregated amount
|
|
5170
6287
|
*/
|
|
5171
6288
|
amount: number;
|
|
6289
|
+
/**
|
|
6290
|
+
* Aggregation project breakdown
|
|
6291
|
+
*/
|
|
6292
|
+
breakdown: AggregationBreakdown[];
|
|
6293
|
+
/**
|
|
6294
|
+
* Usage resources
|
|
6295
|
+
*/
|
|
6296
|
+
resources: UsageResources[];
|
|
6297
|
+
};
|
|
6298
|
+
/**
|
|
6299
|
+
* AggregationBreakdown
|
|
6300
|
+
*/
|
|
6301
|
+
export type AggregationBreakdown = {
|
|
6302
|
+
/**
|
|
6303
|
+
* Aggregation ID.
|
|
6304
|
+
*/
|
|
6305
|
+
$id: string;
|
|
6306
|
+
/**
|
|
6307
|
+
* Project name
|
|
6308
|
+
*/
|
|
6309
|
+
name: string;
|
|
6310
|
+
/**
|
|
6311
|
+
* Project region
|
|
6312
|
+
*/
|
|
6313
|
+
region: string;
|
|
6314
|
+
/**
|
|
6315
|
+
* Aggregated amount
|
|
6316
|
+
*/
|
|
6317
|
+
amount: number;
|
|
6318
|
+
/**
|
|
6319
|
+
*
|
|
6320
|
+
*/
|
|
6321
|
+
resources: UsageResources[];
|
|
5172
6322
|
};
|
|
5173
6323
|
/**
|
|
5174
6324
|
* Archive
|
|
@@ -5313,7 +6463,7 @@ export declare namespace Models {
|
|
|
5313
6463
|
*/
|
|
5314
6464
|
projects: number;
|
|
5315
6465
|
/**
|
|
5316
|
-
*
|
|
6466
|
+
* Platforms
|
|
5317
6467
|
*/
|
|
5318
6468
|
platforms: number;
|
|
5319
6469
|
/**
|
|
@@ -5328,6 +6478,18 @@ export declare namespace Models {
|
|
|
5328
6478
|
* Databases
|
|
5329
6479
|
*/
|
|
5330
6480
|
databases: number;
|
|
6481
|
+
/**
|
|
6482
|
+
* Database reads per month
|
|
6483
|
+
*/
|
|
6484
|
+
databasesReads: number;
|
|
6485
|
+
/**
|
|
6486
|
+
* Database writes per month
|
|
6487
|
+
*/
|
|
6488
|
+
databasesWrites: number;
|
|
6489
|
+
/**
|
|
6490
|
+
* Database batch size limit
|
|
6491
|
+
*/
|
|
6492
|
+
databasesBatchSize: number;
|
|
5331
6493
|
/**
|
|
5332
6494
|
* Buckets
|
|
5333
6495
|
*/
|
|
@@ -5340,18 +6502,46 @@ export declare namespace Models {
|
|
|
5340
6502
|
* Functions
|
|
5341
6503
|
*/
|
|
5342
6504
|
functions: number;
|
|
6505
|
+
/**
|
|
6506
|
+
* Sites
|
|
6507
|
+
*/
|
|
6508
|
+
sites: number;
|
|
5343
6509
|
/**
|
|
5344
6510
|
* Function executions
|
|
5345
6511
|
*/
|
|
5346
6512
|
executions: number;
|
|
6513
|
+
/**
|
|
6514
|
+
* GB hours for functions
|
|
6515
|
+
*/
|
|
6516
|
+
GBHours: number;
|
|
5347
6517
|
/**
|
|
5348
6518
|
* Realtime connections
|
|
5349
6519
|
*/
|
|
5350
6520
|
realtime: number;
|
|
6521
|
+
/**
|
|
6522
|
+
* Messages per month
|
|
6523
|
+
*/
|
|
6524
|
+
messages: number;
|
|
6525
|
+
/**
|
|
6526
|
+
* Topics for messaging
|
|
6527
|
+
*/
|
|
6528
|
+
topics: number;
|
|
6529
|
+
/**
|
|
6530
|
+
* SMS authentications per month
|
|
6531
|
+
*/
|
|
6532
|
+
authPhone: number;
|
|
6533
|
+
/**
|
|
6534
|
+
* Custom domains
|
|
6535
|
+
*/
|
|
6536
|
+
domains: number;
|
|
5351
6537
|
/**
|
|
5352
6538
|
* Log days
|
|
5353
6539
|
*/
|
|
5354
6540
|
logs: number;
|
|
6541
|
+
/**
|
|
6542
|
+
* Alert threshold percentage
|
|
6543
|
+
*/
|
|
6544
|
+
alertLimit: number;
|
|
5355
6545
|
/**
|
|
5356
6546
|
* Additional resources
|
|
5357
6547
|
*/
|
|
@@ -5412,6 +6602,10 @@ export declare namespace Models {
|
|
|
5412
6602
|
* Does plan support backup policies.
|
|
5413
6603
|
*/
|
|
5414
6604
|
backupsEnabled: boolean;
|
|
6605
|
+
/**
|
|
6606
|
+
* Whether usage addons are calculated per project.
|
|
6607
|
+
*/
|
|
6608
|
+
usagePerProject: boolean;
|
|
5415
6609
|
/**
|
|
5416
6610
|
* How many policies does plan support
|
|
5417
6611
|
*/
|
|
@@ -5428,6 +6622,18 @@ export declare namespace Models {
|
|
|
5428
6622
|
* Does the plan support encrypted string attributes or not.
|
|
5429
6623
|
*/
|
|
5430
6624
|
databasesAllowEncrypt: boolean;
|
|
6625
|
+
/**
|
|
6626
|
+
* Plan specific limits
|
|
6627
|
+
*/
|
|
6628
|
+
limits?: BillingPlanLimits;
|
|
6629
|
+
/**
|
|
6630
|
+
* Group of this billing plan for variants
|
|
6631
|
+
*/
|
|
6632
|
+
group: BillingPlanGroup;
|
|
6633
|
+
/**
|
|
6634
|
+
* Details of the program this plan is a part of.
|
|
6635
|
+
*/
|
|
6636
|
+
program?: Program;
|
|
5431
6637
|
};
|
|
5432
6638
|
/**
|
|
5433
6639
|
* BillingPlanAddon
|
|
@@ -5437,6 +6643,10 @@ export declare namespace Models {
|
|
|
5437
6643
|
* Addon seats
|
|
5438
6644
|
*/
|
|
5439
6645
|
seats: BillingPlanAddonDetails;
|
|
6646
|
+
/**
|
|
6647
|
+
* Addon projects
|
|
6648
|
+
*/
|
|
6649
|
+
projects: BillingPlanAddonDetails;
|
|
5440
6650
|
};
|
|
5441
6651
|
/**
|
|
5442
6652
|
* BillingPlanAddonDetails
|
|
@@ -5446,6 +6656,10 @@ export declare namespace Models {
|
|
|
5446
6656
|
* Is the addon supported in the plan?
|
|
5447
6657
|
*/
|
|
5448
6658
|
supported: boolean;
|
|
6659
|
+
/**
|
|
6660
|
+
* Addon plan included value
|
|
6661
|
+
*/
|
|
6662
|
+
planIncluded: number;
|
|
5449
6663
|
/**
|
|
5450
6664
|
* Addon limit
|
|
5451
6665
|
*/
|
|
@@ -5466,6 +6680,23 @@ export declare namespace Models {
|
|
|
5466
6680
|
* Resource value
|
|
5467
6681
|
*/
|
|
5468
6682
|
value: number;
|
|
6683
|
+
/**
|
|
6684
|
+
* Description on invoice
|
|
6685
|
+
*/
|
|
6686
|
+
invoiceDesc: string;
|
|
6687
|
+
};
|
|
6688
|
+
/**
|
|
6689
|
+
* BillingPlanLimits
|
|
6690
|
+
*/
|
|
6691
|
+
export type BillingPlanLimits = {
|
|
6692
|
+
/**
|
|
6693
|
+
* Credits limit per billing cycle
|
|
6694
|
+
*/
|
|
6695
|
+
credits?: number;
|
|
6696
|
+
/**
|
|
6697
|
+
* Daily credits limit (if applicable)
|
|
6698
|
+
*/
|
|
6699
|
+
dailyCredits?: number;
|
|
5469
6700
|
};
|
|
5470
6701
|
/**
|
|
5471
6702
|
* BillingLimits
|
|
@@ -5499,6 +6730,35 @@ export declare namespace Models {
|
|
|
5499
6730
|
* Auth phone limit
|
|
5500
6731
|
*/
|
|
5501
6732
|
authPhone: number;
|
|
6733
|
+
/**
|
|
6734
|
+
* Budget limit percentage
|
|
6735
|
+
*/
|
|
6736
|
+
budgetLimit: number;
|
|
6737
|
+
};
|
|
6738
|
+
/**
|
|
6739
|
+
* Block
|
|
6740
|
+
*/
|
|
6741
|
+
export type Block = {
|
|
6742
|
+
/**
|
|
6743
|
+
* Block creation date in ISO 8601 format.
|
|
6744
|
+
*/
|
|
6745
|
+
$createdAt: string;
|
|
6746
|
+
/**
|
|
6747
|
+
* Resource type that is blocked
|
|
6748
|
+
*/
|
|
6749
|
+
resourceType: string;
|
|
6750
|
+
/**
|
|
6751
|
+
* Resource identifier that is blocked
|
|
6752
|
+
*/
|
|
6753
|
+
resourceId: string;
|
|
6754
|
+
/**
|
|
6755
|
+
* Reason for the block
|
|
6756
|
+
*/
|
|
6757
|
+
reason: string;
|
|
6758
|
+
/**
|
|
6759
|
+
* Block expiration date in ISO 8601 format.
|
|
6760
|
+
*/
|
|
6761
|
+
expiredAt: string;
|
|
5502
6762
|
};
|
|
5503
6763
|
/**
|
|
5504
6764
|
* Campaign
|
|
@@ -5553,6 +6813,47 @@ export declare namespace Models {
|
|
|
5553
6813
|
*/
|
|
5554
6814
|
footer?: boolean;
|
|
5555
6815
|
};
|
|
6816
|
+
/**
|
|
6817
|
+
* Program
|
|
6818
|
+
*/
|
|
6819
|
+
export type Program = {
|
|
6820
|
+
/**
|
|
6821
|
+
* Program ID
|
|
6822
|
+
*/
|
|
6823
|
+
$id: string;
|
|
6824
|
+
/**
|
|
6825
|
+
* Program title
|
|
6826
|
+
*/
|
|
6827
|
+
title: string;
|
|
6828
|
+
/**
|
|
6829
|
+
* Program description
|
|
6830
|
+
*/
|
|
6831
|
+
description: string;
|
|
6832
|
+
/**
|
|
6833
|
+
* Program tag for highlighting on console
|
|
6834
|
+
*/
|
|
6835
|
+
tag: string;
|
|
6836
|
+
/**
|
|
6837
|
+
* Program icon for highlighting on console
|
|
6838
|
+
*/
|
|
6839
|
+
icon: string;
|
|
6840
|
+
/**
|
|
6841
|
+
* URL for more information on this program
|
|
6842
|
+
*/
|
|
6843
|
+
url: string;
|
|
6844
|
+
/**
|
|
6845
|
+
* Whether this program is active
|
|
6846
|
+
*/
|
|
6847
|
+
active: boolean;
|
|
6848
|
+
/**
|
|
6849
|
+
* Whether this program is external
|
|
6850
|
+
*/
|
|
6851
|
+
external: boolean;
|
|
6852
|
+
/**
|
|
6853
|
+
* Billing plan ID that this is program is associated with.
|
|
6854
|
+
*/
|
|
6855
|
+
billingPlanId: string;
|
|
6856
|
+
};
|
|
5556
6857
|
/**
|
|
5557
6858
|
* Coupon
|
|
5558
6859
|
*/
|
|
@@ -5665,6 +6966,51 @@ export declare namespace Models {
|
|
|
5665
6966
|
*/
|
|
5666
6967
|
available: number;
|
|
5667
6968
|
};
|
|
6969
|
+
/**
|
|
6970
|
+
* Downgrade Feedback
|
|
6971
|
+
*/
|
|
6972
|
+
export type DowngradeFeedback = {
|
|
6973
|
+
/**
|
|
6974
|
+
* Feedback ID.
|
|
6975
|
+
*/
|
|
6976
|
+
$id: string;
|
|
6977
|
+
/**
|
|
6978
|
+
* Feedback creation date in ISO 8601 format.
|
|
6979
|
+
*/
|
|
6980
|
+
$createdAt: string;
|
|
6981
|
+
/**
|
|
6982
|
+
* Feedback update date in ISO 8601 format.
|
|
6983
|
+
*/
|
|
6984
|
+
$updatedAt: string;
|
|
6985
|
+
/**
|
|
6986
|
+
* Feedback reason
|
|
6987
|
+
*/
|
|
6988
|
+
title: string;
|
|
6989
|
+
/**
|
|
6990
|
+
* Feedback message
|
|
6991
|
+
*/
|
|
6992
|
+
message: string;
|
|
6993
|
+
/**
|
|
6994
|
+
* Plan ID downgrading from
|
|
6995
|
+
*/
|
|
6996
|
+
fromPlanId: string;
|
|
6997
|
+
/**
|
|
6998
|
+
* Plan ID downgrading to
|
|
6999
|
+
*/
|
|
7000
|
+
toPlanId: string;
|
|
7001
|
+
/**
|
|
7002
|
+
* Organization ID
|
|
7003
|
+
*/
|
|
7004
|
+
teamId: string;
|
|
7005
|
+
/**
|
|
7006
|
+
* User ID who submitted feedback
|
|
7007
|
+
*/
|
|
7008
|
+
userId: string;
|
|
7009
|
+
/**
|
|
7010
|
+
* Console version
|
|
7011
|
+
*/
|
|
7012
|
+
version: string;
|
|
7013
|
+
};
|
|
5668
7014
|
/**
|
|
5669
7015
|
* Invoice
|
|
5670
7016
|
*/
|
|
@@ -5700,7 +7046,7 @@ export declare namespace Models {
|
|
|
5700
7046
|
/**
|
|
5701
7047
|
* Usage breakdown per resource
|
|
5702
7048
|
*/
|
|
5703
|
-
usage:
|
|
7049
|
+
usage: UsageResources[];
|
|
5704
7050
|
/**
|
|
5705
7051
|
* Invoice Amount
|
|
5706
7052
|
*/
|
|
@@ -5795,9 +7141,17 @@ export declare namespace Models {
|
|
|
5795
7141
|
*/
|
|
5796
7142
|
budgetAlerts: number[];
|
|
5797
7143
|
/**
|
|
5798
|
-
*
|
|
7144
|
+
* Organization's billing plan ID.
|
|
5799
7145
|
*/
|
|
5800
7146
|
billingPlan: string;
|
|
7147
|
+
/**
|
|
7148
|
+
* Organization's billing plan ID.
|
|
7149
|
+
*/
|
|
7150
|
+
billingPlanId: string;
|
|
7151
|
+
/**
|
|
7152
|
+
* Organization's billing plan.
|
|
7153
|
+
*/
|
|
7154
|
+
billingPlanDetails: BillingPlan;
|
|
5801
7155
|
/**
|
|
5802
7156
|
* Billing email set for the organization.
|
|
5803
7157
|
*/
|
|
@@ -5855,19 +7209,19 @@ export declare namespace Models {
|
|
|
5855
7209
|
*/
|
|
5856
7210
|
agreementBAA: string;
|
|
5857
7211
|
/**
|
|
5858
|
-
* Program manager
|
|
7212
|
+
* Program manager's name.
|
|
5859
7213
|
*/
|
|
5860
7214
|
programManagerName: string;
|
|
5861
7215
|
/**
|
|
5862
|
-
* Program manager
|
|
7216
|
+
* Program manager's calendar link.
|
|
5863
7217
|
*/
|
|
5864
7218
|
programManagerCalendar: string;
|
|
5865
7219
|
/**
|
|
5866
|
-
* Program
|
|
7220
|
+
* Program's discord channel name.
|
|
5867
7221
|
*/
|
|
5868
7222
|
programDiscordChannelName: string;
|
|
5869
7223
|
/**
|
|
5870
|
-
* Program
|
|
7224
|
+
* Program's discord channel URL.
|
|
5871
7225
|
*/
|
|
5872
7226
|
programDiscordChannelUrl: string;
|
|
5873
7227
|
/**
|
|
@@ -5886,11 +7240,36 @@ export declare namespace Models {
|
|
|
5886
7240
|
* Marked for deletion
|
|
5887
7241
|
*/
|
|
5888
7242
|
markedForDeletion: boolean;
|
|
7243
|
+
/**
|
|
7244
|
+
* Product with which the organization is associated (appwrite or imagine)
|
|
7245
|
+
*/
|
|
7246
|
+
platform: string;
|
|
5889
7247
|
/**
|
|
5890
7248
|
* Selected projects
|
|
5891
7249
|
*/
|
|
5892
7250
|
projects: string[];
|
|
5893
7251
|
};
|
|
7252
|
+
/**
|
|
7253
|
+
* PaymentAuthentication
|
|
7254
|
+
*/
|
|
7255
|
+
export type PaymentAuthentication = {
|
|
7256
|
+
/**
|
|
7257
|
+
* Message for the end user to show on Console.
|
|
7258
|
+
*/
|
|
7259
|
+
message: string;
|
|
7260
|
+
/**
|
|
7261
|
+
* Stripe client secret to use for validation.
|
|
7262
|
+
*/
|
|
7263
|
+
clientSecret: string;
|
|
7264
|
+
/**
|
|
7265
|
+
* Organization ID for which the payment authentication is needed.
|
|
7266
|
+
*/
|
|
7267
|
+
organizationId: string;
|
|
7268
|
+
/**
|
|
7269
|
+
* Invoice ID against which the payment needs to be validated.
|
|
7270
|
+
*/
|
|
7271
|
+
invoiceId: string;
|
|
7272
|
+
};
|
|
5894
7273
|
/**
|
|
5895
7274
|
* paymentMethod
|
|
5896
7275
|
*/
|
|
@@ -5955,12 +7334,16 @@ export declare namespace Models {
|
|
|
5955
7334
|
* Country of the payment method
|
|
5956
7335
|
*/
|
|
5957
7336
|
country: string;
|
|
7337
|
+
/**
|
|
7338
|
+
* State of the payment method
|
|
7339
|
+
*/
|
|
7340
|
+
state: string;
|
|
5958
7341
|
/**
|
|
5959
7342
|
* Last payment error associated with the payment method.
|
|
5960
7343
|
*/
|
|
5961
7344
|
lastError: string;
|
|
5962
7345
|
/**
|
|
5963
|
-
* True when it
|
|
7346
|
+
* True when it's the default payment method.
|
|
5964
7347
|
*/
|
|
5965
7348
|
default: boolean;
|
|
5966
7349
|
/**
|
|
@@ -6165,6 +7548,22 @@ export declare namespace Models {
|
|
|
6165
7548
|
* Aggregated stats for total file transformations.
|
|
6166
7549
|
*/
|
|
6167
7550
|
imageTransformationsTotal: number;
|
|
7551
|
+
/**
|
|
7552
|
+
* Aggregated stats for file transformations.
|
|
7553
|
+
*/
|
|
7554
|
+
screenshotsGenerated: Metric[];
|
|
7555
|
+
/**
|
|
7556
|
+
* Aggregated stats for total file transformations.
|
|
7557
|
+
*/
|
|
7558
|
+
screenshotsGeneratedTotal: number;
|
|
7559
|
+
/**
|
|
7560
|
+
* Aggregated stats for imagine credits.
|
|
7561
|
+
*/
|
|
7562
|
+
imagineCredits: Metric[];
|
|
7563
|
+
/**
|
|
7564
|
+
* Aggregated stats for total imagine credits.
|
|
7565
|
+
*/
|
|
7566
|
+
imagineCreditsTotal: number;
|
|
6168
7567
|
/**
|
|
6169
7568
|
* Aggregated stats for total users.
|
|
6170
7569
|
*/
|
|
@@ -6290,6 +7689,18 @@ export declare namespace Models {
|
|
|
6290
7689
|
* Aggregated stats for total file transformations.
|
|
6291
7690
|
*/
|
|
6292
7691
|
imageTransformationsTotal: number;
|
|
7692
|
+
/**
|
|
7693
|
+
* Aggregated stats for file transformations.
|
|
7694
|
+
*/
|
|
7695
|
+
screenshotsGenerated: Metric[];
|
|
7696
|
+
/**
|
|
7697
|
+
* Aggregated stats for total file transformations.
|
|
7698
|
+
*/
|
|
7699
|
+
screenshotsGeneratedTotal: number;
|
|
7700
|
+
/**
|
|
7701
|
+
* Aggregated stats for imagine credits.
|
|
7702
|
+
*/
|
|
7703
|
+
imagineCredits: number;
|
|
6293
7704
|
};
|
|
6294
7705
|
/**
|
|
6295
7706
|
* Domain
|
|
@@ -6312,11 +7723,11 @@ export declare namespace Models {
|
|
|
6312
7723
|
*/
|
|
6313
7724
|
domain: string;
|
|
6314
7725
|
/**
|
|
6315
|
-
* Domain registrar (e.g.
|
|
7726
|
+
* Domain registrar (e.g. "appwrite" or "third_party").
|
|
6316
7727
|
*/
|
|
6317
7728
|
registrar: string;
|
|
6318
7729
|
/**
|
|
6319
|
-
* Nameservers setting.
|
|
7730
|
+
* Nameservers setting. "Appwrite" or empty string.
|
|
6320
7731
|
*/
|
|
6321
7732
|
nameservers: string;
|
|
6322
7733
|
/**
|
|
@@ -6398,9 +7809,9 @@ export declare namespace Models {
|
|
|
6398
7809
|
comment: string;
|
|
6399
7810
|
};
|
|
6400
7811
|
/**
|
|
6401
|
-
*
|
|
7812
|
+
* UsageResource
|
|
6402
7813
|
*/
|
|
6403
|
-
export type
|
|
7814
|
+
export type UsageResources = {
|
|
6404
7815
|
/**
|
|
6405
7816
|
* Invoice name
|
|
6406
7817
|
*/
|
|
@@ -6421,6 +7832,10 @@ export declare namespace Models {
|
|
|
6421
7832
|
* Invoice description
|
|
6422
7833
|
*/
|
|
6423
7834
|
desc: string;
|
|
7835
|
+
/**
|
|
7836
|
+
* Resource ID
|
|
7837
|
+
*/
|
|
7838
|
+
resourceId: string;
|
|
6424
7839
|
};
|
|
6425
7840
|
/**
|
|
6426
7841
|
* usageBillingPlan
|
|
@@ -6458,6 +7873,10 @@ export declare namespace Models {
|
|
|
6458
7873
|
* Image transformation additional resources
|
|
6459
7874
|
*/
|
|
6460
7875
|
imageTransformations: AdditionalResource;
|
|
7876
|
+
/**
|
|
7877
|
+
* Credits additional resources
|
|
7878
|
+
*/
|
|
7879
|
+
credits: AdditionalResource;
|
|
6461
7880
|
};
|
|
6462
7881
|
/**
|
|
6463
7882
|
* Estimation
|
|
@@ -6533,7 +7952,7 @@ export declare namespace Models {
|
|
|
6533
7952
|
*/
|
|
6534
7953
|
trialEndDate?: string;
|
|
6535
7954
|
/**
|
|
6536
|
-
* Organization
|
|
7955
|
+
* Organization's existing credits
|
|
6537
7956
|
*/
|
|
6538
7957
|
organizationCredits: number;
|
|
6539
7958
|
};
|
|
@@ -6564,7 +7983,7 @@ export declare namespace Models {
|
|
|
6564
7983
|
*/
|
|
6565
7984
|
export type AggregationTeamList = {
|
|
6566
7985
|
/**
|
|
6567
|
-
* Total number of aggregations
|
|
7986
|
+
* Total number of aggregations that matched your query.
|
|
6568
7987
|
*/
|
|
6569
7988
|
total: number;
|
|
6570
7989
|
/**
|
|
@@ -6577,7 +7996,7 @@ export declare namespace Models {
|
|
|
6577
7996
|
*/
|
|
6578
7997
|
export type BackupArchiveList = {
|
|
6579
7998
|
/**
|
|
6580
|
-
* Total number of archives
|
|
7999
|
+
* Total number of archives that matched your query.
|
|
6581
8000
|
*/
|
|
6582
8001
|
total: number;
|
|
6583
8002
|
/**
|
|
@@ -6590,7 +8009,7 @@ export declare namespace Models {
|
|
|
6590
8009
|
*/
|
|
6591
8010
|
export type BackupPolicyList = {
|
|
6592
8011
|
/**
|
|
6593
|
-
* Total number of policies
|
|
8012
|
+
* Total number of policies that matched your query.
|
|
6594
8013
|
*/
|
|
6595
8014
|
total: number;
|
|
6596
8015
|
/**
|
|
@@ -6603,7 +8022,7 @@ export declare namespace Models {
|
|
|
6603
8022
|
*/
|
|
6604
8023
|
export type BackupRestorationList = {
|
|
6605
8024
|
/**
|
|
6606
|
-
* Total number of restorations
|
|
8025
|
+
* Total number of restorations that matched your query.
|
|
6607
8026
|
*/
|
|
6608
8027
|
total: number;
|
|
6609
8028
|
/**
|
|
@@ -6616,7 +8035,7 @@ export declare namespace Models {
|
|
|
6616
8035
|
*/
|
|
6617
8036
|
export type InvoiceList = {
|
|
6618
8037
|
/**
|
|
6619
|
-
* Total number of invoices
|
|
8038
|
+
* Total number of invoices that matched your query.
|
|
6620
8039
|
*/
|
|
6621
8040
|
total: number;
|
|
6622
8041
|
/**
|
|
@@ -6629,7 +8048,7 @@ export declare namespace Models {
|
|
|
6629
8048
|
*/
|
|
6630
8049
|
export type BillingAddressList = {
|
|
6631
8050
|
/**
|
|
6632
|
-
* Total number of billingAddresses
|
|
8051
|
+
* Total number of billingAddresses that matched your query.
|
|
6633
8052
|
*/
|
|
6634
8053
|
total: number;
|
|
6635
8054
|
/**
|
|
@@ -6642,7 +8061,7 @@ export declare namespace Models {
|
|
|
6642
8061
|
*/
|
|
6643
8062
|
export type BillingPlanList = {
|
|
6644
8063
|
/**
|
|
6645
|
-
* Total number of plans
|
|
8064
|
+
* Total number of plans that matched your query.
|
|
6646
8065
|
*/
|
|
6647
8066
|
total: number;
|
|
6648
8067
|
/**
|
|
@@ -6651,11 +8070,11 @@ export declare namespace Models {
|
|
|
6651
8070
|
plans: BillingPlan[];
|
|
6652
8071
|
};
|
|
6653
8072
|
/**
|
|
6654
|
-
* Organizations
|
|
8073
|
+
* Organizations list
|
|
6655
8074
|
*/
|
|
6656
8075
|
export type OrganizationList<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
|
|
6657
8076
|
/**
|
|
6658
|
-
* Total number of teams
|
|
8077
|
+
* Total number of teams that matched your query.
|
|
6659
8078
|
*/
|
|
6660
8079
|
total: number;
|
|
6661
8080
|
/**
|
|
@@ -6668,7 +8087,7 @@ export declare namespace Models {
|
|
|
6668
8087
|
*/
|
|
6669
8088
|
export type PaymentMethodList = {
|
|
6670
8089
|
/**
|
|
6671
|
-
* Total number of paymentMethods
|
|
8090
|
+
* Total number of paymentMethods that matched your query.
|
|
6672
8091
|
*/
|
|
6673
8092
|
total: number;
|
|
6674
8093
|
/**
|
|
@@ -6681,7 +8100,7 @@ export declare namespace Models {
|
|
|
6681
8100
|
*/
|
|
6682
8101
|
export type ConsoleRegionList = {
|
|
6683
8102
|
/**
|
|
6684
|
-
* Total number of regions
|
|
8103
|
+
* Total number of regions that matched your query.
|
|
6685
8104
|
*/
|
|
6686
8105
|
total: number;
|
|
6687
8106
|
/**
|
|
@@ -6694,7 +8113,7 @@ export declare namespace Models {
|
|
|
6694
8113
|
*/
|
|
6695
8114
|
export type DomainsList = {
|
|
6696
8115
|
/**
|
|
6697
|
-
* Total number of domains
|
|
8116
|
+
* Total number of domains that matched your query.
|
|
6698
8117
|
*/
|
|
6699
8118
|
total: number;
|
|
6700
8119
|
/**
|
|
@@ -6707,7 +8126,7 @@ export declare namespace Models {
|
|
|
6707
8126
|
*/
|
|
6708
8127
|
export type DnsRecordsList = {
|
|
6709
8128
|
/**
|
|
6710
|
-
* Total number of dnsRecords
|
|
8129
|
+
* Total number of dnsRecords that matched your query.
|
|
6711
8130
|
*/
|
|
6712
8131
|
total: number;
|
|
6713
8132
|
/**
|