@appwrite.io/console 1.9.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yml +9 -8
- package/CHANGELOG.md +51 -6
- package/LICENSE +1 -1
- package/README.md +84 -4
- package/dist/cjs/sdk.js +15258 -6036
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +15256 -6037
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +15258 -6036
- package/docs/examples/account/create-billing-address.md +8 -8
- package/docs/examples/account/create-email-password-session.md +4 -4
- package/docs/examples/account/create-email-token.md +5 -5
- package/docs/examples/account/{update-magic-u-r-l-session.md → create-email-verification.md} +3 -4
- package/docs/examples/account/{update-m-f-a.md → create-jwt.md} +3 -3
- package/docs/examples/account/{create-magic-u-r-l-token.md → create-magic-url-token.md} +6 -6
- package/docs/examples/account/create-mfa-authenticator.md +3 -3
- package/docs/examples/account/create-mfa-challenge.md +3 -3
- package/docs/examples/account/create-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-o-auth2token.md → create-o-auth-2-session.md} +6 -6
- package/docs/examples/account/{create-o-auth2session.md → create-o-auth-2-token.md} +6 -6
- package/docs/examples/account/create-phone-token.md +4 -4
- package/docs/examples/account/create-push-target.md +5 -5
- package/docs/examples/account/create-recovery.md +4 -4
- package/docs/examples/account/create-session.md +4 -4
- package/docs/examples/account/create-verification.md +3 -3
- package/docs/examples/account/create.md +6 -6
- package/docs/examples/account/delete-billing-address.md +3 -3
- package/docs/examples/account/delete-identity.md +3 -3
- package/docs/examples/account/delete-mfa-authenticator.md +3 -3
- package/docs/examples/account/delete-payment-method.md +3 -3
- package/docs/examples/account/delete-push-target.md +3 -3
- package/docs/examples/account/delete-session.md +3 -3
- package/docs/examples/account/get-billing-address.md +3 -3
- package/docs/examples/account/get-coupon.md +3 -3
- package/docs/examples/account/get-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/get-payment-method.md +3 -3
- package/docs/examples/account/get-session.md +3 -3
- package/docs/examples/account/list-billing-addresses.md +3 -3
- package/docs/examples/account/list-identities.md +4 -3
- package/docs/examples/account/list-invoices.md +3 -3
- package/docs/examples/account/list-logs.md +4 -3
- package/docs/examples/account/list-mfa-factors.md +1 -1
- package/docs/examples/account/list-payment-methods.md +3 -3
- package/docs/examples/account/update-billing-address.md +9 -9
- package/docs/examples/account/update-email-verification.md +14 -0
- package/docs/examples/account/update-email.md +4 -4
- package/docs/examples/account/update-magic-url-session.md +14 -0
- package/docs/examples/account/update-mfa-authenticator.md +4 -4
- package/docs/examples/account/update-mfa-challenge.md +4 -4
- package/docs/examples/account/update-mfa-recovery-codes.md +1 -1
- package/docs/examples/account/{create-j-w-t.md → update-mfa.md} +3 -1
- package/docs/examples/account/update-name.md +3 -3
- package/docs/examples/account/update-password.md +4 -4
- package/docs/examples/account/update-payment-method-mandate-options.md +3 -3
- package/docs/examples/account/update-payment-method-provider.md +6 -5
- package/docs/examples/account/update-payment-method.md +6 -5
- package/docs/examples/account/update-phone-session.md +4 -4
- package/docs/examples/account/update-phone-verification.md +4 -4
- package/docs/examples/account/update-phone.md +4 -4
- package/docs/examples/account/update-prefs.md +7 -3
- package/docs/examples/account/update-push-target.md +4 -4
- package/docs/examples/account/update-recovery.md +5 -5
- package/docs/examples/account/update-session.md +3 -3
- package/docs/examples/account/update-verification.md +4 -4
- package/docs/examples/assistant/chat.md +3 -3
- package/docs/examples/avatars/get-browser.md +6 -6
- package/docs/examples/avatars/get-credit-card.md +6 -6
- package/docs/examples/avatars/get-favicon.md +3 -3
- package/docs/examples/avatars/get-flag.md +6 -6
- package/docs/examples/avatars/get-image.md +5 -5
- package/docs/examples/avatars/get-initials.md +6 -6
- package/docs/examples/avatars/{get-q-r.md → get-qr.md} +6 -6
- package/docs/examples/avatars/get-screenshot.md +35 -0
- package/docs/examples/backups/create-archive.md +4 -4
- package/docs/examples/backups/create-policy.md +9 -9
- package/docs/examples/backups/create-restoration.md +6 -6
- package/docs/examples/backups/delete-archive.md +3 -3
- package/docs/examples/backups/delete-policy.md +3 -3
- package/docs/examples/backups/get-archive.md +3 -3
- package/docs/examples/backups/get-policy.md +3 -3
- package/docs/examples/backups/get-restoration.md +3 -3
- package/docs/examples/backups/list-archives.md +3 -3
- package/docs/examples/backups/list-policies.md +3 -3
- package/docs/examples/backups/list-restorations.md +3 -3
- package/docs/examples/backups/update-policy.md +7 -7
- package/docs/examples/console/create-program-membership.md +3 -3
- package/docs/examples/console/create-source.md +7 -7
- package/docs/examples/console/get-campaign.md +3 -3
- package/docs/examples/console/get-coupon.md +3 -3
- package/docs/examples/console/{plans.md → get-plan.md} +3 -1
- package/docs/examples/console/get-plans.md +13 -0
- package/docs/examples/console/{regions.md → get-program.md} +3 -1
- package/docs/examples/console/get-regions.md +13 -0
- package/docs/examples/console/get-resource.md +4 -4
- package/docs/examples/console/suggest-columns.md +17 -0
- package/docs/examples/console/suggest-indexes.md +16 -0
- package/docs/examples/databases/create-boolean-attribute.md +8 -8
- package/docs/examples/databases/create-collection.md +11 -9
- package/docs/examples/databases/create-datetime-attribute.md +8 -8
- package/docs/examples/databases/create-document.md +16 -11
- package/docs/examples/databases/create-documents.md +7 -6
- package/docs/examples/databases/create-email-attribute.md +8 -8
- package/docs/examples/databases/create-enum-attribute.md +9 -9
- package/docs/examples/databases/create-float-attribute.md +10 -10
- package/docs/examples/databases/create-index.md +9 -9
- package/docs/examples/databases/create-integer-attribute.md +10 -10
- package/docs/examples/databases/create-ip-attribute.md +8 -8
- package/docs/examples/databases/create-line-attribute.md +17 -0
- package/docs/examples/databases/create-operations.md +24 -0
- package/docs/examples/databases/create-point-attribute.md +17 -0
- package/docs/examples/databases/create-polygon-attribute.md +17 -0
- package/docs/examples/databases/create-relationship-attribute.md +10 -10
- package/docs/examples/databases/create-string-attribute.md +10 -10
- package/docs/examples/databases/create-transaction.md +13 -0
- package/docs/examples/databases/create-url-attribute.md +8 -8
- package/docs/examples/databases/create.md +5 -5
- package/docs/examples/databases/decrement-document-attribute.md +9 -8
- package/docs/examples/databases/delete-attribute.md +5 -5
- package/docs/examples/databases/delete-collection.md +4 -4
- package/docs/examples/databases/delete-document.md +6 -5
- package/docs/examples/databases/delete-documents.md +6 -5
- package/docs/examples/databases/delete-index.md +5 -5
- package/docs/examples/databases/{get-database-usage.md → delete-transaction.md} +4 -5
- package/docs/examples/databases/delete.md +3 -3
- package/docs/examples/databases/get-attribute.md +5 -5
- package/docs/examples/databases/get-collection-usage.md +6 -6
- package/docs/examples/databases/get-collection.md +4 -4
- package/docs/examples/databases/get-document.md +7 -6
- package/docs/examples/databases/get-index.md +5 -5
- package/docs/examples/databases/get-transaction.md +13 -0
- package/docs/examples/databases/get-usage.md +5 -4
- package/docs/examples/databases/get.md +3 -3
- package/docs/examples/databases/increment-document-attribute.md +9 -8
- package/docs/examples/databases/list-attributes.md +6 -5
- package/docs/examples/databases/list-collection-logs.md +5 -5
- package/docs/examples/databases/list-collections.md +6 -5
- package/docs/examples/databases/list-document-logs.md +6 -6
- package/docs/examples/databases/list-documents.md +7 -5
- package/docs/examples/databases/list-indexes.md +6 -5
- package/docs/examples/databases/list-logs.md +4 -4
- package/docs/examples/databases/list-transactions.md +13 -0
- package/docs/examples/databases/list-usage.md +13 -0
- package/docs/examples/databases/list.md +5 -4
- package/docs/examples/databases/update-boolean-attribute.md +8 -8
- package/docs/examples/databases/update-collection.md +9 -9
- package/docs/examples/databases/update-datetime-attribute.md +8 -8
- package/docs/examples/databases/update-document.md +15 -8
- package/docs/examples/databases/update-documents.md +13 -6
- package/docs/examples/databases/update-email-attribute.md +8 -8
- package/docs/examples/databases/update-enum-attribute.md +9 -9
- package/docs/examples/databases/update-float-attribute.md +10 -10
- package/docs/examples/databases/update-integer-attribute.md +10 -10
- package/docs/examples/databases/update-ip-attribute.md +8 -8
- package/docs/examples/databases/update-line-attribute.md +18 -0
- package/docs/examples/databases/update-point-attribute.md +18 -0
- package/docs/examples/databases/update-polygon-attribute.md +18 -0
- package/docs/examples/databases/update-relationship-attribute.md +7 -7
- package/docs/examples/databases/update-string-attribute.md +9 -9
- package/docs/examples/databases/update-transaction.md +15 -0
- package/docs/examples/databases/update-url-attribute.md +8 -8
- package/docs/examples/databases/update.md +5 -5
- package/docs/examples/databases/upsert-document.md +15 -8
- package/docs/examples/databases/upsert-documents.md +6 -5
- package/docs/examples/domains/create-preset-google-workspace.md +3 -3
- package/docs/examples/domains/create-preset-i-cloud.md +3 -3
- package/docs/examples/domains/create-preset-mailgun.md +3 -3
- package/docs/examples/domains/create-preset-outlook.md +3 -3
- package/docs/examples/domains/create-preset-proton-mail.md +3 -3
- package/docs/examples/domains/create-preset-zoho.md +3 -3
- package/docs/examples/domains/create-record-a.md +7 -7
- package/docs/examples/domains/{create-record-a-a-a-a.md → create-record-aaaa.md} +7 -7
- package/docs/examples/domains/create-record-alias.md +7 -7
- package/docs/examples/domains/{create-record-n-s.md → create-record-caa.md} +7 -7
- package/docs/examples/domains/{create-record-c-a-a.md → create-record-cname.md} +7 -7
- package/docs/examples/domains/{create-record-h-t-t-p-s.md → create-record-https.md} +7 -7
- package/docs/examples/domains/create-record-mx.md +18 -0
- package/docs/examples/domains/create-record-ns.md +17 -0
- package/docs/examples/domains/create-record-srv.md +20 -0
- package/docs/examples/domains/{create-record-c-n-a-m-e.md → create-record-txt.md} +7 -7
- package/docs/examples/domains/create.md +4 -4
- package/docs/examples/domains/delete-record.md +4 -4
- package/docs/examples/domains/delete.md +3 -3
- package/docs/examples/domains/get-preset-google-workspace.md +3 -3
- package/docs/examples/domains/get-preset-i-cloud.md +3 -3
- package/docs/examples/domains/get-preset-mailgun.md +3 -3
- package/docs/examples/domains/get-preset-outlook.md +3 -3
- package/docs/examples/domains/get-preset-proton-mail.md +3 -3
- package/docs/examples/domains/get-preset-zoho.md +3 -3
- package/docs/examples/domains/get-record.md +4 -4
- package/docs/examples/domains/get-zone.md +3 -3
- package/docs/examples/domains/get.md +3 -3
- package/docs/examples/domains/list-records.md +4 -4
- package/docs/examples/domains/list.md +4 -4
- package/docs/examples/domains/update-nameservers.md +3 -3
- package/docs/examples/domains/update-record-a.md +8 -8
- package/docs/examples/domains/update-record-aaaa.md +18 -0
- package/docs/examples/domains/update-record-alias.md +8 -8
- package/docs/examples/domains/update-record-caa.md +18 -0
- package/docs/examples/domains/update-record-cname.md +18 -0
- package/docs/examples/domains/update-record-https.md +18 -0
- package/docs/examples/domains/update-record-mx.md +19 -0
- package/docs/examples/domains/update-record-ns.md +18 -0
- package/docs/examples/domains/update-record-srv.md +21 -0
- package/docs/examples/domains/update-record-txt.md +18 -0
- package/docs/examples/domains/update-team.md +4 -4
- package/docs/examples/domains/update-zone.md +4 -4
- package/docs/examples/functions/create-deployment.md +7 -7
- package/docs/examples/functions/create-duplicate-deployment.md +5 -5
- package/docs/examples/functions/create-execution.md +9 -9
- package/docs/examples/functions/create-template-deployment.md +10 -9
- package/docs/examples/functions/create-variable.md +6 -6
- package/docs/examples/functions/create-vcs-deployment.md +7 -7
- package/docs/examples/functions/create.md +21 -21
- package/docs/examples/functions/delete-deployment.md +4 -4
- package/docs/examples/functions/delete-execution.md +4 -4
- package/docs/examples/functions/delete-variable.md +4 -4
- package/docs/examples/functions/delete.md +3 -3
- package/docs/examples/functions/get-deployment-download.md +5 -5
- package/docs/examples/functions/get-deployment.md +4 -4
- package/docs/examples/functions/get-execution.md +4 -4
- package/docs/examples/functions/get-template.md +3 -3
- package/docs/examples/functions/get-usage.md +5 -5
- package/docs/examples/functions/get-variable.md +4 -4
- package/docs/examples/functions/get.md +3 -3
- package/docs/examples/functions/list-deployments.md +6 -5
- package/docs/examples/functions/list-executions.md +5 -4
- package/docs/examples/functions/list-templates.md +7 -6
- package/docs/examples/functions/list-usage.md +4 -4
- package/docs/examples/functions/list-variables.md +3 -3
- package/docs/examples/functions/list.md +5 -4
- package/docs/examples/functions/update-deployment-status.md +4 -4
- package/docs/examples/functions/update-function-deployment.md +4 -4
- package/docs/examples/functions/update-variable.md +7 -7
- package/docs/examples/functions/update.md +21 -21
- package/docs/examples/graphql/mutation.md +3 -3
- package/docs/examples/graphql/query.md +3 -3
- package/docs/examples/health/get-certificate.md +3 -3
- package/docs/examples/health/get-failed-jobs.md +5 -5
- package/docs/examples/health/get-queue-billing-project-aggregation.md +3 -3
- package/docs/examples/health/get-queue-billing-team-aggregation.md +3 -3
- package/docs/examples/health/get-queue-builds.md +3 -3
- package/docs/examples/health/get-queue-certificates.md +3 -3
- package/docs/examples/health/get-queue-databases.md +4 -4
- package/docs/examples/health/get-queue-deletes.md +3 -3
- package/docs/examples/health/get-queue-functions.md +3 -3
- package/docs/examples/health/get-queue-logs.md +3 -3
- package/docs/examples/health/get-queue-mails.md +3 -3
- package/docs/examples/health/get-queue-messaging.md +3 -3
- package/docs/examples/health/get-queue-migrations.md +3 -3
- package/docs/examples/health/get-queue-priority-builds.md +3 -3
- package/docs/examples/health/get-queue-region-manager.md +3 -3
- package/docs/examples/health/get-queue-stats-resources.md +3 -3
- package/docs/examples/health/get-queue-threats.md +13 -0
- package/docs/examples/health/get-queue-usage.md +3 -3
- package/docs/examples/health/get-queue-webhooks.md +3 -3
- package/docs/examples/messaging/create-apns-provider.md +10 -10
- package/docs/examples/messaging/create-email.md +14 -14
- package/docs/examples/messaging/create-fcm-provider.md +6 -6
- package/docs/examples/messaging/create-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{create-msg91provider.md → create-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/create-push.md +21 -21
- package/docs/examples/messaging/create-resend-provider.md +20 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/create-sms.md +9 -9
- package/docs/examples/messaging/create-smtp-provider.md +16 -16
- package/docs/examples/messaging/create-subscriber.md +5 -5
- package/docs/examples/messaging/create-telesign-provider.md +8 -8
- package/docs/examples/messaging/create-textmagic-provider.md +8 -8
- package/docs/examples/messaging/create-topic.md +5 -5
- package/docs/examples/messaging/create-twilio-provider.md +8 -8
- package/docs/examples/messaging/create-vonage-provider.md +8 -8
- package/docs/examples/messaging/delete-provider.md +3 -3
- package/docs/examples/messaging/delete-subscriber.md +4 -4
- package/docs/examples/messaging/delete-topic.md +3 -3
- package/docs/examples/messaging/delete.md +3 -3
- package/docs/examples/messaging/get-message.md +3 -3
- package/docs/examples/messaging/get-provider.md +3 -3
- package/docs/examples/messaging/get-subscriber.md +4 -4
- package/docs/examples/messaging/get-topic.md +3 -3
- package/docs/examples/messaging/list-message-logs.md +5 -4
- package/docs/examples/messaging/list-messages.md +5 -4
- package/docs/examples/messaging/list-provider-logs.md +5 -4
- package/docs/examples/messaging/list-providers.md +5 -4
- package/docs/examples/messaging/list-subscriber-logs.md +5 -4
- package/docs/examples/messaging/list-subscribers.md +6 -5
- package/docs/examples/messaging/list-targets.md +5 -4
- package/docs/examples/messaging/list-topic-logs.md +5 -4
- package/docs/examples/messaging/list-topics.md +5 -4
- package/docs/examples/messaging/update-apns-provider.md +10 -10
- package/docs/examples/messaging/update-email.md +14 -14
- package/docs/examples/messaging/update-fcm-provider.md +6 -6
- package/docs/examples/messaging/update-mailgun-provider.md +12 -12
- package/docs/examples/messaging/{update-msg91provider.md → update-msg-91-provider.md} +8 -8
- package/docs/examples/messaging/update-push.md +21 -21
- package/docs/examples/messaging/update-resend-provider.md +20 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +10 -10
- package/docs/examples/messaging/update-sms.md +9 -9
- package/docs/examples/messaging/update-smtp-provider.md +16 -16
- package/docs/examples/messaging/update-telesign-provider.md +8 -8
- package/docs/examples/messaging/update-textmagic-provider.md +8 -8
- package/docs/examples/messaging/update-topic.md +5 -5
- package/docs/examples/messaging/update-twilio-provider.md +8 -8
- package/docs/examples/messaging/update-vonage-provider.md +8 -8
- package/docs/examples/migrations/create-appwrite-migration.md +6 -6
- package/docs/examples/migrations/create-csv-export.md +21 -0
- package/docs/examples/migrations/{create-csv-migration.md → create-csv-import.md} +6 -5
- package/docs/examples/migrations/create-firebase-migration.md +4 -4
- package/docs/examples/migrations/create-n-host-migration.md +10 -10
- package/docs/examples/migrations/create-supabase-migration.md +9 -9
- package/docs/examples/migrations/delete.md +3 -3
- package/docs/examples/migrations/get-appwrite-report.md +6 -6
- package/docs/examples/migrations/get-firebase-report.md +4 -4
- package/docs/examples/migrations/get-n-host-report.md +10 -10
- package/docs/examples/migrations/get-supabase-report.md +9 -9
- package/docs/examples/migrations/get.md +3 -3
- package/docs/examples/migrations/list.md +5 -4
- package/docs/examples/migrations/retry.md +3 -3
- package/docs/examples/organizations/add-credit.md +4 -4
- package/docs/examples/organizations/cancel-downgrade.md +3 -3
- package/docs/examples/organizations/create-downgrade-feedback.md +17 -0
- package/docs/examples/organizations/create-invoice-payment.md +5 -5
- package/docs/examples/organizations/create.md +13 -12
- package/docs/examples/organizations/delete-backup-payment-method.md +3 -3
- package/docs/examples/organizations/delete-billing-address.md +3 -3
- package/docs/examples/organizations/delete-default-payment-method.md +3 -3
- package/docs/examples/organizations/delete.md +3 -3
- package/docs/examples/organizations/estimation-create-organization.md +8 -7
- package/docs/examples/organizations/estimation-delete-organization.md +3 -3
- package/docs/examples/organizations/estimation-update-plan.md +7 -7
- package/docs/examples/organizations/get-aggregation.md +6 -4
- package/docs/examples/organizations/get-available-credits.md +13 -0
- package/docs/examples/organizations/get-billing-address.md +4 -4
- package/docs/examples/organizations/get-credit.md +4 -4
- package/docs/examples/organizations/get-invoice-download.md +4 -4
- package/docs/examples/organizations/get-invoice-view.md +4 -4
- package/docs/examples/organizations/get-invoice.md +4 -4
- package/docs/examples/organizations/get-payment-method.md +4 -4
- package/docs/examples/organizations/get-plan.md +3 -3
- package/docs/examples/organizations/get-scopes.md +3 -3
- package/docs/examples/organizations/get-usage.md +5 -5
- package/docs/examples/organizations/list-aggregations.md +4 -4
- package/docs/examples/organizations/list-credits.md +4 -4
- package/docs/examples/organizations/list-invoices.md +4 -4
- package/docs/examples/organizations/list.md +4 -4
- package/docs/examples/organizations/set-backup-payment-method.md +4 -4
- package/docs/examples/organizations/set-billing-address.md +4 -4
- package/docs/examples/organizations/set-billing-email.md +4 -4
- package/docs/examples/organizations/set-billing-tax-id.md +4 -4
- package/docs/examples/organizations/set-default-payment-method.md +4 -4
- package/docs/examples/organizations/update-budget.md +5 -5
- package/docs/examples/organizations/update-plan.md +11 -11
- package/docs/examples/organizations/update-projects.md +14 -0
- package/docs/examples/organizations/validate-invoice.md +4 -4
- package/docs/examples/organizations/validate-payment.md +4 -4
- package/docs/examples/project/create-variable.md +5 -5
- package/docs/examples/project/delete-variable.md +3 -3
- package/docs/examples/project/get-usage.md +5 -5
- package/docs/examples/project/get-variable.md +3 -3
- package/docs/examples/project/update-variable.md +6 -6
- package/docs/examples/projects/create-dev-key.md +5 -5
- package/docs/examples/projects/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/projects/create-key.md +6 -6
- package/docs/examples/projects/create-platform.md +8 -8
- package/docs/examples/projects/create-smtp-test.md +12 -12
- package/docs/examples/projects/create-webhook.md +10 -10
- package/docs/examples/projects/create.md +16 -16
- package/docs/examples/projects/delete-dev-key.md +4 -4
- package/docs/examples/projects/delete-email-template.md +5 -5
- package/docs/examples/projects/delete-key.md +4 -4
- package/docs/examples/projects/delete-platform.md +4 -4
- package/docs/examples/projects/delete-sms-template.md +5 -5
- package/docs/examples/projects/delete-webhook.md +4 -4
- package/docs/examples/projects/delete.md +3 -3
- package/docs/examples/projects/get-dev-key.md +4 -4
- package/docs/examples/projects/get-email-template.md +5 -5
- package/docs/examples/projects/get-key.md +4 -4
- package/docs/examples/projects/get-platform.md +4 -4
- package/docs/examples/projects/get-sms-template.md +5 -5
- package/docs/examples/projects/get-webhook.md +4 -4
- package/docs/examples/projects/get.md +3 -3
- package/docs/examples/projects/list-dev-keys.md +4 -4
- package/docs/examples/projects/list-keys.md +4 -3
- package/docs/examples/projects/list-platforms.md +4 -3
- package/docs/examples/projects/list-webhooks.md +4 -3
- package/docs/examples/projects/list.md +5 -4
- package/docs/examples/projects/update-api-status-all.md +4 -4
- package/docs/examples/projects/update-api-status.md +6 -6
- package/docs/examples/projects/update-auth-duration.md +4 -4
- package/docs/examples/projects/update-auth-limit.md +4 -4
- package/docs/examples/projects/update-auth-password-dictionary.md +4 -4
- package/docs/examples/projects/update-auth-password-history.md +4 -4
- package/docs/examples/projects/update-auth-sessions-limit.md +4 -4
- package/docs/examples/projects/update-auth-status.md +5 -5
- package/docs/examples/projects/update-dev-key.md +6 -6
- package/docs/examples/projects/update-email-template.md +10 -10
- package/docs/examples/projects/update-key.md +7 -7
- package/docs/examples/projects/update-memberships-privacy.md +6 -6
- package/docs/examples/projects/update-mock-numbers.md +4 -4
- package/docs/examples/projects/{update-o-auth2.md → update-o-auth-2.md} +7 -7
- package/docs/examples/projects/update-personal-data-check.md +4 -4
- package/docs/examples/projects/update-platform.md +8 -8
- package/docs/examples/projects/update-service-status-all.md +4 -4
- package/docs/examples/projects/update-service-status.md +5 -5
- package/docs/examples/projects/update-session-alerts.md +4 -4
- package/docs/examples/projects/update-session-invalidation.md +14 -0
- package/docs/examples/projects/update-sms-template.md +6 -6
- package/docs/examples/projects/update-smtp.md +12 -12
- package/docs/examples/projects/update-status.md +14 -0
- package/docs/examples/projects/update-team.md +4 -4
- package/docs/examples/projects/update-webhook-signature.md +4 -4
- package/docs/examples/projects/update-webhook.md +11 -11
- package/docs/examples/projects/update.md +13 -13
- package/docs/examples/proxy/{create-a-p-i-rule.md → create-api-rule.md} +3 -3
- package/docs/examples/proxy/create-function-rule.md +5 -5
- package/docs/examples/proxy/create-redirect-rule.md +8 -8
- package/docs/examples/proxy/create-site-rule.md +5 -5
- package/docs/examples/proxy/delete-rule.md +3 -3
- package/docs/examples/proxy/get-rule.md +3 -3
- package/docs/examples/proxy/list-rules.md +5 -4
- package/docs/examples/proxy/update-rule-verification.md +3 -3
- package/docs/examples/sites/create-deployment.md +8 -8
- package/docs/examples/sites/create-duplicate-deployment.md +4 -4
- package/docs/examples/sites/create-template-deployment.md +10 -9
- package/docs/examples/sites/create-variable.md +6 -6
- package/docs/examples/sites/create-vcs-deployment.md +7 -7
- package/docs/examples/sites/create.md +21 -21
- package/docs/examples/sites/delete-deployment.md +4 -4
- package/docs/examples/sites/delete-log.md +4 -4
- package/docs/examples/sites/delete-variable.md +4 -4
- package/docs/examples/sites/delete.md +3 -3
- package/docs/examples/sites/get-deployment-download.md +5 -5
- package/docs/examples/sites/get-deployment.md +4 -4
- package/docs/examples/sites/get-log.md +4 -4
- package/docs/examples/sites/get-template.md +3 -3
- package/docs/examples/sites/get-usage.md +5 -5
- package/docs/examples/sites/get-variable.md +4 -4
- package/docs/examples/sites/get.md +3 -3
- package/docs/examples/sites/list-deployments.md +6 -5
- package/docs/examples/sites/list-logs.md +5 -4
- package/docs/examples/sites/list-templates.md +6 -6
- package/docs/examples/sites/list-usage.md +4 -4
- package/docs/examples/sites/list-variables.md +3 -3
- package/docs/examples/sites/list.md +5 -4
- package/docs/examples/sites/update-deployment-status.md +4 -4
- package/docs/examples/sites/update-site-deployment.md +4 -4
- package/docs/examples/sites/update-variable.md +7 -7
- package/docs/examples/sites/update.md +21 -21
- package/docs/examples/storage/create-bucket.md +14 -13
- package/docs/examples/storage/create-file.md +7 -7
- package/docs/examples/storage/delete-bucket.md +3 -3
- package/docs/examples/storage/delete-file.md +4 -4
- package/docs/examples/storage/get-bucket-usage.md +5 -5
- package/docs/examples/storage/get-bucket.md +3 -3
- package/docs/examples/storage/get-file-download.md +5 -5
- package/docs/examples/storage/get-file-preview.md +16 -16
- package/docs/examples/storage/get-file-view.md +5 -5
- package/docs/examples/storage/get-file.md +4 -4
- package/docs/examples/storage/get-usage.md +4 -4
- package/docs/examples/storage/list-buckets.md +5 -4
- package/docs/examples/storage/list-files.md +6 -5
- package/docs/examples/storage/update-bucket.md +14 -13
- package/docs/examples/storage/update-file.md +7 -7
- package/docs/examples/tablesdb/create-boolean-column.md +18 -0
- package/docs/examples/tablesdb/create-datetime-column.md +18 -0
- package/docs/examples/tablesdb/create-email-column.md +18 -0
- package/docs/examples/tablesdb/create-enum-column.md +19 -0
- package/docs/examples/tablesdb/create-float-column.md +20 -0
- package/docs/examples/tablesdb/create-index.md +19 -0
- package/docs/examples/tablesdb/create-integer-column.md +20 -0
- package/docs/examples/tablesdb/create-ip-column.md +18 -0
- package/docs/examples/tablesdb/create-line-column.md +17 -0
- package/docs/examples/tablesdb/create-operations.md +24 -0
- package/docs/examples/tablesdb/create-point-column.md +17 -0
- package/docs/examples/tablesdb/create-polygon-column.md +17 -0
- package/docs/examples/tablesdb/create-relationship-column.md +20 -0
- package/docs/examples/tablesdb/create-row.md +24 -0
- package/docs/examples/tablesdb/create-rows.md +16 -0
- package/docs/examples/tablesdb/create-string-column.md +20 -0
- package/docs/examples/tablesdb/create-table.md +20 -0
- package/docs/examples/tablesdb/create-transaction.md +13 -0
- package/docs/examples/tablesdb/create-url-column.md +18 -0
- package/docs/examples/tablesdb/create.md +15 -0
- package/docs/examples/tablesdb/decrement-row-column.md +19 -0
- package/docs/examples/tablesdb/delete-column.md +15 -0
- package/docs/examples/tablesdb/delete-index.md +15 -0
- package/docs/examples/tablesdb/delete-row.md +16 -0
- package/docs/examples/tablesdb/delete-rows.md +16 -0
- package/docs/examples/tablesdb/delete-table.md +14 -0
- package/docs/examples/tablesdb/delete-transaction.md +13 -0
- package/docs/examples/tablesdb/delete.md +13 -0
- package/docs/examples/tablesdb/get-column.md +15 -0
- package/docs/examples/tablesdb/get-index.md +15 -0
- package/docs/examples/tablesdb/get-row.md +17 -0
- package/docs/examples/tablesdb/get-table-usage.md +15 -0
- package/docs/examples/tablesdb/get-table.md +14 -0
- package/docs/examples/tablesdb/get-transaction.md +13 -0
- package/docs/examples/tablesdb/get-usage.md +14 -0
- package/docs/examples/tablesdb/get.md +13 -0
- package/docs/examples/tablesdb/increment-row-column.md +19 -0
- package/docs/examples/tablesdb/list-columns.md +16 -0
- package/docs/examples/tablesdb/list-indexes.md +16 -0
- package/docs/examples/tablesdb/list-row-logs.md +16 -0
- package/docs/examples/tablesdb/list-rows.md +17 -0
- package/docs/examples/tablesdb/list-table-logs.md +15 -0
- package/docs/examples/tablesdb/list-tables.md +16 -0
- package/docs/examples/tablesdb/list-transactions.md +13 -0
- package/docs/examples/tablesdb/list-usage.md +13 -0
- package/docs/examples/tablesdb/list.md +15 -0
- package/docs/examples/tablesdb/update-boolean-column.md +18 -0
- package/docs/examples/tablesdb/update-datetime-column.md +18 -0
- package/docs/examples/tablesdb/update-email-column.md +18 -0
- package/docs/examples/tablesdb/update-enum-column.md +19 -0
- package/docs/examples/tablesdb/update-float-column.md +20 -0
- package/docs/examples/tablesdb/update-integer-column.md +20 -0
- package/docs/examples/tablesdb/update-ip-column.md +18 -0
- package/docs/examples/tablesdb/update-line-column.md +18 -0
- package/docs/examples/tablesdb/update-point-column.md +18 -0
- package/docs/examples/tablesdb/update-polygon-column.md +18 -0
- package/docs/examples/tablesdb/update-relationship-column.md +17 -0
- package/docs/examples/tablesdb/update-row.md +24 -0
- package/docs/examples/tablesdb/update-rows.md +23 -0
- package/docs/examples/tablesdb/update-string-column.md +19 -0
- package/docs/examples/tablesdb/update-table.md +18 -0
- package/docs/examples/tablesdb/update-transaction.md +15 -0
- package/docs/examples/tablesdb/update-url-column.md +18 -0
- package/docs/examples/tablesdb/update.md +15 -0
- package/docs/examples/tablesdb/upsert-row.md +24 -0
- package/docs/examples/tablesdb/upsert-rows.md +16 -0
- package/docs/examples/teams/create-membership.md +9 -9
- package/docs/examples/teams/create.md +5 -5
- package/docs/examples/teams/delete-membership.md +4 -4
- package/docs/examples/teams/delete.md +3 -3
- package/docs/examples/teams/get-membership.md +4 -4
- package/docs/examples/teams/get-prefs.md +3 -3
- package/docs/examples/teams/get.md +3 -3
- package/docs/examples/teams/list-logs.md +5 -4
- package/docs/examples/teams/list-memberships.md +6 -5
- package/docs/examples/teams/list.md +5 -4
- package/docs/examples/teams/update-membership-status.md +6 -6
- package/docs/examples/teams/update-membership.md +5 -5
- package/docs/examples/teams/update-name.md +4 -4
- package/docs/examples/teams/update-prefs.md +4 -4
- package/docs/examples/tokens/create-file-token.md +5 -5
- package/docs/examples/tokens/delete.md +3 -3
- package/docs/examples/tokens/get.md +3 -3
- package/docs/examples/tokens/list.md +6 -5
- package/docs/examples/tokens/update.md +4 -4
- package/docs/examples/users/{create-m-d5user.md → create-argon-2-user.md} +6 -6
- package/docs/examples/users/create-bcrypt-user.md +6 -6
- package/docs/examples/users/{create-j-w-t.md → create-jwt.md} +5 -5
- package/docs/examples/users/{create-argon2user.md → create-md-5-user.md} +6 -6
- package/docs/examples/users/create-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/{create-p-h-pass-user.md → create-ph-pass-user.md} +6 -6
- package/docs/examples/users/create-scrypt-modified-user.md +9 -9
- package/docs/examples/users/create-scrypt-user.md +11 -11
- package/docs/examples/users/create-session.md +3 -3
- package/docs/examples/users/{create-s-h-a-user.md → create-sha-user.md} +7 -7
- package/docs/examples/users/create-target.md +8 -8
- package/docs/examples/users/create-token.md +5 -5
- package/docs/examples/users/create.md +7 -7
- package/docs/examples/users/delete-identity.md +3 -3
- package/docs/examples/users/delete-mfa-authenticator.md +4 -4
- package/docs/examples/users/delete-session.md +4 -4
- package/docs/examples/users/delete-sessions.md +3 -3
- package/docs/examples/users/delete-target.md +4 -4
- package/docs/examples/users/delete.md +3 -3
- package/docs/examples/users/get-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/get-prefs.md +3 -3
- package/docs/examples/users/get-target.md +4 -4
- package/docs/examples/users/get-usage.md +4 -4
- package/docs/examples/users/get.md +3 -3
- package/docs/examples/users/list-identities.md +5 -4
- package/docs/examples/users/list-logs.md +5 -4
- package/docs/examples/users/list-memberships.md +6 -5
- package/docs/examples/users/list-mfa-factors.md +3 -3
- package/docs/examples/users/list-sessions.md +4 -3
- package/docs/examples/users/list-targets.md +5 -4
- package/docs/examples/users/list.md +5 -4
- package/docs/examples/users/update-email-verification.md +4 -4
- package/docs/examples/users/update-email.md +4 -4
- package/docs/examples/users/update-labels.md +4 -4
- package/docs/examples/users/update-mfa-recovery-codes.md +3 -3
- package/docs/examples/users/update-mfa.md +4 -4
- package/docs/examples/users/update-name.md +4 -4
- package/docs/examples/users/update-password.md +4 -4
- package/docs/examples/users/update-phone-verification.md +4 -4
- package/docs/examples/users/update-phone.md +4 -4
- package/docs/examples/users/update-prefs.md +4 -4
- package/docs/examples/users/update-status.md +4 -4
- package/docs/examples/users/update-target.md +7 -7
- package/docs/examples/vcs/create-repository-detection.md +6 -6
- package/docs/examples/vcs/create-repository.md +5 -5
- package/docs/examples/vcs/delete-installation.md +3 -3
- package/docs/examples/vcs/get-installation.md +3 -3
- package/docs/examples/vcs/get-repository-contents.md +6 -5
- package/docs/examples/vcs/get-repository.md +4 -4
- package/docs/examples/vcs/list-installations.md +5 -4
- package/docs/examples/vcs/list-repositories.md +6 -5
- package/docs/examples/vcs/list-repository-branches.md +4 -4
- package/docs/examples/vcs/update-external-deployments.md +5 -5
- package/package.json +4 -4
- package/src/client.ts +42 -7
- package/src/enums/api-service.ts +1 -0
- package/src/enums/attribute-status.ts +7 -0
- package/src/enums/billing-plan-group.ts +5 -0
- package/src/enums/build-runtime.ts +2 -0
- package/src/enums/column-status.ts +7 -0
- package/src/enums/credit-card.ts +1 -1
- package/src/enums/database-type.ts +4 -0
- package/src/enums/deployment-status.ts +7 -0
- package/src/enums/execution-method.ts +1 -0
- package/src/enums/execution-status.ts +7 -0
- package/src/enums/execution-trigger.ts +5 -0
- package/src/enums/framework.ts +1 -0
- package/src/enums/health-antivirus-status.ts +5 -0
- package/src/enums/health-check-status.ts +4 -0
- package/src/enums/index-status.ts +7 -0
- package/src/enums/index-type.ts +1 -0
- package/src/enums/message-status.ts +7 -0
- package/src/enums/o-auth-provider.ts +3 -0
- package/src/enums/platform.ts +4 -0
- package/src/enums/proxy-rule-deployment-resource-type.ts +4 -0
- package/src/enums/proxy-rule-status.ts +6 -0
- package/src/enums/region.ts +3 -0
- package/src/enums/runtime.ts +2 -0
- package/src/enums/status.ts +4 -0
- package/src/enums/template-reference-type.ts +5 -0
- package/src/enums/theme.ts +4 -0
- package/src/enums/timezone.ts +421 -0
- package/src/enums/{user-usage-range.ts → usage-range.ts} +1 -1
- package/src/enums/{v-c-s-deployment-type.ts → vcs-reference-type.ts} +1 -1
- package/src/index.ts +27 -11
- package/src/models.ts +1925 -239
- package/src/operator.ts +308 -0
- package/src/query.ts +246 -2
- package/src/services/account.ts +2278 -235
- package/src/services/assistant.ts +29 -3
- package/src/services/avatars.ts +511 -52
- package/src/services/backups.ts +400 -42
- package/src/services/console.ts +499 -19
- package/src/services/databases.ts +3584 -430
- package/src/services/domains.ts +1795 -266
- package/src/services/functions.ts +1197 -155
- package/src/services/graphql.ts +56 -4
- package/src/services/health.ts +586 -42
- package/src/services/locale.ts +18 -2
- package/src/services/messaging.ts +3418 -386
- package/src/services/migrations.ts +653 -65
- package/src/services/organizations.ts +1411 -126
- package/src/services/project.ts +173 -17
- package/src/services/projects.ts +2808 -282
- package/src/services/proxy.ts +272 -26
- package/src/services/realtime.ts +437 -0
- package/src/services/sites.ts +1129 -143
- package/src/services/storage.ts +672 -89
- package/src/services/tables-db.ts +5439 -0
- package/src/services/teams.ts +535 -65
- package/src/services/tokens.ts +171 -16
- package/src/services/users.ts +1916 -182
- package/src/services/vcs.ts +373 -41
- package/types/client.d.ts +14 -5
- package/types/enums/api-service.d.ts +1 -0
- package/types/enums/attribute-status.d.ts +7 -0
- package/types/enums/billing-plan-group.d.ts +5 -0
- package/types/enums/build-runtime.d.ts +3 -1
- package/types/enums/column-status.d.ts +7 -0
- package/types/enums/credit-card.d.ts +1 -1
- package/types/enums/database-type.d.ts +4 -0
- package/types/enums/deployment-status.d.ts +7 -0
- package/types/enums/execution-method.d.ts +2 -1
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/framework.d.ts +1 -0
- package/types/enums/health-antivirus-status.d.ts +5 -0
- package/types/enums/health-check-status.d.ts +4 -0
- package/types/enums/index-status.d.ts +7 -0
- package/types/enums/index-type.d.ts +2 -1
- package/types/enums/message-status.d.ts +7 -0
- package/types/enums/o-auth-provider.d.ts +4 -1
- package/types/enums/platform.d.ts +4 -0
- package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
- package/types/enums/proxy-rule-status.d.ts +6 -0
- package/types/enums/region.d.ts +4 -1
- package/types/enums/runtime.d.ts +3 -1
- package/types/enums/status.d.ts +4 -0
- package/types/enums/template-reference-type.d.ts +5 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +421 -0
- package/types/enums/{site-usage-range.d.ts → usage-range.d.ts} +1 -1
- package/types/enums/{v-c-s-deployment-type.d.ts → vcs-reference-type.d.ts} +1 -1
- package/types/index.d.ts +27 -11
- package/types/models.d.ts +1877 -422
- package/types/operator.d.ts +180 -0
- package/types/query.d.ts +198 -2
- package/types/services/account.d.ts +1020 -158
- package/types/services/assistant.d.ts +13 -2
- package/types/services/avatars.d.ts +263 -45
- package/types/services/backups.d.ts +190 -30
- package/types/services/console.d.ts +202 -15
- package/types/services/databases.d.ts +1756 -299
- package/types/services/domains.d.ts +971 -219
- package/types/services/functions.d.ts +622 -131
- package/types/services/graphql.d.ts +24 -2
- package/types/services/health.d.ts +246 -24
- package/types/services/locale.d.ts +2 -2
- package/types/services/messaging.d.ts +1670 -281
- package/types/services/migrations.d.ts +319 -53
- package/types/services/organizations.d.ts +664 -109
- package/types/services/project.d.ts +81 -12
- package/types/services/projects.d.ts +1308 -202
- package/types/services/proxy.d.ts +128 -19
- package/types/services/realtime.d.ts +118 -0
- package/types/services/sites.d.ts +580 -119
- package/types/services/storage.d.ts +362 -81
- package/types/services/tables-db.d.ts +2040 -0
- package/types/services/teams.d.ts +277 -61
- package/types/services/tokens.d.ts +80 -12
- package/types/services/users.d.ts +906 -149
- package/types/services/vcs.d.ts +182 -34
- package/docs/examples/domains/create-record-m-x.md +0 -18
- package/docs/examples/domains/create-record-s-r-v.md +0 -20
- package/docs/examples/domains/create-record-t-x-t.md +0 -17
- package/docs/examples/domains/update-record-a-a-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-a-a.md +0 -18
- package/docs/examples/domains/update-record-c-n-a-m-e.md +0 -18
- package/docs/examples/domains/update-record-h-t-t-p-s.md +0 -18
- package/docs/examples/domains/update-record-m-x.md +0 -19
- package/docs/examples/domains/update-record-n-s.md +0 -18
- package/docs/examples/domains/update-record-s-r-v.md +0 -21
- package/docs/examples/domains/update-record-t-x-t.md +0 -18
- package/src/enums/billing-plan.ts +0 -5
- package/src/enums/database-usage-range.ts +0 -5
- package/src/enums/function-usage-range.ts +0 -5
- package/src/enums/site-usage-range.ts +0 -5
- package/src/enums/storage-usage-range.ts +0 -5
- package/types/enums/billing-plan.d.ts +0 -5
- package/types/enums/database-usage-range.d.ts +0 -5
- package/types/enums/function-usage-range.d.ts +0 -5
- package/types/enums/storage-usage-range.d.ts +0 -5
- package/types/enums/user-usage-range.d.ts +0 -5
- /package/docs/examples/health/{get-d-b.md → get-db.md} +0 -0
- /package/docs/examples/locale/{list-countries-e-u.md → list-countries-eu.md} +0 -0
- /package/src/enums/{s-m-t-p-secure.ts → smtp-secure.ts} +0 -0
- /package/src/enums/{v-c-s-detection-type.ts → vcs-detection-type.ts} +0 -0
- /package/types/enums/{s-m-t-p-secure.d.ts → smtp-secure.d.ts} +0 -0
- /package/types/enums/{v-c-s-detection-type.d.ts → vcs-detection-type.d.ts} +0 -0
package/src/services/vcs.ts
CHANGED
|
@@ -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 { VCSDetectionType } from '../enums/vcs-detection-type';
|
|
5
6
|
|
|
6
7
|
export class Vcs {
|
|
7
8
|
client: Client;
|
|
@@ -11,16 +12,50 @@ export class Vcs {
|
|
|
11
12
|
}
|
|
12
13
|
|
|
13
14
|
/**
|
|
14
|
-
* Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository
|
|
15
|
+
* Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
|
|
16
|
+
*
|
|
17
|
+
* @param {string} params.installationId - Installation Id
|
|
18
|
+
* @param {string} params.providerRepositoryId - Repository Id
|
|
19
|
+
* @param {VCSDetectionType} params.type - Detector type. Must be one of the following: runtime, framework
|
|
20
|
+
* @param {string} params.providerRootDirectory - Path to Root Directory
|
|
21
|
+
* @throws {AppwriteException}
|
|
22
|
+
* @returns {Promise<Models.DetectionFramework>}
|
|
23
|
+
*/
|
|
24
|
+
createRepositoryDetection(params: { installationId: string, providerRepositoryId: string, type: VCSDetectionType, providerRootDirectory?: string }): Promise<Models.DetectionFramework>;
|
|
25
|
+
/**
|
|
26
|
+
* Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
|
|
15
27
|
*
|
|
16
|
-
* @param {string} installationId
|
|
17
|
-
* @param {string} providerRepositoryId
|
|
18
|
-
* @param {VCSDetectionType} type
|
|
19
|
-
* @param {string} providerRootDirectory
|
|
28
|
+
* @param {string} installationId - Installation Id
|
|
29
|
+
* @param {string} providerRepositoryId - Repository Id
|
|
30
|
+
* @param {VCSDetectionType} type - Detector type. Must be one of the following: runtime, framework
|
|
31
|
+
* @param {string} providerRootDirectory - Path to Root Directory
|
|
20
32
|
* @throws {AppwriteException}
|
|
21
33
|
* @returns {Promise<Models.DetectionFramework>}
|
|
34
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
22
35
|
*/
|
|
23
|
-
createRepositoryDetection(installationId: string, providerRepositoryId: string, type: VCSDetectionType, providerRootDirectory?: string): Promise<Models.DetectionFramework
|
|
36
|
+
createRepositoryDetection(installationId: string, providerRepositoryId: string, type: VCSDetectionType, providerRootDirectory?: string): Promise<Models.DetectionFramework>;
|
|
37
|
+
createRepositoryDetection(
|
|
38
|
+
paramsOrFirst: { installationId: string, providerRepositoryId: string, type: VCSDetectionType, providerRootDirectory?: string } | string,
|
|
39
|
+
...rest: [(string)?, (VCSDetectionType)?, (string)?]
|
|
40
|
+
): Promise<Models.DetectionFramework> {
|
|
41
|
+
let params: { installationId: string, providerRepositoryId: string, type: VCSDetectionType, providerRootDirectory?: string };
|
|
42
|
+
|
|
43
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
44
|
+
params = (paramsOrFirst || {}) as { installationId: string, providerRepositoryId: string, type: VCSDetectionType, providerRootDirectory?: string };
|
|
45
|
+
} else {
|
|
46
|
+
params = {
|
|
47
|
+
installationId: paramsOrFirst as string,
|
|
48
|
+
providerRepositoryId: rest[0] as string,
|
|
49
|
+
type: rest[1] as VCSDetectionType,
|
|
50
|
+
providerRootDirectory: rest[2] as string
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const installationId = params.installationId;
|
|
55
|
+
const providerRepositoryId = params.providerRepositoryId;
|
|
56
|
+
const type = params.type;
|
|
57
|
+
const providerRootDirectory = params.providerRootDirectory;
|
|
58
|
+
|
|
24
59
|
if (typeof installationId === 'undefined') {
|
|
25
60
|
throw new AppwriteException('Missing required parameter: "installationId"');
|
|
26
61
|
}
|
|
@@ -30,6 +65,7 @@ export class Vcs {
|
|
|
30
65
|
if (typeof type === 'undefined') {
|
|
31
66
|
throw new AppwriteException('Missing required parameter: "type"');
|
|
32
67
|
}
|
|
68
|
+
|
|
33
69
|
const apiPath = '/vcs/github/installations/{installationId}/detections'.replace('{installationId}', installationId);
|
|
34
70
|
const payload: Payload = {};
|
|
35
71
|
if (typeof providerRepositoryId !== 'undefined') {
|
|
@@ -54,22 +90,59 @@ export class Vcs {
|
|
|
54
90
|
payload
|
|
55
91
|
);
|
|
56
92
|
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
|
|
96
|
+
*
|
|
97
|
+
* @param {string} params.installationId - Installation Id
|
|
98
|
+
* @param {VCSDetectionType} params.type - Detector type. Must be one of the following: runtime, framework
|
|
99
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
100
|
+
* @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). Only supported methods are limit and offset
|
|
101
|
+
* @throws {AppwriteException}
|
|
102
|
+
* @returns {Promise<Models.ProviderRepositoryFrameworkList>}
|
|
103
|
+
*/
|
|
104
|
+
listRepositories(params: { installationId: string, type: VCSDetectionType, search?: string, queries?: string[] }): Promise<Models.ProviderRepositoryFrameworkList>;
|
|
57
105
|
/**
|
|
58
|
-
* Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository
|
|
106
|
+
* Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
|
|
59
107
|
*
|
|
60
|
-
* @param {string} installationId
|
|
61
|
-
* @param {VCSDetectionType} type
|
|
62
|
-
* @param {string} search
|
|
108
|
+
* @param {string} installationId - Installation Id
|
|
109
|
+
* @param {VCSDetectionType} type - Detector type. Must be one of the following: runtime, framework
|
|
110
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
111
|
+
* @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). Only supported methods are limit and offset
|
|
63
112
|
* @throws {AppwriteException}
|
|
64
113
|
* @returns {Promise<Models.ProviderRepositoryFrameworkList>}
|
|
114
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
65
115
|
*/
|
|
66
|
-
listRepositories(installationId: string, type: VCSDetectionType, search?: string): Promise<Models.ProviderRepositoryFrameworkList
|
|
116
|
+
listRepositories(installationId: string, type: VCSDetectionType, search?: string, queries?: string[]): Promise<Models.ProviderRepositoryFrameworkList>;
|
|
117
|
+
listRepositories(
|
|
118
|
+
paramsOrFirst: { installationId: string, type: VCSDetectionType, search?: string, queries?: string[] } | string,
|
|
119
|
+
...rest: [(VCSDetectionType)?, (string)?, (string[])?]
|
|
120
|
+
): Promise<Models.ProviderRepositoryFrameworkList> {
|
|
121
|
+
let params: { installationId: string, type: VCSDetectionType, search?: string, queries?: string[] };
|
|
122
|
+
|
|
123
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
124
|
+
params = (paramsOrFirst || {}) as { installationId: string, type: VCSDetectionType, search?: string, queries?: string[] };
|
|
125
|
+
} else {
|
|
126
|
+
params = {
|
|
127
|
+
installationId: paramsOrFirst as string,
|
|
128
|
+
type: rest[0] as VCSDetectionType,
|
|
129
|
+
search: rest[1] as string,
|
|
130
|
+
queries: rest[2] as string[]
|
|
131
|
+
};
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
const installationId = params.installationId;
|
|
135
|
+
const type = params.type;
|
|
136
|
+
const search = params.search;
|
|
137
|
+
const queries = params.queries;
|
|
138
|
+
|
|
67
139
|
if (typeof installationId === 'undefined') {
|
|
68
140
|
throw new AppwriteException('Missing required parameter: "installationId"');
|
|
69
141
|
}
|
|
70
142
|
if (typeof type === 'undefined') {
|
|
71
143
|
throw new AppwriteException('Missing required parameter: "type"');
|
|
72
144
|
}
|
|
145
|
+
|
|
73
146
|
const apiPath = '/vcs/github/installations/{installationId}/providerRepositories'.replace('{installationId}', installationId);
|
|
74
147
|
const payload: Payload = {};
|
|
75
148
|
if (typeof type !== 'undefined') {
|
|
@@ -78,6 +151,9 @@ export class Vcs {
|
|
|
78
151
|
if (typeof search !== 'undefined') {
|
|
79
152
|
payload['search'] = search;
|
|
80
153
|
}
|
|
154
|
+
if (typeof queries !== 'undefined') {
|
|
155
|
+
payload['queries'] = queries;
|
|
156
|
+
}
|
|
81
157
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
82
158
|
|
|
83
159
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -90,16 +166,48 @@ export class Vcs {
|
|
|
90
166
|
payload
|
|
91
167
|
);
|
|
92
168
|
}
|
|
169
|
+
|
|
170
|
+
/**
|
|
171
|
+
* Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
|
|
172
|
+
*
|
|
173
|
+
* @param {string} params.installationId - Installation Id
|
|
174
|
+
* @param {string} params.name - Repository name (slug)
|
|
175
|
+
* @param {boolean} params.xprivate - Mark repository public or private
|
|
176
|
+
* @throws {AppwriteException}
|
|
177
|
+
* @returns {Promise<Models.ProviderRepository>}
|
|
178
|
+
*/
|
|
179
|
+
createRepository(params: { installationId: string, name: string, xprivate: boolean }): Promise<Models.ProviderRepository>;
|
|
93
180
|
/**
|
|
94
181
|
* Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
|
|
95
182
|
*
|
|
96
|
-
* @param {string} installationId
|
|
97
|
-
* @param {string} name
|
|
98
|
-
* @param {boolean} xprivate
|
|
183
|
+
* @param {string} installationId - Installation Id
|
|
184
|
+
* @param {string} name - Repository name (slug)
|
|
185
|
+
* @param {boolean} xprivate - Mark repository public or private
|
|
99
186
|
* @throws {AppwriteException}
|
|
100
187
|
* @returns {Promise<Models.ProviderRepository>}
|
|
188
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
101
189
|
*/
|
|
102
|
-
createRepository(installationId: string, name: string, xprivate: boolean): Promise<Models.ProviderRepository
|
|
190
|
+
createRepository(installationId: string, name: string, xprivate: boolean): Promise<Models.ProviderRepository>;
|
|
191
|
+
createRepository(
|
|
192
|
+
paramsOrFirst: { installationId: string, name: string, xprivate: boolean } | string,
|
|
193
|
+
...rest: [(string)?, (boolean)?]
|
|
194
|
+
): Promise<Models.ProviderRepository> {
|
|
195
|
+
let params: { installationId: string, name: string, xprivate: boolean };
|
|
196
|
+
|
|
197
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
198
|
+
params = (paramsOrFirst || {}) as { installationId: string, name: string, xprivate: boolean };
|
|
199
|
+
} else {
|
|
200
|
+
params = {
|
|
201
|
+
installationId: paramsOrFirst as string,
|
|
202
|
+
name: rest[0] as string,
|
|
203
|
+
xprivate: rest[1] as boolean
|
|
204
|
+
};
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
const installationId = params.installationId;
|
|
208
|
+
const name = params.name;
|
|
209
|
+
const xprivate = params.xprivate;
|
|
210
|
+
|
|
103
211
|
if (typeof installationId === 'undefined') {
|
|
104
212
|
throw new AppwriteException('Missing required parameter: "installationId"');
|
|
105
213
|
}
|
|
@@ -109,6 +217,7 @@ export class Vcs {
|
|
|
109
217
|
if (typeof xprivate === 'undefined') {
|
|
110
218
|
throw new AppwriteException('Missing required parameter: "xprivate"');
|
|
111
219
|
}
|
|
220
|
+
|
|
112
221
|
const apiPath = '/vcs/github/installations/{installationId}/providerRepositories'.replace('{installationId}', installationId);
|
|
113
222
|
const payload: Payload = {};
|
|
114
223
|
if (typeof name !== 'undefined') {
|
|
@@ -130,21 +239,51 @@ export class Vcs {
|
|
|
130
239
|
payload
|
|
131
240
|
);
|
|
132
241
|
}
|
|
242
|
+
|
|
243
|
+
/**
|
|
244
|
+
* Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
|
|
245
|
+
*
|
|
246
|
+
* @param {string} params.installationId - Installation Id
|
|
247
|
+
* @param {string} params.providerRepositoryId - Repository Id
|
|
248
|
+
* @throws {AppwriteException}
|
|
249
|
+
* @returns {Promise<Models.ProviderRepository>}
|
|
250
|
+
*/
|
|
251
|
+
getRepository(params: { installationId: string, providerRepositoryId: string }): Promise<Models.ProviderRepository>;
|
|
133
252
|
/**
|
|
134
253
|
* Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
|
|
135
254
|
*
|
|
136
|
-
* @param {string} installationId
|
|
137
|
-
* @param {string} providerRepositoryId
|
|
255
|
+
* @param {string} installationId - Installation Id
|
|
256
|
+
* @param {string} providerRepositoryId - Repository Id
|
|
138
257
|
* @throws {AppwriteException}
|
|
139
258
|
* @returns {Promise<Models.ProviderRepository>}
|
|
259
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
140
260
|
*/
|
|
141
|
-
getRepository(installationId: string, providerRepositoryId: string): Promise<Models.ProviderRepository
|
|
261
|
+
getRepository(installationId: string, providerRepositoryId: string): Promise<Models.ProviderRepository>;
|
|
262
|
+
getRepository(
|
|
263
|
+
paramsOrFirst: { installationId: string, providerRepositoryId: string } | string,
|
|
264
|
+
...rest: [(string)?]
|
|
265
|
+
): Promise<Models.ProviderRepository> {
|
|
266
|
+
let params: { installationId: string, providerRepositoryId: string };
|
|
267
|
+
|
|
268
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
269
|
+
params = (paramsOrFirst || {}) as { installationId: string, providerRepositoryId: string };
|
|
270
|
+
} else {
|
|
271
|
+
params = {
|
|
272
|
+
installationId: paramsOrFirst as string,
|
|
273
|
+
providerRepositoryId: rest[0] as string
|
|
274
|
+
};
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
const installationId = params.installationId;
|
|
278
|
+
const providerRepositoryId = params.providerRepositoryId;
|
|
279
|
+
|
|
142
280
|
if (typeof installationId === 'undefined') {
|
|
143
281
|
throw new AppwriteException('Missing required parameter: "installationId"');
|
|
144
282
|
}
|
|
145
283
|
if (typeof providerRepositoryId === 'undefined') {
|
|
146
284
|
throw new AppwriteException('Missing required parameter: "providerRepositoryId"');
|
|
147
285
|
}
|
|
286
|
+
|
|
148
287
|
const apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
|
|
149
288
|
const payload: Payload = {};
|
|
150
289
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -159,22 +298,53 @@ export class Vcs {
|
|
|
159
298
|
payload
|
|
160
299
|
);
|
|
161
300
|
}
|
|
301
|
+
|
|
162
302
|
/**
|
|
163
303
|
* Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
|
|
164
|
-
|
|
304
|
+
*
|
|
305
|
+
*
|
|
306
|
+
* @param {string} params.installationId - Installation Id
|
|
307
|
+
* @param {string} params.providerRepositoryId - Repository Id
|
|
308
|
+
* @throws {AppwriteException}
|
|
309
|
+
* @returns {Promise<Models.BranchList>}
|
|
310
|
+
*/
|
|
311
|
+
listRepositoryBranches(params: { installationId: string, providerRepositoryId: string }): Promise<Models.BranchList>;
|
|
312
|
+
/**
|
|
313
|
+
* Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
|
|
314
|
+
*
|
|
165
315
|
*
|
|
166
|
-
* @param {string} installationId
|
|
167
|
-
* @param {string} providerRepositoryId
|
|
316
|
+
* @param {string} installationId - Installation Id
|
|
317
|
+
* @param {string} providerRepositoryId - Repository Id
|
|
168
318
|
* @throws {AppwriteException}
|
|
169
319
|
* @returns {Promise<Models.BranchList>}
|
|
320
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
170
321
|
*/
|
|
171
|
-
listRepositoryBranches(installationId: string, providerRepositoryId: string): Promise<Models.BranchList
|
|
322
|
+
listRepositoryBranches(installationId: string, providerRepositoryId: string): Promise<Models.BranchList>;
|
|
323
|
+
listRepositoryBranches(
|
|
324
|
+
paramsOrFirst: { installationId: string, providerRepositoryId: string } | string,
|
|
325
|
+
...rest: [(string)?]
|
|
326
|
+
): Promise<Models.BranchList> {
|
|
327
|
+
let params: { installationId: string, providerRepositoryId: string };
|
|
328
|
+
|
|
329
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
330
|
+
params = (paramsOrFirst || {}) as { installationId: string, providerRepositoryId: string };
|
|
331
|
+
} else {
|
|
332
|
+
params = {
|
|
333
|
+
installationId: paramsOrFirst as string,
|
|
334
|
+
providerRepositoryId: rest[0] as string
|
|
335
|
+
};
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
const installationId = params.installationId;
|
|
339
|
+
const providerRepositoryId = params.providerRepositoryId;
|
|
340
|
+
|
|
172
341
|
if (typeof installationId === 'undefined') {
|
|
173
342
|
throw new AppwriteException('Missing required parameter: "installationId"');
|
|
174
343
|
}
|
|
175
344
|
if (typeof providerRepositoryId === 'undefined') {
|
|
176
345
|
throw new AppwriteException('Missing required parameter: "providerRepositoryId"');
|
|
177
346
|
}
|
|
347
|
+
|
|
178
348
|
const apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}/branches'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
|
|
179
349
|
const payload: Payload = {};
|
|
180
350
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -189,28 +359,67 @@ export class Vcs {
|
|
|
189
359
|
payload
|
|
190
360
|
);
|
|
191
361
|
}
|
|
362
|
+
|
|
363
|
+
/**
|
|
364
|
+
* Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
|
|
365
|
+
*
|
|
366
|
+
* @param {string} params.installationId - Installation Id
|
|
367
|
+
* @param {string} params.providerRepositoryId - Repository Id
|
|
368
|
+
* @param {string} params.providerRootDirectory - Path to get contents of nested directory
|
|
369
|
+
* @param {string} params.providerReference - Git reference (branch, tag, commit) to get contents from
|
|
370
|
+
* @throws {AppwriteException}
|
|
371
|
+
* @returns {Promise<Models.VcsContentList>}
|
|
372
|
+
*/
|
|
373
|
+
getRepositoryContents(params: { installationId: string, providerRepositoryId: string, providerRootDirectory?: string, providerReference?: string }): Promise<Models.VcsContentList>;
|
|
192
374
|
/**
|
|
193
375
|
* Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
|
|
194
|
-
|
|
195
376
|
*
|
|
196
|
-
* @param {string} installationId
|
|
197
|
-
* @param {string} providerRepositoryId
|
|
198
|
-
* @param {string} providerRootDirectory
|
|
377
|
+
* @param {string} installationId - Installation Id
|
|
378
|
+
* @param {string} providerRepositoryId - Repository Id
|
|
379
|
+
* @param {string} providerRootDirectory - Path to get contents of nested directory
|
|
380
|
+
* @param {string} providerReference - Git reference (branch, tag, commit) to get contents from
|
|
199
381
|
* @throws {AppwriteException}
|
|
200
382
|
* @returns {Promise<Models.VcsContentList>}
|
|
383
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
201
384
|
*/
|
|
202
|
-
getRepositoryContents(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.VcsContentList
|
|
385
|
+
getRepositoryContents(installationId: string, providerRepositoryId: string, providerRootDirectory?: string, providerReference?: string): Promise<Models.VcsContentList>;
|
|
386
|
+
getRepositoryContents(
|
|
387
|
+
paramsOrFirst: { installationId: string, providerRepositoryId: string, providerRootDirectory?: string, providerReference?: string } | string,
|
|
388
|
+
...rest: [(string)?, (string)?, (string)?]
|
|
389
|
+
): Promise<Models.VcsContentList> {
|
|
390
|
+
let params: { installationId: string, providerRepositoryId: string, providerRootDirectory?: string, providerReference?: string };
|
|
391
|
+
|
|
392
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
393
|
+
params = (paramsOrFirst || {}) as { installationId: string, providerRepositoryId: string, providerRootDirectory?: string, providerReference?: string };
|
|
394
|
+
} else {
|
|
395
|
+
params = {
|
|
396
|
+
installationId: paramsOrFirst as string,
|
|
397
|
+
providerRepositoryId: rest[0] as string,
|
|
398
|
+
providerRootDirectory: rest[1] as string,
|
|
399
|
+
providerReference: rest[2] as string
|
|
400
|
+
};
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
const installationId = params.installationId;
|
|
404
|
+
const providerRepositoryId = params.providerRepositoryId;
|
|
405
|
+
const providerRootDirectory = params.providerRootDirectory;
|
|
406
|
+
const providerReference = params.providerReference;
|
|
407
|
+
|
|
203
408
|
if (typeof installationId === 'undefined') {
|
|
204
409
|
throw new AppwriteException('Missing required parameter: "installationId"');
|
|
205
410
|
}
|
|
206
411
|
if (typeof providerRepositoryId === 'undefined') {
|
|
207
412
|
throw new AppwriteException('Missing required parameter: "providerRepositoryId"');
|
|
208
413
|
}
|
|
414
|
+
|
|
209
415
|
const apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}/contents'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
|
|
210
416
|
const payload: Payload = {};
|
|
211
417
|
if (typeof providerRootDirectory !== 'undefined') {
|
|
212
418
|
payload['providerRootDirectory'] = providerRootDirectory;
|
|
213
419
|
}
|
|
420
|
+
if (typeof providerReference !== 'undefined') {
|
|
421
|
+
payload['providerReference'] = providerReference;
|
|
422
|
+
}
|
|
214
423
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
215
424
|
|
|
216
425
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -223,16 +432,48 @@ export class Vcs {
|
|
|
223
432
|
payload
|
|
224
433
|
);
|
|
225
434
|
}
|
|
435
|
+
|
|
436
|
+
/**
|
|
437
|
+
* Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.
|
|
438
|
+
*
|
|
439
|
+
* @param {string} params.installationId - Installation Id
|
|
440
|
+
* @param {string} params.repositoryId - VCS Repository Id
|
|
441
|
+
* @param {string} params.providerPullRequestId - GitHub Pull Request Id
|
|
442
|
+
* @throws {AppwriteException}
|
|
443
|
+
* @returns {Promise<{}>}
|
|
444
|
+
*/
|
|
445
|
+
updateExternalDeployments(params: { installationId: string, repositoryId: string, providerPullRequestId: string }): Promise<{}>;
|
|
226
446
|
/**
|
|
227
447
|
* Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.
|
|
228
448
|
*
|
|
229
|
-
* @param {string} installationId
|
|
230
|
-
* @param {string} repositoryId
|
|
231
|
-
* @param {string} providerPullRequestId
|
|
449
|
+
* @param {string} installationId - Installation Id
|
|
450
|
+
* @param {string} repositoryId - VCS Repository Id
|
|
451
|
+
* @param {string} providerPullRequestId - GitHub Pull Request Id
|
|
232
452
|
* @throws {AppwriteException}
|
|
233
453
|
* @returns {Promise<{}>}
|
|
454
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
234
455
|
*/
|
|
235
|
-
updateExternalDeployments(installationId: string, repositoryId: string, providerPullRequestId: string): Promise<{}
|
|
456
|
+
updateExternalDeployments(installationId: string, repositoryId: string, providerPullRequestId: string): Promise<{}>;
|
|
457
|
+
updateExternalDeployments(
|
|
458
|
+
paramsOrFirst: { installationId: string, repositoryId: string, providerPullRequestId: string } | string,
|
|
459
|
+
...rest: [(string)?, (string)?]
|
|
460
|
+
): Promise<{}> {
|
|
461
|
+
let params: { installationId: string, repositoryId: string, providerPullRequestId: string };
|
|
462
|
+
|
|
463
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
464
|
+
params = (paramsOrFirst || {}) as { installationId: string, repositoryId: string, providerPullRequestId: string };
|
|
465
|
+
} else {
|
|
466
|
+
params = {
|
|
467
|
+
installationId: paramsOrFirst as string,
|
|
468
|
+
repositoryId: rest[0] as string,
|
|
469
|
+
providerPullRequestId: rest[1] as string
|
|
470
|
+
};
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
const installationId = params.installationId;
|
|
474
|
+
const repositoryId = params.repositoryId;
|
|
475
|
+
const providerPullRequestId = params.providerPullRequestId;
|
|
476
|
+
|
|
236
477
|
if (typeof installationId === 'undefined') {
|
|
237
478
|
throw new AppwriteException('Missing required parameter: "installationId"');
|
|
238
479
|
}
|
|
@@ -242,6 +483,7 @@ export class Vcs {
|
|
|
242
483
|
if (typeof providerPullRequestId === 'undefined') {
|
|
243
484
|
throw new AppwriteException('Missing required parameter: "providerPullRequestId"');
|
|
244
485
|
}
|
|
486
|
+
|
|
245
487
|
const apiPath = '/vcs/github/installations/{installationId}/repositories/{repositoryId}'.replace('{installationId}', installationId).replace('{repositoryId}', repositoryId);
|
|
246
488
|
const payload: Payload = {};
|
|
247
489
|
if (typeof providerPullRequestId !== 'undefined') {
|
|
@@ -260,16 +502,51 @@ export class Vcs {
|
|
|
260
502
|
payload
|
|
261
503
|
);
|
|
262
504
|
}
|
|
505
|
+
|
|
263
506
|
/**
|
|
264
507
|
* List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
|
|
265
|
-
|
|
508
|
+
*
|
|
266
509
|
*
|
|
267
|
-
* @param {string[]} queries
|
|
268
|
-
* @param {string} search
|
|
510
|
+
* @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: provider, organization
|
|
511
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
512
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
269
513
|
* @throws {AppwriteException}
|
|
270
514
|
* @returns {Promise<Models.InstallationList>}
|
|
271
515
|
*/
|
|
272
|
-
listInstallations(queries?: string[], search?: string): Promise<Models.InstallationList
|
|
516
|
+
listInstallations(params?: { queries?: string[], search?: string, total?: boolean }): Promise<Models.InstallationList>;
|
|
517
|
+
/**
|
|
518
|
+
* List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
|
|
519
|
+
*
|
|
520
|
+
*
|
|
521
|
+
* @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: provider, organization
|
|
522
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
523
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
524
|
+
* @throws {AppwriteException}
|
|
525
|
+
* @returns {Promise<Models.InstallationList>}
|
|
526
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
527
|
+
*/
|
|
528
|
+
listInstallations(queries?: string[], search?: string, total?: boolean): Promise<Models.InstallationList>;
|
|
529
|
+
listInstallations(
|
|
530
|
+
paramsOrFirst?: { queries?: string[], search?: string, total?: boolean } | string[],
|
|
531
|
+
...rest: [(string)?, (boolean)?]
|
|
532
|
+
): Promise<Models.InstallationList> {
|
|
533
|
+
let params: { queries?: string[], search?: string, total?: boolean };
|
|
534
|
+
|
|
535
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
536
|
+
params = (paramsOrFirst || {}) as { queries?: string[], search?: string, total?: boolean };
|
|
537
|
+
} else {
|
|
538
|
+
params = {
|
|
539
|
+
queries: paramsOrFirst as string[],
|
|
540
|
+
search: rest[0] as string,
|
|
541
|
+
total: rest[1] as boolean
|
|
542
|
+
};
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
const queries = params.queries;
|
|
546
|
+
const search = params.search;
|
|
547
|
+
const total = params.total;
|
|
548
|
+
|
|
549
|
+
|
|
273
550
|
const apiPath = '/vcs/installations';
|
|
274
551
|
const payload: Payload = {};
|
|
275
552
|
if (typeof queries !== 'undefined') {
|
|
@@ -278,6 +555,9 @@ export class Vcs {
|
|
|
278
555
|
if (typeof search !== 'undefined') {
|
|
279
556
|
payload['search'] = search;
|
|
280
557
|
}
|
|
558
|
+
if (typeof total !== 'undefined') {
|
|
559
|
+
payload['total'] = total;
|
|
560
|
+
}
|
|
281
561
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
282
562
|
|
|
283
563
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -290,17 +570,43 @@ export class Vcs {
|
|
|
290
570
|
payload
|
|
291
571
|
);
|
|
292
572
|
}
|
|
573
|
+
|
|
574
|
+
/**
|
|
575
|
+
* Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration.
|
|
576
|
+
*
|
|
577
|
+
* @param {string} params.installationId - Installation Id
|
|
578
|
+
* @throws {AppwriteException}
|
|
579
|
+
* @returns {Promise<Models.Installation>}
|
|
580
|
+
*/
|
|
581
|
+
getInstallation(params: { installationId: string }): Promise<Models.Installation>;
|
|
293
582
|
/**
|
|
294
|
-
* Get a VCS installation by its unique ID. This endpoint returns the installation
|
|
583
|
+
* Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration.
|
|
295
584
|
*
|
|
296
|
-
* @param {string} installationId
|
|
585
|
+
* @param {string} installationId - Installation Id
|
|
297
586
|
* @throws {AppwriteException}
|
|
298
587
|
* @returns {Promise<Models.Installation>}
|
|
588
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
299
589
|
*/
|
|
300
|
-
getInstallation(installationId: string): Promise<Models.Installation
|
|
590
|
+
getInstallation(installationId: string): Promise<Models.Installation>;
|
|
591
|
+
getInstallation(
|
|
592
|
+
paramsOrFirst: { installationId: string } | string
|
|
593
|
+
): Promise<Models.Installation> {
|
|
594
|
+
let params: { installationId: string };
|
|
595
|
+
|
|
596
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
597
|
+
params = (paramsOrFirst || {}) as { installationId: string };
|
|
598
|
+
} else {
|
|
599
|
+
params = {
|
|
600
|
+
installationId: paramsOrFirst as string
|
|
601
|
+
};
|
|
602
|
+
}
|
|
603
|
+
|
|
604
|
+
const installationId = params.installationId;
|
|
605
|
+
|
|
301
606
|
if (typeof installationId === 'undefined') {
|
|
302
607
|
throw new AppwriteException('Missing required parameter: "installationId"');
|
|
303
608
|
}
|
|
609
|
+
|
|
304
610
|
const apiPath = '/vcs/installations/{installationId}'.replace('{installationId}', installationId);
|
|
305
611
|
const payload: Payload = {};
|
|
306
612
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
@@ -315,17 +621,43 @@ export class Vcs {
|
|
|
315
621
|
payload
|
|
316
622
|
);
|
|
317
623
|
}
|
|
624
|
+
|
|
318
625
|
/**
|
|
319
626
|
* Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.
|
|
320
627
|
*
|
|
321
|
-
* @param {string} installationId
|
|
628
|
+
* @param {string} params.installationId - Installation Id
|
|
322
629
|
* @throws {AppwriteException}
|
|
323
630
|
* @returns {Promise<{}>}
|
|
324
631
|
*/
|
|
325
|
-
deleteInstallation(installationId: string): Promise<{}
|
|
632
|
+
deleteInstallation(params: { installationId: string }): Promise<{}>;
|
|
633
|
+
/**
|
|
634
|
+
* Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.
|
|
635
|
+
*
|
|
636
|
+
* @param {string} installationId - Installation Id
|
|
637
|
+
* @throws {AppwriteException}
|
|
638
|
+
* @returns {Promise<{}>}
|
|
639
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
640
|
+
*/
|
|
641
|
+
deleteInstallation(installationId: string): Promise<{}>;
|
|
642
|
+
deleteInstallation(
|
|
643
|
+
paramsOrFirst: { installationId: string } | string
|
|
644
|
+
): Promise<{}> {
|
|
645
|
+
let params: { installationId: string };
|
|
646
|
+
|
|
647
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
648
|
+
params = (paramsOrFirst || {}) as { installationId: string };
|
|
649
|
+
} else {
|
|
650
|
+
params = {
|
|
651
|
+
installationId: paramsOrFirst as string
|
|
652
|
+
};
|
|
653
|
+
}
|
|
654
|
+
|
|
655
|
+
const installationId = params.installationId;
|
|
656
|
+
|
|
326
657
|
if (typeof installationId === 'undefined') {
|
|
327
658
|
throw new AppwriteException('Missing required parameter: "installationId"');
|
|
328
659
|
}
|
|
660
|
+
|
|
329
661
|
const apiPath = '/vcs/installations/{installationId}'.replace('{installationId}', installationId);
|
|
330
662
|
const payload: Payload = {};
|
|
331
663
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
package/types/client.d.ts
CHANGED
|
@@ -95,11 +95,7 @@ declare class Client {
|
|
|
95
95
|
config: {
|
|
96
96
|
endpoint: string;
|
|
97
97
|
endpointRealtime: string;
|
|
98
|
-
|
|
99
|
-
key: string;
|
|
100
|
-
jwt: string;
|
|
101
|
-
locale: string;
|
|
102
|
-
mode: string;
|
|
98
|
+
[key: string]: string | undefined;
|
|
103
99
|
};
|
|
104
100
|
/**
|
|
105
101
|
* Custom headers for API requests.
|
|
@@ -169,10 +165,23 @@ declare class Client {
|
|
|
169
165
|
* @return {this}
|
|
170
166
|
*/
|
|
171
167
|
setMode(value: string): this;
|
|
168
|
+
/**
|
|
169
|
+
* Set Platform
|
|
170
|
+
*
|
|
171
|
+
* The platform type (Appwrite or Imagine)
|
|
172
|
+
*
|
|
173
|
+
* @param value string
|
|
174
|
+
*
|
|
175
|
+
* @return {this}
|
|
176
|
+
*/
|
|
177
|
+
setPlatform(value: string): this;
|
|
172
178
|
private realtime;
|
|
173
179
|
/**
|
|
174
180
|
* Subscribes to Appwrite events and passes you the payload in realtime.
|
|
175
181
|
*
|
|
182
|
+
* @deprecated Use the Realtime service instead.
|
|
183
|
+
* @see Realtime
|
|
184
|
+
*
|
|
176
185
|
* @param {string|string[]} channels
|
|
177
186
|
* Channel to subscribe - pass a single channel as a string or multiple with an array of strings.
|
|
178
187
|
*
|