@appwrite.io/console 1.4.6 → 1.5.0

package/dist/esm/sdk.js

@@ -278,7 +278,7 @@ class Client {
             'x-sdk-name': 'Console',
             'x-sdk-platform': 'console',
             'x-sdk-language': 'web',
-            'x-sdk-version': '1.4.6',
+            'x-sdk-version': '1.5.0',
             'X-Appwrite-Response-Format': '1.6.0',
         };
         this.realtime = {
@@ -801,6 +801,7 @@ class Account {
     /**
      * List billing addresses
      *
+     * List all billing addresses for a user.
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
@@ -823,6 +824,7 @@ class Account {
     /**
      * Create new billing address
      *
+     * Add a new billing address to a user's account.
      *
      * @param {string} country
      * @param {string} streetAddress
@@ -877,6 +879,7 @@ class Account {
     /**
      * Get billing address
      *
+     * Get a specific billing address for a user using it's ID.
      *
      * @param {string} billingAddressId
      * @throws {AppwriteException}
@@ -899,6 +902,7 @@ class Account {
     /**
      * Update billing address
      *
+     * Update a specific billing address using it's ID.
      *
      * @param {string} billingAddressId
      * @param {string} country
@@ -957,6 +961,7 @@ class Account {
     /**
      * Delete billing address
      *
+     * Delete a specific billing address using it's ID.
      *
      * @param {string} billingAddressId
      * @throws {AppwriteException}
@@ -979,6 +984,7 @@ class Account {
     /**
      * Get coupon details
      *
+     * Get coupon details for an account.
      *
      * @param {string} couponId
      * @throws {AppwriteException}
@@ -1082,6 +1088,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
     /**
      * List invoices
      *
+     * List all invoices tied to an account.
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
@@ -1279,7 +1286,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
      * @param {string} challengeId
      * @param {string} otp
      * @throws {AppwriteException}
-     * @returns {Promise<{}>}
+     * @returns {Promise<Models.Session>}
      */
     updateMfaChallenge(challengeId, otp) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1439,6 +1446,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
     /**
      * List payment methods
      *
+     * List payment methods for this account.
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
@@ -1461,6 +1469,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
     /**
      * Create new payment method
      *
+     * Create a new payment method for the current user account.
      *
      * @throws {AppwriteException}
      * @returns {Promise<Models.PaymentMethod>}
@@ -1479,6 +1488,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
     /**
      * Get payment method
      *
+     * Get a specific payment method for the user.
      *
      * @param {string} paymentMethodId
      * @throws {AppwriteException}
@@ -1501,6 +1511,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
     /**
      * Update payment method
      *
+     * Update a new payment method for the current user account.
      *
      * @param {string} paymentMethodId
      * @param {number} expiryMonth
@@ -1537,6 +1548,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
     /**
      * Delete payment method
      *
+     * Delete a specific payment method from a user&#039;s account.
      *
      * @param {string} paymentMethodId
      * @throws {AppwriteException}
@@ -1559,6 +1571,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
     /**
      * Update payment method provider id
      *
+     * Update payment method provider.
      *
      * @param {string} paymentMethodId
      * @param {string} providerMethodId
@@ -1595,6 +1608,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
     /**
      * Update payment method with new setup with mandates for indian cards
      *
+     * Update payment method mandate options.
      *
      * @param {string} paymentMethodId
      * @throws {AppwriteException}
@@ -2096,6 +2110,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about
     /**
      * Create push target
      *
+     * Use this endpoint to register a device for push notifications. Provide a target ID (custom or generated using ID.unique()), a device identifier (usually a device token), and optionally specify which provider should send notifications to this target. The target is automatically linked to the current session and includes device information like brand and model.
      *
      * @param {string} targetId
      * @param {string} identifier
@@ -2132,6 +2147,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about
     /**
      * Update push target
      *
+     * Update the currently logged in user&#039;s push notification target. You can modify the target&#039;s identifier (device token) and provider ID (token, email, phone etc.). The target must exist and belong to the current user. If you change the provider ID, notifications will be sent through the new messaging provider instead.
      *
      * @param {string} targetId
      * @param {string} identifier
@@ -2161,6 +2177,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about
     /**
      * Delete push target
      *
+     * Delete a push notification target for the currently logged in user. After deletion, the device will no longer receive push notifications. The target must exist and belong to the current user.
      *
      * @param {string} targetId
      * @throws {AppwriteException}
@@ -2752,6 +2769,7 @@ class Backups {
     /**
      * List archives
      *
+     * List all archives for a project.
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
@@ -2774,6 +2792,7 @@ class Backups {
     /**
      * Create archive
      *
+     * Create a new archive asynchronously for a project.
      *
      * @param {string[]} services
      * @param {string} resourceId
@@ -2803,6 +2822,7 @@ class Backups {
     /**
      * Get backup archive
      *
+     * Get a backup archive using it&#039;s ID.
      *
      * @param {string} archiveId
      * @throws {AppwriteException}
@@ -2825,6 +2845,7 @@ class Backups {
     /**
      * Delete archive
      *
+     * Delete an existing archive for a project.
      *
      * @param {string} archiveId
      * @throws {AppwriteException}
@@ -2847,6 +2868,7 @@ class Backups {
     /**
      * List backup policies
      *
+     * List all policies for a project.
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
@@ -2869,6 +2891,7 @@ class Backups {
     /**
      * Create backup policy
      *
+     * Create a new backup policy.
      *
      * @param {string} policyId
      * @param {string[]} services
@@ -2927,6 +2950,7 @@ class Backups {
     /**
      * Get backup policy
      *
+     * Get a backup policy using it&#039;s ID.
      *
      * @param {string} policyId
      * @throws {AppwriteException}
@@ -2949,6 +2973,7 @@ class Backups {
     /**
      * Update backup policy
      *
+     * Update an existing policy using it&#039;s ID.
      *
      * @param {string} policyId
      * @param {string} name
@@ -2987,6 +3012,7 @@ class Backups {
     /**
      * Delete backup policy
      *
+     * Delete a policy using it&#039;s ID.
      *
      * @param {string} policyId
      * @throws {AppwriteException}
@@ -3009,6 +3035,7 @@ class Backups {
     /**
      * Create restoration
      *
+     * Create and trigger a new restoration for a backup on a project.
      *
      * @param {string} archiveId
      * @param {string[]} services
@@ -3049,6 +3076,7 @@ class Backups {
     /**
      * List restorations
      *
+     * List all backup restorations for a project.
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
@@ -3071,10 +3099,11 @@ class Backups {
     /**
      * Get backup restoration
      *
+     * Get the current status of a backup restoration.
      *
      * @param {string} restorationId
      * @throws {AppwriteException}
-     * @returns {Promise<Models.BackupArchive>}
+     * @returns {Promise<Models.BackupRestoration>}
      */
     getRestoration(restorationId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -3099,6 +3128,7 @@ class Assistant {
     /**
      * Ask query
      *
+     * Send a prompt to the AI assistant and receive a response. This endpoint allows you to interact with Appwrite&#039;s AI assistant by sending questions or prompts and receiving helpful responses in real-time through a server-sent events stream.
      *
      * @param {string} prompt
      * @throws {AppwriteException}
@@ -3130,6 +3160,7 @@ class Console {
     /**
      * Get campaign details
      *
+     * Recieve the details of a compaign using it&#039;s ID.
      *
      * @param {string} campaignId
      * @throws {AppwriteException}
@@ -3152,6 +3183,7 @@ class Console {
     /**
      * Get coupon details
      *
+     * Get the details of a coupon using it&#039;s coupon ID.
      *
      * @param {string} couponId
      * @throws {AppwriteException}
@@ -3174,6 +3206,7 @@ class Console {
     /**
      * Get plans
      *
+     * Return a list of all available plans.
      *
      * @throws {AppwriteException}
      * @returns {Promise<Models.BillingPlanList>}
@@ -3192,10 +3225,11 @@ class Console {
     /**
      * Create program membership
      *
+     * Create a new membership for an account to a program.
      *
      * @param {string} programId
      * @throws {AppwriteException}
-     * @returns {Promise<{}>}
+     * @returns {Promise<Models.Organization<Preferences>>}
      */
     createProgramMembership(programId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -3214,6 +3248,7 @@ class Console {
     /**
      * Get Regions
      *
+     * Get all available regions for the console.
      *
      * @throws {AppwriteException}
      * @returns {Promise<Models.ConsoleRegionList>}
@@ -3232,6 +3267,7 @@ class Console {
     /**
      * Create source
      *
+     * Create a new source.
      *
      * @param {string} ref
      * @param {string} referrer
@@ -3360,6 +3396,7 @@ class Databases {
     /**
      * Get databases usage stats
      *
+     * Get usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
      *
      * @param {DatabaseUsageRange} range
      * @throws {AppwriteException}
@@ -5196,6 +5233,7 @@ Attributes can be `key`, `fulltext`, and `unique`.
     /**
      * Get collection usage stats
      *
+     * Get usage metrics and statistics for a collection. Returning the total number of documents. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -5253,6 +5291,7 @@ Attributes can be `key`, `fulltext`, and `unique`.
     /**
      * Get database usage stats
      *
+     * Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
      *
      * @param {string} databaseId
      * @param {DatabaseUsageRange} range
@@ -5525,6 +5564,7 @@ class Functions {
     /**
      * Get functions usage
      *
+     * Get usage metrics and statistics for a for all functions. View statistics including total functions, deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.
      *
      * @param {FunctionUsageRange} range
      * @throws {AppwriteException}
@@ -5848,6 +5888,7 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
     /**
      * Rebuild deployment
      *
+     * Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified The build process will be queued and executed asynchronously. The original deployment&#039;s code will be preserved and used for the new build.
      *
      * @param {string} functionId
      * @param {string} deploymentId
@@ -5878,6 +5919,7 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
     /**
      * Cancel deployment
      *
+     * Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn&#039;t started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status &#039;ready&#039;) or failed. The response includes the final build status and details.
      *
      * @param {string} functionId
      * @param {string} deploymentId
@@ -6067,6 +6109,7 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
     /**
      * Get function usage
      *
+     * Get usage metrics and statistics for a for a specific function. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.
      *
      * @param {string} functionId
      * @param {FunctionUsageRange} range
@@ -6448,6 +6491,7 @@ class Health {
     /**
      * Get billing aggregation queue
      *
+     * Get billing aggregation queue
      *
      * @param {number} threshold
      * @throws {AppwriteException}
@@ -6493,6 +6537,7 @@ class Health {
     /**
      * Get billing aggregation queue
      *
+     * Get the priority builds queue size.
      *
      * @param {number} threshold
      * @throws {AppwriteException}
@@ -6751,6 +6796,29 @@ class Health {
             return yield this.client.call('get', uri, apiHeaders, payload);
         });
     }
+    /**
+     * Get usage count aggregation queue
+     *
+     * Get the usage count aggregation queue.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueUsageCount(threshold) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiPath = '/health/queue/usage-count';
+            const payload = {};
+            if (typeof threshold !== 'undefined') {
+                payload['threshold'] = threshold;
+            }
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            const apiHeaders = {
+                'content-type': 'application/json',
+            };
+            return yield this.client.call('get', uri, apiHeaders, payload);
+        });
+    }
     /**
      * Get usage dump queue
      *
@@ -7209,23 +7277,20 @@ class Messaging {
      * @param {string} sound
      * @param {string} color
      * @param {string} tag
-     * @param {string} badge
+     * @param {number} badge
      * @param {boolean} draft
      * @param {string} scheduledAt
+     * @param {boolean} contentAvailable
+     * @param {boolean} critical
+     * @param {MessagePriority} priority
      * @throws {AppwriteException}
      * @returns {Promise<Models.Message>}
      */
-    createPush(messageId, title, body, topics, users, targets, data, action, image, icon, sound, color, tag, badge, draft, scheduledAt) {
+    createPush(messageId, title, body, topics, users, targets, data, action, image, icon, sound, color, tag, badge, draft, scheduledAt, contentAvailable, critical, priority) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof messageId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "messageId"');
             }
-            if (typeof title === 'undefined') {
-                throw new AppwriteException('Missing required parameter: "title"');
-            }
-            if (typeof body === 'undefined') {
-                throw new AppwriteException('Missing required parameter: "body"');
-            }
             const apiPath = '/messaging/messages/push';
             const payload = {};
             if (typeof messageId !== 'undefined') {
@@ -7276,6 +7341,15 @@ class Messaging {
             if (typeof scheduledAt !== 'undefined') {
                 payload['scheduledAt'] = scheduledAt;
             }
+            if (typeof contentAvailable !== 'undefined') {
+                payload['contentAvailable'] = contentAvailable;
+            }
+            if (typeof critical !== 'undefined') {
+                payload['critical'] = critical;
+            }
+            if (typeof priority !== 'undefined') {
+                payload['priority'] = priority;
+            }
             const uri = new URL(this.client.config.endpoint + apiPath);
             const apiHeaders = {
                 'content-type': 'application/json',
@@ -7305,10 +7379,13 @@ class Messaging {
      * @param {number} badge
      * @param {boolean} draft
      * @param {string} scheduledAt
+     * @param {boolean} contentAvailable
+     * @param {boolean} critical
+     * @param {MessagePriority} priority
      * @throws {AppwriteException}
      * @returns {Promise<Models.Message>}
      */
-    updatePush(messageId, topics, users, targets, title, body, data, action, image, icon, sound, color, tag, badge, draft, scheduledAt) {
+    updatePush(messageId, topics, users, targets, title, body, data, action, image, icon, sound, color, tag, badge, draft, scheduledAt, contentAvailable, critical, priority) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof messageId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "messageId"');
@@ -7360,6 +7437,15 @@ class Messaging {
             if (typeof scheduledAt !== 'undefined') {
                 payload['scheduledAt'] = scheduledAt;
             }
+            if (typeof contentAvailable !== 'undefined') {
+                payload['contentAvailable'] = contentAvailable;
+            }
+            if (typeof critical !== 'undefined') {
+                payload['critical'] = critical;
+            }
+            if (typeof priority !== 'undefined') {
+                payload['priority'] = priority;
+            }
             const uri = new URL(this.client.config.endpoint + apiPath);
             const apiHeaders = {
                 'content-type': 'application/json',
@@ -7423,7 +7509,7 @@ class Messaging {
     /**
      * Update SMS
      *
-     * Update an email message by its unique ID.
+     * Update an SMS message by its unique ID.
 
      *
      * @param {string} messageId
@@ -9034,6 +9120,7 @@ class Migrations {
     /**
      * List migrations
      *
+     * List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
      *
      * @param {string[]} queries
      * @param {string} search
@@ -9060,6 +9147,7 @@ class Migrations {
     /**
      * Migrate Appwrite data
      *
+     * Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project.
      *
      * @param {string[]} resources
      * @param {string} endpoint
@@ -9106,6 +9194,7 @@ class Migrations {
     /**
      * Generate a report on Appwrite data
      *
+     * Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
      * @param {string[]} resources
      * @param {string} endpoint
@@ -9152,6 +9241,7 @@ class Migrations {
     /**
      * Migrate Firebase data
      *
+     * Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
      *
      * @param {string[]} resources
      * @param {string} serviceAccount
@@ -9184,6 +9274,7 @@ class Migrations {
     /**
      * Generate a report on Firebase data
      *
+     * Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
      * @param {string[]} resources
      * @param {string} serviceAccount
@@ -9216,6 +9307,7 @@ class Migrations {
     /**
      * Migrate NHost data
      *
+     * Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
      *
      * @param {string[]} resources
      * @param {string} subdomain
@@ -9287,6 +9379,7 @@ class Migrations {
     /**
      * Generate a report on NHost Data
      *
+     * Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
      * @param {string[]} resources
      * @param {string} subdomain
@@ -9358,6 +9451,7 @@ class Migrations {
     /**
      * Migrate Supabase data
      *
+     * Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project.
      *
      * @param {string[]} resources
      * @param {string} endpoint
@@ -9422,6 +9516,7 @@ class Migrations {
     /**
      * Generate a report on Supabase Data
      *
+     * Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
      * @param {string[]} resources
      * @param {string} endpoint
@@ -9486,6 +9581,7 @@ class Migrations {
     /**
      * Get migration
      *
+     * Get a migration by its unique ID. This endpoint returns detailed information about a specific migration including its current status, progress, and any errors that occurred during the migration process.
      *
      * @param {string} migrationId
      * @throws {AppwriteException}
@@ -9508,6 +9604,7 @@ class Migrations {
     /**
      * Retry migration
      *
+     * Retry a failed migration. This endpoint allows you to retry a migration that has previously failed.
      *
      * @param {string} migrationId
      * @throws {AppwriteException}
@@ -9530,6 +9627,7 @@ class Migrations {
     /**
      * Delete migration
      *
+     * Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project&#039;s migration history.
      *
      * @param {string} migrationId
      * @throws {AppwriteException}
@@ -9585,7 +9683,8 @@ class Organizations {
     /**
      * Create Organization
      *
-     * Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.
+     * Create a new organization.
+
      *
      * @param {string} organizationId
      * @param {string} name
@@ -9633,7 +9732,7 @@ class Organizations {
     /**
      * Delete team
      *
-     * Delete a team using its ID. Only team members with the owner role can delete the team.
+     * Delete an organization.
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -9656,6 +9755,7 @@ class Organizations {
     /**
      * List aggregations
      *
+     * Get a list of all aggregations for an organization.
      *
      * @param {string} organizationId
      * @param {string[]} queries
@@ -9682,6 +9782,7 @@ class Organizations {
     /**
      * Get invoice
      *
+     * Get a specific aggregation using it&#039;s aggregation ID.
      *
      * @param {string} organizationId
      * @param {string} aggregationId
@@ -9708,6 +9809,7 @@ class Organizations {
     /**
      * Set team&#039;s billing address
      *
+     * Set a billing address for an organization.
      *
      * @param {string} organizationId
      * @param {string} billingAddressId
@@ -9737,6 +9839,7 @@ class Organizations {
     /**
      * Delete team&#039;s billing address
      *
+     * Delete a team&#039;s billing address.
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -9759,6 +9862,7 @@ class Organizations {
     /**
      * Get billing address
      *
+     * Get a billing address using it&#039;s ID.
      *
      * @param {string} organizationId
      * @param {string} billingAddressId
@@ -9785,6 +9889,7 @@ class Organizations {
     /**
      * Set team&#039;s billing email
      *
+     * Set the current billing email for the organization.
      *
      * @param {string} organizationId
      * @param {string} billingEmail
@@ -9814,6 +9919,7 @@ class Organizations {
     /**
      * Update organization budget
      *
+     * Update the budget limit for an organization.
      *
      * @param {string} organizationId
      * @param {number} budget
@@ -9847,6 +9953,8 @@ class Organizations {
     /**
      * List credits
      *
+     * List all credits for an organization.
+
      *
      * @param {string} organizationId
      * @param {string[]} queries
@@ -9873,6 +9981,7 @@ class Organizations {
     /**
      * Add credits from coupon
      *
+     * Add credit to an organization using a coupon.
      *
      * @param {string} organizationId
      * @param {string} couponId
@@ -9902,6 +10011,7 @@ class Organizations {
     /**
      * Get credit details
      *
+     * Get credit details.
      *
      * @param {string} organizationId
      * @param {string} creditId
@@ -9928,6 +10038,7 @@ class Organizations {
     /**
      * List invoices
      *
+     * List all invoices for an organization.
      *
      * @param {string} organizationId
      * @param {string[]} queries
@@ -9954,6 +10065,7 @@ class Organizations {
     /**
      * Get invoice
      *
+     * Get an invoice by its unique ID.
      *
      * @param {string} organizationId
      * @param {string} invoiceId
@@ -9980,6 +10092,7 @@ class Organizations {
     /**
      * Download invoice in PDF
      *
+     * Download invoice in PDF
      *
      * @param {string} organizationId
      * @param {string} invoiceId
@@ -10006,6 +10119,7 @@ class Organizations {
     /**
      * Initiate payment for failed invoice to pay live from console
      *
+     * Initiate payment for failed invoice to pay live from console
      *
      * @param {string} organizationId
      * @param {string} invoiceId
@@ -10039,6 +10153,7 @@ class Organizations {
     /**
      * View invoice in PDF
      *
+     * View invoice in PDF
      *
      * @param {string} organizationId
      * @param {string} invoiceId
@@ -10065,6 +10180,7 @@ class Organizations {
     /**
      * Set team&#039;s payment method
      *
+     * Set a organization&#039;s default payment method.
      *
      * @param {string} organizationId
      * @param {string} paymentMethodId
@@ -10094,6 +10210,7 @@ class Organizations {
     /**
      * Delete team&#039;s default payment method
      *
+     * Delete the default payment method for an organization.
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -10116,6 +10233,8 @@ class Organizations {
     /**
      * Set team&#039;s backup payment method
      *
+     * Set an organization&#039;s backup payment method.
+
      *
      * @param {string} organizationId
      * @param {string} paymentMethodId
@@ -10145,6 +10264,7 @@ class Organizations {
     /**
      * Delete team&#039;s backup payment method
      *
+     * Delete a backup payment method for an organization.
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -10167,6 +10287,7 @@ class Organizations {
     /**
      * Get payment method
      *
+     * Get an organization&#039;s payment method using it&#039;s payment method ID.
      *
      * @param {string} organizationId
      * @param {string} paymentMethodId
@@ -10193,6 +10314,7 @@ class Organizations {
     /**
      * Get organization billing plan details
      *
+     * Get the details of the current billing plan for an organization.
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -10215,6 +10337,7 @@ class Organizations {
     /**
      * Update organization billing plan
      *
+     * Update the billing plan for an organization.
      *
      * @param {string} organizationId
      * @param {BillingPlan} billingPlan
@@ -10252,6 +10375,7 @@ class Organizations {
     /**
      * Get Scopes
      *
+     * Get Scopes
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -10274,6 +10398,7 @@ class Organizations {
     /**
      * Set team&#039;s tax Id
      *
+     * Set an organization&#039;s billing tax ID.
      *
      * @param {string} organizationId
      * @param {string} taxId
@@ -10303,6 +10428,7 @@ class Organizations {
     /**
      * Get team&#039;s usage data
      *
+     * Get the usage data for an organization.
      *
      * @param {string} organizationId
      * @param {string} startDate
@@ -10339,6 +10465,7 @@ class Project {
     /**
      * Get project usage stats
      *
+     * Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.
      *
      * @param {string} startDate
      * @param {string} endDate
@@ -10513,6 +10640,7 @@ class Projects {
     /**
      * List projects
      *
+     * Get a list of all projects. You can use the query params to filter your results.
      *
      * @param {string[]} queries
      * @param {string} search
@@ -10539,6 +10667,7 @@ class Projects {
     /**
      * Create project
      *
+     * Create a new project. You can create a maximum of 100 projects per account.
      *
      * @param {string} projectId
      * @param {string} name
@@ -10618,6 +10747,7 @@ class Projects {
     /**
      * Get project
      *
+     * Get a project by its unique ID. This endpoint allows you to retrieve the project&#039;s details, including its name, description, team, region, and other metadata.
      *
      * @param {string} projectId
      * @throws {AppwriteException}
@@ -10640,6 +10770,7 @@ class Projects {
     /**
      * Update project
      *
+     * Update a project by its unique ID.
      *
      * @param {string} projectId
      * @param {string} name
@@ -10705,6 +10836,7 @@ class Projects {
     /**
      * Delete project
      *
+     * Delete a project by its unique ID.
      *
      * @param {string} projectId
      * @throws {AppwriteException}
@@ -10727,6 +10859,7 @@ class Projects {
     /**
      * Update API status
      *
+     * Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
      *
      * @param {string} projectId
      * @param {Api} api
@@ -10763,6 +10896,7 @@ class Projects {
     /**
      * Update all API status
      *
+     * Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
      *
      * @param {string} projectId
      * @param {boolean} status
@@ -10792,6 +10926,7 @@ class Projects {
     /**
      * Update project authentication duration
      *
+     * Update how long sessions created within a project should stay active for.
      *
      * @param {string} projectId
      * @param {number} duration
@@ -10821,6 +10956,7 @@ class Projects {
     /**
      * Update project users limit
      *
+     * Update the maximum number of users allowed in this project. Set to 0 for unlimited users.
      *
      * @param {string} projectId
      * @param {number} limit
@@ -10850,6 +10986,7 @@ class Projects {
     /**
      * Update project user sessions limit
      *
+     * Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
      *
      * @param {string} projectId
      * @param {number} limit
@@ -10879,6 +11016,7 @@ class Projects {
     /**
      * Update project memberships privacy attributes
      *
+     * Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status.
      *
      * @param {string} projectId
      * @param {boolean} userName
@@ -10922,6 +11060,7 @@ class Projects {
     /**
      * Update the mock numbers for the project
      *
+     * Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development.
      *
      * @param {string} projectId
      * @param {object[]} numbers
@@ -10951,6 +11090,7 @@ class Projects {
     /**
      * Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password
      *
+     * Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don&#039;t use common and insecure passwords.
      *
      * @param {string} projectId
      * @param {boolean} enabled
@@ -10980,6 +11120,7 @@ class Projects {
     /**
      * Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.
      *
+     * Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
      *
      * @param {string} projectId
      * @param {number} limit
@@ -11009,6 +11150,7 @@ class Projects {
     /**
      * Enable or disable checking user passwords for similarity with their personal data.
      *
+     * Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords.
      *
      * @param {string} projectId
      * @param {boolean} enabled
@@ -11038,6 +11180,7 @@ class Projects {
     /**
      * Update project sessions emails
      *
+     * Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.
      *
      * @param {string} projectId
      * @param {boolean} alerts
@@ -11067,6 +11210,7 @@ class Projects {
     /**
      * Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.
      *
+     * Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project.
      *
      * @param {string} projectId
      * @param {AuthMethod} method
@@ -11100,6 +11244,7 @@ class Projects {
     /**
      * Create JWT
      *
+     * Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
      *
      * @param {string} projectId
      * @param {string[]} scopes
@@ -11133,6 +11278,7 @@ class Projects {
     /**
      * List keys
      *
+     * Get a list of all API keys from the current project.
      *
      * @param {string} projectId
      * @throws {AppwriteException}
@@ -11155,6 +11301,7 @@ class Projects {
     /**
      * Create key
      *
+     * Create a new API key. It&#039;s recommended to have multiple API keys with strict scopes for separate functions within your project.
      *
      * @param {string} projectId
      * @param {string} name
@@ -11195,6 +11342,7 @@ class Projects {
     /**
      * Get key
      *
+     * Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it&#039;s scopes.
      *
      * @param {string} projectId
      * @param {string} keyId
@@ -11221,6 +11369,7 @@ class Projects {
     /**
      * Update key
      *
+     * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
      *
      * @param {string} projectId
      * @param {string} keyId
@@ -11265,6 +11414,7 @@ class Projects {
     /**
      * Delete key
      *
+     * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
      *
      * @param {string} projectId
      * @param {string} keyId
@@ -11291,6 +11441,7 @@ class Projects {
     /**
      * Update project OAuth2
      *
+     * Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers.
      *
      * @param {string} projectId
      * @param {OAuthProvider} provider
@@ -11332,6 +11483,7 @@ class Projects {
     /**
      * List platforms
      *
+     * Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
      *
      * @param {string} projectId
      * @throws {AppwriteException}
@@ -11354,6 +11506,7 @@ class Projects {
     /**
      * Create platform
      *
+     * Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
      *
      * @param {string} projectId
      * @param {PlatformType} type
@@ -11402,6 +11555,7 @@ class Projects {
     /**
      * Get platform
      *
+     * Get a platform by its unique ID. This endpoint returns the platform&#039;s details, including its name, type, and key configurations.
      *
      * @param {string} projectId
      * @param {string} platformId
@@ -11428,6 +11582,7 @@ class Projects {
     /**
      * Update platform
      *
+     * Update a platform by its unique ID. Use this endpoint to update the platform&#039;s name, key, platform store ID, or hostname.
      *
      * @param {string} projectId
      * @param {string} platformId
@@ -11473,6 +11628,7 @@ class Projects {
     /**
      * Delete platform
      *
+     * Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
      *
      * @param {string} projectId
      * @param {string} platformId
@@ -11499,6 +11655,7 @@ class Projects {
     /**
      * Update service status
      *
+     * Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
      *
      * @param {string} projectId
      * @param {ApiService} service
@@ -11535,6 +11692,7 @@ class Projects {
     /**
      * Update all service status
      *
+     * Update the status of all services. Use this endpoint to enable or disable all optional services at once.
      *
      * @param {string} projectId
      * @param {boolean} status
@@ -11564,6 +11722,7 @@ class Projects {
     /**
      * Update SMTP
      *
+     * Update the SMTP configuration for your project. Use this endpoint to configure your project&#039;s SMTP provider with your custom settings for sending transactional emails.
      *
      * @param {string} projectId
      * @param {boolean} enabled
@@ -11625,6 +11784,7 @@ class Projects {
     /**
      * Create SMTP test
      *
+     * Send a test email to verify SMTP configuration.
      *
      * @param {string} projectId
      * @param {string[]} emails
@@ -11695,6 +11855,7 @@ class Projects {
     /**
      * Update project team
      *
+     * Update the team ID of a project allowing for it to be transferred to another team.
      *
      * @param {string} projectId
      * @param {string} teamId
@@ -11724,6 +11885,7 @@ class Projects {
     /**
      * Get custom email template
      *
+     * Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
      *
      * @param {string} projectId
      * @param {EmailTemplateType} type
@@ -11754,6 +11916,7 @@ class Projects {
     /**
      * Update custom email templates
      *
+     * Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
      *
      * @param {string} projectId
      * @param {EmailTemplateType} type
@@ -11764,7 +11927,7 @@ class Projects {
      * @param {string} senderEmail
      * @param {string} replyTo
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Project>}
+     * @returns {Promise<Models.EmailTemplate>}
      */
     updateEmailTemplate(projectId, type, locale, subject, message, senderName, senderEmail, replyTo) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -11810,6 +11973,7 @@ class Projects {
     /**
      * Reset custom email template
      *
+     * Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state.
      *
      * @param {string} projectId
      * @param {EmailTemplateType} type
@@ -11840,6 +12004,7 @@ class Projects {
     /**
      * Get custom SMS template
      *
+     * Get a custom SMS template for the specified locale and type returning it&#039;s contents.
      *
      * @param {string} projectId
      * @param {SmsTemplateType} type
@@ -11870,6 +12035,7 @@ class Projects {
     /**
      * Update custom SMS template
      *
+     * Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
      *
      * @param {string} projectId
      * @param {SmsTemplateType} type
@@ -11907,6 +12073,7 @@ class Projects {
     /**
      * Reset custom SMS template
      *
+     * Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
      *
      * @param {string} projectId
      * @param {SmsTemplateType} type
@@ -11937,6 +12104,7 @@ class Projects {
     /**
      * List webhooks
      *
+     * Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
      *
      * @param {string} projectId
      * @throws {AppwriteException}
@@ -11959,6 +12127,7 @@ class Projects {
     /**
      * Create webhook
      *
+     * Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
      *
      * @param {string} projectId
      * @param {string} name
@@ -12021,6 +12190,7 @@ class Projects {
     /**
      * Get webhook
      *
+     * Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
      *
      * @param {string} projectId
      * @param {string} webhookId
@@ -12047,6 +12217,7 @@ class Projects {
     /**
      * Update webhook
      *
+     * Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
      *
      * @param {string} projectId
      * @param {string} webhookId
@@ -12113,6 +12284,7 @@ class Projects {
     /**
      * Delete webhook
      *
+     * Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
      *
      * @param {string} projectId
      * @param {string} webhookId
@@ -12139,6 +12311,7 @@ class Projects {
     /**
      * Update webhook signature key
      *
+     * Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
      *
      * @param {string} projectId
      * @param {string} webhookId
@@ -12281,6 +12454,7 @@ class Proxy {
     /**
      * Update rule verification status
      *
+     * Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.
      *
      * @param {string} ruleId
      * @throws {AppwriteException}
@@ -12811,6 +12985,8 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
     /**
      * Get storage usage stats
      *
+     * Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
+
      *
      * @param {StorageUsageRange} range
      * @throws {AppwriteException}
@@ -12833,6 +13009,8 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
     /**
      * Get bucket usage stats
      *
+     * Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
+
      *
      * @param {string} bucketId
      * @param {StorageUsageRange} range
@@ -13799,6 +13977,8 @@ class Users {
     /**
      * Get users usage stats
      *
+     * Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
+
      *
      * @param {UserUsageRange} range
      * @throws {AppwriteException}
@@ -14045,7 +14225,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
      * @param {string} userId
      * @param {AuthenticatorType} type
      * @throws {AppwriteException}
-     * @returns {Promise<Models.User<Preferences>>}
+     * @returns {Promise<{}>}
      */
     deleteMfaAuthenticator(userId, type) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -14700,6 +14880,7 @@ class Vcs {
     /**
      * List repositories
      *
+     * 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&#039;s runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
      *
      * @param {string} installationId
      * @param {string} search
@@ -14726,6 +14907,7 @@ class Vcs {
     /**
      * Create repository
      *
+     * 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.
      *
      * @param {string} installationId
      * @param {string} name
@@ -14762,6 +14944,7 @@ class Vcs {
     /**
      * Get repository
      *
+     * 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.
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -14788,6 +14971,8 @@ class Vcs {
     /**
      * List repository branches
      *
+     * 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.
+
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -14814,6 +14999,8 @@ class Vcs {
     /**
      * Get files and directories of a VCS repository
      *
+     * 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.
+
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -14844,6 +15031,7 @@ class Vcs {
     /**
      * Detect runtime settings from source code
      *
+     * Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository&#039;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.
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -14874,6 +15062,7 @@ class Vcs {
     /**
      * Authorize external deployment
      *
+     * 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.
      *
      * @param {string} installationId
      * @param {string} repositoryId
@@ -14907,6 +15096,8 @@ class Vcs {
     /**
      * List installations
      *
+     * List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
+
      *
      * @param {string[]} queries
      * @param {string} search
@@ -14933,6 +15124,7 @@ class Vcs {
     /**
      * Get installation
      *
+     * Get a VCS installation by its unique ID. This endpoint returns the installation&#039;s details including its provider, organization, and configuration.
      *
      * @param {string} installationId
      * @throws {AppwriteException}
@@ -14955,6 +15147,7 @@ class Vcs {
     /**
      * Delete installation
      *
+     * Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.
      *
      * @param {string} installationId
      * @throws {AppwriteException}
@@ -15579,6 +15772,12 @@ var Name;
     Name["V1migrations"] = "v1-migrations";
 })(Name || (Name = {}));
 
+var MessagePriority;
+(function (MessagePriority) {
+    MessagePriority["Normal"] = "normal";
+    MessagePriority["High"] = "high";
+})(MessagePriority || (MessagePriority = {}));
+
 var SmtpEncryption;
 (function (SmtpEncryption) {
     SmtpEncryption["None"] = "none";
@@ -15985,6 +16184,7 @@ var ImageFormat;
     ImageFormat["Gif"] = "gif";
     ImageFormat["Png"] = "png";
     ImageFormat["Webp"] = "webp";
+    ImageFormat["Heic"] = "heic";
     ImageFormat["Avif"] = "avif";
 })(ImageFormat || (ImageFormat = {}));
 
@@ -16024,5 +16224,5 @@ var MessagingProviderType;
     MessagingProviderType["Push"] = "push";
 })(MessagingProviderType || (MessagingProviderType = {}));
 
-export { Account, Api, ApiService, AppwriteException, Assistant, AuthMethod, AuthenticationFactor, AuthenticatorType, Avatars, Backups, BillingPlan, Browser, Client, Compression, Console, CreditCard, DatabaseUsageRange, Databases, EmailTemplateLocale, EmailTemplateType, ExecutionMethod, Flag, FunctionUsageRange, Functions, Graphql, Health, ID, ImageFormat, ImageGravity, IndexType, Locale, Messaging, MessagingProviderType, Migrations, Name, OAuthProvider, Organizations, PasswordHash, Permission, PlatformType, Project, ProjectUsageRange, Projects, Proxy, Query, Region, RelationMutate, RelationshipType, ResourceType, Role, Runtime, SMTPSecure, SmsTemplateLocale, SmsTemplateType, SmtpEncryption, Storage, StorageUsageRange, Teams, UserUsageRange, Users, Vcs };
+export { Account, Api, ApiService, AppwriteException, Assistant, AuthMethod, AuthenticationFactor, AuthenticatorType, Avatars, Backups, BillingPlan, Browser, Client, Compression, Console, CreditCard, DatabaseUsageRange, Databases, EmailTemplateLocale, EmailTemplateType, ExecutionMethod, Flag, FunctionUsageRange, Functions, Graphql, Health, ID, ImageFormat, ImageGravity, IndexType, Locale, MessagePriority, Messaging, MessagingProviderType, Migrations, Name, OAuthProvider, Organizations, PasswordHash, Permission, PlatformType, Project, ProjectUsageRange, Projects, Proxy, Query, Region, RelationMutate, RelationshipType, ResourceType, Role, Runtime, SMTPSecure, SmsTemplateLocale, SmsTemplateType, SmtpEncryption, Storage, StorageUsageRange, Teams, UserUsageRange, Users, Vcs };
 //# sourceMappingURL=sdk.js.map