@appwrite.io/console 1.4.5 → 1.4.7

package/types/services/account.d.ts

@@ -40,6 +40,7 @@ export declare class Account {
     /**
      * List billing addresses
      *
+     * List all billing addresses for a user.
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
@@ -49,6 +50,7 @@ export declare class Account {
     /**
      * Create new billing address
      *
+     * Add a new billing address to a user's account.
      *
      * @param {string} country
      * @param {string} streetAddress
@@ -63,6 +65,7 @@ export declare class Account {
     /**
      * Get billing address
      *
+     * Get a specific billing address for a user using it's ID.
      *
      * @param {string} billingAddressId
      * @throws {AppwriteException}
@@ -72,6 +75,7 @@ export declare class Account {
     /**
      * Update billing address
      *
+     * Update a specific billing address using it's ID.
      *
      * @param {string} billingAddressId
      * @param {string} country
@@ -87,6 +91,7 @@ export declare class Account {
     /**
      * Delete billing address
      *
+     * Delete a specific billing address using it's ID.
      *
      * @param {string} billingAddressId
      * @throws {AppwriteException}
@@ -96,6 +101,7 @@ export declare class Account {
     /**
      * Get coupon details
      *
+     * Get coupon details for an account.
      *
      * @param {string} couponId
      * @throws {AppwriteException}
@@ -138,6 +144,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}
@@ -222,9 +229,9 @@ 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: string, otp: string): Promise<{}>;
+    updateMfaChallenge(challengeId: string, otp: string): Promise<Models.Session>;
     /**
      * List factors
      *
@@ -285,6 +292,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}
@@ -294,6 +302,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>}
@@ -302,6 +311,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}
@@ -311,6 +321,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
@@ -322,6 +333,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}
@@ -331,6 +343,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
@@ -342,6 +355,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}
@@ -536,6 +550,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
@@ -547,6 +562,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
@@ -557,6 +573,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}

package/types/services/assistant.d.ts

@@ -5,6 +5,7 @@ export declare class Assistant {
     /**
      * Ask query
      *
+     * Send a prompt to the AI assistant and receive a response. This endpoint allows you to interact with Appwrite'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}

package/types/services/backups.d.ts

@@ -6,6 +6,7 @@ export declare class Backups {
     /**
      * List archives
      *
+     * List all archives for a project.
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
@@ -15,6 +16,7 @@ export declare class Backups {
     /**
      * Create archive
      *
+     * Create a new archive asynchronously for a project.
      *
      * @param {string[]} services
      * @param {string} resourceId
@@ -25,6 +27,7 @@ export declare class Backups {
     /**
      * Get backup archive
      *
+     * Get a backup archive using it's ID.
      *
      * @param {string} archiveId
      * @throws {AppwriteException}
@@ -34,6 +37,7 @@ export declare class Backups {
     /**
      * Delete archive
      *
+     * Delete an existing archive for a project.
      *
      * @param {string} archiveId
      * @throws {AppwriteException}
@@ -43,6 +47,7 @@ export declare class Backups {
     /**
      * List backup policies
      *
+     * List all policies for a project.
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
@@ -52,6 +57,7 @@ export declare class Backups {
     /**
      * Create backup policy
      *
+     * Create a new backup policy.
      *
      * @param {string} policyId
      * @param {string[]} services
@@ -67,6 +73,7 @@ export declare class Backups {
     /**
      * Get backup policy
      *
+     * Get a backup policy using it's ID.
      *
      * @param {string} policyId
      * @throws {AppwriteException}
@@ -76,6 +83,7 @@ export declare class Backups {
     /**
      * Update backup policy
      *
+     * Update an existing policy using it's ID.
      *
      * @param {string} policyId
      * @param {string} name
@@ -89,6 +97,7 @@ export declare class Backups {
     /**
      * Delete backup policy
      *
+     * Delete a policy using it's ID.
      *
      * @param {string} policyId
      * @throws {AppwriteException}
@@ -98,6 +107,7 @@ export declare class Backups {
     /**
      * Create restoration
      *
+     * Create and trigger a new restoration for a backup on a project.
      *
      * @param {string} archiveId
      * @param {string[]} services
@@ -110,6 +120,7 @@ export declare class Backups {
     /**
      * List restorations
      *
+     * List all backup restorations for a project.
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
@@ -119,10 +130,11 @@ export declare 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: string): Promise<Models.BackupArchive>;
+    getRestoration(restorationId: string): Promise<Models.BackupRestoration>;
 }

package/types/services/console.d.ts

@@ -6,6 +6,7 @@ export declare class Console {
     /**
      * Get campaign details
      *
+     * Recieve the details of a compaign using it's ID.
      *
      * @param {string} campaignId
      * @throws {AppwriteException}
@@ -15,6 +16,7 @@ export declare class Console {
     /**
      * Get coupon details
      *
+     * Get the details of a coupon using it's coupon ID.
      *
      * @param {string} couponId
      * @throws {AppwriteException}
@@ -24,6 +26,7 @@ export declare class Console {
     /**
      * Get plans
      *
+     * Return a list of all available plans.
      *
      * @throws {AppwriteException}
      * @returns {Promise<Models.BillingPlanList>}
@@ -32,15 +35,17 @@ export declare 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: string): Promise<{}>;
+    createProgramMembership<Preferences extends Models.Preferences>(programId: string): Promise<Models.Organization<Preferences>>;
     /**
      * Get Regions
      *
+     * Get all available regions for the console.
      *
      * @throws {AppwriteException}
      * @returns {Promise<Models.ConsoleRegionList>}
@@ -49,6 +54,7 @@ export declare class Console {
     /**
      * Create source
      *
+     * Create a new source.
      *
      * @param {string} ref
      * @param {string} referrer

package/types/services/databases.d.ts

@@ -34,6 +34,7 @@ export declare 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}
@@ -648,6 +649,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
@@ -670,6 +672,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

package/types/services/functions.d.ts

@@ -93,6 +93,7 @@ export declare 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}
@@ -212,6 +213,7 @@ Use the "command" 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's code will be preserved and used for the new build.
      *
      * @param {string} functionId
      * @param {string} deploymentId
@@ -223,6 +225,7 @@ Use the "command" 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't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.
      *
      * @param {string} functionId
      * @param {string} deploymentId
@@ -295,6 +298,7 @@ Use the "command" 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

package/types/services/health.d.ts

@@ -71,6 +71,7 @@ export declare class Health {
     /**
      * Get billing aggregation queue
      *
+     * Get billing aggregation queue
      *
      * @param {number} threshold
      * @throws {AppwriteException}
@@ -90,6 +91,7 @@ export declare class Health {
     /**
      * Get billing aggregation queue
      *
+     * Get the priority builds queue size.
      *
      * @param {number} threshold
      * @throws {AppwriteException}
@@ -199,6 +201,16 @@ export declare class Health {
      * @returns {Promise<Models.HealthQueue>}
      */
     getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get usage count aggregation queue
+     *
+     * Get the usage count aggregation queue.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueUsageCount(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get usage dump queue
      *

package/types/services/messaging.d.ts

@@ -1,5 +1,6 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { MessagePriority } from '../enums/message-priority';
 import { SmtpEncryption } from '../enums/smtp-encryption';
 export declare class Messaging {
     client: Client;
@@ -76,13 +77,16 @@ export declare 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: string, title: string, body: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
+    createPush(messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority): Promise<Models.Message>;
     /**
      * Update push notification
      *
@@ -105,10 +109,13 @@ export declare 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: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
+    updatePush(messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority): Promise<Models.Message>;
     /**
      * Create SMS
      *
@@ -128,7 +135,7 @@ export declare class Messaging {
     /**
      * Update SMS
      *
-     * Update an email message by its unique ID.
+     * Update an SMS message by its unique ID.
 
      *
      * @param {string} messageId

package/types/services/migrations.d.ts

@@ -6,6 +6,7 @@ export declare 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
@@ -16,6 +17,7 @@ export declare 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
@@ -28,6 +30,7 @@ export declare 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
@@ -40,6 +43,7 @@ export declare 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
@@ -50,6 +54,7 @@ export declare 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
@@ -60,6 +65,7 @@ export declare 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
@@ -76,6 +82,7 @@ export declare 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
@@ -92,6 +99,7 @@ export declare 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
@@ -107,6 +115,7 @@ export declare 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
@@ -122,6 +131,7 @@ export declare 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}
@@ -131,6 +141,7 @@ export declare 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}
@@ -140,6 +151,7 @@ export declare class Migrations {
     /**
      * Delete migration
      *
+     * Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project's migration history.
      *
      * @param {string} migrationId
      * @throws {AppwriteException}