@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,7 +1,8 @@
|
|
|
1
1
|
import { Service } from '../service';
|
|
2
2
|
import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
|
|
3
3
|
import type { Models } from '../models';
|
|
4
|
-
|
|
4
|
+
|
|
5
|
+
import { Platform } from '../enums/platform';
|
|
5
6
|
|
|
6
7
|
export class Organizations {
|
|
7
8
|
client: Client;
|
|
@@ -13,12 +14,41 @@ export class Organizations {
|
|
|
13
14
|
/**
|
|
14
15
|
* Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
|
|
15
16
|
*
|
|
16
|
-
* @param {string[]} queries
|
|
17
|
-
* @param {string} search
|
|
17
|
+
* @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
|
|
18
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
19
|
+
* @throws {AppwriteException}
|
|
20
|
+
* @returns {Promise<Models.OrganizationList<Preferences>>}
|
|
21
|
+
*/
|
|
22
|
+
list<Preferences extends Models.Preferences = Models.DefaultPreferences>(params?: { queries?: string[], search?: string }): Promise<Models.OrganizationList<Preferences>>;
|
|
23
|
+
/**
|
|
24
|
+
* Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
|
|
25
|
+
*
|
|
26
|
+
* @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
|
|
27
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
18
28
|
* @throws {AppwriteException}
|
|
19
29
|
* @returns {Promise<Models.OrganizationList<Preferences>>}
|
|
30
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
20
31
|
*/
|
|
21
|
-
list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.OrganizationList<Preferences
|
|
32
|
+
list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.OrganizationList<Preferences>>;
|
|
33
|
+
list<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
34
|
+
paramsOrFirst?: { queries?: string[], search?: string } | string[],
|
|
35
|
+
...rest: [(string)?]
|
|
36
|
+
): Promise<Models.OrganizationList<Preferences>> {
|
|
37
|
+
let params: { queries?: string[], search?: string };
|
|
38
|
+
|
|
39
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
40
|
+
params = (paramsOrFirst || {}) as { queries?: string[], search?: string };
|
|
41
|
+
} else {
|
|
42
|
+
params = {
|
|
43
|
+
queries: paramsOrFirst as string[],
|
|
44
|
+
search: rest[0] as string
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
const queries = params.queries;
|
|
49
|
+
const search = params.search;
|
|
50
|
+
|
|
51
|
+
|
|
22
52
|
const apiPath = '/organizations';
|
|
23
53
|
const payload: Payload = {};
|
|
24
54
|
if (typeof queries !== 'undefined') {
|
|
@@ -39,23 +69,78 @@ export class Organizations {
|
|
|
39
69
|
payload
|
|
40
70
|
);
|
|
41
71
|
}
|
|
72
|
+
|
|
42
73
|
/**
|
|
43
74
|
* Create a new organization.
|
|
44
|
-
|
|
75
|
+
*
|
|
45
76
|
*
|
|
46
|
-
* @param {string} organizationId
|
|
47
|
-
* @param {string} name
|
|
48
|
-
* @param {
|
|
49
|
-
* @param {string} paymentMethodId
|
|
50
|
-
* @param {string} billingAddressId
|
|
51
|
-
* @param {string[]} invites
|
|
52
|
-
* @param {string} couponId
|
|
53
|
-
* @param {string} taxId
|
|
54
|
-
* @param {number} budget
|
|
77
|
+
* @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.
|
|
78
|
+
* @param {string} params.name - Organization name. Max length: 128 chars.
|
|
79
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
80
|
+
* @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.
|
|
81
|
+
* @param {string} params.billingAddressId - Unique ID of billing address
|
|
82
|
+
* @param {string[]} params.invites - Additional member invites
|
|
83
|
+
* @param {string} params.couponId - Coupon id
|
|
84
|
+
* @param {string} params.taxId - Tax Id associated to billing.
|
|
85
|
+
* @param {number} params.budget - Budget limit for additional usage set for the organization
|
|
86
|
+
* @param {Platform} params.platform - Platform type
|
|
55
87
|
* @throws {AppwriteException}
|
|
56
|
-
* @returns {Promise<Models.Organization<Preferences
|
|
88
|
+
* @returns {Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>}
|
|
57
89
|
*/
|
|
58
|
-
create<Preferences extends Models.Preferences>(organizationId: string, name: string, billingPlan:
|
|
90
|
+
create<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { 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>;
|
|
91
|
+
/**
|
|
92
|
+
* Create a new organization.
|
|
93
|
+
*
|
|
94
|
+
*
|
|
95
|
+
* @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.
|
|
96
|
+
* @param {string} name - Organization name. Max length: 128 chars.
|
|
97
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
98
|
+
* @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
99
|
+
* @param {string} billingAddressId - Unique ID of billing address
|
|
100
|
+
* @param {string[]} invites - Additional member invites
|
|
101
|
+
* @param {string} couponId - Coupon id
|
|
102
|
+
* @param {string} taxId - Tax Id associated to billing.
|
|
103
|
+
* @param {number} budget - Budget limit for additional usage set for the organization
|
|
104
|
+
* @param {Platform} platform - Platform type
|
|
105
|
+
* @throws {AppwriteException}
|
|
106
|
+
* @returns {Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>}
|
|
107
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
108
|
+
*/
|
|
109
|
+
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>;
|
|
110
|
+
create<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
111
|
+
paramsOrFirst: { organizationId: string, name: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number, platform?: Platform } | string,
|
|
112
|
+
...rest: [(string)?, (string)?, (string)?, (string)?, (string[])?, (string)?, (string)?, (number)?, (Platform)?]
|
|
113
|
+
): Promise<Models.Organization<Preferences> | Models.PaymentAuthentication> {
|
|
114
|
+
let params: { organizationId: string, name: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number, platform?: Platform };
|
|
115
|
+
|
|
116
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
117
|
+
params = (paramsOrFirst || {}) as { organizationId: string, name: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number, platform?: Platform };
|
|
118
|
+
} else {
|
|
119
|
+
params = {
|
|
120
|
+
organizationId: paramsOrFirst as string,
|
|
121
|
+
name: rest[0] as string,
|
|
122
|
+
billingPlan: rest[1] as string,
|
|
123
|
+
paymentMethodId: rest[2] as string,
|
|
124
|
+
billingAddressId: rest[3] as string,
|
|
125
|
+
invites: rest[4] as string[],
|
|
126
|
+
couponId: rest[5] as string,
|
|
127
|
+
taxId: rest[6] as string,
|
|
128
|
+
budget: rest[7] as number,
|
|
129
|
+
platform: rest[8] as Platform
|
|
130
|
+
};
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
const organizationId = params.organizationId;
|
|
134
|
+
const name = params.name;
|
|
135
|
+
const billingPlan = params.billingPlan;
|
|
136
|
+
const paymentMethodId = params.paymentMethodId;
|
|
137
|
+
const billingAddressId = params.billingAddressId;
|
|
138
|
+
const invites = params.invites;
|
|
139
|
+
const couponId = params.couponId;
|
|
140
|
+
const taxId = params.taxId;
|
|
141
|
+
const budget = params.budget;
|
|
142
|
+
const platform = params.platform;
|
|
143
|
+
|
|
59
144
|
if (typeof organizationId === 'undefined') {
|
|
60
145
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
61
146
|
}
|
|
@@ -65,6 +150,7 @@ export class Organizations {
|
|
|
65
150
|
if (typeof billingPlan === 'undefined') {
|
|
66
151
|
throw new AppwriteException('Missing required parameter: "billingPlan"');
|
|
67
152
|
}
|
|
153
|
+
|
|
68
154
|
const apiPath = '/organizations';
|
|
69
155
|
const payload: Payload = {};
|
|
70
156
|
if (typeof organizationId !== 'undefined') {
|
|
@@ -94,6 +180,9 @@ export class Organizations {
|
|
|
94
180
|
if (typeof budget !== 'undefined') {
|
|
95
181
|
payload['budget'] = budget;
|
|
96
182
|
}
|
|
183
|
+
if (typeof platform !== 'undefined') {
|
|
184
|
+
payload['platform'] = platform;
|
|
185
|
+
}
|
|
97
186
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
98
187
|
|
|
99
188
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -107,20 +196,60 @@ export class Organizations {
|
|
|
107
196
|
payload
|
|
108
197
|
);
|
|
109
198
|
}
|
|
199
|
+
|
|
200
|
+
/**
|
|
201
|
+
* Get estimation for creating an organization.
|
|
202
|
+
*
|
|
203
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
204
|
+
* @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.
|
|
205
|
+
* @param {string[]} params.invites - Additional member invites
|
|
206
|
+
* @param {string} params.couponId - Coupon id
|
|
207
|
+
* @param {Platform} params.platform - Platform type
|
|
208
|
+
* @throws {AppwriteException}
|
|
209
|
+
* @returns {Promise<Models.Estimation>}
|
|
210
|
+
*/
|
|
211
|
+
estimationCreateOrganization(params: { billingPlan: string, paymentMethodId?: string, invites?: string[], couponId?: string, platform?: Platform }): Promise<Models.Estimation>;
|
|
110
212
|
/**
|
|
111
213
|
* Get estimation for creating an organization.
|
|
112
214
|
*
|
|
113
|
-
* @param {
|
|
114
|
-
* @param {string} paymentMethodId
|
|
115
|
-
* @param {string[]} invites
|
|
116
|
-
* @param {string} couponId
|
|
215
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
216
|
+
* @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
217
|
+
* @param {string[]} invites - Additional member invites
|
|
218
|
+
* @param {string} couponId - Coupon id
|
|
219
|
+
* @param {Platform} platform - Platform type
|
|
117
220
|
* @throws {AppwriteException}
|
|
118
221
|
* @returns {Promise<Models.Estimation>}
|
|
222
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
119
223
|
*/
|
|
120
|
-
estimationCreateOrganization(billingPlan:
|
|
224
|
+
estimationCreateOrganization(billingPlan: string, paymentMethodId?: string, invites?: string[], couponId?: string, platform?: Platform): Promise<Models.Estimation>;
|
|
225
|
+
estimationCreateOrganization(
|
|
226
|
+
paramsOrFirst: { billingPlan: string, paymentMethodId?: string, invites?: string[], couponId?: string, platform?: Platform } | string,
|
|
227
|
+
...rest: [(string)?, (string[])?, (string)?, (Platform)?]
|
|
228
|
+
): Promise<Models.Estimation> {
|
|
229
|
+
let params: { billingPlan: string, paymentMethodId?: string, invites?: string[], couponId?: string, platform?: Platform };
|
|
230
|
+
|
|
231
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
232
|
+
params = (paramsOrFirst || {}) as { billingPlan: string, paymentMethodId?: string, invites?: string[], couponId?: string, platform?: Platform };
|
|
233
|
+
} else {
|
|
234
|
+
params = {
|
|
235
|
+
billingPlan: paramsOrFirst as string,
|
|
236
|
+
paymentMethodId: rest[0] as string,
|
|
237
|
+
invites: rest[1] as string[],
|
|
238
|
+
couponId: rest[2] as string,
|
|
239
|
+
platform: rest[3] as Platform
|
|
240
|
+
};
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
const billingPlan = params.billingPlan;
|
|
244
|
+
const paymentMethodId = params.paymentMethodId;
|
|
245
|
+
const invites = params.invites;
|
|
246
|
+
const couponId = params.couponId;
|
|
247
|
+
const platform = params.platform;
|
|
248
|
+
|
|
121
249
|
if (typeof billingPlan === 'undefined') {
|
|
122
250
|
throw new AppwriteException('Missing required parameter: "billingPlan"');
|
|
123
251
|
}
|
|
252
|
+
|
|
124
253
|
const apiPath = '/organizations/estimations/create-organization';
|
|
125
254
|
const payload: Payload = {};
|
|
126
255
|
if (typeof billingPlan !== 'undefined') {
|
|
@@ -135,6 +264,9 @@ export class Organizations {
|
|
|
135
264
|
if (typeof couponId !== 'undefined') {
|
|
136
265
|
payload['couponId'] = couponId;
|
|
137
266
|
}
|
|
267
|
+
if (typeof platform !== 'undefined') {
|
|
268
|
+
payload['platform'] = platform;
|
|
269
|
+
}
|
|
138
270
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
139
271
|
|
|
140
272
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -148,17 +280,43 @@ export class Organizations {
|
|
|
148
280
|
payload
|
|
149
281
|
);
|
|
150
282
|
}
|
|
283
|
+
|
|
151
284
|
/**
|
|
152
285
|
* Delete an organization.
|
|
153
286
|
*
|
|
154
|
-
* @param {string} organizationId
|
|
287
|
+
* @param {string} params.organizationId - Team ID.
|
|
155
288
|
* @throws {AppwriteException}
|
|
156
289
|
* @returns {Promise<{}>}
|
|
157
290
|
*/
|
|
158
|
-
delete(organizationId: string): Promise<{}
|
|
291
|
+
delete(params: { organizationId: string }): Promise<{}>;
|
|
292
|
+
/**
|
|
293
|
+
* Delete an organization.
|
|
294
|
+
*
|
|
295
|
+
* @param {string} organizationId - Team ID.
|
|
296
|
+
* @throws {AppwriteException}
|
|
297
|
+
* @returns {Promise<{}>}
|
|
298
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
299
|
+
*/
|
|
300
|
+
delete(organizationId: string): Promise<{}>;
|
|
301
|
+
delete(
|
|
302
|
+
paramsOrFirst: { organizationId: string } | string
|
|
303
|
+
): Promise<{}> {
|
|
304
|
+
let params: { organizationId: string };
|
|
305
|
+
|
|
306
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
307
|
+
params = (paramsOrFirst || {}) as { organizationId: string };
|
|
308
|
+
} else {
|
|
309
|
+
params = {
|
|
310
|
+
organizationId: paramsOrFirst as string
|
|
311
|
+
};
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
const organizationId = params.organizationId;
|
|
315
|
+
|
|
159
316
|
if (typeof organizationId === 'undefined') {
|
|
160
317
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
161
318
|
}
|
|
319
|
+
|
|
162
320
|
const apiPath = '/organizations/{organizationId}'.replace('{organizationId}', organizationId);
|
|
163
321
|
const payload: Payload = {};
|
|
164
322
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -174,18 +332,48 @@ export class Organizations {
|
|
|
174
332
|
payload
|
|
175
333
|
);
|
|
176
334
|
}
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* Get a list of all aggregations for an organization.
|
|
338
|
+
*
|
|
339
|
+
* @param {string} params.organizationId - Organization ID
|
|
340
|
+
* @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
|
|
341
|
+
* @throws {AppwriteException}
|
|
342
|
+
* @returns {Promise<Models.AggregationTeamList>}
|
|
343
|
+
*/
|
|
344
|
+
listAggregations(params: { organizationId: string, queries?: string[] }): Promise<Models.AggregationTeamList>;
|
|
177
345
|
/**
|
|
178
346
|
* Get a list of all aggregations for an organization.
|
|
179
347
|
*
|
|
180
|
-
* @param {string} organizationId
|
|
181
|
-
* @param {string[]} queries
|
|
348
|
+
* @param {string} organizationId - Organization ID
|
|
349
|
+
* @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
|
|
182
350
|
* @throws {AppwriteException}
|
|
183
351
|
* @returns {Promise<Models.AggregationTeamList>}
|
|
352
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
184
353
|
*/
|
|
185
|
-
listAggregations(organizationId: string, queries?: string[]): Promise<Models.AggregationTeamList
|
|
354
|
+
listAggregations(organizationId: string, queries?: string[]): Promise<Models.AggregationTeamList>;
|
|
355
|
+
listAggregations(
|
|
356
|
+
paramsOrFirst: { organizationId: string, queries?: string[] } | string,
|
|
357
|
+
...rest: [(string[])?]
|
|
358
|
+
): Promise<Models.AggregationTeamList> {
|
|
359
|
+
let params: { organizationId: string, queries?: string[] };
|
|
360
|
+
|
|
361
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
362
|
+
params = (paramsOrFirst || {}) as { organizationId: string, queries?: string[] };
|
|
363
|
+
} else {
|
|
364
|
+
params = {
|
|
365
|
+
organizationId: paramsOrFirst as string,
|
|
366
|
+
queries: rest[0] as string[]
|
|
367
|
+
};
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
const organizationId = params.organizationId;
|
|
371
|
+
const queries = params.queries;
|
|
372
|
+
|
|
186
373
|
if (typeof organizationId === 'undefined') {
|
|
187
374
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
188
375
|
}
|
|
376
|
+
|
|
189
377
|
const apiPath = '/organizations/{organizationId}/aggregations'.replace('{organizationId}', organizationId);
|
|
190
378
|
const payload: Payload = {};
|
|
191
379
|
if (typeof queries !== 'undefined') {
|
|
@@ -203,23 +391,67 @@ export class Organizations {
|
|
|
203
391
|
payload
|
|
204
392
|
);
|
|
205
393
|
}
|
|
394
|
+
|
|
395
|
+
/**
|
|
396
|
+
* Get a specific aggregation using it's aggregation ID.
|
|
397
|
+
*
|
|
398
|
+
* @param {string} params.organizationId - Organization ID
|
|
399
|
+
* @param {string} params.aggregationId - Invoice unique ID
|
|
400
|
+
* @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.
|
|
401
|
+
* @param {number} params.offset - Offset value. The default value is 0. Use this param to manage pagination.
|
|
402
|
+
* @throws {AppwriteException}
|
|
403
|
+
* @returns {Promise<Models.AggregationTeam>}
|
|
404
|
+
*/
|
|
405
|
+
getAggregation(params: { organizationId: string, aggregationId: string, limit?: number, offset?: number }): Promise<Models.AggregationTeam>;
|
|
206
406
|
/**
|
|
207
|
-
* Get a specific aggregation using it
|
|
407
|
+
* Get a specific aggregation using it's aggregation ID.
|
|
208
408
|
*
|
|
209
|
-
* @param {string} organizationId
|
|
210
|
-
* @param {string} aggregationId
|
|
409
|
+
* @param {string} organizationId - Organization ID
|
|
410
|
+
* @param {string} aggregationId - Invoice unique ID
|
|
411
|
+
* @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.
|
|
412
|
+
* @param {number} offset - Offset value. The default value is 0. Use this param to manage pagination.
|
|
211
413
|
* @throws {AppwriteException}
|
|
212
414
|
* @returns {Promise<Models.AggregationTeam>}
|
|
415
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
213
416
|
*/
|
|
214
|
-
getAggregation(organizationId: string, aggregationId: string): Promise<Models.AggregationTeam
|
|
417
|
+
getAggregation(organizationId: string, aggregationId: string, limit?: number, offset?: number): Promise<Models.AggregationTeam>;
|
|
418
|
+
getAggregation(
|
|
419
|
+
paramsOrFirst: { organizationId: string, aggregationId: string, limit?: number, offset?: number } | string,
|
|
420
|
+
...rest: [(string)?, (number)?, (number)?]
|
|
421
|
+
): Promise<Models.AggregationTeam> {
|
|
422
|
+
let params: { organizationId: string, aggregationId: string, limit?: number, offset?: number };
|
|
423
|
+
|
|
424
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
425
|
+
params = (paramsOrFirst || {}) as { organizationId: string, aggregationId: string, limit?: number, offset?: number };
|
|
426
|
+
} else {
|
|
427
|
+
params = {
|
|
428
|
+
organizationId: paramsOrFirst as string,
|
|
429
|
+
aggregationId: rest[0] as string,
|
|
430
|
+
limit: rest[1] as number,
|
|
431
|
+
offset: rest[2] as number
|
|
432
|
+
};
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
const organizationId = params.organizationId;
|
|
436
|
+
const aggregationId = params.aggregationId;
|
|
437
|
+
const limit = params.limit;
|
|
438
|
+
const offset = params.offset;
|
|
439
|
+
|
|
215
440
|
if (typeof organizationId === 'undefined') {
|
|
216
441
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
217
442
|
}
|
|
218
443
|
if (typeof aggregationId === 'undefined') {
|
|
219
444
|
throw new AppwriteException('Missing required parameter: "aggregationId"');
|
|
220
445
|
}
|
|
446
|
+
|
|
221
447
|
const apiPath = '/organizations/{organizationId}/aggregations/{aggregationId}'.replace('{organizationId}', organizationId).replace('{aggregationId}', aggregationId);
|
|
222
448
|
const payload: Payload = {};
|
|
449
|
+
if (typeof limit !== 'undefined') {
|
|
450
|
+
payload['limit'] = limit;
|
|
451
|
+
}
|
|
452
|
+
if (typeof offset !== 'undefined') {
|
|
453
|
+
payload['offset'] = offset;
|
|
454
|
+
}
|
|
223
455
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
224
456
|
|
|
225
457
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -232,21 +464,51 @@ export class Organizations {
|
|
|
232
464
|
payload
|
|
233
465
|
);
|
|
234
466
|
}
|
|
467
|
+
|
|
235
468
|
/**
|
|
236
469
|
* Set a billing address for an organization.
|
|
237
470
|
*
|
|
238
|
-
* @param {string} organizationId
|
|
239
|
-
* @param {string} billingAddressId
|
|
471
|
+
* @param {string} params.organizationId - Organization ID
|
|
472
|
+
* @param {string} params.billingAddressId - Unique ID of billing address
|
|
240
473
|
* @throws {AppwriteException}
|
|
241
474
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
242
475
|
*/
|
|
243
|
-
setBillingAddress<Preferences extends Models.Preferences>(organizationId: string, billingAddressId: string): Promise<Models.Organization<Preferences
|
|
476
|
+
setBillingAddress<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string, billingAddressId: string }): Promise<Models.Organization<Preferences>>;
|
|
477
|
+
/**
|
|
478
|
+
* Set a billing address for an organization.
|
|
479
|
+
*
|
|
480
|
+
* @param {string} organizationId - Organization ID
|
|
481
|
+
* @param {string} billingAddressId - Unique ID of billing address
|
|
482
|
+
* @throws {AppwriteException}
|
|
483
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
484
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
485
|
+
*/
|
|
486
|
+
setBillingAddress<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingAddressId: string): Promise<Models.Organization<Preferences>>;
|
|
487
|
+
setBillingAddress<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
488
|
+
paramsOrFirst: { organizationId: string, billingAddressId: string } | string,
|
|
489
|
+
...rest: [(string)?]
|
|
490
|
+
): Promise<Models.Organization<Preferences>> {
|
|
491
|
+
let params: { organizationId: string, billingAddressId: string };
|
|
492
|
+
|
|
493
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
494
|
+
params = (paramsOrFirst || {}) as { organizationId: string, billingAddressId: string };
|
|
495
|
+
} else {
|
|
496
|
+
params = {
|
|
497
|
+
organizationId: paramsOrFirst as string,
|
|
498
|
+
billingAddressId: rest[0] as string
|
|
499
|
+
};
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
const organizationId = params.organizationId;
|
|
503
|
+
const billingAddressId = params.billingAddressId;
|
|
504
|
+
|
|
244
505
|
if (typeof organizationId === 'undefined') {
|
|
245
506
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
246
507
|
}
|
|
247
508
|
if (typeof billingAddressId === 'undefined') {
|
|
248
509
|
throw new AppwriteException('Missing required parameter: "billingAddressId"');
|
|
249
510
|
}
|
|
511
|
+
|
|
250
512
|
const apiPath = '/organizations/{organizationId}/billing-address'.replace('{organizationId}', organizationId);
|
|
251
513
|
const payload: Payload = {};
|
|
252
514
|
if (typeof billingAddressId !== 'undefined') {
|
|
@@ -265,17 +527,43 @@ export class Organizations {
|
|
|
265
527
|
payload
|
|
266
528
|
);
|
|
267
529
|
}
|
|
530
|
+
|
|
531
|
+
/**
|
|
532
|
+
* Delete a team's billing address.
|
|
533
|
+
*
|
|
534
|
+
* @param {string} params.organizationId - Organization ID
|
|
535
|
+
* @throws {AppwriteException}
|
|
536
|
+
* @returns {Promise<{}>}
|
|
537
|
+
*/
|
|
538
|
+
deleteBillingAddress(params: { organizationId: string }): Promise<{}>;
|
|
268
539
|
/**
|
|
269
|
-
* Delete a team
|
|
540
|
+
* Delete a team's billing address.
|
|
270
541
|
*
|
|
271
|
-
* @param {string} organizationId
|
|
542
|
+
* @param {string} organizationId - Organization ID
|
|
272
543
|
* @throws {AppwriteException}
|
|
273
544
|
* @returns {Promise<{}>}
|
|
545
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
274
546
|
*/
|
|
275
|
-
deleteBillingAddress(organizationId: string): Promise<{}
|
|
547
|
+
deleteBillingAddress(organizationId: string): Promise<{}>;
|
|
548
|
+
deleteBillingAddress(
|
|
549
|
+
paramsOrFirst: { organizationId: string } | string
|
|
550
|
+
): Promise<{}> {
|
|
551
|
+
let params: { organizationId: string };
|
|
552
|
+
|
|
553
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
554
|
+
params = (paramsOrFirst || {}) as { organizationId: string };
|
|
555
|
+
} else {
|
|
556
|
+
params = {
|
|
557
|
+
organizationId: paramsOrFirst as string
|
|
558
|
+
};
|
|
559
|
+
}
|
|
560
|
+
|
|
561
|
+
const organizationId = params.organizationId;
|
|
562
|
+
|
|
276
563
|
if (typeof organizationId === 'undefined') {
|
|
277
564
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
278
565
|
}
|
|
566
|
+
|
|
279
567
|
const apiPath = '/organizations/{organizationId}/billing-address'.replace('{organizationId}', organizationId);
|
|
280
568
|
const payload: Payload = {};
|
|
281
569
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -291,21 +579,51 @@ export class Organizations {
|
|
|
291
579
|
payload
|
|
292
580
|
);
|
|
293
581
|
}
|
|
582
|
+
|
|
294
583
|
/**
|
|
295
|
-
* Get a billing address using it
|
|
584
|
+
* Get a billing address using it's ID.
|
|
296
585
|
*
|
|
297
|
-
* @param {string} organizationId
|
|
298
|
-
* @param {string} billingAddressId
|
|
586
|
+
* @param {string} params.organizationId - Organization ID
|
|
587
|
+
* @param {string} params.billingAddressId - Unique ID of billing address
|
|
299
588
|
* @throws {AppwriteException}
|
|
300
589
|
* @returns {Promise<Models.BillingAddress>}
|
|
301
590
|
*/
|
|
302
|
-
getBillingAddress(organizationId: string, billingAddressId: string): Promise<Models.BillingAddress
|
|
591
|
+
getBillingAddress(params: { organizationId: string, billingAddressId: string }): Promise<Models.BillingAddress>;
|
|
592
|
+
/**
|
|
593
|
+
* Get a billing address using it's ID.
|
|
594
|
+
*
|
|
595
|
+
* @param {string} organizationId - Organization ID
|
|
596
|
+
* @param {string} billingAddressId - Unique ID of billing address
|
|
597
|
+
* @throws {AppwriteException}
|
|
598
|
+
* @returns {Promise<Models.BillingAddress>}
|
|
599
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
600
|
+
*/
|
|
601
|
+
getBillingAddress(organizationId: string, billingAddressId: string): Promise<Models.BillingAddress>;
|
|
602
|
+
getBillingAddress(
|
|
603
|
+
paramsOrFirst: { organizationId: string, billingAddressId: string } | string,
|
|
604
|
+
...rest: [(string)?]
|
|
605
|
+
): Promise<Models.BillingAddress> {
|
|
606
|
+
let params: { organizationId: string, billingAddressId: string };
|
|
607
|
+
|
|
608
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
609
|
+
params = (paramsOrFirst || {}) as { organizationId: string, billingAddressId: string };
|
|
610
|
+
} else {
|
|
611
|
+
params = {
|
|
612
|
+
organizationId: paramsOrFirst as string,
|
|
613
|
+
billingAddressId: rest[0] as string
|
|
614
|
+
};
|
|
615
|
+
}
|
|
616
|
+
|
|
617
|
+
const organizationId = params.organizationId;
|
|
618
|
+
const billingAddressId = params.billingAddressId;
|
|
619
|
+
|
|
303
620
|
if (typeof organizationId === 'undefined') {
|
|
304
621
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
305
622
|
}
|
|
306
623
|
if (typeof billingAddressId === 'undefined') {
|
|
307
624
|
throw new AppwriteException('Missing required parameter: "billingAddressId"');
|
|
308
625
|
}
|
|
626
|
+
|
|
309
627
|
const apiPath = '/organizations/{organizationId}/billing-addresses/{billingAddressId}'.replace('{organizationId}', organizationId).replace('{billingAddressId}', billingAddressId);
|
|
310
628
|
const payload: Payload = {};
|
|
311
629
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -320,21 +638,51 @@ export class Organizations {
|
|
|
320
638
|
payload
|
|
321
639
|
);
|
|
322
640
|
}
|
|
641
|
+
|
|
323
642
|
/**
|
|
324
643
|
* Set the current billing email for the organization.
|
|
325
644
|
*
|
|
326
|
-
* @param {string} organizationId
|
|
327
|
-
* @param {string} billingEmail
|
|
645
|
+
* @param {string} params.organizationId - Organization ID
|
|
646
|
+
* @param {string} params.billingEmail - Billing email for the organization.
|
|
328
647
|
* @throws {AppwriteException}
|
|
329
648
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
330
649
|
*/
|
|
331
|
-
setBillingEmail<Preferences extends Models.Preferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences
|
|
650
|
+
setBillingEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string, billingEmail: string }): Promise<Models.Organization<Preferences>>;
|
|
651
|
+
/**
|
|
652
|
+
* Set the current billing email for the organization.
|
|
653
|
+
*
|
|
654
|
+
* @param {string} organizationId - Organization ID
|
|
655
|
+
* @param {string} billingEmail - Billing email for the organization.
|
|
656
|
+
* @throws {AppwriteException}
|
|
657
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
658
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
659
|
+
*/
|
|
660
|
+
setBillingEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences>>;
|
|
661
|
+
setBillingEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
662
|
+
paramsOrFirst: { organizationId: string, billingEmail: string } | string,
|
|
663
|
+
...rest: [(string)?]
|
|
664
|
+
): Promise<Models.Organization<Preferences>> {
|
|
665
|
+
let params: { organizationId: string, billingEmail: string };
|
|
666
|
+
|
|
667
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
668
|
+
params = (paramsOrFirst || {}) as { organizationId: string, billingEmail: string };
|
|
669
|
+
} else {
|
|
670
|
+
params = {
|
|
671
|
+
organizationId: paramsOrFirst as string,
|
|
672
|
+
billingEmail: rest[0] as string
|
|
673
|
+
};
|
|
674
|
+
}
|
|
675
|
+
|
|
676
|
+
const organizationId = params.organizationId;
|
|
677
|
+
const billingEmail = params.billingEmail;
|
|
678
|
+
|
|
332
679
|
if (typeof organizationId === 'undefined') {
|
|
333
680
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
334
681
|
}
|
|
335
682
|
if (typeof billingEmail === 'undefined') {
|
|
336
683
|
throw new AppwriteException('Missing required parameter: "billingEmail"');
|
|
337
684
|
}
|
|
685
|
+
|
|
338
686
|
const apiPath = '/organizations/{organizationId}/billing-email'.replace('{organizationId}', organizationId);
|
|
339
687
|
const payload: Payload = {};
|
|
340
688
|
if (typeof billingEmail !== 'undefined') {
|
|
@@ -353,22 +701,55 @@ export class Organizations {
|
|
|
353
701
|
payload
|
|
354
702
|
);
|
|
355
703
|
}
|
|
704
|
+
|
|
705
|
+
/**
|
|
706
|
+
* Update the budget limit for an organization.
|
|
707
|
+
*
|
|
708
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
709
|
+
* @param {number} params.budget - Budget limit for additional usage set for the organization
|
|
710
|
+
* @param {number[]} params.alerts - Budget alert limit percentage
|
|
711
|
+
* @throws {AppwriteException}
|
|
712
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
713
|
+
*/
|
|
714
|
+
updateBudget<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string, budget?: number, alerts?: number[] }): Promise<Models.Organization<Preferences>>;
|
|
356
715
|
/**
|
|
357
716
|
* Update the budget limit for an organization.
|
|
358
717
|
*
|
|
359
|
-
* @param {string} organizationId
|
|
360
|
-
* @param {number} budget
|
|
361
|
-
* @param {number[]} alerts
|
|
718
|
+
* @param {string} organizationId - Organization Unique ID
|
|
719
|
+
* @param {number} budget - Budget limit for additional usage set for the organization
|
|
720
|
+
* @param {number[]} alerts - Budget alert limit percentage
|
|
362
721
|
* @throws {AppwriteException}
|
|
363
722
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
723
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
364
724
|
*/
|
|
365
|
-
updateBudget<Preferences extends Models.Preferences>(organizationId: string, budget?: number, alerts?: number[]): Promise<Models.Organization<Preferences
|
|
725
|
+
updateBudget<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, budget?: number, alerts?: number[]): Promise<Models.Organization<Preferences>>;
|
|
726
|
+
updateBudget<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
727
|
+
paramsOrFirst: { organizationId: string, budget?: number, alerts?: number[] } | string,
|
|
728
|
+
...rest: [(number)?, (number[])?]
|
|
729
|
+
): Promise<Models.Organization<Preferences>> {
|
|
730
|
+
let params: { organizationId: string, budget?: number, alerts?: number[] };
|
|
731
|
+
|
|
732
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
733
|
+
params = (paramsOrFirst || {}) as { organizationId: string, budget?: number, alerts?: number[] };
|
|
734
|
+
} else {
|
|
735
|
+
params = {
|
|
736
|
+
organizationId: paramsOrFirst as string,
|
|
737
|
+
budget: rest[0] as number,
|
|
738
|
+
alerts: rest[1] as number[]
|
|
739
|
+
};
|
|
740
|
+
}
|
|
741
|
+
|
|
742
|
+
const organizationId = params.organizationId;
|
|
743
|
+
const budget = params.budget;
|
|
744
|
+
const alerts = params.alerts;
|
|
745
|
+
|
|
366
746
|
if (typeof organizationId === 'undefined') {
|
|
367
747
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
368
748
|
}
|
|
369
749
|
if (typeof budget === 'undefined') {
|
|
370
750
|
throw new AppwriteException('Missing required parameter: "budget"');
|
|
371
751
|
}
|
|
752
|
+
|
|
372
753
|
const apiPath = '/organizations/{organizationId}/budget'.replace('{organizationId}', organizationId);
|
|
373
754
|
const payload: Payload = {};
|
|
374
755
|
if (typeof budget !== 'undefined') {
|
|
@@ -390,19 +771,50 @@ export class Organizations {
|
|
|
390
771
|
payload
|
|
391
772
|
);
|
|
392
773
|
}
|
|
774
|
+
|
|
393
775
|
/**
|
|
394
776
|
* List all credits for an organization.
|
|
395
|
-
|
|
777
|
+
*
|
|
396
778
|
*
|
|
397
|
-
* @param {string} organizationId
|
|
398
|
-
* @param {string[]} queries
|
|
779
|
+
* @param {string} params.organizationId - Organization ID
|
|
780
|
+
* @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
|
|
399
781
|
* @throws {AppwriteException}
|
|
400
782
|
* @returns {Promise<Models.CreditList>}
|
|
401
783
|
*/
|
|
402
|
-
listCredits(organizationId: string, queries?: string[]): Promise<Models.CreditList
|
|
784
|
+
listCredits(params: { organizationId: string, queries?: string[] }): Promise<Models.CreditList>;
|
|
785
|
+
/**
|
|
786
|
+
* List all credits for an organization.
|
|
787
|
+
*
|
|
788
|
+
*
|
|
789
|
+
* @param {string} organizationId - Organization ID
|
|
790
|
+
* @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
|
|
791
|
+
* @throws {AppwriteException}
|
|
792
|
+
* @returns {Promise<Models.CreditList>}
|
|
793
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
794
|
+
*/
|
|
795
|
+
listCredits(organizationId: string, queries?: string[]): Promise<Models.CreditList>;
|
|
796
|
+
listCredits(
|
|
797
|
+
paramsOrFirst: { organizationId: string, queries?: string[] } | string,
|
|
798
|
+
...rest: [(string[])?]
|
|
799
|
+
): Promise<Models.CreditList> {
|
|
800
|
+
let params: { organizationId: string, queries?: string[] };
|
|
801
|
+
|
|
802
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
803
|
+
params = (paramsOrFirst || {}) as { organizationId: string, queries?: string[] };
|
|
804
|
+
} else {
|
|
805
|
+
params = {
|
|
806
|
+
organizationId: paramsOrFirst as string,
|
|
807
|
+
queries: rest[0] as string[]
|
|
808
|
+
};
|
|
809
|
+
}
|
|
810
|
+
|
|
811
|
+
const organizationId = params.organizationId;
|
|
812
|
+
const queries = params.queries;
|
|
813
|
+
|
|
403
814
|
if (typeof organizationId === 'undefined') {
|
|
404
815
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
405
816
|
}
|
|
817
|
+
|
|
406
818
|
const apiPath = '/organizations/{organizationId}/credits'.replace('{organizationId}', organizationId);
|
|
407
819
|
const payload: Payload = {};
|
|
408
820
|
if (typeof queries !== 'undefined') {
|
|
@@ -420,21 +832,51 @@ export class Organizations {
|
|
|
420
832
|
payload
|
|
421
833
|
);
|
|
422
834
|
}
|
|
835
|
+
|
|
423
836
|
/**
|
|
424
837
|
* Add credit to an organization using a coupon.
|
|
425
838
|
*
|
|
426
|
-
* @param {string} organizationId
|
|
427
|
-
* @param {string} couponId
|
|
839
|
+
* @param {string} params.organizationId - Organization ID
|
|
840
|
+
* @param {string} params.couponId - ID of the coupon
|
|
428
841
|
* @throws {AppwriteException}
|
|
429
842
|
* @returns {Promise<Models.Credit>}
|
|
430
843
|
*/
|
|
431
|
-
addCredit(organizationId: string, couponId: string): Promise<Models.Credit
|
|
844
|
+
addCredit(params: { organizationId: string, couponId: string }): Promise<Models.Credit>;
|
|
845
|
+
/**
|
|
846
|
+
* Add credit to an organization using a coupon.
|
|
847
|
+
*
|
|
848
|
+
* @param {string} organizationId - Organization ID
|
|
849
|
+
* @param {string} couponId - ID of the coupon
|
|
850
|
+
* @throws {AppwriteException}
|
|
851
|
+
* @returns {Promise<Models.Credit>}
|
|
852
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
853
|
+
*/
|
|
854
|
+
addCredit(organizationId: string, couponId: string): Promise<Models.Credit>;
|
|
855
|
+
addCredit(
|
|
856
|
+
paramsOrFirst: { organizationId: string, couponId: string } | string,
|
|
857
|
+
...rest: [(string)?]
|
|
858
|
+
): Promise<Models.Credit> {
|
|
859
|
+
let params: { organizationId: string, couponId: string };
|
|
860
|
+
|
|
861
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
862
|
+
params = (paramsOrFirst || {}) as { organizationId: string, couponId: string };
|
|
863
|
+
} else {
|
|
864
|
+
params = {
|
|
865
|
+
organizationId: paramsOrFirst as string,
|
|
866
|
+
couponId: rest[0] as string
|
|
867
|
+
};
|
|
868
|
+
}
|
|
869
|
+
|
|
870
|
+
const organizationId = params.organizationId;
|
|
871
|
+
const couponId = params.couponId;
|
|
872
|
+
|
|
432
873
|
if (typeof organizationId === 'undefined') {
|
|
433
874
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
434
875
|
}
|
|
435
876
|
if (typeof couponId === 'undefined') {
|
|
436
877
|
throw new AppwriteException('Missing required parameter: "couponId"');
|
|
437
878
|
}
|
|
879
|
+
|
|
438
880
|
const apiPath = '/organizations/{organizationId}/credits'.replace('{organizationId}', organizationId);
|
|
439
881
|
const payload: Payload = {};
|
|
440
882
|
if (typeof couponId !== 'undefined') {
|
|
@@ -453,21 +895,102 @@ export class Organizations {
|
|
|
453
895
|
payload
|
|
454
896
|
);
|
|
455
897
|
}
|
|
898
|
+
|
|
899
|
+
/**
|
|
900
|
+
* Get total available valid credits for an organization.
|
|
901
|
+
*
|
|
902
|
+
* @param {string} params.organizationId - Organization ID
|
|
903
|
+
* @throws {AppwriteException}
|
|
904
|
+
* @returns {Promise<Models.CreditAvailable>}
|
|
905
|
+
*/
|
|
906
|
+
getAvailableCredits(params: { organizationId: string }): Promise<Models.CreditAvailable>;
|
|
907
|
+
/**
|
|
908
|
+
* Get total available valid credits for an organization.
|
|
909
|
+
*
|
|
910
|
+
* @param {string} organizationId - Organization ID
|
|
911
|
+
* @throws {AppwriteException}
|
|
912
|
+
* @returns {Promise<Models.CreditAvailable>}
|
|
913
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
914
|
+
*/
|
|
915
|
+
getAvailableCredits(organizationId: string): Promise<Models.CreditAvailable>;
|
|
916
|
+
getAvailableCredits(
|
|
917
|
+
paramsOrFirst: { organizationId: string } | string
|
|
918
|
+
): Promise<Models.CreditAvailable> {
|
|
919
|
+
let params: { organizationId: string };
|
|
920
|
+
|
|
921
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
922
|
+
params = (paramsOrFirst || {}) as { organizationId: string };
|
|
923
|
+
} else {
|
|
924
|
+
params = {
|
|
925
|
+
organizationId: paramsOrFirst as string
|
|
926
|
+
};
|
|
927
|
+
}
|
|
928
|
+
|
|
929
|
+
const organizationId = params.organizationId;
|
|
930
|
+
|
|
931
|
+
if (typeof organizationId === 'undefined') {
|
|
932
|
+
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
933
|
+
}
|
|
934
|
+
|
|
935
|
+
const apiPath = '/organizations/{organizationId}/credits/available'.replace('{organizationId}', organizationId);
|
|
936
|
+
const payload: Payload = {};
|
|
937
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
938
|
+
|
|
939
|
+
const apiHeaders: { [header: string]: string } = {
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
return this.client.call(
|
|
943
|
+
'get',
|
|
944
|
+
uri,
|
|
945
|
+
apiHeaders,
|
|
946
|
+
payload
|
|
947
|
+
);
|
|
948
|
+
}
|
|
949
|
+
|
|
950
|
+
/**
|
|
951
|
+
* Get credit details.
|
|
952
|
+
*
|
|
953
|
+
* @param {string} params.organizationId - Organization ID
|
|
954
|
+
* @param {string} params.creditId - Credit Unique ID
|
|
955
|
+
* @throws {AppwriteException}
|
|
956
|
+
* @returns {Promise<Models.Credit>}
|
|
957
|
+
*/
|
|
958
|
+
getCredit(params: { organizationId: string, creditId: string }): Promise<Models.Credit>;
|
|
456
959
|
/**
|
|
457
960
|
* Get credit details.
|
|
458
961
|
*
|
|
459
|
-
* @param {string} organizationId
|
|
460
|
-
* @param {string} creditId
|
|
962
|
+
* @param {string} organizationId - Organization ID
|
|
963
|
+
* @param {string} creditId - Credit Unique ID
|
|
461
964
|
* @throws {AppwriteException}
|
|
462
965
|
* @returns {Promise<Models.Credit>}
|
|
966
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
463
967
|
*/
|
|
464
|
-
getCredit(organizationId: string, creditId: string): Promise<Models.Credit
|
|
968
|
+
getCredit(organizationId: string, creditId: string): Promise<Models.Credit>;
|
|
969
|
+
getCredit(
|
|
970
|
+
paramsOrFirst: { organizationId: string, creditId: string } | string,
|
|
971
|
+
...rest: [(string)?]
|
|
972
|
+
): Promise<Models.Credit> {
|
|
973
|
+
let params: { organizationId: string, creditId: string };
|
|
974
|
+
|
|
975
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
976
|
+
params = (paramsOrFirst || {}) as { organizationId: string, creditId: string };
|
|
977
|
+
} else {
|
|
978
|
+
params = {
|
|
979
|
+
organizationId: paramsOrFirst as string,
|
|
980
|
+
creditId: rest[0] as string
|
|
981
|
+
};
|
|
982
|
+
}
|
|
983
|
+
|
|
984
|
+
const organizationId = params.organizationId;
|
|
985
|
+
const creditId = params.creditId;
|
|
986
|
+
|
|
465
987
|
if (typeof organizationId === 'undefined') {
|
|
466
988
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
467
989
|
}
|
|
468
990
|
if (typeof creditId === 'undefined') {
|
|
469
991
|
throw new AppwriteException('Missing required parameter: "creditId"');
|
|
470
992
|
}
|
|
993
|
+
|
|
471
994
|
const apiPath = '/organizations/{organizationId}/credits/{creditId}'.replace('{organizationId}', organizationId).replace('{creditId}', creditId);
|
|
472
995
|
const payload: Payload = {};
|
|
473
996
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -482,17 +1005,43 @@ export class Organizations {
|
|
|
482
1005
|
payload
|
|
483
1006
|
);
|
|
484
1007
|
}
|
|
1008
|
+
|
|
1009
|
+
/**
|
|
1010
|
+
* Get estimation for deleting an organization.
|
|
1011
|
+
*
|
|
1012
|
+
* @param {string} params.organizationId - Team ID.
|
|
1013
|
+
* @throws {AppwriteException}
|
|
1014
|
+
* @returns {Promise<Models.EstimationDeleteOrganization>}
|
|
1015
|
+
*/
|
|
1016
|
+
estimationDeleteOrganization(params: { organizationId: string }): Promise<Models.EstimationDeleteOrganization>;
|
|
485
1017
|
/**
|
|
486
1018
|
* Get estimation for deleting an organization.
|
|
487
1019
|
*
|
|
488
|
-
* @param {string} organizationId
|
|
1020
|
+
* @param {string} organizationId - Team ID.
|
|
489
1021
|
* @throws {AppwriteException}
|
|
490
1022
|
* @returns {Promise<Models.EstimationDeleteOrganization>}
|
|
1023
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
491
1024
|
*/
|
|
492
|
-
estimationDeleteOrganization(organizationId: string): Promise<Models.EstimationDeleteOrganization
|
|
1025
|
+
estimationDeleteOrganization(organizationId: string): Promise<Models.EstimationDeleteOrganization>;
|
|
1026
|
+
estimationDeleteOrganization(
|
|
1027
|
+
paramsOrFirst: { organizationId: string } | string
|
|
1028
|
+
): Promise<Models.EstimationDeleteOrganization> {
|
|
1029
|
+
let params: { organizationId: string };
|
|
1030
|
+
|
|
1031
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1032
|
+
params = (paramsOrFirst || {}) as { organizationId: string };
|
|
1033
|
+
} else {
|
|
1034
|
+
params = {
|
|
1035
|
+
organizationId: paramsOrFirst as string
|
|
1036
|
+
};
|
|
1037
|
+
}
|
|
1038
|
+
|
|
1039
|
+
const organizationId = params.organizationId;
|
|
1040
|
+
|
|
493
1041
|
if (typeof organizationId === 'undefined') {
|
|
494
1042
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
495
1043
|
}
|
|
1044
|
+
|
|
496
1045
|
const apiPath = '/organizations/{organizationId}/estimations/delete-organization'.replace('{organizationId}', organizationId);
|
|
497
1046
|
const payload: Payload = {};
|
|
498
1047
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -508,23 +1057,59 @@ export class Organizations {
|
|
|
508
1057
|
payload
|
|
509
1058
|
);
|
|
510
1059
|
}
|
|
1060
|
+
|
|
1061
|
+
/**
|
|
1062
|
+
* Get estimation for updating the organization plan.
|
|
1063
|
+
*
|
|
1064
|
+
* @param {string} params.organizationId - Organization ID
|
|
1065
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
1066
|
+
* @param {string[]} params.invites - Additional member invites
|
|
1067
|
+
* @param {string} params.couponId - Coupon id
|
|
1068
|
+
* @throws {AppwriteException}
|
|
1069
|
+
* @returns {Promise<Models.EstimationUpdatePlan>}
|
|
1070
|
+
*/
|
|
1071
|
+
estimationUpdatePlan(params: { organizationId: string, billingPlan: string, invites?: string[], couponId?: string }): Promise<Models.EstimationUpdatePlan>;
|
|
511
1072
|
/**
|
|
512
1073
|
* Get estimation for updating the organization plan.
|
|
513
1074
|
*
|
|
514
|
-
* @param {string} organizationId
|
|
515
|
-
* @param {
|
|
516
|
-
* @param {string[]} invites
|
|
517
|
-
* @param {string} couponId
|
|
1075
|
+
* @param {string} organizationId - Organization ID
|
|
1076
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
1077
|
+
* @param {string[]} invites - Additional member invites
|
|
1078
|
+
* @param {string} couponId - Coupon id
|
|
518
1079
|
* @throws {AppwriteException}
|
|
519
1080
|
* @returns {Promise<Models.EstimationUpdatePlan>}
|
|
1081
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
520
1082
|
*/
|
|
521
|
-
estimationUpdatePlan(organizationId: string, billingPlan:
|
|
1083
|
+
estimationUpdatePlan(organizationId: string, billingPlan: string, invites?: string[], couponId?: string): Promise<Models.EstimationUpdatePlan>;
|
|
1084
|
+
estimationUpdatePlan(
|
|
1085
|
+
paramsOrFirst: { organizationId: string, billingPlan: string, invites?: string[], couponId?: string } | string,
|
|
1086
|
+
...rest: [(string)?, (string[])?, (string)?]
|
|
1087
|
+
): Promise<Models.EstimationUpdatePlan> {
|
|
1088
|
+
let params: { organizationId: string, billingPlan: string, invites?: string[], couponId?: string };
|
|
1089
|
+
|
|
1090
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1091
|
+
params = (paramsOrFirst || {}) as { organizationId: string, billingPlan: string, invites?: string[], couponId?: string };
|
|
1092
|
+
} else {
|
|
1093
|
+
params = {
|
|
1094
|
+
organizationId: paramsOrFirst as string,
|
|
1095
|
+
billingPlan: rest[0] as string,
|
|
1096
|
+
invites: rest[1] as string[],
|
|
1097
|
+
couponId: rest[2] as string
|
|
1098
|
+
};
|
|
1099
|
+
}
|
|
1100
|
+
|
|
1101
|
+
const organizationId = params.organizationId;
|
|
1102
|
+
const billingPlan = params.billingPlan;
|
|
1103
|
+
const invites = params.invites;
|
|
1104
|
+
const couponId = params.couponId;
|
|
1105
|
+
|
|
522
1106
|
if (typeof organizationId === 'undefined') {
|
|
523
1107
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
524
1108
|
}
|
|
525
1109
|
if (typeof billingPlan === 'undefined') {
|
|
526
1110
|
throw new AppwriteException('Missing required parameter: "billingPlan"');
|
|
527
1111
|
}
|
|
1112
|
+
|
|
528
1113
|
const apiPath = '/organizations/{organizationId}/estimations/update-plan'.replace('{organizationId}', organizationId);
|
|
529
1114
|
const payload: Payload = {};
|
|
530
1115
|
if (typeof billingPlan !== 'undefined') {
|
|
@@ -549,18 +1134,143 @@ export class Organizations {
|
|
|
549
1134
|
payload
|
|
550
1135
|
);
|
|
551
1136
|
}
|
|
1137
|
+
|
|
1138
|
+
/**
|
|
1139
|
+
* Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
|
|
1140
|
+
*
|
|
1141
|
+
*
|
|
1142
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
1143
|
+
* @param {string} params.reason - Feedback reason
|
|
1144
|
+
* @param {string} params.message - Feedback message
|
|
1145
|
+
* @param {string} params.fromPlanId - Plan downgrading from
|
|
1146
|
+
* @param {string} params.toPlanId - Plan downgrading to
|
|
1147
|
+
* @throws {AppwriteException}
|
|
1148
|
+
* @returns {Promise<Models.DowngradeFeedback>}
|
|
1149
|
+
*/
|
|
1150
|
+
createDowngradeFeedback(params: { organizationId: string, reason: string, message: string, fromPlanId: string, toPlanId: string }): Promise<Models.DowngradeFeedback>;
|
|
1151
|
+
/**
|
|
1152
|
+
* Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
|
|
1153
|
+
*
|
|
1154
|
+
*
|
|
1155
|
+
* @param {string} organizationId - Organization Unique ID
|
|
1156
|
+
* @param {string} reason - Feedback reason
|
|
1157
|
+
* @param {string} message - Feedback message
|
|
1158
|
+
* @param {string} fromPlanId - Plan downgrading from
|
|
1159
|
+
* @param {string} toPlanId - Plan downgrading to
|
|
1160
|
+
* @throws {AppwriteException}
|
|
1161
|
+
* @returns {Promise<Models.DowngradeFeedback>}
|
|
1162
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1163
|
+
*/
|
|
1164
|
+
createDowngradeFeedback(organizationId: string, reason: string, message: string, fromPlanId: string, toPlanId: string): Promise<Models.DowngradeFeedback>;
|
|
1165
|
+
createDowngradeFeedback(
|
|
1166
|
+
paramsOrFirst: { organizationId: string, reason: string, message: string, fromPlanId: string, toPlanId: string } | string,
|
|
1167
|
+
...rest: [(string)?, (string)?, (string)?, (string)?]
|
|
1168
|
+
): Promise<Models.DowngradeFeedback> {
|
|
1169
|
+
let params: { organizationId: string, reason: string, message: string, fromPlanId: string, toPlanId: string };
|
|
1170
|
+
|
|
1171
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1172
|
+
params = (paramsOrFirst || {}) as { organizationId: string, reason: string, message: string, fromPlanId: string, toPlanId: string };
|
|
1173
|
+
} else {
|
|
1174
|
+
params = {
|
|
1175
|
+
organizationId: paramsOrFirst as string,
|
|
1176
|
+
reason: rest[0] as string,
|
|
1177
|
+
message: rest[1] as string,
|
|
1178
|
+
fromPlanId: rest[2] as string,
|
|
1179
|
+
toPlanId: rest[3] as string
|
|
1180
|
+
};
|
|
1181
|
+
}
|
|
1182
|
+
|
|
1183
|
+
const organizationId = params.organizationId;
|
|
1184
|
+
const reason = params.reason;
|
|
1185
|
+
const message = params.message;
|
|
1186
|
+
const fromPlanId = params.fromPlanId;
|
|
1187
|
+
const toPlanId = params.toPlanId;
|
|
1188
|
+
|
|
1189
|
+
if (typeof organizationId === 'undefined') {
|
|
1190
|
+
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
1191
|
+
}
|
|
1192
|
+
if (typeof reason === 'undefined') {
|
|
1193
|
+
throw new AppwriteException('Missing required parameter: "reason"');
|
|
1194
|
+
}
|
|
1195
|
+
if (typeof message === 'undefined') {
|
|
1196
|
+
throw new AppwriteException('Missing required parameter: "message"');
|
|
1197
|
+
}
|
|
1198
|
+
if (typeof fromPlanId === 'undefined') {
|
|
1199
|
+
throw new AppwriteException('Missing required parameter: "fromPlanId"');
|
|
1200
|
+
}
|
|
1201
|
+
if (typeof toPlanId === 'undefined') {
|
|
1202
|
+
throw new AppwriteException('Missing required parameter: "toPlanId"');
|
|
1203
|
+
}
|
|
1204
|
+
|
|
1205
|
+
const apiPath = '/organizations/{organizationId}/feedbacks/downgrade'.replace('{organizationId}', organizationId);
|
|
1206
|
+
const payload: Payload = {};
|
|
1207
|
+
if (typeof reason !== 'undefined') {
|
|
1208
|
+
payload['reason'] = reason;
|
|
1209
|
+
}
|
|
1210
|
+
if (typeof message !== 'undefined') {
|
|
1211
|
+
payload['message'] = message;
|
|
1212
|
+
}
|
|
1213
|
+
if (typeof fromPlanId !== 'undefined') {
|
|
1214
|
+
payload['fromPlanId'] = fromPlanId;
|
|
1215
|
+
}
|
|
1216
|
+
if (typeof toPlanId !== 'undefined') {
|
|
1217
|
+
payload['toPlanId'] = toPlanId;
|
|
1218
|
+
}
|
|
1219
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
1220
|
+
|
|
1221
|
+
const apiHeaders: { [header: string]: string } = {
|
|
1222
|
+
'content-type': 'application/json',
|
|
1223
|
+
}
|
|
1224
|
+
|
|
1225
|
+
return this.client.call(
|
|
1226
|
+
'post',
|
|
1227
|
+
uri,
|
|
1228
|
+
apiHeaders,
|
|
1229
|
+
payload
|
|
1230
|
+
);
|
|
1231
|
+
}
|
|
1232
|
+
|
|
552
1233
|
/**
|
|
553
1234
|
* List all invoices for an organization.
|
|
554
1235
|
*
|
|
555
|
-
* @param {string} organizationId
|
|
556
|
-
* @param {string[]} queries
|
|
1236
|
+
* @param {string} params.organizationId - Organization ID
|
|
1237
|
+
* @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
|
|
557
1238
|
* @throws {AppwriteException}
|
|
558
1239
|
* @returns {Promise<Models.InvoiceList>}
|
|
559
1240
|
*/
|
|
560
|
-
listInvoices(organizationId: string, queries?: string[]): Promise<Models.InvoiceList
|
|
1241
|
+
listInvoices(params: { organizationId: string, queries?: string[] }): Promise<Models.InvoiceList>;
|
|
1242
|
+
/**
|
|
1243
|
+
* List all invoices for an organization.
|
|
1244
|
+
*
|
|
1245
|
+
* @param {string} organizationId - Organization ID
|
|
1246
|
+
* @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
|
|
1247
|
+
* @throws {AppwriteException}
|
|
1248
|
+
* @returns {Promise<Models.InvoiceList>}
|
|
1249
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1250
|
+
*/
|
|
1251
|
+
listInvoices(organizationId: string, queries?: string[]): Promise<Models.InvoiceList>;
|
|
1252
|
+
listInvoices(
|
|
1253
|
+
paramsOrFirst: { organizationId: string, queries?: string[] } | string,
|
|
1254
|
+
...rest: [(string[])?]
|
|
1255
|
+
): Promise<Models.InvoiceList> {
|
|
1256
|
+
let params: { organizationId: string, queries?: string[] };
|
|
1257
|
+
|
|
1258
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1259
|
+
params = (paramsOrFirst || {}) as { organizationId: string, queries?: string[] };
|
|
1260
|
+
} else {
|
|
1261
|
+
params = {
|
|
1262
|
+
organizationId: paramsOrFirst as string,
|
|
1263
|
+
queries: rest[0] as string[]
|
|
1264
|
+
};
|
|
1265
|
+
}
|
|
1266
|
+
|
|
1267
|
+
const organizationId = params.organizationId;
|
|
1268
|
+
const queries = params.queries;
|
|
1269
|
+
|
|
561
1270
|
if (typeof organizationId === 'undefined') {
|
|
562
1271
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
563
1272
|
}
|
|
1273
|
+
|
|
564
1274
|
const apiPath = '/organizations/{organizationId}/invoices'.replace('{organizationId}', organizationId);
|
|
565
1275
|
const payload: Payload = {};
|
|
566
1276
|
if (typeof queries !== 'undefined') {
|
|
@@ -578,21 +1288,51 @@ export class Organizations {
|
|
|
578
1288
|
payload
|
|
579
1289
|
);
|
|
580
1290
|
}
|
|
1291
|
+
|
|
1292
|
+
/**
|
|
1293
|
+
* Get an invoice by its unique ID.
|
|
1294
|
+
*
|
|
1295
|
+
* @param {string} params.organizationId - Organization ID
|
|
1296
|
+
* @param {string} params.invoiceId - Invoice unique ID
|
|
1297
|
+
* @throws {AppwriteException}
|
|
1298
|
+
* @returns {Promise<Models.Invoice>}
|
|
1299
|
+
*/
|
|
1300
|
+
getInvoice(params: { organizationId: string, invoiceId: string }): Promise<Models.Invoice>;
|
|
581
1301
|
/**
|
|
582
1302
|
* Get an invoice by its unique ID.
|
|
583
1303
|
*
|
|
584
|
-
* @param {string} organizationId
|
|
585
|
-
* @param {string} invoiceId
|
|
1304
|
+
* @param {string} organizationId - Organization ID
|
|
1305
|
+
* @param {string} invoiceId - Invoice unique ID
|
|
586
1306
|
* @throws {AppwriteException}
|
|
587
1307
|
* @returns {Promise<Models.Invoice>}
|
|
1308
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
588
1309
|
*/
|
|
589
|
-
getInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice
|
|
1310
|
+
getInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice>;
|
|
1311
|
+
getInvoice(
|
|
1312
|
+
paramsOrFirst: { organizationId: string, invoiceId: string } | string,
|
|
1313
|
+
...rest: [(string)?]
|
|
1314
|
+
): Promise<Models.Invoice> {
|
|
1315
|
+
let params: { organizationId: string, invoiceId: string };
|
|
1316
|
+
|
|
1317
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1318
|
+
params = (paramsOrFirst || {}) as { organizationId: string, invoiceId: string };
|
|
1319
|
+
} else {
|
|
1320
|
+
params = {
|
|
1321
|
+
organizationId: paramsOrFirst as string,
|
|
1322
|
+
invoiceId: rest[0] as string
|
|
1323
|
+
};
|
|
1324
|
+
}
|
|
1325
|
+
|
|
1326
|
+
const organizationId = params.organizationId;
|
|
1327
|
+
const invoiceId = params.invoiceId;
|
|
1328
|
+
|
|
590
1329
|
if (typeof organizationId === 'undefined') {
|
|
591
1330
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
592
1331
|
}
|
|
593
1332
|
if (typeof invoiceId === 'undefined') {
|
|
594
1333
|
throw new AppwriteException('Missing required parameter: "invoiceId"');
|
|
595
1334
|
}
|
|
1335
|
+
|
|
596
1336
|
const apiPath = '/organizations/{organizationId}/invoices/{invoiceId}'.replace('{organizationId}', organizationId).replace('{invoiceId}', invoiceId);
|
|
597
1337
|
const payload: Payload = {};
|
|
598
1338
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -607,21 +1347,51 @@ export class Organizations {
|
|
|
607
1347
|
payload
|
|
608
1348
|
);
|
|
609
1349
|
}
|
|
1350
|
+
|
|
610
1351
|
/**
|
|
611
1352
|
* Download invoice in PDF
|
|
612
1353
|
*
|
|
613
|
-
* @param {string} organizationId
|
|
614
|
-
* @param {string} invoiceId
|
|
1354
|
+
* @param {string} params.organizationId - Organization ID
|
|
1355
|
+
* @param {string} params.invoiceId - Invoice unique ID
|
|
615
1356
|
* @throws {AppwriteException}
|
|
616
1357
|
* @returns {Promise<Models.PaymentMethod>}
|
|
617
1358
|
*/
|
|
618
|
-
getInvoiceDownload(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod
|
|
1359
|
+
getInvoiceDownload(params: { organizationId: string, invoiceId: string }): Promise<Models.PaymentMethod>;
|
|
1360
|
+
/**
|
|
1361
|
+
* Download invoice in PDF
|
|
1362
|
+
*
|
|
1363
|
+
* @param {string} organizationId - Organization ID
|
|
1364
|
+
* @param {string} invoiceId - Invoice unique ID
|
|
1365
|
+
* @throws {AppwriteException}
|
|
1366
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
1367
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1368
|
+
*/
|
|
1369
|
+
getInvoiceDownload(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
|
|
1370
|
+
getInvoiceDownload(
|
|
1371
|
+
paramsOrFirst: { organizationId: string, invoiceId: string } | string,
|
|
1372
|
+
...rest: [(string)?]
|
|
1373
|
+
): Promise<Models.PaymentMethod> {
|
|
1374
|
+
let params: { organizationId: string, invoiceId: string };
|
|
1375
|
+
|
|
1376
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1377
|
+
params = (paramsOrFirst || {}) as { organizationId: string, invoiceId: string };
|
|
1378
|
+
} else {
|
|
1379
|
+
params = {
|
|
1380
|
+
organizationId: paramsOrFirst as string,
|
|
1381
|
+
invoiceId: rest[0] as string
|
|
1382
|
+
};
|
|
1383
|
+
}
|
|
1384
|
+
|
|
1385
|
+
const organizationId = params.organizationId;
|
|
1386
|
+
const invoiceId = params.invoiceId;
|
|
1387
|
+
|
|
619
1388
|
if (typeof organizationId === 'undefined') {
|
|
620
1389
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
621
1390
|
}
|
|
622
1391
|
if (typeof invoiceId === 'undefined') {
|
|
623
1392
|
throw new AppwriteException('Missing required parameter: "invoiceId"');
|
|
624
1393
|
}
|
|
1394
|
+
|
|
625
1395
|
const apiPath = '/organizations/{organizationId}/invoices/{invoiceId}/download'.replace('{organizationId}', organizationId).replace('{invoiceId}', invoiceId);
|
|
626
1396
|
const payload: Payload = {};
|
|
627
1397
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -636,16 +1406,48 @@ export class Organizations {
|
|
|
636
1406
|
payload
|
|
637
1407
|
);
|
|
638
1408
|
}
|
|
1409
|
+
|
|
639
1410
|
/**
|
|
640
1411
|
* Initiate payment for failed invoice to pay live from console
|
|
641
1412
|
*
|
|
642
|
-
* @param {string} organizationId
|
|
643
|
-
* @param {string} invoiceId
|
|
644
|
-
* @param {string} paymentMethodId
|
|
1413
|
+
* @param {string} params.organizationId - Organization ID
|
|
1414
|
+
* @param {string} params.invoiceId - Invoice unique ID
|
|
1415
|
+
* @param {string} params.paymentMethodId - Payment method ID
|
|
645
1416
|
* @throws {AppwriteException}
|
|
646
1417
|
* @returns {Promise<Models.Invoice>}
|
|
647
1418
|
*/
|
|
648
|
-
createInvoicePayment(organizationId: string, invoiceId: string, paymentMethodId: string): Promise<Models.Invoice
|
|
1419
|
+
createInvoicePayment(params: { organizationId: string, invoiceId: string, paymentMethodId: string }): Promise<Models.Invoice>;
|
|
1420
|
+
/**
|
|
1421
|
+
* Initiate payment for failed invoice to pay live from console
|
|
1422
|
+
*
|
|
1423
|
+
* @param {string} organizationId - Organization ID
|
|
1424
|
+
* @param {string} invoiceId - Invoice unique ID
|
|
1425
|
+
* @param {string} paymentMethodId - Payment method ID
|
|
1426
|
+
* @throws {AppwriteException}
|
|
1427
|
+
* @returns {Promise<Models.Invoice>}
|
|
1428
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1429
|
+
*/
|
|
1430
|
+
createInvoicePayment(organizationId: string, invoiceId: string, paymentMethodId: string): Promise<Models.Invoice>;
|
|
1431
|
+
createInvoicePayment(
|
|
1432
|
+
paramsOrFirst: { organizationId: string, invoiceId: string, paymentMethodId: string } | string,
|
|
1433
|
+
...rest: [(string)?, (string)?]
|
|
1434
|
+
): Promise<Models.Invoice> {
|
|
1435
|
+
let params: { organizationId: string, invoiceId: string, paymentMethodId: string };
|
|
1436
|
+
|
|
1437
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1438
|
+
params = (paramsOrFirst || {}) as { organizationId: string, invoiceId: string, paymentMethodId: string };
|
|
1439
|
+
} else {
|
|
1440
|
+
params = {
|
|
1441
|
+
organizationId: paramsOrFirst as string,
|
|
1442
|
+
invoiceId: rest[0] as string,
|
|
1443
|
+
paymentMethodId: rest[1] as string
|
|
1444
|
+
};
|
|
1445
|
+
}
|
|
1446
|
+
|
|
1447
|
+
const organizationId = params.organizationId;
|
|
1448
|
+
const invoiceId = params.invoiceId;
|
|
1449
|
+
const paymentMethodId = params.paymentMethodId;
|
|
1450
|
+
|
|
649
1451
|
if (typeof organizationId === 'undefined') {
|
|
650
1452
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
651
1453
|
}
|
|
@@ -655,6 +1457,7 @@ export class Organizations {
|
|
|
655
1457
|
if (typeof paymentMethodId === 'undefined') {
|
|
656
1458
|
throw new AppwriteException('Missing required parameter: "paymentMethodId"');
|
|
657
1459
|
}
|
|
1460
|
+
|
|
658
1461
|
const apiPath = '/organizations/{organizationId}/invoices/{invoiceId}/payments'.replace('{organizationId}', organizationId).replace('{invoiceId}', invoiceId);
|
|
659
1462
|
const payload: Payload = {};
|
|
660
1463
|
if (typeof paymentMethodId !== 'undefined') {
|
|
@@ -673,21 +1476,51 @@ export class Organizations {
|
|
|
673
1476
|
payload
|
|
674
1477
|
);
|
|
675
1478
|
}
|
|
1479
|
+
|
|
1480
|
+
/**
|
|
1481
|
+
* Validates the payment linked with the invoice and updates the invoice status if the payment status is changed.
|
|
1482
|
+
*
|
|
1483
|
+
* @param {string} params.organizationId - Organization ID
|
|
1484
|
+
* @param {string} params.invoiceId - Invoice unique ID
|
|
1485
|
+
* @throws {AppwriteException}
|
|
1486
|
+
* @returns {Promise<Models.Invoice>}
|
|
1487
|
+
*/
|
|
1488
|
+
validateInvoice(params: { organizationId: string, invoiceId: string }): Promise<Models.Invoice>;
|
|
676
1489
|
/**
|
|
677
1490
|
* Validates the payment linked with the invoice and updates the invoice status if the payment status is changed.
|
|
678
1491
|
*
|
|
679
|
-
* @param {string} organizationId
|
|
680
|
-
* @param {string} invoiceId
|
|
1492
|
+
* @param {string} organizationId - Organization ID
|
|
1493
|
+
* @param {string} invoiceId - Invoice unique ID
|
|
681
1494
|
* @throws {AppwriteException}
|
|
682
1495
|
* @returns {Promise<Models.Invoice>}
|
|
1496
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
683
1497
|
*/
|
|
684
|
-
validateInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice
|
|
1498
|
+
validateInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice>;
|
|
1499
|
+
validateInvoice(
|
|
1500
|
+
paramsOrFirst: { organizationId: string, invoiceId: string } | string,
|
|
1501
|
+
...rest: [(string)?]
|
|
1502
|
+
): Promise<Models.Invoice> {
|
|
1503
|
+
let params: { organizationId: string, invoiceId: string };
|
|
1504
|
+
|
|
1505
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1506
|
+
params = (paramsOrFirst || {}) as { organizationId: string, invoiceId: string };
|
|
1507
|
+
} else {
|
|
1508
|
+
params = {
|
|
1509
|
+
organizationId: paramsOrFirst as string,
|
|
1510
|
+
invoiceId: rest[0] as string
|
|
1511
|
+
};
|
|
1512
|
+
}
|
|
1513
|
+
|
|
1514
|
+
const organizationId = params.organizationId;
|
|
1515
|
+
const invoiceId = params.invoiceId;
|
|
1516
|
+
|
|
685
1517
|
if (typeof organizationId === 'undefined') {
|
|
686
1518
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
687
1519
|
}
|
|
688
1520
|
if (typeof invoiceId === 'undefined') {
|
|
689
1521
|
throw new AppwriteException('Missing required parameter: "invoiceId"');
|
|
690
1522
|
}
|
|
1523
|
+
|
|
691
1524
|
const apiPath = '/organizations/{organizationId}/invoices/{invoiceId}/status'.replace('{organizationId}', organizationId).replace('{invoiceId}', invoiceId);
|
|
692
1525
|
const payload: Payload = {};
|
|
693
1526
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -703,21 +1536,51 @@ export class Organizations {
|
|
|
703
1536
|
payload
|
|
704
1537
|
);
|
|
705
1538
|
}
|
|
1539
|
+
|
|
706
1540
|
/**
|
|
707
1541
|
* View invoice in PDF
|
|
708
1542
|
*
|
|
709
|
-
* @param {string} organizationId
|
|
710
|
-
* @param {string} invoiceId
|
|
1543
|
+
* @param {string} params.organizationId - Organization ID
|
|
1544
|
+
* @param {string} params.invoiceId - Invoice unique ID
|
|
711
1545
|
* @throws {AppwriteException}
|
|
712
1546
|
* @returns {Promise<Models.PaymentMethod>}
|
|
713
1547
|
*/
|
|
714
|
-
getInvoiceView(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod
|
|
1548
|
+
getInvoiceView(params: { organizationId: string, invoiceId: string }): Promise<Models.PaymentMethod>;
|
|
1549
|
+
/**
|
|
1550
|
+
* View invoice in PDF
|
|
1551
|
+
*
|
|
1552
|
+
* @param {string} organizationId - Organization ID
|
|
1553
|
+
* @param {string} invoiceId - Invoice unique ID
|
|
1554
|
+
* @throws {AppwriteException}
|
|
1555
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
1556
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1557
|
+
*/
|
|
1558
|
+
getInvoiceView(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
|
|
1559
|
+
getInvoiceView(
|
|
1560
|
+
paramsOrFirst: { organizationId: string, invoiceId: string } | string,
|
|
1561
|
+
...rest: [(string)?]
|
|
1562
|
+
): Promise<Models.PaymentMethod> {
|
|
1563
|
+
let params: { organizationId: string, invoiceId: string };
|
|
1564
|
+
|
|
1565
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1566
|
+
params = (paramsOrFirst || {}) as { organizationId: string, invoiceId: string };
|
|
1567
|
+
} else {
|
|
1568
|
+
params = {
|
|
1569
|
+
organizationId: paramsOrFirst as string,
|
|
1570
|
+
invoiceId: rest[0] as string
|
|
1571
|
+
};
|
|
1572
|
+
}
|
|
1573
|
+
|
|
1574
|
+
const organizationId = params.organizationId;
|
|
1575
|
+
const invoiceId = params.invoiceId;
|
|
1576
|
+
|
|
715
1577
|
if (typeof organizationId === 'undefined') {
|
|
716
1578
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
717
1579
|
}
|
|
718
1580
|
if (typeof invoiceId === 'undefined') {
|
|
719
1581
|
throw new AppwriteException('Missing required parameter: "invoiceId"');
|
|
720
1582
|
}
|
|
1583
|
+
|
|
721
1584
|
const apiPath = '/organizations/{organizationId}/invoices/{invoiceId}/view'.replace('{organizationId}', organizationId).replace('{invoiceId}', invoiceId);
|
|
722
1585
|
const payload: Payload = {};
|
|
723
1586
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -732,21 +1595,51 @@ export class Organizations {
|
|
|
732
1595
|
payload
|
|
733
1596
|
);
|
|
734
1597
|
}
|
|
1598
|
+
|
|
1599
|
+
/**
|
|
1600
|
+
* Set a organization's default payment method.
|
|
1601
|
+
*
|
|
1602
|
+
* @param {string} params.organizationId - Organization ID
|
|
1603
|
+
* @param {string} params.paymentMethodId - Unique ID of payment method
|
|
1604
|
+
* @throws {AppwriteException}
|
|
1605
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1606
|
+
*/
|
|
1607
|
+
setDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string, paymentMethodId: string }): Promise<Models.Organization<Preferences>>;
|
|
735
1608
|
/**
|
|
736
|
-
* Set a organization
|
|
1609
|
+
* Set a organization's default payment method.
|
|
737
1610
|
*
|
|
738
|
-
* @param {string} organizationId
|
|
739
|
-
* @param {string} paymentMethodId
|
|
1611
|
+
* @param {string} organizationId - Organization ID
|
|
1612
|
+
* @param {string} paymentMethodId - Unique ID of payment method
|
|
740
1613
|
* @throws {AppwriteException}
|
|
741
1614
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1615
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
742
1616
|
*/
|
|
743
|
-
setDefaultPaymentMethod<Preferences extends Models.Preferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences
|
|
1617
|
+
setDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
|
|
1618
|
+
setDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
1619
|
+
paramsOrFirst: { organizationId: string, paymentMethodId: string } | string,
|
|
1620
|
+
...rest: [(string)?]
|
|
1621
|
+
): Promise<Models.Organization<Preferences>> {
|
|
1622
|
+
let params: { organizationId: string, paymentMethodId: string };
|
|
1623
|
+
|
|
1624
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1625
|
+
params = (paramsOrFirst || {}) as { organizationId: string, paymentMethodId: string };
|
|
1626
|
+
} else {
|
|
1627
|
+
params = {
|
|
1628
|
+
organizationId: paramsOrFirst as string,
|
|
1629
|
+
paymentMethodId: rest[0] as string
|
|
1630
|
+
};
|
|
1631
|
+
}
|
|
1632
|
+
|
|
1633
|
+
const organizationId = params.organizationId;
|
|
1634
|
+
const paymentMethodId = params.paymentMethodId;
|
|
1635
|
+
|
|
744
1636
|
if (typeof organizationId === 'undefined') {
|
|
745
1637
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
746
1638
|
}
|
|
747
1639
|
if (typeof paymentMethodId === 'undefined') {
|
|
748
1640
|
throw new AppwriteException('Missing required parameter: "paymentMethodId"');
|
|
749
1641
|
}
|
|
1642
|
+
|
|
750
1643
|
const apiPath = '/organizations/{organizationId}/payment-method'.replace('{organizationId}', organizationId);
|
|
751
1644
|
const payload: Payload = {};
|
|
752
1645
|
if (typeof paymentMethodId !== 'undefined') {
|
|
@@ -765,17 +1658,43 @@ export class Organizations {
|
|
|
765
1658
|
payload
|
|
766
1659
|
);
|
|
767
1660
|
}
|
|
1661
|
+
|
|
1662
|
+
/**
|
|
1663
|
+
* Delete the default payment method for an organization.
|
|
1664
|
+
*
|
|
1665
|
+
* @param {string} params.organizationId - Organization ID
|
|
1666
|
+
* @throws {AppwriteException}
|
|
1667
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1668
|
+
*/
|
|
1669
|
+
deleteDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string }): Promise<Models.Organization<Preferences>>;
|
|
768
1670
|
/**
|
|
769
1671
|
* Delete the default payment method for an organization.
|
|
770
1672
|
*
|
|
771
|
-
* @param {string} organizationId
|
|
1673
|
+
* @param {string} organizationId - Organization ID
|
|
772
1674
|
* @throws {AppwriteException}
|
|
773
1675
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1676
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
774
1677
|
*/
|
|
775
|
-
deleteDefaultPaymentMethod<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences
|
|
1678
|
+
deleteDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
1679
|
+
deleteDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
1680
|
+
paramsOrFirst: { organizationId: string } | string
|
|
1681
|
+
): Promise<Models.Organization<Preferences>> {
|
|
1682
|
+
let params: { organizationId: string };
|
|
1683
|
+
|
|
1684
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1685
|
+
params = (paramsOrFirst || {}) as { organizationId: string };
|
|
1686
|
+
} else {
|
|
1687
|
+
params = {
|
|
1688
|
+
organizationId: paramsOrFirst as string
|
|
1689
|
+
};
|
|
1690
|
+
}
|
|
1691
|
+
|
|
1692
|
+
const organizationId = params.organizationId;
|
|
1693
|
+
|
|
776
1694
|
if (typeof organizationId === 'undefined') {
|
|
777
1695
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
778
1696
|
}
|
|
1697
|
+
|
|
779
1698
|
const apiPath = '/organizations/{organizationId}/payment-method'.replace('{organizationId}', organizationId);
|
|
780
1699
|
const payload: Payload = {};
|
|
781
1700
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -791,22 +1710,53 @@ export class Organizations {
|
|
|
791
1710
|
payload
|
|
792
1711
|
);
|
|
793
1712
|
}
|
|
794
|
-
/**
|
|
795
|
-
* Set an organization's backup payment method.
|
|
796
1713
|
|
|
1714
|
+
/**
|
|
1715
|
+
* Set an organization's backup payment method.
|
|
1716
|
+
*
|
|
1717
|
+
*
|
|
1718
|
+
* @param {string} params.organizationId - Organization ID
|
|
1719
|
+
* @param {string} params.paymentMethodId - Unique ID of payment method
|
|
1720
|
+
* @throws {AppwriteException}
|
|
1721
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1722
|
+
*/
|
|
1723
|
+
setBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string, paymentMethodId: string }): Promise<Models.Organization<Preferences>>;
|
|
1724
|
+
/**
|
|
1725
|
+
* Set an organization's backup payment method.
|
|
1726
|
+
*
|
|
797
1727
|
*
|
|
798
|
-
* @param {string} organizationId
|
|
799
|
-
* @param {string} paymentMethodId
|
|
1728
|
+
* @param {string} organizationId - Organization ID
|
|
1729
|
+
* @param {string} paymentMethodId - Unique ID of payment method
|
|
800
1730
|
* @throws {AppwriteException}
|
|
801
1731
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1732
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
802
1733
|
*/
|
|
803
|
-
setBackupPaymentMethod<Preferences extends Models.Preferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences
|
|
1734
|
+
setBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
|
|
1735
|
+
setBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
1736
|
+
paramsOrFirst: { organizationId: string, paymentMethodId: string } | string,
|
|
1737
|
+
...rest: [(string)?]
|
|
1738
|
+
): Promise<Models.Organization<Preferences>> {
|
|
1739
|
+
let params: { organizationId: string, paymentMethodId: string };
|
|
1740
|
+
|
|
1741
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1742
|
+
params = (paramsOrFirst || {}) as { organizationId: string, paymentMethodId: string };
|
|
1743
|
+
} else {
|
|
1744
|
+
params = {
|
|
1745
|
+
organizationId: paramsOrFirst as string,
|
|
1746
|
+
paymentMethodId: rest[0] as string
|
|
1747
|
+
};
|
|
1748
|
+
}
|
|
1749
|
+
|
|
1750
|
+
const organizationId = params.organizationId;
|
|
1751
|
+
const paymentMethodId = params.paymentMethodId;
|
|
1752
|
+
|
|
804
1753
|
if (typeof organizationId === 'undefined') {
|
|
805
1754
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
806
1755
|
}
|
|
807
1756
|
if (typeof paymentMethodId === 'undefined') {
|
|
808
1757
|
throw new AppwriteException('Missing required parameter: "paymentMethodId"');
|
|
809
1758
|
}
|
|
1759
|
+
|
|
810
1760
|
const apiPath = '/organizations/{organizationId}/payment-method/backup'.replace('{organizationId}', organizationId);
|
|
811
1761
|
const payload: Payload = {};
|
|
812
1762
|
if (typeof paymentMethodId !== 'undefined') {
|
|
@@ -825,17 +1775,43 @@ export class Organizations {
|
|
|
825
1775
|
payload
|
|
826
1776
|
);
|
|
827
1777
|
}
|
|
1778
|
+
|
|
1779
|
+
/**
|
|
1780
|
+
* Delete a backup payment method for an organization.
|
|
1781
|
+
*
|
|
1782
|
+
* @param {string} params.organizationId - Organization ID
|
|
1783
|
+
* @throws {AppwriteException}
|
|
1784
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1785
|
+
*/
|
|
1786
|
+
deleteBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string }): Promise<Models.Organization<Preferences>>;
|
|
828
1787
|
/**
|
|
829
1788
|
* Delete a backup payment method for an organization.
|
|
830
1789
|
*
|
|
831
|
-
* @param {string} organizationId
|
|
1790
|
+
* @param {string} organizationId - Organization ID
|
|
832
1791
|
* @throws {AppwriteException}
|
|
833
1792
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1793
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
834
1794
|
*/
|
|
835
|
-
deleteBackupPaymentMethod<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences
|
|
1795
|
+
deleteBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
1796
|
+
deleteBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
1797
|
+
paramsOrFirst: { organizationId: string } | string
|
|
1798
|
+
): Promise<Models.Organization<Preferences>> {
|
|
1799
|
+
let params: { organizationId: string };
|
|
1800
|
+
|
|
1801
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1802
|
+
params = (paramsOrFirst || {}) as { organizationId: string };
|
|
1803
|
+
} else {
|
|
1804
|
+
params = {
|
|
1805
|
+
organizationId: paramsOrFirst as string
|
|
1806
|
+
};
|
|
1807
|
+
}
|
|
1808
|
+
|
|
1809
|
+
const organizationId = params.organizationId;
|
|
1810
|
+
|
|
836
1811
|
if (typeof organizationId === 'undefined') {
|
|
837
1812
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
838
1813
|
}
|
|
1814
|
+
|
|
839
1815
|
const apiPath = '/organizations/{organizationId}/payment-method/backup'.replace('{organizationId}', organizationId);
|
|
840
1816
|
const payload: Payload = {};
|
|
841
1817
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -851,21 +1827,51 @@ export class Organizations {
|
|
|
851
1827
|
payload
|
|
852
1828
|
);
|
|
853
1829
|
}
|
|
1830
|
+
|
|
854
1831
|
/**
|
|
855
|
-
* Get an organization
|
|
1832
|
+
* Get an organization's payment method using it's payment method ID.
|
|
856
1833
|
*
|
|
857
|
-
* @param {string} organizationId
|
|
858
|
-
* @param {string} paymentMethodId
|
|
1834
|
+
* @param {string} params.organizationId - Organization ID
|
|
1835
|
+
* @param {string} params.paymentMethodId - Unique ID of payment method
|
|
859
1836
|
* @throws {AppwriteException}
|
|
860
1837
|
* @returns {Promise<Models.PaymentMethod>}
|
|
861
1838
|
*/
|
|
862
|
-
getPaymentMethod(organizationId: string, paymentMethodId: string): Promise<Models.PaymentMethod
|
|
1839
|
+
getPaymentMethod(params: { organizationId: string, paymentMethodId: string }): Promise<Models.PaymentMethod>;
|
|
1840
|
+
/**
|
|
1841
|
+
* Get an organization's payment method using it's payment method ID.
|
|
1842
|
+
*
|
|
1843
|
+
* @param {string} organizationId - Organization ID
|
|
1844
|
+
* @param {string} paymentMethodId - Unique ID of payment method
|
|
1845
|
+
* @throws {AppwriteException}
|
|
1846
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
1847
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1848
|
+
*/
|
|
1849
|
+
getPaymentMethod(organizationId: string, paymentMethodId: string): Promise<Models.PaymentMethod>;
|
|
1850
|
+
getPaymentMethod(
|
|
1851
|
+
paramsOrFirst: { organizationId: string, paymentMethodId: string } | string,
|
|
1852
|
+
...rest: [(string)?]
|
|
1853
|
+
): Promise<Models.PaymentMethod> {
|
|
1854
|
+
let params: { organizationId: string, paymentMethodId: string };
|
|
1855
|
+
|
|
1856
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1857
|
+
params = (paramsOrFirst || {}) as { organizationId: string, paymentMethodId: string };
|
|
1858
|
+
} else {
|
|
1859
|
+
params = {
|
|
1860
|
+
organizationId: paramsOrFirst as string,
|
|
1861
|
+
paymentMethodId: rest[0] as string
|
|
1862
|
+
};
|
|
1863
|
+
}
|
|
1864
|
+
|
|
1865
|
+
const organizationId = params.organizationId;
|
|
1866
|
+
const paymentMethodId = params.paymentMethodId;
|
|
1867
|
+
|
|
863
1868
|
if (typeof organizationId === 'undefined') {
|
|
864
1869
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
865
1870
|
}
|
|
866
1871
|
if (typeof paymentMethodId === 'undefined') {
|
|
867
1872
|
throw new AppwriteException('Missing required parameter: "paymentMethodId"');
|
|
868
1873
|
}
|
|
1874
|
+
|
|
869
1875
|
const apiPath = '/organizations/{organizationId}/payment-methods/{paymentMethodId}'.replace('{organizationId}', organizationId).replace('{paymentMethodId}', paymentMethodId);
|
|
870
1876
|
const payload: Payload = {};
|
|
871
1877
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -880,17 +1886,43 @@ export class Organizations {
|
|
|
880
1886
|
payload
|
|
881
1887
|
);
|
|
882
1888
|
}
|
|
1889
|
+
|
|
883
1890
|
/**
|
|
884
1891
|
* Get the details of the current billing plan for an organization.
|
|
885
1892
|
*
|
|
886
|
-
* @param {string} organizationId
|
|
1893
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
887
1894
|
* @throws {AppwriteException}
|
|
888
1895
|
* @returns {Promise<Models.BillingPlan>}
|
|
889
1896
|
*/
|
|
890
|
-
getPlan(organizationId: string): Promise<Models.BillingPlan
|
|
1897
|
+
getPlan(params: { organizationId: string }): Promise<Models.BillingPlan>;
|
|
1898
|
+
/**
|
|
1899
|
+
* Get the details of the current billing plan for an organization.
|
|
1900
|
+
*
|
|
1901
|
+
* @param {string} organizationId - Organization Unique ID
|
|
1902
|
+
* @throws {AppwriteException}
|
|
1903
|
+
* @returns {Promise<Models.BillingPlan>}
|
|
1904
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1905
|
+
*/
|
|
1906
|
+
getPlan(organizationId: string): Promise<Models.BillingPlan>;
|
|
1907
|
+
getPlan(
|
|
1908
|
+
paramsOrFirst: { organizationId: string } | string
|
|
1909
|
+
): Promise<Models.BillingPlan> {
|
|
1910
|
+
let params: { organizationId: string };
|
|
1911
|
+
|
|
1912
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1913
|
+
params = (paramsOrFirst || {}) as { organizationId: string };
|
|
1914
|
+
} else {
|
|
1915
|
+
params = {
|
|
1916
|
+
organizationId: paramsOrFirst as string
|
|
1917
|
+
};
|
|
1918
|
+
}
|
|
1919
|
+
|
|
1920
|
+
const organizationId = params.organizationId;
|
|
1921
|
+
|
|
891
1922
|
if (typeof organizationId === 'undefined') {
|
|
892
1923
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
893
1924
|
}
|
|
1925
|
+
|
|
894
1926
|
const apiPath = '/organizations/{organizationId}/plan'.replace('{organizationId}', organizationId);
|
|
895
1927
|
const payload: Payload = {};
|
|
896
1928
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -905,27 +1937,75 @@ export class Organizations {
|
|
|
905
1937
|
payload
|
|
906
1938
|
);
|
|
907
1939
|
}
|
|
1940
|
+
|
|
1941
|
+
/**
|
|
1942
|
+
* Update the billing plan for an organization.
|
|
1943
|
+
*
|
|
1944
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
1945
|
+
* @param {string} params.billingPlan - Organization billing plan chosen
|
|
1946
|
+
* @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.
|
|
1947
|
+
* @param {string} params.billingAddressId - Unique ID of billing address
|
|
1948
|
+
* @param {string[]} params.invites - Additional member invites
|
|
1949
|
+
* @param {string} params.couponId - Coupon id
|
|
1950
|
+
* @param {string} params.taxId - Tax Id associated to billing.
|
|
1951
|
+
* @param {number} params.budget - Budget limit for additional usage set for the organization
|
|
1952
|
+
* @throws {AppwriteException}
|
|
1953
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1954
|
+
*/
|
|
1955
|
+
updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number }): Promise<Models.Organization<Preferences>>;
|
|
908
1956
|
/**
|
|
909
1957
|
* Update the billing plan for an organization.
|
|
910
1958
|
*
|
|
911
|
-
* @param {string} organizationId
|
|
912
|
-
* @param {
|
|
913
|
-
* @param {string} paymentMethodId
|
|
914
|
-
* @param {string} billingAddressId
|
|
915
|
-
* @param {string[]} invites
|
|
916
|
-
* @param {string} couponId
|
|
917
|
-
* @param {string} taxId
|
|
918
|
-
* @param {number} budget
|
|
1959
|
+
* @param {string} organizationId - Organization Unique ID
|
|
1960
|
+
* @param {string} billingPlan - Organization billing plan chosen
|
|
1961
|
+
* @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
|
|
1962
|
+
* @param {string} billingAddressId - Unique ID of billing address
|
|
1963
|
+
* @param {string[]} invites - Additional member invites
|
|
1964
|
+
* @param {string} couponId - Coupon id
|
|
1965
|
+
* @param {string} taxId - Tax Id associated to billing.
|
|
1966
|
+
* @param {number} budget - Budget limit for additional usage set for the organization
|
|
919
1967
|
* @throws {AppwriteException}
|
|
920
1968
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1969
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
921
1970
|
*/
|
|
922
|
-
updatePlan<Preferences extends Models.Preferences>(organizationId: string, billingPlan:
|
|
1971
|
+
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>>;
|
|
1972
|
+
updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
1973
|
+
paramsOrFirst: { organizationId: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number } | string,
|
|
1974
|
+
...rest: [(string)?, (string)?, (string)?, (string[])?, (string)?, (string)?, (number)?]
|
|
1975
|
+
): Promise<Models.Organization<Preferences>> {
|
|
1976
|
+
let params: { organizationId: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number };
|
|
1977
|
+
|
|
1978
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1979
|
+
params = (paramsOrFirst || {}) as { organizationId: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number };
|
|
1980
|
+
} else {
|
|
1981
|
+
params = {
|
|
1982
|
+
organizationId: paramsOrFirst as string,
|
|
1983
|
+
billingPlan: rest[0] as string,
|
|
1984
|
+
paymentMethodId: rest[1] as string,
|
|
1985
|
+
billingAddressId: rest[2] as string,
|
|
1986
|
+
invites: rest[3] as string[],
|
|
1987
|
+
couponId: rest[4] as string,
|
|
1988
|
+
taxId: rest[5] as string,
|
|
1989
|
+
budget: rest[6] as number
|
|
1990
|
+
};
|
|
1991
|
+
}
|
|
1992
|
+
|
|
1993
|
+
const organizationId = params.organizationId;
|
|
1994
|
+
const billingPlan = params.billingPlan;
|
|
1995
|
+
const paymentMethodId = params.paymentMethodId;
|
|
1996
|
+
const billingAddressId = params.billingAddressId;
|
|
1997
|
+
const invites = params.invites;
|
|
1998
|
+
const couponId = params.couponId;
|
|
1999
|
+
const taxId = params.taxId;
|
|
2000
|
+
const budget = params.budget;
|
|
2001
|
+
|
|
923
2002
|
if (typeof organizationId === 'undefined') {
|
|
924
2003
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
925
2004
|
}
|
|
926
2005
|
if (typeof billingPlan === 'undefined') {
|
|
927
2006
|
throw new AppwriteException('Missing required parameter: "billingPlan"');
|
|
928
2007
|
}
|
|
2008
|
+
|
|
929
2009
|
const apiPath = '/organizations/{organizationId}/plan'.replace('{organizationId}', organizationId);
|
|
930
2010
|
const payload: Payload = {};
|
|
931
2011
|
if (typeof billingPlan !== 'undefined') {
|
|
@@ -962,17 +2042,43 @@ export class Organizations {
|
|
|
962
2042
|
payload
|
|
963
2043
|
);
|
|
964
2044
|
}
|
|
2045
|
+
|
|
2046
|
+
/**
|
|
2047
|
+
* Cancel the downgrade initiated for an organization.
|
|
2048
|
+
*
|
|
2049
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
2050
|
+
* @throws {AppwriteException}
|
|
2051
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
2052
|
+
*/
|
|
2053
|
+
cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string }): Promise<Models.Organization<Preferences>>;
|
|
965
2054
|
/**
|
|
966
2055
|
* Cancel the downgrade initiated for an organization.
|
|
967
2056
|
*
|
|
968
|
-
* @param {string} organizationId
|
|
2057
|
+
* @param {string} organizationId - Organization Unique ID
|
|
969
2058
|
* @throws {AppwriteException}
|
|
970
2059
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
2060
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
971
2061
|
*/
|
|
972
|
-
cancelDowngrade<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences
|
|
2062
|
+
cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
2063
|
+
cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
2064
|
+
paramsOrFirst: { organizationId: string } | string
|
|
2065
|
+
): Promise<Models.Organization<Preferences>> {
|
|
2066
|
+
let params: { organizationId: string };
|
|
2067
|
+
|
|
2068
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2069
|
+
params = (paramsOrFirst || {}) as { organizationId: string };
|
|
2070
|
+
} else {
|
|
2071
|
+
params = {
|
|
2072
|
+
organizationId: paramsOrFirst as string
|
|
2073
|
+
};
|
|
2074
|
+
}
|
|
2075
|
+
|
|
2076
|
+
const organizationId = params.organizationId;
|
|
2077
|
+
|
|
973
2078
|
if (typeof organizationId === 'undefined') {
|
|
974
2079
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
975
2080
|
}
|
|
2081
|
+
|
|
976
2082
|
const apiPath = '/organizations/{organizationId}/plan/cancel'.replace('{organizationId}', organizationId);
|
|
977
2083
|
const payload: Payload = {};
|
|
978
2084
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -988,17 +2094,103 @@ export class Organizations {
|
|
|
988
2094
|
payload
|
|
989
2095
|
);
|
|
990
2096
|
}
|
|
2097
|
+
|
|
2098
|
+
/**
|
|
2099
|
+
* Update selected projects to keep in the organization.
|
|
2100
|
+
*
|
|
2101
|
+
* @param {string} params.organizationId - Organization Unique ID
|
|
2102
|
+
* @param {string[]} params.projects - List of project IDs to be selected for the organization
|
|
2103
|
+
* @throws {AppwriteException}
|
|
2104
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
2105
|
+
*/
|
|
2106
|
+
updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string, projects?: string[] }): Promise<Models.Organization<Preferences>>;
|
|
2107
|
+
/**
|
|
2108
|
+
* Update selected projects to keep in the organization.
|
|
2109
|
+
*
|
|
2110
|
+
* @param {string} organizationId - Organization Unique ID
|
|
2111
|
+
* @param {string[]} projects - List of project IDs to be selected for the organization
|
|
2112
|
+
* @throws {AppwriteException}
|
|
2113
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
2114
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2115
|
+
*/
|
|
2116
|
+
updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, projects?: string[]): Promise<Models.Organization<Preferences>>;
|
|
2117
|
+
updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
2118
|
+
paramsOrFirst: { organizationId: string, projects?: string[] } | string,
|
|
2119
|
+
...rest: [(string[])?]
|
|
2120
|
+
): Promise<Models.Organization<Preferences>> {
|
|
2121
|
+
let params: { organizationId: string, projects?: string[] };
|
|
2122
|
+
|
|
2123
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2124
|
+
params = (paramsOrFirst || {}) as { organizationId: string, projects?: string[] };
|
|
2125
|
+
} else {
|
|
2126
|
+
params = {
|
|
2127
|
+
organizationId: paramsOrFirst as string,
|
|
2128
|
+
projects: rest[0] as string[]
|
|
2129
|
+
};
|
|
2130
|
+
}
|
|
2131
|
+
|
|
2132
|
+
const organizationId = params.organizationId;
|
|
2133
|
+
const projects = params.projects;
|
|
2134
|
+
|
|
2135
|
+
if (typeof organizationId === 'undefined') {
|
|
2136
|
+
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
2137
|
+
}
|
|
2138
|
+
|
|
2139
|
+
const apiPath = '/organizations/{organizationId}/projects'.replace('{organizationId}', organizationId);
|
|
2140
|
+
const payload: Payload = {};
|
|
2141
|
+
if (typeof projects !== 'undefined') {
|
|
2142
|
+
payload['projects'] = projects;
|
|
2143
|
+
}
|
|
2144
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
2145
|
+
|
|
2146
|
+
const apiHeaders: { [header: string]: string } = {
|
|
2147
|
+
'content-type': 'application/json',
|
|
2148
|
+
}
|
|
2149
|
+
|
|
2150
|
+
return this.client.call(
|
|
2151
|
+
'patch',
|
|
2152
|
+
uri,
|
|
2153
|
+
apiHeaders,
|
|
2154
|
+
payload
|
|
2155
|
+
);
|
|
2156
|
+
}
|
|
2157
|
+
|
|
2158
|
+
/**
|
|
2159
|
+
* Get Scopes
|
|
2160
|
+
*
|
|
2161
|
+
* @param {string} params.organizationId - Organization id
|
|
2162
|
+
* @throws {AppwriteException}
|
|
2163
|
+
* @returns {Promise<Models.Roles>}
|
|
2164
|
+
*/
|
|
2165
|
+
getScopes(params: { organizationId: string }): Promise<Models.Roles>;
|
|
991
2166
|
/**
|
|
992
2167
|
* Get Scopes
|
|
993
2168
|
*
|
|
994
|
-
* @param {string} organizationId
|
|
2169
|
+
* @param {string} organizationId - Organization id
|
|
995
2170
|
* @throws {AppwriteException}
|
|
996
2171
|
* @returns {Promise<Models.Roles>}
|
|
2172
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
997
2173
|
*/
|
|
998
|
-
getScopes(organizationId: string): Promise<Models.Roles
|
|
2174
|
+
getScopes(organizationId: string): Promise<Models.Roles>;
|
|
2175
|
+
getScopes(
|
|
2176
|
+
paramsOrFirst: { organizationId: string } | string
|
|
2177
|
+
): Promise<Models.Roles> {
|
|
2178
|
+
let params: { organizationId: string };
|
|
2179
|
+
|
|
2180
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2181
|
+
params = (paramsOrFirst || {}) as { organizationId: string };
|
|
2182
|
+
} else {
|
|
2183
|
+
params = {
|
|
2184
|
+
organizationId: paramsOrFirst as string
|
|
2185
|
+
};
|
|
2186
|
+
}
|
|
2187
|
+
|
|
2188
|
+
const organizationId = params.organizationId;
|
|
2189
|
+
|
|
999
2190
|
if (typeof organizationId === 'undefined') {
|
|
1000
2191
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
1001
2192
|
}
|
|
2193
|
+
|
|
1002
2194
|
const apiPath = '/organizations/{organizationId}/roles'.replace('{organizationId}', organizationId);
|
|
1003
2195
|
const payload: Payload = {};
|
|
1004
2196
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -1013,21 +2205,51 @@ export class Organizations {
|
|
|
1013
2205
|
payload
|
|
1014
2206
|
);
|
|
1015
2207
|
}
|
|
2208
|
+
|
|
1016
2209
|
/**
|
|
1017
|
-
* Set an organization
|
|
2210
|
+
* Set an organization's billing tax ID.
|
|
1018
2211
|
*
|
|
1019
|
-
* @param {string} organizationId
|
|
1020
|
-
* @param {string} taxId
|
|
2212
|
+
* @param {string} params.organizationId - Organization ID
|
|
2213
|
+
* @param {string} params.taxId - Tax Id associated to billing.
|
|
1021
2214
|
* @throws {AppwriteException}
|
|
1022
2215
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1023
2216
|
*/
|
|
1024
|
-
setBillingTaxId<Preferences extends Models.Preferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences
|
|
2217
|
+
setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string, taxId: string }): Promise<Models.Organization<Preferences>>;
|
|
2218
|
+
/**
|
|
2219
|
+
* Set an organization's billing tax ID.
|
|
2220
|
+
*
|
|
2221
|
+
* @param {string} organizationId - Organization ID
|
|
2222
|
+
* @param {string} taxId - Tax Id associated to billing.
|
|
2223
|
+
* @throws {AppwriteException}
|
|
2224
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
2225
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2226
|
+
*/
|
|
2227
|
+
setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>>;
|
|
2228
|
+
setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
2229
|
+
paramsOrFirst: { organizationId: string, taxId: string } | string,
|
|
2230
|
+
...rest: [(string)?]
|
|
2231
|
+
): Promise<Models.Organization<Preferences>> {
|
|
2232
|
+
let params: { organizationId: string, taxId: string };
|
|
2233
|
+
|
|
2234
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2235
|
+
params = (paramsOrFirst || {}) as { organizationId: string, taxId: string };
|
|
2236
|
+
} else {
|
|
2237
|
+
params = {
|
|
2238
|
+
organizationId: paramsOrFirst as string,
|
|
2239
|
+
taxId: rest[0] as string
|
|
2240
|
+
};
|
|
2241
|
+
}
|
|
2242
|
+
|
|
2243
|
+
const organizationId = params.organizationId;
|
|
2244
|
+
const taxId = params.taxId;
|
|
2245
|
+
|
|
1025
2246
|
if (typeof organizationId === 'undefined') {
|
|
1026
2247
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
1027
2248
|
}
|
|
1028
2249
|
if (typeof taxId === 'undefined') {
|
|
1029
2250
|
throw new AppwriteException('Missing required parameter: "taxId"');
|
|
1030
2251
|
}
|
|
2252
|
+
|
|
1031
2253
|
const apiPath = '/organizations/{organizationId}/taxId'.replace('{organizationId}', organizationId);
|
|
1032
2254
|
const payload: Payload = {};
|
|
1033
2255
|
if (typeof taxId !== 'undefined') {
|
|
@@ -1046,19 +2268,52 @@ export class Organizations {
|
|
|
1046
2268
|
payload
|
|
1047
2269
|
);
|
|
1048
2270
|
}
|
|
2271
|
+
|
|
1049
2272
|
/**
|
|
1050
2273
|
* Get the usage data for an organization.
|
|
1051
2274
|
*
|
|
1052
|
-
* @param {string} organizationId
|
|
1053
|
-
* @param {string} startDate
|
|
1054
|
-
* @param {string} endDate
|
|
2275
|
+
* @param {string} params.organizationId - Organization ID
|
|
2276
|
+
* @param {string} params.startDate - Starting date for the usage
|
|
2277
|
+
* @param {string} params.endDate - End date for the usage
|
|
1055
2278
|
* @throws {AppwriteException}
|
|
1056
2279
|
* @returns {Promise<Models.UsageOrganization>}
|
|
1057
2280
|
*/
|
|
1058
|
-
getUsage(organizationId: string, startDate?: string, endDate?: string): Promise<Models.UsageOrganization
|
|
2281
|
+
getUsage(params: { organizationId: string, startDate?: string, endDate?: string }): Promise<Models.UsageOrganization>;
|
|
2282
|
+
/**
|
|
2283
|
+
* Get the usage data for an organization.
|
|
2284
|
+
*
|
|
2285
|
+
* @param {string} organizationId - Organization ID
|
|
2286
|
+
* @param {string} startDate - Starting date for the usage
|
|
2287
|
+
* @param {string} endDate - End date for the usage
|
|
2288
|
+
* @throws {AppwriteException}
|
|
2289
|
+
* @returns {Promise<Models.UsageOrganization>}
|
|
2290
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2291
|
+
*/
|
|
2292
|
+
getUsage(organizationId: string, startDate?: string, endDate?: string): Promise<Models.UsageOrganization>;
|
|
2293
|
+
getUsage(
|
|
2294
|
+
paramsOrFirst: { organizationId: string, startDate?: string, endDate?: string } | string,
|
|
2295
|
+
...rest: [(string)?, (string)?]
|
|
2296
|
+
): Promise<Models.UsageOrganization> {
|
|
2297
|
+
let params: { organizationId: string, startDate?: string, endDate?: string };
|
|
2298
|
+
|
|
2299
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2300
|
+
params = (paramsOrFirst || {}) as { organizationId: string, startDate?: string, endDate?: string };
|
|
2301
|
+
} else {
|
|
2302
|
+
params = {
|
|
2303
|
+
organizationId: paramsOrFirst as string,
|
|
2304
|
+
startDate: rest[0] as string,
|
|
2305
|
+
endDate: rest[1] as string
|
|
2306
|
+
};
|
|
2307
|
+
}
|
|
2308
|
+
|
|
2309
|
+
const organizationId = params.organizationId;
|
|
2310
|
+
const startDate = params.startDate;
|
|
2311
|
+
const endDate = params.endDate;
|
|
2312
|
+
|
|
1059
2313
|
if (typeof organizationId === 'undefined') {
|
|
1060
2314
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
1061
2315
|
}
|
|
2316
|
+
|
|
1062
2317
|
const apiPath = '/organizations/{organizationId}/usage'.replace('{organizationId}', organizationId);
|
|
1063
2318
|
const payload: Payload = {};
|
|
1064
2319
|
if (typeof startDate !== 'undefined') {
|
|
@@ -1079,18 +2334,48 @@ export class Organizations {
|
|
|
1079
2334
|
payload
|
|
1080
2335
|
);
|
|
1081
2336
|
}
|
|
2337
|
+
|
|
2338
|
+
/**
|
|
2339
|
+
* Validate payment for team after creation or upgrade.
|
|
2340
|
+
*
|
|
2341
|
+
* @param {string} params.organizationId - Organization ID
|
|
2342
|
+
* @param {string[]} params.invites - Additional member invites
|
|
2343
|
+
* @throws {AppwriteException}
|
|
2344
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
2345
|
+
*/
|
|
2346
|
+
validatePayment<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { organizationId: string, invites?: string[] }): Promise<Models.Organization<Preferences>>;
|
|
1082
2347
|
/**
|
|
1083
2348
|
* Validate payment for team after creation or upgrade.
|
|
1084
2349
|
*
|
|
1085
|
-
* @param {string} organizationId
|
|
1086
|
-
* @param {string[]} invites
|
|
2350
|
+
* @param {string} organizationId - Organization ID
|
|
2351
|
+
* @param {string[]} invites - Additional member invites
|
|
1087
2352
|
* @throws {AppwriteException}
|
|
1088
2353
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
2354
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1089
2355
|
*/
|
|
1090
|
-
validatePayment<Preferences extends Models.Preferences>(organizationId: string, invites?: string[]): Promise<Models.Organization<Preferences
|
|
2356
|
+
validatePayment<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, invites?: string[]): Promise<Models.Organization<Preferences>>;
|
|
2357
|
+
validatePayment<Preferences extends Models.Preferences = Models.DefaultPreferences>(
|
|
2358
|
+
paramsOrFirst: { organizationId: string, invites?: string[] } | string,
|
|
2359
|
+
...rest: [(string[])?]
|
|
2360
|
+
): Promise<Models.Organization<Preferences>> {
|
|
2361
|
+
let params: { organizationId: string, invites?: string[] };
|
|
2362
|
+
|
|
2363
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
2364
|
+
params = (paramsOrFirst || {}) as { organizationId: string, invites?: string[] };
|
|
2365
|
+
} else {
|
|
2366
|
+
params = {
|
|
2367
|
+
organizationId: paramsOrFirst as string,
|
|
2368
|
+
invites: rest[0] as string[]
|
|
2369
|
+
};
|
|
2370
|
+
}
|
|
2371
|
+
|
|
2372
|
+
const organizationId = params.organizationId;
|
|
2373
|
+
const invites = params.invites;
|
|
2374
|
+
|
|
1091
2375
|
if (typeof organizationId === 'undefined') {
|
|
1092
2376
|
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
1093
2377
|
}
|
|
2378
|
+
|
|
1094
2379
|
const apiPath = '/organizations/{organizationId}/validate'.replace('{organizationId}', organizationId);
|
|
1095
2380
|
const payload: Payload = {};
|
|
1096
2381
|
if (typeof invites !== 'undefined') {
|