@appwrite.io/console 1.9.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yml +9 -8
- package/CHANGELOG.md +51 -6
- package/LICENSE +1 -1
- package/README.md +84 -4
- package/dist/cjs/sdk.js +15258 -6036
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +15256 -6037
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +15258 -6036
- 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 +16 -11
- package/docs/examples/databases/create-documents.md +7 -6
- 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 +13 -0
- 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 +14 -0
- 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 -5
- package/docs/examples/vcs/get-repository.md +4 -4
- package/docs/examples/vcs/list-installations.md +5 -4
- package/docs/examples/vcs/list-repositories.md +6 -5
- package/docs/examples/vcs/list-repository-branches.md +4 -4
- package/docs/examples/vcs/update-external-deployments.md +5 -5
- package/package.json +4 -4
- package/src/client.ts +42 -7
- package/src/enums/api-service.ts +1 -0
- package/src/enums/attribute-status.ts +7 -0
- package/src/enums/billing-plan-group.ts +5 -0
- package/src/enums/build-runtime.ts +2 -0
- package/src/enums/column-status.ts +7 -0
- package/src/enums/credit-card.ts +1 -1
- package/src/enums/database-type.ts +4 -0
- package/src/enums/deployment-status.ts +7 -0
- package/src/enums/execution-method.ts +1 -0
- package/src/enums/execution-status.ts +7 -0
- package/src/enums/execution-trigger.ts +5 -0
- package/src/enums/framework.ts +1 -0
- package/src/enums/health-antivirus-status.ts +5 -0
- package/src/enums/health-check-status.ts +4 -0
- package/src/enums/index-status.ts +7 -0
- package/src/enums/index-type.ts +1 -0
- package/src/enums/message-status.ts +7 -0
- package/src/enums/o-auth-provider.ts +3 -0
- package/src/enums/platform.ts +4 -0
- package/src/enums/proxy-rule-deployment-resource-type.ts +4 -0
- package/src/enums/proxy-rule-status.ts +6 -0
- package/src/enums/region.ts +3 -0
- package/src/enums/runtime.ts +2 -0
- package/src/enums/status.ts +4 -0
- package/src/enums/template-reference-type.ts +5 -0
- package/src/enums/theme.ts +4 -0
- package/src/enums/timezone.ts +421 -0
- package/src/enums/{user-usage-range.ts → usage-range.ts} +1 -1
- package/src/enums/{v-c-s-deployment-type.ts → vcs-reference-type.ts} +1 -1
- package/src/index.ts +27 -11
- package/src/models.ts +1925 -239
- package/src/operator.ts +308 -0
- package/src/query.ts +246 -2
- package/src/services/account.ts +2278 -235
- package/src/services/assistant.ts +29 -3
- package/src/services/avatars.ts +511 -52
- package/src/services/backups.ts +400 -42
- package/src/services/console.ts +499 -19
- package/src/services/databases.ts +3584 -430
- package/src/services/domains.ts +1795 -266
- package/src/services/functions.ts +1197 -155
- package/src/services/graphql.ts +56 -4
- package/src/services/health.ts +586 -42
- package/src/services/locale.ts +18 -2
- package/src/services/messaging.ts +3418 -386
- package/src/services/migrations.ts +653 -65
- package/src/services/organizations.ts +1411 -126
- package/src/services/project.ts +173 -17
- package/src/services/projects.ts +2808 -282
- package/src/services/proxy.ts +272 -26
- package/src/services/realtime.ts +437 -0
- package/src/services/sites.ts +1129 -143
- package/src/services/storage.ts +672 -89
- package/src/services/tables-db.ts +5439 -0
- package/src/services/teams.ts +535 -65
- package/src/services/tokens.ts +171 -16
- package/src/services/users.ts +1916 -182
- package/src/services/vcs.ts +373 -41
- package/types/client.d.ts +14 -5
- package/types/enums/api-service.d.ts +1 -0
- package/types/enums/attribute-status.d.ts +7 -0
- package/types/enums/billing-plan-group.d.ts +5 -0
- package/types/enums/build-runtime.d.ts +3 -1
- package/types/enums/column-status.d.ts +7 -0
- package/types/enums/credit-card.d.ts +1 -1
- package/types/enums/database-type.d.ts +4 -0
- package/types/enums/deployment-status.d.ts +7 -0
- package/types/enums/execution-method.d.ts +2 -1
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/framework.d.ts +1 -0
- package/types/enums/health-antivirus-status.d.ts +5 -0
- package/types/enums/health-check-status.d.ts +4 -0
- package/types/enums/index-status.d.ts +7 -0
- package/types/enums/index-type.d.ts +2 -1
- package/types/enums/message-status.d.ts +7 -0
- package/types/enums/o-auth-provider.d.ts +4 -1
- package/types/enums/platform.d.ts +4 -0
- package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
- package/types/enums/proxy-rule-status.d.ts +6 -0
- package/types/enums/region.d.ts +4 -1
- package/types/enums/runtime.d.ts +3 -1
- package/types/enums/status.d.ts +4 -0
- package/types/enums/template-reference-type.d.ts +5 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +421 -0
- package/types/enums/{site-usage-range.d.ts → usage-range.d.ts} +1 -1
- package/types/enums/{v-c-s-deployment-type.d.ts → vcs-reference-type.d.ts} +1 -1
- package/types/index.d.ts +27 -11
- package/types/models.d.ts +1877 -422
- package/types/operator.d.ts +180 -0
- package/types/query.d.ts +198 -2
- package/types/services/account.d.ts +1020 -158
- package/types/services/assistant.d.ts +13 -2
- package/types/services/avatars.d.ts +263 -45
- package/types/services/backups.d.ts +190 -30
- package/types/services/console.d.ts +202 -15
- package/types/services/databases.d.ts +1756 -299
- package/types/services/domains.d.ts +971 -219
- package/types/services/functions.d.ts +622 -131
- package/types/services/graphql.d.ts +24 -2
- package/types/services/health.d.ts +246 -24
- package/types/services/locale.d.ts +2 -2
- package/types/services/messaging.d.ts +1670 -281
- package/types/services/migrations.d.ts +319 -53
- package/types/services/organizations.d.ts +664 -109
- 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 +580 -119
- package/types/services/storage.d.ts +362 -81
- package/types/services/tables-db.d.ts +2040 -0
- package/types/services/teams.d.ts +277 -61
- package/types/services/tokens.d.ts +80 -12
- package/types/services/users.d.ts +906 -149
- package/types/services/vcs.d.ts +182 -34
- 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/src/services/storage.ts
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import { Service } from '../service';
|
|
2
2
|
import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
|
|
3
3
|
import type { Models } from '../models';
|
|
4
|
+
|
|
4
5
|
import { Compression } from '../enums/compression';
|
|
5
6
|
import { ImageGravity } from '../enums/image-gravity';
|
|
6
7
|
import { ImageFormat } from '../enums/image-format';
|
|
7
|
-
import {
|
|
8
|
+
import { UsageRange } from '../enums/usage-range';
|
|
8
9
|
|
|
9
10
|
export class Storage {
|
|
10
11
|
client: Client;
|
|
@@ -16,12 +17,45 @@ export class Storage {
|
|
|
16
17
|
/**
|
|
17
18
|
* Get a list of all the storage buckets. You can use the query params to filter your results.
|
|
18
19
|
*
|
|
19
|
-
* @param {string[]} queries
|
|
20
|
-
* @param {string} search
|
|
20
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations
|
|
21
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
22
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
23
|
+
* @throws {AppwriteException}
|
|
24
|
+
* @returns {Promise<Models.BucketList>}
|
|
25
|
+
*/
|
|
26
|
+
listBuckets(params?: { queries?: string[], search?: string, total?: boolean }): Promise<Models.BucketList>;
|
|
27
|
+
/**
|
|
28
|
+
* Get a list of all the storage buckets. You can use the query params to filter your results.
|
|
29
|
+
*
|
|
30
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations
|
|
31
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
32
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
21
33
|
* @throws {AppwriteException}
|
|
22
34
|
* @returns {Promise<Models.BucketList>}
|
|
35
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
23
36
|
*/
|
|
24
|
-
listBuckets(queries?: string[], search?: string): Promise<Models.BucketList
|
|
37
|
+
listBuckets(queries?: string[], search?: string, total?: boolean): Promise<Models.BucketList>;
|
|
38
|
+
listBuckets(
|
|
39
|
+
paramsOrFirst?: { queries?: string[], search?: string, total?: boolean } | string[],
|
|
40
|
+
...rest: [(string)?, (boolean)?]
|
|
41
|
+
): Promise<Models.BucketList> {
|
|
42
|
+
let params: { queries?: string[], search?: string, total?: boolean };
|
|
43
|
+
|
|
44
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
45
|
+
params = (paramsOrFirst || {}) as { queries?: string[], search?: string, total?: boolean };
|
|
46
|
+
} else {
|
|
47
|
+
params = {
|
|
48
|
+
queries: paramsOrFirst as string[],
|
|
49
|
+
search: rest[0] as string,
|
|
50
|
+
total: rest[1] as boolean
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const queries = params.queries;
|
|
55
|
+
const search = params.search;
|
|
56
|
+
const total = params.total;
|
|
57
|
+
|
|
58
|
+
|
|
25
59
|
const apiPath = '/storage/buckets';
|
|
26
60
|
const payload: Payload = {};
|
|
27
61
|
if (typeof queries !== 'undefined') {
|
|
@@ -30,6 +64,9 @@ export class Storage {
|
|
|
30
64
|
if (typeof search !== 'undefined') {
|
|
31
65
|
payload['search'] = search;
|
|
32
66
|
}
|
|
67
|
+
if (typeof total !== 'undefined') {
|
|
68
|
+
payload['total'] = total;
|
|
69
|
+
}
|
|
33
70
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
34
71
|
|
|
35
72
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -42,29 +79,87 @@ export class Storage {
|
|
|
42
79
|
payload
|
|
43
80
|
);
|
|
44
81
|
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Create a new storage bucket.
|
|
85
|
+
*
|
|
86
|
+
* @param {string} params.bucketId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
87
|
+
* @param {string} params.name - Bucket name
|
|
88
|
+
* @param {string[]} params.permissions - An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
89
|
+
* @param {boolean} params.fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
90
|
+
* @param {boolean} params.enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
|
|
91
|
+
* @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
92
|
+
* @param {string[]} params.allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
|
|
93
|
+
* @param {Compression} params.compression - Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
|
|
94
|
+
* @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
|
|
95
|
+
* @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
|
|
96
|
+
* @param {boolean} params.transformations - Are image transformations enabled?
|
|
97
|
+
* @throws {AppwriteException}
|
|
98
|
+
* @returns {Promise<Models.Bucket>}
|
|
99
|
+
*/
|
|
100
|
+
createBucket(params: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean }): Promise<Models.Bucket>;
|
|
45
101
|
/**
|
|
46
102
|
* Create a new storage bucket.
|
|
47
103
|
*
|
|
48
|
-
* @param {string} bucketId
|
|
49
|
-
* @param {string} name
|
|
50
|
-
* @param {string[]} permissions
|
|
51
|
-
* @param {boolean} fileSecurity
|
|
52
|
-
* @param {boolean} enabled
|
|
53
|
-
* @param {number} maximumFileSize
|
|
54
|
-
* @param {string[]} allowedFileExtensions
|
|
55
|
-
* @param {Compression} compression
|
|
56
|
-
* @param {boolean} encryption
|
|
57
|
-
* @param {boolean} antivirus
|
|
104
|
+
* @param {string} bucketId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
105
|
+
* @param {string} name - Bucket name
|
|
106
|
+
* @param {string[]} permissions - An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
107
|
+
* @param {boolean} fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
108
|
+
* @param {boolean} enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
|
|
109
|
+
* @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
110
|
+
* @param {string[]} allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
|
|
111
|
+
* @param {Compression} compression - Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
|
|
112
|
+
* @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
|
|
113
|
+
* @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
|
|
114
|
+
* @param {boolean} transformations - Are image transformations enabled?
|
|
58
115
|
* @throws {AppwriteException}
|
|
59
116
|
* @returns {Promise<Models.Bucket>}
|
|
117
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
60
118
|
*/
|
|
61
|
-
createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket
|
|
119
|
+
createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
|
|
120
|
+
createBucket(
|
|
121
|
+
paramsOrFirst: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean } | string,
|
|
122
|
+
...rest: [(string)?, (string[])?, (boolean)?, (boolean)?, (number)?, (string[])?, (Compression)?, (boolean)?, (boolean)?, (boolean)?]
|
|
123
|
+
): Promise<Models.Bucket> {
|
|
124
|
+
let params: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean };
|
|
125
|
+
|
|
126
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
127
|
+
params = (paramsOrFirst || {}) as { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean };
|
|
128
|
+
} else {
|
|
129
|
+
params = {
|
|
130
|
+
bucketId: paramsOrFirst as string,
|
|
131
|
+
name: rest[0] as string,
|
|
132
|
+
permissions: rest[1] as string[],
|
|
133
|
+
fileSecurity: rest[2] as boolean,
|
|
134
|
+
enabled: rest[3] as boolean,
|
|
135
|
+
maximumFileSize: rest[4] as number,
|
|
136
|
+
allowedFileExtensions: rest[5] as string[],
|
|
137
|
+
compression: rest[6] as Compression,
|
|
138
|
+
encryption: rest[7] as boolean,
|
|
139
|
+
antivirus: rest[8] as boolean,
|
|
140
|
+
transformations: rest[9] as boolean
|
|
141
|
+
};
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
const bucketId = params.bucketId;
|
|
145
|
+
const name = params.name;
|
|
146
|
+
const permissions = params.permissions;
|
|
147
|
+
const fileSecurity = params.fileSecurity;
|
|
148
|
+
const enabled = params.enabled;
|
|
149
|
+
const maximumFileSize = params.maximumFileSize;
|
|
150
|
+
const allowedFileExtensions = params.allowedFileExtensions;
|
|
151
|
+
const compression = params.compression;
|
|
152
|
+
const encryption = params.encryption;
|
|
153
|
+
const antivirus = params.antivirus;
|
|
154
|
+
const transformations = params.transformations;
|
|
155
|
+
|
|
62
156
|
if (typeof bucketId === 'undefined') {
|
|
63
157
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
64
158
|
}
|
|
65
159
|
if (typeof name === 'undefined') {
|
|
66
160
|
throw new AppwriteException('Missing required parameter: "name"');
|
|
67
161
|
}
|
|
162
|
+
|
|
68
163
|
const apiPath = '/storage/buckets';
|
|
69
164
|
const payload: Payload = {};
|
|
70
165
|
if (typeof bucketId !== 'undefined') {
|
|
@@ -97,6 +192,9 @@ export class Storage {
|
|
|
97
192
|
if (typeof antivirus !== 'undefined') {
|
|
98
193
|
payload['antivirus'] = antivirus;
|
|
99
194
|
}
|
|
195
|
+
if (typeof transformations !== 'undefined') {
|
|
196
|
+
payload['transformations'] = transformations;
|
|
197
|
+
}
|
|
100
198
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
101
199
|
|
|
102
200
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -110,17 +208,43 @@ export class Storage {
|
|
|
110
208
|
payload
|
|
111
209
|
);
|
|
112
210
|
}
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.
|
|
214
|
+
*
|
|
215
|
+
* @param {string} params.bucketId - Bucket unique ID.
|
|
216
|
+
* @throws {AppwriteException}
|
|
217
|
+
* @returns {Promise<Models.Bucket>}
|
|
218
|
+
*/
|
|
219
|
+
getBucket(params: { bucketId: string }): Promise<Models.Bucket>;
|
|
113
220
|
/**
|
|
114
221
|
* Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.
|
|
115
222
|
*
|
|
116
|
-
* @param {string} bucketId
|
|
223
|
+
* @param {string} bucketId - Bucket unique ID.
|
|
117
224
|
* @throws {AppwriteException}
|
|
118
225
|
* @returns {Promise<Models.Bucket>}
|
|
226
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
119
227
|
*/
|
|
120
|
-
getBucket(bucketId: string): Promise<Models.Bucket
|
|
228
|
+
getBucket(bucketId: string): Promise<Models.Bucket>;
|
|
229
|
+
getBucket(
|
|
230
|
+
paramsOrFirst: { bucketId: string } | string
|
|
231
|
+
): Promise<Models.Bucket> {
|
|
232
|
+
let params: { bucketId: string };
|
|
233
|
+
|
|
234
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
235
|
+
params = (paramsOrFirst || {}) as { bucketId: string };
|
|
236
|
+
} else {
|
|
237
|
+
params = {
|
|
238
|
+
bucketId: paramsOrFirst as string
|
|
239
|
+
};
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
const bucketId = params.bucketId;
|
|
243
|
+
|
|
121
244
|
if (typeof bucketId === 'undefined') {
|
|
122
245
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
123
246
|
}
|
|
247
|
+
|
|
124
248
|
const apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
|
|
125
249
|
const payload: Payload = {};
|
|
126
250
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -135,29 +259,87 @@ export class Storage {
|
|
|
135
259
|
payload
|
|
136
260
|
);
|
|
137
261
|
}
|
|
262
|
+
|
|
138
263
|
/**
|
|
139
264
|
* Update a storage bucket by its unique ID.
|
|
140
265
|
*
|
|
141
|
-
* @param {string} bucketId
|
|
142
|
-
* @param {string} name
|
|
143
|
-
* @param {string[]} permissions
|
|
144
|
-
* @param {boolean} fileSecurity
|
|
145
|
-
* @param {boolean} enabled
|
|
146
|
-
* @param {number} maximumFileSize
|
|
147
|
-
* @param {string[]} allowedFileExtensions
|
|
148
|
-
* @param {Compression} compression
|
|
149
|
-
* @param {boolean} encryption
|
|
150
|
-
* @param {boolean} antivirus
|
|
266
|
+
* @param {string} params.bucketId - Bucket unique ID.
|
|
267
|
+
* @param {string} params.name - Bucket name
|
|
268
|
+
* @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
269
|
+
* @param {boolean} params.fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
270
|
+
* @param {boolean} params.enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
|
|
271
|
+
* @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
272
|
+
* @param {string[]} params.allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
|
|
273
|
+
* @param {Compression} params.compression - Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
|
|
274
|
+
* @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
|
|
275
|
+
* @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
|
|
276
|
+
* @param {boolean} params.transformations - Are image transformations enabled?
|
|
151
277
|
* @throws {AppwriteException}
|
|
152
278
|
* @returns {Promise<Models.Bucket>}
|
|
153
279
|
*/
|
|
154
|
-
updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket
|
|
280
|
+
updateBucket(params: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean }): Promise<Models.Bucket>;
|
|
281
|
+
/**
|
|
282
|
+
* Update a storage bucket by its unique ID.
|
|
283
|
+
*
|
|
284
|
+
* @param {string} bucketId - Bucket unique ID.
|
|
285
|
+
* @param {string} name - Bucket name
|
|
286
|
+
* @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
287
|
+
* @param {boolean} fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
288
|
+
* @param {boolean} enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
|
|
289
|
+
* @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
290
|
+
* @param {string[]} allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
|
|
291
|
+
* @param {Compression} compression - Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
|
|
292
|
+
* @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
|
|
293
|
+
* @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
|
|
294
|
+
* @param {boolean} transformations - Are image transformations enabled?
|
|
295
|
+
* @throws {AppwriteException}
|
|
296
|
+
* @returns {Promise<Models.Bucket>}
|
|
297
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
298
|
+
*/
|
|
299
|
+
updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
|
|
300
|
+
updateBucket(
|
|
301
|
+
paramsOrFirst: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean } | string,
|
|
302
|
+
...rest: [(string)?, (string[])?, (boolean)?, (boolean)?, (number)?, (string[])?, (Compression)?, (boolean)?, (boolean)?, (boolean)?]
|
|
303
|
+
): Promise<Models.Bucket> {
|
|
304
|
+
let params: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean };
|
|
305
|
+
|
|
306
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
307
|
+
params = (paramsOrFirst || {}) as { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean };
|
|
308
|
+
} else {
|
|
309
|
+
params = {
|
|
310
|
+
bucketId: paramsOrFirst as string,
|
|
311
|
+
name: rest[0] as string,
|
|
312
|
+
permissions: rest[1] as string[],
|
|
313
|
+
fileSecurity: rest[2] as boolean,
|
|
314
|
+
enabled: rest[3] as boolean,
|
|
315
|
+
maximumFileSize: rest[4] as number,
|
|
316
|
+
allowedFileExtensions: rest[5] as string[],
|
|
317
|
+
compression: rest[6] as Compression,
|
|
318
|
+
encryption: rest[7] as boolean,
|
|
319
|
+
antivirus: rest[8] as boolean,
|
|
320
|
+
transformations: rest[9] as boolean
|
|
321
|
+
};
|
|
322
|
+
}
|
|
323
|
+
|
|
324
|
+
const bucketId = params.bucketId;
|
|
325
|
+
const name = params.name;
|
|
326
|
+
const permissions = params.permissions;
|
|
327
|
+
const fileSecurity = params.fileSecurity;
|
|
328
|
+
const enabled = params.enabled;
|
|
329
|
+
const maximumFileSize = params.maximumFileSize;
|
|
330
|
+
const allowedFileExtensions = params.allowedFileExtensions;
|
|
331
|
+
const compression = params.compression;
|
|
332
|
+
const encryption = params.encryption;
|
|
333
|
+
const antivirus = params.antivirus;
|
|
334
|
+
const transformations = params.transformations;
|
|
335
|
+
|
|
155
336
|
if (typeof bucketId === 'undefined') {
|
|
156
337
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
157
338
|
}
|
|
158
339
|
if (typeof name === 'undefined') {
|
|
159
340
|
throw new AppwriteException('Missing required parameter: "name"');
|
|
160
341
|
}
|
|
342
|
+
|
|
161
343
|
const apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
|
|
162
344
|
const payload: Payload = {};
|
|
163
345
|
if (typeof name !== 'undefined') {
|
|
@@ -187,6 +369,9 @@ export class Storage {
|
|
|
187
369
|
if (typeof antivirus !== 'undefined') {
|
|
188
370
|
payload['antivirus'] = antivirus;
|
|
189
371
|
}
|
|
372
|
+
if (typeof transformations !== 'undefined') {
|
|
373
|
+
payload['transformations'] = transformations;
|
|
374
|
+
}
|
|
190
375
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
191
376
|
|
|
192
377
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -200,17 +385,43 @@ export class Storage {
|
|
|
200
385
|
payload
|
|
201
386
|
);
|
|
202
387
|
}
|
|
388
|
+
|
|
389
|
+
/**
|
|
390
|
+
* Delete a storage bucket by its unique ID.
|
|
391
|
+
*
|
|
392
|
+
* @param {string} params.bucketId - Bucket unique ID.
|
|
393
|
+
* @throws {AppwriteException}
|
|
394
|
+
* @returns {Promise<{}>}
|
|
395
|
+
*/
|
|
396
|
+
deleteBucket(params: { bucketId: string }): Promise<{}>;
|
|
203
397
|
/**
|
|
204
398
|
* Delete a storage bucket by its unique ID.
|
|
205
399
|
*
|
|
206
|
-
* @param {string} bucketId
|
|
400
|
+
* @param {string} bucketId - Bucket unique ID.
|
|
207
401
|
* @throws {AppwriteException}
|
|
208
402
|
* @returns {Promise<{}>}
|
|
403
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
209
404
|
*/
|
|
210
|
-
deleteBucket(bucketId: string): Promise<{}
|
|
405
|
+
deleteBucket(bucketId: string): Promise<{}>;
|
|
406
|
+
deleteBucket(
|
|
407
|
+
paramsOrFirst: { bucketId: string } | string
|
|
408
|
+
): Promise<{}> {
|
|
409
|
+
let params: { bucketId: string };
|
|
410
|
+
|
|
411
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
412
|
+
params = (paramsOrFirst || {}) as { bucketId: string };
|
|
413
|
+
} else {
|
|
414
|
+
params = {
|
|
415
|
+
bucketId: paramsOrFirst as string
|
|
416
|
+
};
|
|
417
|
+
}
|
|
418
|
+
|
|
419
|
+
const bucketId = params.bucketId;
|
|
420
|
+
|
|
211
421
|
if (typeof bucketId === 'undefined') {
|
|
212
422
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
213
423
|
}
|
|
424
|
+
|
|
214
425
|
const apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
|
|
215
426
|
const payload: Payload = {};
|
|
216
427
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -226,19 +437,56 @@ export class Storage {
|
|
|
226
437
|
payload
|
|
227
438
|
);
|
|
228
439
|
}
|
|
440
|
+
|
|
441
|
+
/**
|
|
442
|
+
* Get a list of all the user files. You can use the query params to filter your results.
|
|
443
|
+
*
|
|
444
|
+
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
445
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
|
|
446
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
447
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
448
|
+
* @throws {AppwriteException}
|
|
449
|
+
* @returns {Promise<Models.FileList>}
|
|
450
|
+
*/
|
|
451
|
+
listFiles(params: { bucketId: string, queries?: string[], search?: string, total?: boolean }): Promise<Models.FileList>;
|
|
229
452
|
/**
|
|
230
453
|
* Get a list of all the user files. You can use the query params to filter your results.
|
|
231
454
|
*
|
|
232
|
-
* @param {string} bucketId
|
|
233
|
-
* @param {string[]} queries
|
|
234
|
-
* @param {string} search
|
|
455
|
+
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
456
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
|
|
457
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
458
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
235
459
|
* @throws {AppwriteException}
|
|
236
460
|
* @returns {Promise<Models.FileList>}
|
|
461
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
237
462
|
*/
|
|
238
|
-
listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList
|
|
463
|
+
listFiles(bucketId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.FileList>;
|
|
464
|
+
listFiles(
|
|
465
|
+
paramsOrFirst: { bucketId: string, queries?: string[], search?: string, total?: boolean } | string,
|
|
466
|
+
...rest: [(string[])?, (string)?, (boolean)?]
|
|
467
|
+
): Promise<Models.FileList> {
|
|
468
|
+
let params: { bucketId: string, queries?: string[], search?: string, total?: boolean };
|
|
469
|
+
|
|
470
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
471
|
+
params = (paramsOrFirst || {}) as { bucketId: string, queries?: string[], search?: string, total?: boolean };
|
|
472
|
+
} else {
|
|
473
|
+
params = {
|
|
474
|
+
bucketId: paramsOrFirst as string,
|
|
475
|
+
queries: rest[0] as string[],
|
|
476
|
+
search: rest[1] as string,
|
|
477
|
+
total: rest[2] as boolean
|
|
478
|
+
};
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
const bucketId = params.bucketId;
|
|
482
|
+
const queries = params.queries;
|
|
483
|
+
const search = params.search;
|
|
484
|
+
const total = params.total;
|
|
485
|
+
|
|
239
486
|
if (typeof bucketId === 'undefined') {
|
|
240
487
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
241
488
|
}
|
|
489
|
+
|
|
242
490
|
const apiPath = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
|
|
243
491
|
const payload: Payload = {};
|
|
244
492
|
if (typeof queries !== 'undefined') {
|
|
@@ -247,6 +495,9 @@ export class Storage {
|
|
|
247
495
|
if (typeof search !== 'undefined') {
|
|
248
496
|
payload['search'] = search;
|
|
249
497
|
}
|
|
498
|
+
if (typeof total !== 'undefined') {
|
|
499
|
+
payload['total'] = total;
|
|
500
|
+
}
|
|
250
501
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
251
502
|
|
|
252
503
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -259,24 +510,69 @@ export class Storage {
|
|
|
259
510
|
payload
|
|
260
511
|
);
|
|
261
512
|
}
|
|
513
|
+
|
|
262
514
|
/**
|
|
263
515
|
* Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
|
|
264
|
-
|
|
265
|
-
Larger files should be uploaded using multiple requests with the [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.
|
|
266
|
-
|
|
267
|
-
When the first request is sent, the server will return the **File** object, and the subsequent part request must include the file
|
|
268
|
-
|
|
269
|
-
If you
|
|
270
|
-
|
|
516
|
+
*
|
|
517
|
+
* Larger files should be uploaded using multiple requests with the [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.
|
|
518
|
+
*
|
|
519
|
+
* When the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.
|
|
520
|
+
*
|
|
521
|
+
* If you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.
|
|
522
|
+
*
|
|
271
523
|
*
|
|
272
|
-
* @param {string} bucketId
|
|
273
|
-
* @param {string} fileId
|
|
274
|
-
* @param {File} file
|
|
275
|
-
* @param {string[]} permissions
|
|
524
|
+
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
525
|
+
* @param {string} params.fileId - File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
526
|
+
* @param {File} params.file - Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).
|
|
527
|
+
* @param {string[]} params.permissions - An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
276
528
|
* @throws {AppwriteException}
|
|
277
529
|
* @returns {Promise<Models.File>}
|
|
278
530
|
*/
|
|
279
|
-
createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress
|
|
531
|
+
createFile(params: { bucketId: string, fileId: string, file: File, permissions?: string[] , onProgress?: (progress: UploadProgress) => void }): Promise<Models.File>;
|
|
532
|
+
/**
|
|
533
|
+
* Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
|
|
534
|
+
*
|
|
535
|
+
* Larger files should be uploaded using multiple requests with the [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.
|
|
536
|
+
*
|
|
537
|
+
* When the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.
|
|
538
|
+
*
|
|
539
|
+
* If you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.
|
|
540
|
+
*
|
|
541
|
+
*
|
|
542
|
+
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
543
|
+
* @param {string} fileId - File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
544
|
+
* @param {File} file - Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).
|
|
545
|
+
* @param {string[]} permissions - An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
546
|
+
* @throws {AppwriteException}
|
|
547
|
+
* @returns {Promise<Models.File>}
|
|
548
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
549
|
+
*/
|
|
550
|
+
createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
|
|
551
|
+
createFile(
|
|
552
|
+
paramsOrFirst: { bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void } | string,
|
|
553
|
+
...rest: [(string)?, (File)?, (string[])?,((progress: UploadProgress) => void)?]
|
|
554
|
+
): Promise<Models.File> {
|
|
555
|
+
let params: { bucketId: string, fileId: string, file: File, permissions?: string[] };
|
|
556
|
+
let onProgress: ((progress: UploadProgress) => void);
|
|
557
|
+
|
|
558
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
559
|
+
params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, file: File, permissions?: string[] };
|
|
560
|
+
onProgress = paramsOrFirst?.onProgress as ((progress: UploadProgress) => void);
|
|
561
|
+
} else {
|
|
562
|
+
params = {
|
|
563
|
+
bucketId: paramsOrFirst as string,
|
|
564
|
+
fileId: rest[0] as string,
|
|
565
|
+
file: rest[1] as File,
|
|
566
|
+
permissions: rest[2] as string[]
|
|
567
|
+
};
|
|
568
|
+
onProgress = rest[3] as ((progress: UploadProgress) => void);
|
|
569
|
+
}
|
|
570
|
+
|
|
571
|
+
const bucketId = params.bucketId;
|
|
572
|
+
const fileId = params.fileId;
|
|
573
|
+
const file = params.file;
|
|
574
|
+
const permissions = params.permissions;
|
|
575
|
+
|
|
280
576
|
if (typeof bucketId === 'undefined') {
|
|
281
577
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
282
578
|
}
|
|
@@ -286,6 +582,7 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
|
|
|
286
582
|
if (typeof file === 'undefined') {
|
|
287
583
|
throw new AppwriteException('Missing required parameter: "file"');
|
|
288
584
|
}
|
|
585
|
+
|
|
289
586
|
const apiPath = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
|
|
290
587
|
const payload: Payload = {};
|
|
291
588
|
if (typeof fileId !== 'undefined') {
|
|
@@ -311,21 +608,51 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
|
|
|
311
608
|
onProgress
|
|
312
609
|
);
|
|
313
610
|
}
|
|
611
|
+
|
|
612
|
+
/**
|
|
613
|
+
* Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
|
|
614
|
+
*
|
|
615
|
+
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
616
|
+
* @param {string} params.fileId - File ID.
|
|
617
|
+
* @throws {AppwriteException}
|
|
618
|
+
* @returns {Promise<Models.File>}
|
|
619
|
+
*/
|
|
620
|
+
getFile(params: { bucketId: string, fileId: string }): Promise<Models.File>;
|
|
314
621
|
/**
|
|
315
622
|
* Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
|
|
316
623
|
*
|
|
317
|
-
* @param {string} bucketId
|
|
318
|
-
* @param {string} fileId
|
|
624
|
+
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
625
|
+
* @param {string} fileId - File ID.
|
|
319
626
|
* @throws {AppwriteException}
|
|
320
627
|
* @returns {Promise<Models.File>}
|
|
628
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
321
629
|
*/
|
|
322
|
-
getFile(bucketId: string, fileId: string): Promise<Models.File
|
|
630
|
+
getFile(bucketId: string, fileId: string): Promise<Models.File>;
|
|
631
|
+
getFile(
|
|
632
|
+
paramsOrFirst: { bucketId: string, fileId: string } | string,
|
|
633
|
+
...rest: [(string)?]
|
|
634
|
+
): Promise<Models.File> {
|
|
635
|
+
let params: { bucketId: string, fileId: string };
|
|
636
|
+
|
|
637
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
638
|
+
params = (paramsOrFirst || {}) as { bucketId: string, fileId: string };
|
|
639
|
+
} else {
|
|
640
|
+
params = {
|
|
641
|
+
bucketId: paramsOrFirst as string,
|
|
642
|
+
fileId: rest[0] as string
|
|
643
|
+
};
|
|
644
|
+
}
|
|
645
|
+
|
|
646
|
+
const bucketId = params.bucketId;
|
|
647
|
+
const fileId = params.fileId;
|
|
648
|
+
|
|
323
649
|
if (typeof bucketId === 'undefined') {
|
|
324
650
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
325
651
|
}
|
|
326
652
|
if (typeof fileId === 'undefined') {
|
|
327
653
|
throw new AppwriteException('Missing required parameter: "fileId"');
|
|
328
654
|
}
|
|
655
|
+
|
|
329
656
|
const apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
|
|
330
657
|
const payload: Payload = {};
|
|
331
658
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -340,23 +667,59 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
|
|
|
340
667
|
payload
|
|
341
668
|
);
|
|
342
669
|
}
|
|
670
|
+
|
|
671
|
+
/**
|
|
672
|
+
* Update a file by its unique ID. Only users with write permissions have access to update this resource.
|
|
673
|
+
*
|
|
674
|
+
* @param {string} params.bucketId - Bucket unique ID.
|
|
675
|
+
* @param {string} params.fileId - File ID.
|
|
676
|
+
* @param {string} params.name - File name.
|
|
677
|
+
* @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
678
|
+
* @throws {AppwriteException}
|
|
679
|
+
* @returns {Promise<Models.File>}
|
|
680
|
+
*/
|
|
681
|
+
updateFile(params: { bucketId: string, fileId: string, name?: string, permissions?: string[] }): Promise<Models.File>;
|
|
343
682
|
/**
|
|
344
683
|
* Update a file by its unique ID. Only users with write permissions have access to update this resource.
|
|
345
684
|
*
|
|
346
|
-
* @param {string} bucketId
|
|
347
|
-
* @param {string} fileId
|
|
348
|
-
* @param {string} name
|
|
349
|
-
* @param {string[]} permissions
|
|
685
|
+
* @param {string} bucketId - Bucket unique ID.
|
|
686
|
+
* @param {string} fileId - File ID.
|
|
687
|
+
* @param {string} name - File name.
|
|
688
|
+
* @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
350
689
|
* @throws {AppwriteException}
|
|
351
690
|
* @returns {Promise<Models.File>}
|
|
691
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
352
692
|
*/
|
|
353
|
-
updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File
|
|
693
|
+
updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File>;
|
|
694
|
+
updateFile(
|
|
695
|
+
paramsOrFirst: { bucketId: string, fileId: string, name?: string, permissions?: string[] } | string,
|
|
696
|
+
...rest: [(string)?, (string)?, (string[])?]
|
|
697
|
+
): Promise<Models.File> {
|
|
698
|
+
let params: { bucketId: string, fileId: string, name?: string, permissions?: string[] };
|
|
699
|
+
|
|
700
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
701
|
+
params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, name?: string, permissions?: string[] };
|
|
702
|
+
} else {
|
|
703
|
+
params = {
|
|
704
|
+
bucketId: paramsOrFirst as string,
|
|
705
|
+
fileId: rest[0] as string,
|
|
706
|
+
name: rest[1] as string,
|
|
707
|
+
permissions: rest[2] as string[]
|
|
708
|
+
};
|
|
709
|
+
}
|
|
710
|
+
|
|
711
|
+
const bucketId = params.bucketId;
|
|
712
|
+
const fileId = params.fileId;
|
|
713
|
+
const name = params.name;
|
|
714
|
+
const permissions = params.permissions;
|
|
715
|
+
|
|
354
716
|
if (typeof bucketId === 'undefined') {
|
|
355
717
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
356
718
|
}
|
|
357
719
|
if (typeof fileId === 'undefined') {
|
|
358
720
|
throw new AppwriteException('Missing required parameter: "fileId"');
|
|
359
721
|
}
|
|
722
|
+
|
|
360
723
|
const apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
|
|
361
724
|
const payload: Payload = {};
|
|
362
725
|
if (typeof name !== 'undefined') {
|
|
@@ -378,21 +741,51 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
|
|
|
378
741
|
payload
|
|
379
742
|
);
|
|
380
743
|
}
|
|
744
|
+
|
|
381
745
|
/**
|
|
382
746
|
* Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
|
|
383
747
|
*
|
|
384
|
-
* @param {string} bucketId
|
|
385
|
-
* @param {string} fileId
|
|
748
|
+
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
749
|
+
* @param {string} params.fileId - File ID.
|
|
386
750
|
* @throws {AppwriteException}
|
|
387
751
|
* @returns {Promise<{}>}
|
|
388
752
|
*/
|
|
389
|
-
deleteFile(bucketId: string, fileId: string): Promise<{}
|
|
753
|
+
deleteFile(params: { bucketId: string, fileId: string }): Promise<{}>;
|
|
754
|
+
/**
|
|
755
|
+
* Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
|
|
756
|
+
*
|
|
757
|
+
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
758
|
+
* @param {string} fileId - File ID.
|
|
759
|
+
* @throws {AppwriteException}
|
|
760
|
+
* @returns {Promise<{}>}
|
|
761
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
762
|
+
*/
|
|
763
|
+
deleteFile(bucketId: string, fileId: string): Promise<{}>;
|
|
764
|
+
deleteFile(
|
|
765
|
+
paramsOrFirst: { bucketId: string, fileId: string } | string,
|
|
766
|
+
...rest: [(string)?]
|
|
767
|
+
): Promise<{}> {
|
|
768
|
+
let params: { bucketId: string, fileId: string };
|
|
769
|
+
|
|
770
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
771
|
+
params = (paramsOrFirst || {}) as { bucketId: string, fileId: string };
|
|
772
|
+
} else {
|
|
773
|
+
params = {
|
|
774
|
+
bucketId: paramsOrFirst as string,
|
|
775
|
+
fileId: rest[0] as string
|
|
776
|
+
};
|
|
777
|
+
}
|
|
778
|
+
|
|
779
|
+
const bucketId = params.bucketId;
|
|
780
|
+
const fileId = params.fileId;
|
|
781
|
+
|
|
390
782
|
if (typeof bucketId === 'undefined') {
|
|
391
783
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
392
784
|
}
|
|
393
785
|
if (typeof fileId === 'undefined') {
|
|
394
786
|
throw new AppwriteException('Missing required parameter: "fileId"');
|
|
395
787
|
}
|
|
788
|
+
|
|
396
789
|
const apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
|
|
397
790
|
const payload: Payload = {};
|
|
398
791
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -408,22 +801,55 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
|
|
|
408
801
|
payload
|
|
409
802
|
);
|
|
410
803
|
}
|
|
804
|
+
|
|
411
805
|
/**
|
|
412
|
-
* Get a file content by its unique ID. The endpoint response return with a
|
|
806
|
+
* Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
|
|
413
807
|
*
|
|
414
|
-
* @param {string} bucketId
|
|
415
|
-
* @param {string} fileId
|
|
416
|
-
* @param {string} token
|
|
808
|
+
* @param {string} params.bucketId - Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
809
|
+
* @param {string} params.fileId - File ID.
|
|
810
|
+
* @param {string} params.token - File token for accessing this file.
|
|
417
811
|
* @throws {AppwriteException}
|
|
418
812
|
* @returns {string}
|
|
419
813
|
*/
|
|
420
|
-
getFileDownload(bucketId: string, fileId: string, token?: string): string
|
|
814
|
+
getFileDownload(params: { bucketId: string, fileId: string, token?: string }): string;
|
|
815
|
+
/**
|
|
816
|
+
* Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
|
|
817
|
+
*
|
|
818
|
+
* @param {string} bucketId - Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
819
|
+
* @param {string} fileId - File ID.
|
|
820
|
+
* @param {string} token - File token for accessing this file.
|
|
821
|
+
* @throws {AppwriteException}
|
|
822
|
+
* @returns {string}
|
|
823
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
824
|
+
*/
|
|
825
|
+
getFileDownload(bucketId: string, fileId: string, token?: string): string;
|
|
826
|
+
getFileDownload(
|
|
827
|
+
paramsOrFirst: { bucketId: string, fileId: string, token?: string } | string,
|
|
828
|
+
...rest: [(string)?, (string)?]
|
|
829
|
+
): string {
|
|
830
|
+
let params: { bucketId: string, fileId: string, token?: string };
|
|
831
|
+
|
|
832
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
833
|
+
params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, token?: string };
|
|
834
|
+
} else {
|
|
835
|
+
params = {
|
|
836
|
+
bucketId: paramsOrFirst as string,
|
|
837
|
+
fileId: rest[0] as string,
|
|
838
|
+
token: rest[1] as string
|
|
839
|
+
};
|
|
840
|
+
}
|
|
841
|
+
|
|
842
|
+
const bucketId = params.bucketId;
|
|
843
|
+
const fileId = params.fileId;
|
|
844
|
+
const token = params.token;
|
|
845
|
+
|
|
421
846
|
if (typeof bucketId === 'undefined') {
|
|
422
847
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
423
848
|
}
|
|
424
849
|
if (typeof fileId === 'undefined') {
|
|
425
850
|
throw new AppwriteException('Missing required parameter: "fileId"');
|
|
426
851
|
}
|
|
852
|
+
|
|
427
853
|
const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
|
|
428
854
|
const payload: Payload = {};
|
|
429
855
|
if (typeof token !== 'undefined') {
|
|
@@ -442,33 +868,99 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
|
|
|
442
868
|
|
|
443
869
|
return uri.toString();
|
|
444
870
|
}
|
|
871
|
+
|
|
872
|
+
/**
|
|
873
|
+
* Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.
|
|
874
|
+
*
|
|
875
|
+
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
876
|
+
* @param {string} params.fileId - File ID
|
|
877
|
+
* @param {number} params.width - Resize preview image width, Pass an integer between 0 to 4000.
|
|
878
|
+
* @param {number} params.height - Resize preview image height, Pass an integer between 0 to 4000.
|
|
879
|
+
* @param {ImageGravity} params.gravity - Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
|
|
880
|
+
* @param {number} params.quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
881
|
+
* @param {number} params.borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
|
|
882
|
+
* @param {string} params.borderColor - Preview image border color. Use a valid HEX color, no # is needed for prefix.
|
|
883
|
+
* @param {number} params.borderRadius - Preview image border radius in pixels. Pass an integer between 0 to 4000.
|
|
884
|
+
* @param {number} params.opacity - Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
|
|
885
|
+
* @param {number} params.rotation - Preview image rotation in degrees. Pass an integer between -360 and 360.
|
|
886
|
+
* @param {string} params.background - Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
|
|
887
|
+
* @param {ImageFormat} params.output - Output format type (jpeg, jpg, png, gif and webp).
|
|
888
|
+
* @param {string} params.token - File token for accessing this file.
|
|
889
|
+
* @throws {AppwriteException}
|
|
890
|
+
* @returns {string}
|
|
891
|
+
*/
|
|
892
|
+
getFilePreview(params: { bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string }): string;
|
|
445
893
|
/**
|
|
446
894
|
* Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.
|
|
447
895
|
*
|
|
448
|
-
* @param {string} bucketId
|
|
449
|
-
* @param {string} fileId
|
|
450
|
-
* @param {number} width
|
|
451
|
-
* @param {number} height
|
|
452
|
-
* @param {ImageGravity} gravity
|
|
453
|
-
* @param {number} quality
|
|
454
|
-
* @param {number} borderWidth
|
|
455
|
-
* @param {string} borderColor
|
|
456
|
-
* @param {number} borderRadius
|
|
457
|
-
* @param {number} opacity
|
|
458
|
-
* @param {number} rotation
|
|
459
|
-
* @param {string} background
|
|
460
|
-
* @param {ImageFormat} output
|
|
461
|
-
* @param {string} token
|
|
896
|
+
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
897
|
+
* @param {string} fileId - File ID
|
|
898
|
+
* @param {number} width - Resize preview image width, Pass an integer between 0 to 4000.
|
|
899
|
+
* @param {number} height - Resize preview image height, Pass an integer between 0 to 4000.
|
|
900
|
+
* @param {ImageGravity} gravity - Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
|
|
901
|
+
* @param {number} quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
902
|
+
* @param {number} borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
|
|
903
|
+
* @param {string} borderColor - Preview image border color. Use a valid HEX color, no # is needed for prefix.
|
|
904
|
+
* @param {number} borderRadius - Preview image border radius in pixels. Pass an integer between 0 to 4000.
|
|
905
|
+
* @param {number} opacity - Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
|
|
906
|
+
* @param {number} rotation - Preview image rotation in degrees. Pass an integer between -360 and 360.
|
|
907
|
+
* @param {string} background - Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
|
|
908
|
+
* @param {ImageFormat} output - Output format type (jpeg, jpg, png, gif and webp).
|
|
909
|
+
* @param {string} token - File token for accessing this file.
|
|
462
910
|
* @throws {AppwriteException}
|
|
463
911
|
* @returns {string}
|
|
912
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
464
913
|
*/
|
|
465
|
-
getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string): string
|
|
914
|
+
getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string): string;
|
|
915
|
+
getFilePreview(
|
|
916
|
+
paramsOrFirst: { bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string } | string,
|
|
917
|
+
...rest: [(string)?, (number)?, (number)?, (ImageGravity)?, (number)?, (number)?, (string)?, (number)?, (number)?, (number)?, (string)?, (ImageFormat)?, (string)?]
|
|
918
|
+
): string {
|
|
919
|
+
let params: { bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string };
|
|
920
|
+
|
|
921
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
922
|
+
params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string };
|
|
923
|
+
} else {
|
|
924
|
+
params = {
|
|
925
|
+
bucketId: paramsOrFirst as string,
|
|
926
|
+
fileId: rest[0] as string,
|
|
927
|
+
width: rest[1] as number,
|
|
928
|
+
height: rest[2] as number,
|
|
929
|
+
gravity: rest[3] as ImageGravity,
|
|
930
|
+
quality: rest[4] as number,
|
|
931
|
+
borderWidth: rest[5] as number,
|
|
932
|
+
borderColor: rest[6] as string,
|
|
933
|
+
borderRadius: rest[7] as number,
|
|
934
|
+
opacity: rest[8] as number,
|
|
935
|
+
rotation: rest[9] as number,
|
|
936
|
+
background: rest[10] as string,
|
|
937
|
+
output: rest[11] as ImageFormat,
|
|
938
|
+
token: rest[12] as string
|
|
939
|
+
};
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
const bucketId = params.bucketId;
|
|
943
|
+
const fileId = params.fileId;
|
|
944
|
+
const width = params.width;
|
|
945
|
+
const height = params.height;
|
|
946
|
+
const gravity = params.gravity;
|
|
947
|
+
const quality = params.quality;
|
|
948
|
+
const borderWidth = params.borderWidth;
|
|
949
|
+
const borderColor = params.borderColor;
|
|
950
|
+
const borderRadius = params.borderRadius;
|
|
951
|
+
const opacity = params.opacity;
|
|
952
|
+
const rotation = params.rotation;
|
|
953
|
+
const background = params.background;
|
|
954
|
+
const output = params.output;
|
|
955
|
+
const token = params.token;
|
|
956
|
+
|
|
466
957
|
if (typeof bucketId === 'undefined') {
|
|
467
958
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
468
959
|
}
|
|
469
960
|
if (typeof fileId === 'undefined') {
|
|
470
961
|
throw new AppwriteException('Missing required parameter: "fileId"');
|
|
471
962
|
}
|
|
963
|
+
|
|
472
964
|
const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
|
|
473
965
|
const payload: Payload = {};
|
|
474
966
|
if (typeof width !== 'undefined') {
|
|
@@ -520,22 +1012,55 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
|
|
|
520
1012
|
|
|
521
1013
|
return uri.toString();
|
|
522
1014
|
}
|
|
1015
|
+
|
|
1016
|
+
/**
|
|
1017
|
+
* Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.
|
|
1018
|
+
*
|
|
1019
|
+
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
1020
|
+
* @param {string} params.fileId - File ID.
|
|
1021
|
+
* @param {string} params.token - File token for accessing this file.
|
|
1022
|
+
* @throws {AppwriteException}
|
|
1023
|
+
* @returns {string}
|
|
1024
|
+
*/
|
|
1025
|
+
getFileView(params: { bucketId: string, fileId: string, token?: string }): string;
|
|
523
1026
|
/**
|
|
524
|
-
* Get a file content by its unique ID. This endpoint is similar to the download method but returns with no
|
|
1027
|
+
* Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.
|
|
525
1028
|
*
|
|
526
|
-
* @param {string} bucketId
|
|
527
|
-
* @param {string} fileId
|
|
528
|
-
* @param {string} token
|
|
1029
|
+
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
1030
|
+
* @param {string} fileId - File ID.
|
|
1031
|
+
* @param {string} token - File token for accessing this file.
|
|
529
1032
|
* @throws {AppwriteException}
|
|
530
1033
|
* @returns {string}
|
|
1034
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
531
1035
|
*/
|
|
532
|
-
getFileView(bucketId: string, fileId: string, token?: string): string
|
|
1036
|
+
getFileView(bucketId: string, fileId: string, token?: string): string;
|
|
1037
|
+
getFileView(
|
|
1038
|
+
paramsOrFirst: { bucketId: string, fileId: string, token?: string } | string,
|
|
1039
|
+
...rest: [(string)?, (string)?]
|
|
1040
|
+
): string {
|
|
1041
|
+
let params: { bucketId: string, fileId: string, token?: string };
|
|
1042
|
+
|
|
1043
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1044
|
+
params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, token?: string };
|
|
1045
|
+
} else {
|
|
1046
|
+
params = {
|
|
1047
|
+
bucketId: paramsOrFirst as string,
|
|
1048
|
+
fileId: rest[0] as string,
|
|
1049
|
+
token: rest[1] as string
|
|
1050
|
+
};
|
|
1051
|
+
}
|
|
1052
|
+
|
|
1053
|
+
const bucketId = params.bucketId;
|
|
1054
|
+
const fileId = params.fileId;
|
|
1055
|
+
const token = params.token;
|
|
1056
|
+
|
|
533
1057
|
if (typeof bucketId === 'undefined') {
|
|
534
1058
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
535
1059
|
}
|
|
536
1060
|
if (typeof fileId === 'undefined') {
|
|
537
1061
|
throw new AppwriteException('Missing required parameter: "fileId"');
|
|
538
1062
|
}
|
|
1063
|
+
|
|
539
1064
|
const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
|
|
540
1065
|
const payload: Payload = {};
|
|
541
1066
|
if (typeof token !== 'undefined') {
|
|
@@ -554,15 +1079,42 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
|
|
|
554
1079
|
|
|
555
1080
|
return uri.toString();
|
|
556
1081
|
}
|
|
1082
|
+
|
|
557
1083
|
/**
|
|
558
1084
|
* Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
|
|
559
|
-
|
|
1085
|
+
*
|
|
560
1086
|
*
|
|
561
|
-
* @param {
|
|
1087
|
+
* @param {UsageRange} params.range - Date range.
|
|
562
1088
|
* @throws {AppwriteException}
|
|
563
1089
|
* @returns {Promise<Models.UsageStorage>}
|
|
564
1090
|
*/
|
|
565
|
-
getUsage(range?:
|
|
1091
|
+
getUsage(params?: { range?: UsageRange }): Promise<Models.UsageStorage>;
|
|
1092
|
+
/**
|
|
1093
|
+
* Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
|
|
1094
|
+
*
|
|
1095
|
+
*
|
|
1096
|
+
* @param {UsageRange} range - Date range.
|
|
1097
|
+
* @throws {AppwriteException}
|
|
1098
|
+
* @returns {Promise<Models.UsageStorage>}
|
|
1099
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1100
|
+
*/
|
|
1101
|
+
getUsage(range?: UsageRange): Promise<Models.UsageStorage>;
|
|
1102
|
+
getUsage(
|
|
1103
|
+
paramsOrFirst?: { range?: UsageRange } | UsageRange
|
|
1104
|
+
): Promise<Models.UsageStorage> {
|
|
1105
|
+
let params: { range?: UsageRange };
|
|
1106
|
+
|
|
1107
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst) && 'range' in paramsOrFirst)) {
|
|
1108
|
+
params = (paramsOrFirst || {}) as { range?: UsageRange };
|
|
1109
|
+
} else {
|
|
1110
|
+
params = {
|
|
1111
|
+
range: paramsOrFirst as UsageRange
|
|
1112
|
+
};
|
|
1113
|
+
}
|
|
1114
|
+
|
|
1115
|
+
const range = params.range;
|
|
1116
|
+
|
|
1117
|
+
|
|
566
1118
|
const apiPath = '/storage/usage';
|
|
567
1119
|
const payload: Payload = {};
|
|
568
1120
|
if (typeof range !== 'undefined') {
|
|
@@ -580,19 +1132,50 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
|
|
|
580
1132
|
payload
|
|
581
1133
|
);
|
|
582
1134
|
}
|
|
1135
|
+
|
|
583
1136
|
/**
|
|
584
1137
|
* Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
|
|
585
|
-
|
|
1138
|
+
*
|
|
586
1139
|
*
|
|
587
|
-
* @param {string} bucketId
|
|
588
|
-
* @param {
|
|
1140
|
+
* @param {string} params.bucketId - Bucket ID.
|
|
1141
|
+
* @param {UsageRange} params.range - Date range.
|
|
589
1142
|
* @throws {AppwriteException}
|
|
590
1143
|
* @returns {Promise<Models.UsageBuckets>}
|
|
591
1144
|
*/
|
|
592
|
-
getBucketUsage(bucketId: string, range?:
|
|
1145
|
+
getBucketUsage(params: { bucketId: string, range?: UsageRange }): Promise<Models.UsageBuckets>;
|
|
1146
|
+
/**
|
|
1147
|
+
* Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
|
|
1148
|
+
*
|
|
1149
|
+
*
|
|
1150
|
+
* @param {string} bucketId - Bucket ID.
|
|
1151
|
+
* @param {UsageRange} range - Date range.
|
|
1152
|
+
* @throws {AppwriteException}
|
|
1153
|
+
* @returns {Promise<Models.UsageBuckets>}
|
|
1154
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1155
|
+
*/
|
|
1156
|
+
getBucketUsage(bucketId: string, range?: UsageRange): Promise<Models.UsageBuckets>;
|
|
1157
|
+
getBucketUsage(
|
|
1158
|
+
paramsOrFirst: { bucketId: string, range?: UsageRange } | string,
|
|
1159
|
+
...rest: [(UsageRange)?]
|
|
1160
|
+
): Promise<Models.UsageBuckets> {
|
|
1161
|
+
let params: { bucketId: string, range?: UsageRange };
|
|
1162
|
+
|
|
1163
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1164
|
+
params = (paramsOrFirst || {}) as { bucketId: string, range?: UsageRange };
|
|
1165
|
+
} else {
|
|
1166
|
+
params = {
|
|
1167
|
+
bucketId: paramsOrFirst as string,
|
|
1168
|
+
range: rest[0] as UsageRange
|
|
1169
|
+
};
|
|
1170
|
+
}
|
|
1171
|
+
|
|
1172
|
+
const bucketId = params.bucketId;
|
|
1173
|
+
const range = params.range;
|
|
1174
|
+
|
|
593
1175
|
if (typeof bucketId === 'undefined') {
|
|
594
1176
|
throw new AppwriteException('Missing required parameter: "bucketId"');
|
|
595
1177
|
}
|
|
1178
|
+
|
|
596
1179
|
const apiPath = '/storage/{bucketId}/usage'.replace('{bucketId}', bucketId);
|
|
597
1180
|
const payload: Payload = {};
|
|
598
1181
|
if (typeof range !== 'undefined') {
|