@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
|
@@ -1,328 +1,883 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
-
import {
|
|
3
|
+
import { Platform } from '../enums/platform';
|
|
4
4
|
export declare class Organizations {
|
|
5
5
|
client: Client;
|
|
6
6
|
constructor(client: Client);
|
|
7
7
|
/**
|
|
8
8
|
* Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
|
|
9
9
|
*
|
|
10
|
-
* @param {string[]} queries
|
|
11
|
-
* @param {string} search
|
|
10
|
+
* @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, total, billingPlan, paymentMethodId, backupPaymentMethodId, platform
|
|
11
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
12
12
|
* @throws {AppwriteException}
|
|
13
13
|
* @returns {Promise<Models.OrganizationList<Preferences>>}
|
|
14
14
|
*/
|
|
15
|
-
list<Preferences extends Models.Preferences>(
|
|
15
|
+
list<Preferences extends Models.Preferences = Models.DefaultPreferences>(params?: {
|
|
16
|
+
queries?: string[];
|
|
17
|
+
search?: string;
|
|
18
|
+
}): Promise<Models.OrganizationList<Preferences>>;
|
|
19
|
+
/**
|
|
20
|
+
* Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
|
|
21
|
+
*
|
|
22
|
+
* @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, total, billingPlan, paymentMethodId, backupPaymentMethodId, platform
|
|
23
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
24
|
+
* @throws {AppwriteException}
|
|
25
|
+
* @returns {Promise<Models.OrganizationList<Preferences>>}
|
|
26
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
27
|
+
*/
|
|
28
|
+
list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.OrganizationList<Preferences>>;
|
|
16
29
|
/**
|
|
17
30
|
* Create a new organization.
|
|
18
|
-
|
|
19
|
-
*
|
|
20
|
-
* @param {string} organizationId
|
|
21
|
-
* @param {string} name
|
|
22
|
-
* @param {
|
|
23
|
-
* @param {string} paymentMethodId
|
|
24
|
-
* @param {string} billingAddressId
|
|
25
|
-
* @param {string[]} invites
|
|
26
|
-
* @param {string} couponId
|
|
27
|
-
* @param {string} taxId
|
|
28
|
-
* @param {number} budget
|
|
31
|
+
*
|
|
32
|
+
*
|
|
33
|
+
* @param {string} params.organizationId - Organization 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.
|
|
34
|
+
* @param {string} params.name - Organization name. Max length: 128 chars.
|
|
35
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
36
|
+
* @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
37
|
+
* @param {string} params.billingAddressId - Unique ID of billing address
|
|
38
|
+
* @param {string[]} params.invites - Additional member invites
|
|
39
|
+
* @param {string} params.couponId - Coupon id
|
|
40
|
+
* @param {string} params.taxId - Tax Id associated to billing.
|
|
41
|
+
* @param {number} params.budget - Budget limit for additional usage set for the organization
|
|
42
|
+
* @param {Platform} params.platform - Platform type
|
|
43
|
+
* @throws {AppwriteException}
|
|
44
|
+
* @returns {Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>}
|
|
45
|
+
*/
|
|
46
|
+
create<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
47
|
+
organizationId: string;
|
|
48
|
+
name: string;
|
|
49
|
+
billingPlan: string;
|
|
50
|
+
paymentMethodId?: string;
|
|
51
|
+
billingAddressId?: string;
|
|
52
|
+
invites?: string[];
|
|
53
|
+
couponId?: string;
|
|
54
|
+
taxId?: string;
|
|
55
|
+
budget?: number;
|
|
56
|
+
platform?: Platform;
|
|
57
|
+
}): Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>;
|
|
58
|
+
/**
|
|
59
|
+
* Create a new organization.
|
|
60
|
+
*
|
|
61
|
+
*
|
|
62
|
+
* @param {string} organizationId - Organization 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.
|
|
63
|
+
* @param {string} name - Organization name. Max length: 128 chars.
|
|
64
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
65
|
+
* @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
66
|
+
* @param {string} billingAddressId - Unique ID of billing address
|
|
67
|
+
* @param {string[]} invites - Additional member invites
|
|
68
|
+
* @param {string} couponId - Coupon id
|
|
69
|
+
* @param {string} taxId - Tax Id associated to billing.
|
|
70
|
+
* @param {number} budget - Budget limit for additional usage set for the organization
|
|
71
|
+
* @param {Platform} platform - Platform type
|
|
29
72
|
* @throws {AppwriteException}
|
|
30
|
-
* @returns {Promise<Models.Organization<Preferences
|
|
73
|
+
* @returns {Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>}
|
|
74
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
31
75
|
*/
|
|
32
|
-
create<Preferences extends Models.Preferences>(organizationId: string, name: string, billingPlan:
|
|
76
|
+
create<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, name: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number, platform?: Platform): Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>;
|
|
33
77
|
/**
|
|
34
78
|
* Get estimation for creating an organization.
|
|
35
79
|
*
|
|
36
|
-
* @param {
|
|
37
|
-
* @param {string} paymentMethodId
|
|
38
|
-
* @param {string[]} invites
|
|
39
|
-
* @param {string} couponId
|
|
80
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
81
|
+
* @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
82
|
+
* @param {string[]} params.invites - Additional member invites
|
|
83
|
+
* @param {string} params.couponId - Coupon id
|
|
84
|
+
* @param {Platform} params.platform - Platform type
|
|
40
85
|
* @throws {AppwriteException}
|
|
41
86
|
* @returns {Promise<Models.Estimation>}
|
|
42
87
|
*/
|
|
43
|
-
estimationCreateOrganization(
|
|
88
|
+
estimationCreateOrganization(params: {
|
|
89
|
+
billingPlan: string;
|
|
90
|
+
paymentMethodId?: string;
|
|
91
|
+
invites?: string[];
|
|
92
|
+
couponId?: string;
|
|
93
|
+
platform?: Platform;
|
|
94
|
+
}): Promise<Models.Estimation>;
|
|
95
|
+
/**
|
|
96
|
+
* Get estimation for creating an organization.
|
|
97
|
+
*
|
|
98
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
99
|
+
* @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
100
|
+
* @param {string[]} invites - Additional member invites
|
|
101
|
+
* @param {string} couponId - Coupon id
|
|
102
|
+
* @param {Platform} platform - Platform type
|
|
103
|
+
* @throws {AppwriteException}
|
|
104
|
+
* @returns {Promise<Models.Estimation>}
|
|
105
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
106
|
+
*/
|
|
107
|
+
estimationCreateOrganization(billingPlan: string, paymentMethodId?: string, invites?: string[], couponId?: string, platform?: Platform): Promise<Models.Estimation>;
|
|
108
|
+
/**
|
|
109
|
+
* Delete an organization.
|
|
110
|
+
*
|
|
111
|
+
* @param {string} params.organizationId - Team ID.
|
|
112
|
+
* @throws {AppwriteException}
|
|
113
|
+
* @returns {Promise<{}>}
|
|
114
|
+
*/
|
|
115
|
+
delete(params: {
|
|
116
|
+
organizationId: string;
|
|
117
|
+
}): Promise<{}>;
|
|
44
118
|
/**
|
|
45
119
|
* Delete an organization.
|
|
46
120
|
*
|
|
47
|
-
* @param {string} organizationId
|
|
121
|
+
* @param {string} organizationId - Team ID.
|
|
48
122
|
* @throws {AppwriteException}
|
|
49
123
|
* @returns {Promise<{}>}
|
|
124
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
50
125
|
*/
|
|
51
126
|
delete(organizationId: string): Promise<{}>;
|
|
52
127
|
/**
|
|
53
128
|
* Get a list of all aggregations for an organization.
|
|
54
129
|
*
|
|
55
|
-
* @param {string} organizationId
|
|
56
|
-
* @param {string[]} queries
|
|
130
|
+
* @param {string} params.organizationId - Organization ID
|
|
131
|
+
* @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, from, to
|
|
132
|
+
* @throws {AppwriteException}
|
|
133
|
+
* @returns {Promise<Models.AggregationTeamList>}
|
|
134
|
+
*/
|
|
135
|
+
listAggregations(params: {
|
|
136
|
+
organizationId: string;
|
|
137
|
+
queries?: string[];
|
|
138
|
+
}): Promise<Models.AggregationTeamList>;
|
|
139
|
+
/**
|
|
140
|
+
* Get a list of all aggregations for an organization.
|
|
141
|
+
*
|
|
142
|
+
* @param {string} organizationId - Organization ID
|
|
143
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, from, to
|
|
57
144
|
* @throws {AppwriteException}
|
|
58
145
|
* @returns {Promise<Models.AggregationTeamList>}
|
|
146
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
59
147
|
*/
|
|
60
148
|
listAggregations(organizationId: string, queries?: string[]): Promise<Models.AggregationTeamList>;
|
|
61
149
|
/**
|
|
62
|
-
* Get a specific aggregation using it
|
|
150
|
+
* Get a specific aggregation using it's aggregation ID.
|
|
151
|
+
*
|
|
152
|
+
* @param {string} params.organizationId - Organization ID
|
|
153
|
+
* @param {string} params.aggregationId - Invoice unique ID
|
|
154
|
+
* @param {number} params.limit - Maximum number of project aggregations to return in response. By default will return maximum 5 results. Maximum of 10 results allowed per request.
|
|
155
|
+
* @param {number} params.offset - Offset value. The default value is 0. Use this param to manage pagination.
|
|
156
|
+
* @throws {AppwriteException}
|
|
157
|
+
* @returns {Promise<Models.AggregationTeam>}
|
|
158
|
+
*/
|
|
159
|
+
getAggregation(params: {
|
|
160
|
+
organizationId: string;
|
|
161
|
+
aggregationId: string;
|
|
162
|
+
limit?: number;
|
|
163
|
+
offset?: number;
|
|
164
|
+
}): Promise<Models.AggregationTeam>;
|
|
165
|
+
/**
|
|
166
|
+
* Get a specific aggregation using it's aggregation ID.
|
|
63
167
|
*
|
|
64
|
-
* @param {string} organizationId
|
|
65
|
-
* @param {string} aggregationId
|
|
168
|
+
* @param {string} organizationId - Organization ID
|
|
169
|
+
* @param {string} aggregationId - Invoice unique ID
|
|
170
|
+
* @param {number} limit - Maximum number of project aggregations to return in response. By default will return maximum 5 results. Maximum of 10 results allowed per request.
|
|
171
|
+
* @param {number} offset - Offset value. The default value is 0. Use this param to manage pagination.
|
|
66
172
|
* @throws {AppwriteException}
|
|
67
173
|
* @returns {Promise<Models.AggregationTeam>}
|
|
174
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
68
175
|
*/
|
|
69
|
-
getAggregation(organizationId: string, aggregationId: string): Promise<Models.AggregationTeam>;
|
|
176
|
+
getAggregation(organizationId: string, aggregationId: string, limit?: number, offset?: number): Promise<Models.AggregationTeam>;
|
|
70
177
|
/**
|
|
71
178
|
* Set a billing address for an organization.
|
|
72
179
|
*
|
|
73
|
-
* @param {string} organizationId
|
|
74
|
-
* @param {string} billingAddressId
|
|
180
|
+
* @param {string} params.organizationId - Organization ID
|
|
181
|
+
* @param {string} params.billingAddressId - Unique ID of billing address
|
|
75
182
|
* @throws {AppwriteException}
|
|
76
183
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
77
184
|
*/
|
|
78
|
-
setBillingAddress<Preferences extends Models.Preferences>(
|
|
185
|
+
setBillingAddress<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
186
|
+
organizationId: string;
|
|
187
|
+
billingAddressId: string;
|
|
188
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
79
189
|
/**
|
|
80
|
-
*
|
|
190
|
+
* Set a billing address for an organization.
|
|
81
191
|
*
|
|
82
|
-
* @param {string} organizationId
|
|
192
|
+
* @param {string} organizationId - Organization ID
|
|
193
|
+
* @param {string} billingAddressId - Unique ID of billing address
|
|
194
|
+
* @throws {AppwriteException}
|
|
195
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
196
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
197
|
+
*/
|
|
198
|
+
setBillingAddress<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingAddressId: string): Promise<Models.Organization<Preferences>>;
|
|
199
|
+
/**
|
|
200
|
+
* Delete a team's billing address.
|
|
201
|
+
*
|
|
202
|
+
* @param {string} params.organizationId - Organization ID
|
|
83
203
|
* @throws {AppwriteException}
|
|
84
204
|
* @returns {Promise<{}>}
|
|
85
205
|
*/
|
|
206
|
+
deleteBillingAddress(params: {
|
|
207
|
+
organizationId: string;
|
|
208
|
+
}): Promise<{}>;
|
|
209
|
+
/**
|
|
210
|
+
* Delete a team's billing address.
|
|
211
|
+
*
|
|
212
|
+
* @param {string} organizationId - Organization ID
|
|
213
|
+
* @throws {AppwriteException}
|
|
214
|
+
* @returns {Promise<{}>}
|
|
215
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
216
|
+
*/
|
|
86
217
|
deleteBillingAddress(organizationId: string): Promise<{}>;
|
|
87
218
|
/**
|
|
88
|
-
* Get a billing address using it
|
|
219
|
+
* Get a billing address using it's ID.
|
|
220
|
+
*
|
|
221
|
+
* @param {string} params.organizationId - Organization ID
|
|
222
|
+
* @param {string} params.billingAddressId - Unique ID of billing address
|
|
223
|
+
* @throws {AppwriteException}
|
|
224
|
+
* @returns {Promise<Models.BillingAddress>}
|
|
225
|
+
*/
|
|
226
|
+
getBillingAddress(params: {
|
|
227
|
+
organizationId: string;
|
|
228
|
+
billingAddressId: string;
|
|
229
|
+
}): Promise<Models.BillingAddress>;
|
|
230
|
+
/**
|
|
231
|
+
* Get a billing address using it's ID.
|
|
89
232
|
*
|
|
90
|
-
* @param {string} organizationId
|
|
91
|
-
* @param {string} billingAddressId
|
|
233
|
+
* @param {string} organizationId - Organization ID
|
|
234
|
+
* @param {string} billingAddressId - Unique ID of billing address
|
|
92
235
|
* @throws {AppwriteException}
|
|
93
236
|
* @returns {Promise<Models.BillingAddress>}
|
|
237
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
94
238
|
*/
|
|
95
239
|
getBillingAddress(organizationId: string, billingAddressId: string): Promise<Models.BillingAddress>;
|
|
96
240
|
/**
|
|
97
241
|
* Set the current billing email for the organization.
|
|
98
242
|
*
|
|
99
|
-
* @param {string} organizationId
|
|
100
|
-
* @param {string} billingEmail
|
|
243
|
+
* @param {string} params.organizationId - Organization ID
|
|
244
|
+
* @param {string} params.billingEmail - Billing email for the organization.
|
|
245
|
+
* @throws {AppwriteException}
|
|
246
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
247
|
+
*/
|
|
248
|
+
setBillingEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
249
|
+
organizationId: string;
|
|
250
|
+
billingEmail: string;
|
|
251
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
252
|
+
/**
|
|
253
|
+
* Set the current billing email for the organization.
|
|
254
|
+
*
|
|
255
|
+
* @param {string} organizationId - Organization ID
|
|
256
|
+
* @param {string} billingEmail - Billing email for the organization.
|
|
101
257
|
* @throws {AppwriteException}
|
|
102
258
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
259
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
103
260
|
*/
|
|
104
|
-
setBillingEmail<Preferences extends Models.Preferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences>>;
|
|
261
|
+
setBillingEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences>>;
|
|
105
262
|
/**
|
|
106
263
|
* Update the budget limit for an organization.
|
|
107
264
|
*
|
|
108
|
-
* @param {string} organizationId
|
|
109
|
-
* @param {number} budget
|
|
110
|
-
* @param {number[]} alerts
|
|
265
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
266
|
+
* @param {number} params.budget - Budget limit for additional usage set for the organization
|
|
267
|
+
* @param {number[]} params.alerts - Budget alert limit percentage
|
|
111
268
|
* @throws {AppwriteException}
|
|
112
269
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
113
270
|
*/
|
|
114
|
-
updateBudget<Preferences extends Models.Preferences>(
|
|
271
|
+
updateBudget<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
272
|
+
organizationId: string;
|
|
273
|
+
budget?: number;
|
|
274
|
+
alerts?: number[];
|
|
275
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
276
|
+
/**
|
|
277
|
+
* Update the budget limit for an organization.
|
|
278
|
+
*
|
|
279
|
+
* @param {string} organizationId - Organization Unique ID
|
|
280
|
+
* @param {number} budget - Budget limit for additional usage set for the organization
|
|
281
|
+
* @param {number[]} alerts - Budget alert limit percentage
|
|
282
|
+
* @throws {AppwriteException}
|
|
283
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
284
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
285
|
+
*/
|
|
286
|
+
updateBudget<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, budget?: number, alerts?: number[]): Promise<Models.Organization<Preferences>>;
|
|
115
287
|
/**
|
|
116
288
|
* List all credits for an organization.
|
|
117
|
-
|
|
118
289
|
*
|
|
119
|
-
*
|
|
120
|
-
* @param {string
|
|
290
|
+
*
|
|
291
|
+
* @param {string} params.organizationId - Organization ID
|
|
292
|
+
* @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, couponId, credits, expiration, status
|
|
121
293
|
* @throws {AppwriteException}
|
|
122
294
|
* @returns {Promise<Models.CreditList>}
|
|
123
295
|
*/
|
|
296
|
+
listCredits(params: {
|
|
297
|
+
organizationId: string;
|
|
298
|
+
queries?: string[];
|
|
299
|
+
}): Promise<Models.CreditList>;
|
|
300
|
+
/**
|
|
301
|
+
* List all credits for an organization.
|
|
302
|
+
*
|
|
303
|
+
*
|
|
304
|
+
* @param {string} organizationId - Organization ID
|
|
305
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, couponId, credits, expiration, status
|
|
306
|
+
* @throws {AppwriteException}
|
|
307
|
+
* @returns {Promise<Models.CreditList>}
|
|
308
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
309
|
+
*/
|
|
124
310
|
listCredits(organizationId: string, queries?: string[]): Promise<Models.CreditList>;
|
|
125
311
|
/**
|
|
126
312
|
* Add credit to an organization using a coupon.
|
|
127
313
|
*
|
|
128
|
-
* @param {string} organizationId
|
|
129
|
-
* @param {string} couponId
|
|
314
|
+
* @param {string} params.organizationId - Organization ID
|
|
315
|
+
* @param {string} params.couponId - ID of the coupon
|
|
130
316
|
* @throws {AppwriteException}
|
|
131
317
|
* @returns {Promise<Models.Credit>}
|
|
132
318
|
*/
|
|
319
|
+
addCredit(params: {
|
|
320
|
+
organizationId: string;
|
|
321
|
+
couponId: string;
|
|
322
|
+
}): Promise<Models.Credit>;
|
|
323
|
+
/**
|
|
324
|
+
* Add credit to an organization using a coupon.
|
|
325
|
+
*
|
|
326
|
+
* @param {string} organizationId - Organization ID
|
|
327
|
+
* @param {string} couponId - ID of the coupon
|
|
328
|
+
* @throws {AppwriteException}
|
|
329
|
+
* @returns {Promise<Models.Credit>}
|
|
330
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
331
|
+
*/
|
|
133
332
|
addCredit(organizationId: string, couponId: string): Promise<Models.Credit>;
|
|
333
|
+
/**
|
|
334
|
+
* Get total available valid credits for an organization.
|
|
335
|
+
*
|
|
336
|
+
* @param {string} params.organizationId - Organization ID
|
|
337
|
+
* @throws {AppwriteException}
|
|
338
|
+
* @returns {Promise<Models.CreditAvailable>}
|
|
339
|
+
*/
|
|
340
|
+
getAvailableCredits(params: {
|
|
341
|
+
organizationId: string;
|
|
342
|
+
}): Promise<Models.CreditAvailable>;
|
|
343
|
+
/**
|
|
344
|
+
* Get total available valid credits for an organization.
|
|
345
|
+
*
|
|
346
|
+
* @param {string} organizationId - Organization ID
|
|
347
|
+
* @throws {AppwriteException}
|
|
348
|
+
* @returns {Promise<Models.CreditAvailable>}
|
|
349
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
350
|
+
*/
|
|
351
|
+
getAvailableCredits(organizationId: string): Promise<Models.CreditAvailable>;
|
|
134
352
|
/**
|
|
135
353
|
* Get credit details.
|
|
136
354
|
*
|
|
137
|
-
* @param {string} organizationId
|
|
138
|
-
* @param {string} creditId
|
|
355
|
+
* @param {string} params.organizationId - Organization ID
|
|
356
|
+
* @param {string} params.creditId - Credit Unique ID
|
|
139
357
|
* @throws {AppwriteException}
|
|
140
358
|
* @returns {Promise<Models.Credit>}
|
|
141
359
|
*/
|
|
360
|
+
getCredit(params: {
|
|
361
|
+
organizationId: string;
|
|
362
|
+
creditId: string;
|
|
363
|
+
}): Promise<Models.Credit>;
|
|
364
|
+
/**
|
|
365
|
+
* Get credit details.
|
|
366
|
+
*
|
|
367
|
+
* @param {string} organizationId - Organization ID
|
|
368
|
+
* @param {string} creditId - Credit Unique ID
|
|
369
|
+
* @throws {AppwriteException}
|
|
370
|
+
* @returns {Promise<Models.Credit>}
|
|
371
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
372
|
+
*/
|
|
142
373
|
getCredit(organizationId: string, creditId: string): Promise<Models.Credit>;
|
|
143
374
|
/**
|
|
144
375
|
* Get estimation for deleting an organization.
|
|
145
376
|
*
|
|
146
|
-
* @param {string} organizationId
|
|
377
|
+
* @param {string} params.organizationId - Team ID.
|
|
378
|
+
* @throws {AppwriteException}
|
|
379
|
+
* @returns {Promise<Models.EstimationDeleteOrganization>}
|
|
380
|
+
*/
|
|
381
|
+
estimationDeleteOrganization(params: {
|
|
382
|
+
organizationId: string;
|
|
383
|
+
}): Promise<Models.EstimationDeleteOrganization>;
|
|
384
|
+
/**
|
|
385
|
+
* Get estimation for deleting an organization.
|
|
386
|
+
*
|
|
387
|
+
* @param {string} organizationId - Team ID.
|
|
147
388
|
* @throws {AppwriteException}
|
|
148
389
|
* @returns {Promise<Models.EstimationDeleteOrganization>}
|
|
390
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
149
391
|
*/
|
|
150
392
|
estimationDeleteOrganization(organizationId: string): Promise<Models.EstimationDeleteOrganization>;
|
|
151
393
|
/**
|
|
152
394
|
* Get estimation for updating the organization plan.
|
|
153
395
|
*
|
|
154
|
-
* @param {string} organizationId
|
|
155
|
-
* @param {
|
|
156
|
-
* @param {string[]} invites
|
|
157
|
-
* @param {string} couponId
|
|
396
|
+
* @param {string} params.organizationId - Organization ID
|
|
397
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
398
|
+
* @param {string[]} params.invites - Additional member invites
|
|
399
|
+
* @param {string} params.couponId - Coupon id
|
|
400
|
+
* @throws {AppwriteException}
|
|
401
|
+
* @returns {Promise<Models.EstimationUpdatePlan>}
|
|
402
|
+
*/
|
|
403
|
+
estimationUpdatePlan(params: {
|
|
404
|
+
organizationId: string;
|
|
405
|
+
billingPlan: string;
|
|
406
|
+
invites?: string[];
|
|
407
|
+
couponId?: string;
|
|
408
|
+
}): Promise<Models.EstimationUpdatePlan>;
|
|
409
|
+
/**
|
|
410
|
+
* Get estimation for updating the organization plan.
|
|
411
|
+
*
|
|
412
|
+
* @param {string} organizationId - Organization ID
|
|
413
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
414
|
+
* @param {string[]} invites - Additional member invites
|
|
415
|
+
* @param {string} couponId - Coupon id
|
|
158
416
|
* @throws {AppwriteException}
|
|
159
417
|
* @returns {Promise<Models.EstimationUpdatePlan>}
|
|
418
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
419
|
+
*/
|
|
420
|
+
estimationUpdatePlan(organizationId: string, billingPlan: string, invites?: string[], couponId?: string): Promise<Models.EstimationUpdatePlan>;
|
|
421
|
+
/**
|
|
422
|
+
* Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
|
|
423
|
+
*
|
|
424
|
+
*
|
|
425
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
426
|
+
* @param {string} params.reason - Feedback reason
|
|
427
|
+
* @param {string} params.message - Feedback message
|
|
428
|
+
* @param {string} params.fromPlanId - Plan downgrading from
|
|
429
|
+
* @param {string} params.toPlanId - Plan downgrading to
|
|
430
|
+
* @throws {AppwriteException}
|
|
431
|
+
* @returns {Promise<Models.DowngradeFeedback>}
|
|
432
|
+
*/
|
|
433
|
+
createDowngradeFeedback(params: {
|
|
434
|
+
organizationId: string;
|
|
435
|
+
reason: string;
|
|
436
|
+
message: string;
|
|
437
|
+
fromPlanId: string;
|
|
438
|
+
toPlanId: string;
|
|
439
|
+
}): Promise<Models.DowngradeFeedback>;
|
|
440
|
+
/**
|
|
441
|
+
* Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
|
|
442
|
+
*
|
|
443
|
+
*
|
|
444
|
+
* @param {string} organizationId - Organization Unique ID
|
|
445
|
+
* @param {string} reason - Feedback reason
|
|
446
|
+
* @param {string} message - Feedback message
|
|
447
|
+
* @param {string} fromPlanId - Plan downgrading from
|
|
448
|
+
* @param {string} toPlanId - Plan downgrading to
|
|
449
|
+
* @throws {AppwriteException}
|
|
450
|
+
* @returns {Promise<Models.DowngradeFeedback>}
|
|
451
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
452
|
+
*/
|
|
453
|
+
createDowngradeFeedback(organizationId: string, reason: string, message: string, fromPlanId: string, toPlanId: string): Promise<Models.DowngradeFeedback>;
|
|
454
|
+
/**
|
|
455
|
+
* List all invoices for an organization.
|
|
456
|
+
*
|
|
457
|
+
* @param {string} params.organizationId - Organization ID
|
|
458
|
+
* @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount
|
|
459
|
+
* @throws {AppwriteException}
|
|
460
|
+
* @returns {Promise<Models.InvoiceList>}
|
|
160
461
|
*/
|
|
161
|
-
|
|
462
|
+
listInvoices(params: {
|
|
463
|
+
organizationId: string;
|
|
464
|
+
queries?: string[];
|
|
465
|
+
}): Promise<Models.InvoiceList>;
|
|
162
466
|
/**
|
|
163
467
|
* List all invoices for an organization.
|
|
164
468
|
*
|
|
165
|
-
* @param {string} organizationId
|
|
166
|
-
* @param {string[]} queries
|
|
469
|
+
* @param {string} organizationId - Organization ID
|
|
470
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount
|
|
167
471
|
* @throws {AppwriteException}
|
|
168
472
|
* @returns {Promise<Models.InvoiceList>}
|
|
473
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
169
474
|
*/
|
|
170
475
|
listInvoices(organizationId: string, queries?: string[]): Promise<Models.InvoiceList>;
|
|
171
476
|
/**
|
|
172
477
|
* Get an invoice by its unique ID.
|
|
173
478
|
*
|
|
174
|
-
* @param {string} organizationId
|
|
175
|
-
* @param {string} invoiceId
|
|
479
|
+
* @param {string} params.organizationId - Organization ID
|
|
480
|
+
* @param {string} params.invoiceId - Invoice unique ID
|
|
176
481
|
* @throws {AppwriteException}
|
|
177
482
|
* @returns {Promise<Models.Invoice>}
|
|
178
483
|
*/
|
|
484
|
+
getInvoice(params: {
|
|
485
|
+
organizationId: string;
|
|
486
|
+
invoiceId: string;
|
|
487
|
+
}): Promise<Models.Invoice>;
|
|
488
|
+
/**
|
|
489
|
+
* Get an invoice by its unique ID.
|
|
490
|
+
*
|
|
491
|
+
* @param {string} organizationId - Organization ID
|
|
492
|
+
* @param {string} invoiceId - Invoice unique ID
|
|
493
|
+
* @throws {AppwriteException}
|
|
494
|
+
* @returns {Promise<Models.Invoice>}
|
|
495
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
496
|
+
*/
|
|
179
497
|
getInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice>;
|
|
180
498
|
/**
|
|
181
499
|
* Download invoice in PDF
|
|
182
500
|
*
|
|
183
|
-
* @param {string} organizationId
|
|
184
|
-
* @param {string} invoiceId
|
|
501
|
+
* @param {string} params.organizationId - Organization ID
|
|
502
|
+
* @param {string} params.invoiceId - Invoice unique ID
|
|
185
503
|
* @throws {AppwriteException}
|
|
186
504
|
* @returns {Promise<Models.PaymentMethod>}
|
|
187
505
|
*/
|
|
506
|
+
getInvoiceDownload(params: {
|
|
507
|
+
organizationId: string;
|
|
508
|
+
invoiceId: string;
|
|
509
|
+
}): Promise<Models.PaymentMethod>;
|
|
510
|
+
/**
|
|
511
|
+
* Download invoice in PDF
|
|
512
|
+
*
|
|
513
|
+
* @param {string} organizationId - Organization ID
|
|
514
|
+
* @param {string} invoiceId - Invoice unique ID
|
|
515
|
+
* @throws {AppwriteException}
|
|
516
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
517
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
518
|
+
*/
|
|
188
519
|
getInvoiceDownload(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
|
|
189
520
|
/**
|
|
190
521
|
* Initiate payment for failed invoice to pay live from console
|
|
191
522
|
*
|
|
192
|
-
* @param {string} organizationId
|
|
193
|
-
* @param {string} invoiceId
|
|
194
|
-
* @param {string} paymentMethodId
|
|
523
|
+
* @param {string} params.organizationId - Organization ID
|
|
524
|
+
* @param {string} params.invoiceId - Invoice unique ID
|
|
525
|
+
* @param {string} params.paymentMethodId - Payment method ID
|
|
526
|
+
* @throws {AppwriteException}
|
|
527
|
+
* @returns {Promise<Models.Invoice>}
|
|
528
|
+
*/
|
|
529
|
+
createInvoicePayment(params: {
|
|
530
|
+
organizationId: string;
|
|
531
|
+
invoiceId: string;
|
|
532
|
+
paymentMethodId: string;
|
|
533
|
+
}): Promise<Models.Invoice>;
|
|
534
|
+
/**
|
|
535
|
+
* Initiate payment for failed invoice to pay live from console
|
|
536
|
+
*
|
|
537
|
+
* @param {string} organizationId - Organization ID
|
|
538
|
+
* @param {string} invoiceId - Invoice unique ID
|
|
539
|
+
* @param {string} paymentMethodId - Payment method ID
|
|
195
540
|
* @throws {AppwriteException}
|
|
196
541
|
* @returns {Promise<Models.Invoice>}
|
|
542
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
197
543
|
*/
|
|
198
544
|
createInvoicePayment(organizationId: string, invoiceId: string, paymentMethodId: string): Promise<Models.Invoice>;
|
|
199
545
|
/**
|
|
200
546
|
* Validates the payment linked with the invoice and updates the invoice status if the payment status is changed.
|
|
201
547
|
*
|
|
202
|
-
* @param {string} organizationId
|
|
203
|
-
* @param {string} invoiceId
|
|
548
|
+
* @param {string} params.organizationId - Organization ID
|
|
549
|
+
* @param {string} params.invoiceId - Invoice unique ID
|
|
550
|
+
* @throws {AppwriteException}
|
|
551
|
+
* @returns {Promise<Models.Invoice>}
|
|
552
|
+
*/
|
|
553
|
+
validateInvoice(params: {
|
|
554
|
+
organizationId: string;
|
|
555
|
+
invoiceId: string;
|
|
556
|
+
}): Promise<Models.Invoice>;
|
|
557
|
+
/**
|
|
558
|
+
* Validates the payment linked with the invoice and updates the invoice status if the payment status is changed.
|
|
559
|
+
*
|
|
560
|
+
* @param {string} organizationId - Organization ID
|
|
561
|
+
* @param {string} invoiceId - Invoice unique ID
|
|
204
562
|
* @throws {AppwriteException}
|
|
205
563
|
* @returns {Promise<Models.Invoice>}
|
|
564
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
206
565
|
*/
|
|
207
566
|
validateInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice>;
|
|
208
567
|
/**
|
|
209
568
|
* View invoice in PDF
|
|
210
569
|
*
|
|
211
|
-
* @param {string} organizationId
|
|
212
|
-
* @param {string} invoiceId
|
|
570
|
+
* @param {string} params.organizationId - Organization ID
|
|
571
|
+
* @param {string} params.invoiceId - Invoice unique ID
|
|
213
572
|
* @throws {AppwriteException}
|
|
214
573
|
* @returns {Promise<Models.PaymentMethod>}
|
|
215
574
|
*/
|
|
575
|
+
getInvoiceView(params: {
|
|
576
|
+
organizationId: string;
|
|
577
|
+
invoiceId: string;
|
|
578
|
+
}): Promise<Models.PaymentMethod>;
|
|
579
|
+
/**
|
|
580
|
+
* View invoice in PDF
|
|
581
|
+
*
|
|
582
|
+
* @param {string} organizationId - Organization ID
|
|
583
|
+
* @param {string} invoiceId - Invoice unique ID
|
|
584
|
+
* @throws {AppwriteException}
|
|
585
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
586
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
587
|
+
*/
|
|
216
588
|
getInvoiceView(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
|
|
217
589
|
/**
|
|
218
|
-
* Set a organization
|
|
590
|
+
* Set a organization's default payment method.
|
|
219
591
|
*
|
|
220
|
-
* @param {string} organizationId
|
|
221
|
-
* @param {string} paymentMethodId
|
|
592
|
+
* @param {string} params.organizationId - Organization ID
|
|
593
|
+
* @param {string} params.paymentMethodId - Unique ID of payment method
|
|
222
594
|
* @throws {AppwriteException}
|
|
223
595
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
224
596
|
*/
|
|
225
|
-
setDefaultPaymentMethod<Preferences extends Models.Preferences>(
|
|
597
|
+
setDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
598
|
+
organizationId: string;
|
|
599
|
+
paymentMethodId: string;
|
|
600
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
601
|
+
/**
|
|
602
|
+
* Set a organization's default payment method.
|
|
603
|
+
*
|
|
604
|
+
* @param {string} organizationId - Organization ID
|
|
605
|
+
* @param {string} paymentMethodId - Unique ID of payment method
|
|
606
|
+
* @throws {AppwriteException}
|
|
607
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
608
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
609
|
+
*/
|
|
610
|
+
setDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
|
|
226
611
|
/**
|
|
227
612
|
* Delete the default payment method for an organization.
|
|
228
613
|
*
|
|
229
|
-
* @param {string} organizationId
|
|
614
|
+
* @param {string} params.organizationId - Organization ID
|
|
230
615
|
* @throws {AppwriteException}
|
|
231
616
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
232
617
|
*/
|
|
233
|
-
deleteDefaultPaymentMethod<Preferences extends Models.Preferences>(
|
|
618
|
+
deleteDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
619
|
+
organizationId: string;
|
|
620
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
234
621
|
/**
|
|
235
|
-
*
|
|
236
|
-
|
|
622
|
+
* Delete the default payment method for an organization.
|
|
237
623
|
*
|
|
238
|
-
* @param {string} organizationId
|
|
239
|
-
* @param {string} paymentMethodId
|
|
624
|
+
* @param {string} organizationId - Organization ID
|
|
240
625
|
* @throws {AppwriteException}
|
|
241
626
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
627
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
242
628
|
*/
|
|
243
|
-
|
|
629
|
+
deleteDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
630
|
+
/**
|
|
631
|
+
* Set an organization's backup payment method.
|
|
632
|
+
*
|
|
633
|
+
*
|
|
634
|
+
* @param {string} params.organizationId - Organization ID
|
|
635
|
+
* @param {string} params.paymentMethodId - Unique ID of payment method
|
|
636
|
+
* @throws {AppwriteException}
|
|
637
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
638
|
+
*/
|
|
639
|
+
setBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
640
|
+
organizationId: string;
|
|
641
|
+
paymentMethodId: string;
|
|
642
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
643
|
+
/**
|
|
644
|
+
* Set an organization's backup payment method.
|
|
645
|
+
*
|
|
646
|
+
*
|
|
647
|
+
* @param {string} organizationId - Organization ID
|
|
648
|
+
* @param {string} paymentMethodId - Unique ID of payment method
|
|
649
|
+
* @throws {AppwriteException}
|
|
650
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
651
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
652
|
+
*/
|
|
653
|
+
setBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
|
|
244
654
|
/**
|
|
245
655
|
* Delete a backup payment method for an organization.
|
|
246
656
|
*
|
|
247
|
-
* @param {string} organizationId
|
|
657
|
+
* @param {string} params.organizationId - Organization ID
|
|
248
658
|
* @throws {AppwriteException}
|
|
249
659
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
250
660
|
*/
|
|
251
|
-
deleteBackupPaymentMethod<Preferences extends Models.Preferences>(
|
|
661
|
+
deleteBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
662
|
+
organizationId: string;
|
|
663
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
252
664
|
/**
|
|
253
|
-
*
|
|
665
|
+
* Delete a backup payment method for an organization.
|
|
254
666
|
*
|
|
255
|
-
* @param {string} organizationId
|
|
256
|
-
* @
|
|
667
|
+
* @param {string} organizationId - Organization ID
|
|
668
|
+
* @throws {AppwriteException}
|
|
669
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
670
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
671
|
+
*/
|
|
672
|
+
deleteBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
673
|
+
/**
|
|
674
|
+
* Get an organization's payment method using it's payment method ID.
|
|
675
|
+
*
|
|
676
|
+
* @param {string} params.organizationId - Organization ID
|
|
677
|
+
* @param {string} params.paymentMethodId - Unique ID of payment method
|
|
678
|
+
* @throws {AppwriteException}
|
|
679
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
680
|
+
*/
|
|
681
|
+
getPaymentMethod(params: {
|
|
682
|
+
organizationId: string;
|
|
683
|
+
paymentMethodId: string;
|
|
684
|
+
}): Promise<Models.PaymentMethod>;
|
|
685
|
+
/**
|
|
686
|
+
* Get an organization's payment method using it's payment method ID.
|
|
687
|
+
*
|
|
688
|
+
* @param {string} organizationId - Organization ID
|
|
689
|
+
* @param {string} paymentMethodId - Unique ID of payment method
|
|
257
690
|
* @throws {AppwriteException}
|
|
258
691
|
* @returns {Promise<Models.PaymentMethod>}
|
|
692
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
259
693
|
*/
|
|
260
694
|
getPaymentMethod(organizationId: string, paymentMethodId: string): Promise<Models.PaymentMethod>;
|
|
261
695
|
/**
|
|
262
696
|
* Get the details of the current billing plan for an organization.
|
|
263
697
|
*
|
|
264
|
-
* @param {string} organizationId
|
|
698
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
265
699
|
* @throws {AppwriteException}
|
|
266
700
|
* @returns {Promise<Models.BillingPlan>}
|
|
267
701
|
*/
|
|
702
|
+
getPlan(params: {
|
|
703
|
+
organizationId: string;
|
|
704
|
+
}): Promise<Models.BillingPlan>;
|
|
705
|
+
/**
|
|
706
|
+
* Get the details of the current billing plan for an organization.
|
|
707
|
+
*
|
|
708
|
+
* @param {string} organizationId - Organization Unique ID
|
|
709
|
+
* @throws {AppwriteException}
|
|
710
|
+
* @returns {Promise<Models.BillingPlan>}
|
|
711
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
712
|
+
*/
|
|
268
713
|
getPlan(organizationId: string): Promise<Models.BillingPlan>;
|
|
269
714
|
/**
|
|
270
715
|
* Update the billing plan for an organization.
|
|
271
716
|
*
|
|
272
|
-
* @param {string} organizationId
|
|
273
|
-
* @param {
|
|
274
|
-
* @param {string} paymentMethodId
|
|
275
|
-
* @param {string} billingAddressId
|
|
276
|
-
* @param {string[]} invites
|
|
277
|
-
* @param {string} couponId
|
|
278
|
-
* @param {string} taxId
|
|
279
|
-
* @param {number} budget
|
|
717
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
718
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
719
|
+
* @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
720
|
+
* @param {string} params.billingAddressId - Unique ID of billing address
|
|
721
|
+
* @param {string[]} params.invites - Additional member invites
|
|
722
|
+
* @param {string} params.couponId - Coupon id
|
|
723
|
+
* @param {string} params.taxId - Tax Id associated to billing.
|
|
724
|
+
* @param {number} params.budget - Budget limit for additional usage set for the organization
|
|
280
725
|
* @throws {AppwriteException}
|
|
281
726
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
282
727
|
*/
|
|
283
|
-
updatePlan<Preferences extends Models.Preferences>(
|
|
728
|
+
updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
729
|
+
organizationId: string;
|
|
730
|
+
billingPlan: string;
|
|
731
|
+
paymentMethodId?: string;
|
|
732
|
+
billingAddressId?: string;
|
|
733
|
+
invites?: string[];
|
|
734
|
+
couponId?: string;
|
|
735
|
+
taxId?: string;
|
|
736
|
+
budget?: number;
|
|
737
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
738
|
+
/**
|
|
739
|
+
* Update the billing plan for an organization.
|
|
740
|
+
*
|
|
741
|
+
* @param {string} organizationId - Organization Unique ID
|
|
742
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
743
|
+
* @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
744
|
+
* @param {string} billingAddressId - Unique ID of billing address
|
|
745
|
+
* @param {string[]} invites - Additional member invites
|
|
746
|
+
* @param {string} couponId - Coupon id
|
|
747
|
+
* @param {string} taxId - Tax Id associated to billing.
|
|
748
|
+
* @param {number} budget - Budget limit for additional usage set for the organization
|
|
749
|
+
* @throws {AppwriteException}
|
|
750
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
751
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
752
|
+
*/
|
|
753
|
+
updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
|
|
754
|
+
/**
|
|
755
|
+
* Cancel the downgrade initiated for an organization.
|
|
756
|
+
*
|
|
757
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
758
|
+
* @throws {AppwriteException}
|
|
759
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
760
|
+
*/
|
|
761
|
+
cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
762
|
+
organizationId: string;
|
|
763
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
284
764
|
/**
|
|
285
765
|
* Cancel the downgrade initiated for an organization.
|
|
286
766
|
*
|
|
287
|
-
* @param {string} organizationId
|
|
767
|
+
* @param {string} organizationId - Organization Unique ID
|
|
768
|
+
* @throws {AppwriteException}
|
|
769
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
770
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
771
|
+
*/
|
|
772
|
+
cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
773
|
+
/**
|
|
774
|
+
* Update selected projects to keep in the organization.
|
|
775
|
+
*
|
|
776
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
777
|
+
* @param {string[]} params.projects - List of project IDs to be selected for the organization
|
|
288
778
|
* @throws {AppwriteException}
|
|
289
779
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
290
780
|
*/
|
|
291
|
-
|
|
781
|
+
updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
782
|
+
organizationId: string;
|
|
783
|
+
projects?: string[];
|
|
784
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
785
|
+
/**
|
|
786
|
+
* Update selected projects to keep in the organization.
|
|
787
|
+
*
|
|
788
|
+
* @param {string} organizationId - Organization Unique ID
|
|
789
|
+
* @param {string[]} projects - List of project IDs to be selected for the organization
|
|
790
|
+
* @throws {AppwriteException}
|
|
791
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
792
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
793
|
+
*/
|
|
794
|
+
updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, projects?: string[]): Promise<Models.Organization<Preferences>>;
|
|
795
|
+
/**
|
|
796
|
+
* Get Scopes
|
|
797
|
+
*
|
|
798
|
+
* @param {string} params.organizationId - Organization id
|
|
799
|
+
* @throws {AppwriteException}
|
|
800
|
+
* @returns {Promise<Models.Roles>}
|
|
801
|
+
*/
|
|
802
|
+
getScopes(params: {
|
|
803
|
+
organizationId: string;
|
|
804
|
+
}): Promise<Models.Roles>;
|
|
292
805
|
/**
|
|
293
806
|
* Get Scopes
|
|
294
807
|
*
|
|
295
|
-
* @param {string} organizationId
|
|
808
|
+
* @param {string} organizationId - Organization id
|
|
296
809
|
* @throws {AppwriteException}
|
|
297
810
|
* @returns {Promise<Models.Roles>}
|
|
811
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
298
812
|
*/
|
|
299
813
|
getScopes(organizationId: string): Promise<Models.Roles>;
|
|
300
814
|
/**
|
|
301
|
-
* Set an organization
|
|
815
|
+
* Set an organization's billing tax ID.
|
|
816
|
+
*
|
|
817
|
+
* @param {string} params.organizationId - Organization ID
|
|
818
|
+
* @param {string} params.taxId - Tax Id associated to billing.
|
|
819
|
+
* @throws {AppwriteException}
|
|
820
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
821
|
+
*/
|
|
822
|
+
setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
823
|
+
organizationId: string;
|
|
824
|
+
taxId: string;
|
|
825
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
826
|
+
/**
|
|
827
|
+
* Set an organization's billing tax ID.
|
|
302
828
|
*
|
|
303
|
-
* @param {string} organizationId
|
|
304
|
-
* @param {string} taxId
|
|
829
|
+
* @param {string} organizationId - Organization ID
|
|
830
|
+
* @param {string} taxId - Tax Id associated to billing.
|
|
305
831
|
* @throws {AppwriteException}
|
|
306
832
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
833
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
834
|
+
*/
|
|
835
|
+
setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>>;
|
|
836
|
+
/**
|
|
837
|
+
* Get the usage data for an organization.
|
|
838
|
+
*
|
|
839
|
+
* @param {string} params.organizationId - Organization ID
|
|
840
|
+
* @param {string} params.startDate - Starting date for the usage
|
|
841
|
+
* @param {string} params.endDate - End date for the usage
|
|
842
|
+
* @throws {AppwriteException}
|
|
843
|
+
* @returns {Promise<Models.UsageOrganization>}
|
|
307
844
|
*/
|
|
308
|
-
|
|
845
|
+
getUsage(params: {
|
|
846
|
+
organizationId: string;
|
|
847
|
+
startDate?: string;
|
|
848
|
+
endDate?: string;
|
|
849
|
+
}): Promise<Models.UsageOrganization>;
|
|
309
850
|
/**
|
|
310
851
|
* Get the usage data for an organization.
|
|
311
852
|
*
|
|
312
|
-
* @param {string} organizationId
|
|
313
|
-
* @param {string} startDate
|
|
314
|
-
* @param {string} endDate
|
|
853
|
+
* @param {string} organizationId - Organization ID
|
|
854
|
+
* @param {string} startDate - Starting date for the usage
|
|
855
|
+
* @param {string} endDate - End date for the usage
|
|
315
856
|
* @throws {AppwriteException}
|
|
316
857
|
* @returns {Promise<Models.UsageOrganization>}
|
|
858
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
317
859
|
*/
|
|
318
860
|
getUsage(organizationId: string, startDate?: string, endDate?: string): Promise<Models.UsageOrganization>;
|
|
319
861
|
/**
|
|
320
862
|
* Validate payment for team after creation or upgrade.
|
|
321
863
|
*
|
|
322
|
-
* @param {string} organizationId
|
|
323
|
-
* @param {string[]} invites
|
|
864
|
+
* @param {string} params.organizationId - Organization ID
|
|
865
|
+
* @param {string[]} params.invites - Additional member invites
|
|
866
|
+
* @throws {AppwriteException}
|
|
867
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
868
|
+
*/
|
|
869
|
+
validatePayment<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
870
|
+
organizationId: string;
|
|
871
|
+
invites?: string[];
|
|
872
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
873
|
+
/**
|
|
874
|
+
* Validate payment for team after creation or upgrade.
|
|
875
|
+
*
|
|
876
|
+
* @param {string} organizationId - Organization ID
|
|
877
|
+
* @param {string[]} invites - Additional member invites
|
|
324
878
|
* @throws {AppwriteException}
|
|
325
879
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
880
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
326
881
|
*/
|
|
327
|
-
validatePayment<Preferences extends Models.Preferences>(organizationId: string, invites?: string[]): Promise<Models.Organization<Preferences>>;
|
|
882
|
+
validatePayment<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, invites?: string[]): Promise<Models.Organization<Preferences>>;
|
|
328
883
|
}
|