@appwrite.io/console 8.2.0 → 9.0.0

package/types/services/databases.d.ts

@@ -373,6 +373,7 @@ export declare class Databases {
      * @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @param {boolean} params.documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @param {boolean} params.enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
+     * @param {boolean} params.purge - When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Collection>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateTable` instead.
@@ -384,6 +385,7 @@ export declare class Databases {
         permissions?: string[];
         documentSecurity?: boolean;
         enabled?: boolean;
+        purge?: boolean;
     }): Promise<Models.Collection>;
     /**
      * Update a collection by its unique ID.
@@ -394,11 +396,12 @@ export declare class Databases {
      * @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @param {boolean} documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @param {boolean} enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
+     * @param {boolean} purge - When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Collection>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updateCollection(databaseId: string, collectionId: string, name?: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
+    updateCollection(databaseId: string, collectionId: string, name?: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean, purge?: boolean): Promise<Models.Collection>;
     /**
      * Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.
      *
@@ -1794,7 +1797,7 @@ export declare class Databases {
      * @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.
      * @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
      * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
-     * @param {number} params.ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
+     * @param {number} params.ttl - TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listRows` instead.
@@ -1815,7 +1818,7 @@ export declare class Databases {
      * @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.
      * @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
      * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
-     * @param {number} ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
+     * @param {number} ttl - TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated Use the object parameter style method for a better developer experience.

package/types/services/migrations.d.ts

@@ -204,6 +204,8 @@ export declare class Migrations {
      */
     getFirebaseReport(resources: FirebaseMigrationResource[], serviceAccount: string): Promise<Models.MigrationReport>;
     /**
+     * Export documents to a JSON file from your Appwrite database. This endpoint allows you to export documents to a JSON file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
+     *
      *
      * @param {string} params.resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.
      * @param {string} params.filename - The name of the file to be created for the export, excluding the .json extension.
@@ -221,6 +223,8 @@ export declare class Migrations {
         notify?: boolean;
     }): Promise<Models.Migration>;
     /**
+     * Export documents to a JSON file from your Appwrite database. This endpoint allows you to export documents to a JSON file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
+     *
      *
      * @param {string} resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.
      * @param {string} filename - The name of the file to be created for the export, excluding the .json extension.
@@ -233,6 +237,8 @@ export declare class Migrations {
      */
     createJSONExport(resourceId: string, filename: string, columns?: string[], queries?: string[], notify?: boolean): Promise<Models.Migration>;
     /**
+     * Import documents from a JSON file into your Appwrite database. This endpoint allows you to import documents from a JSON file uploaded to Appwrite Storage bucket.
+     *
      *
      * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
      * @param {string} params.fileId - File ID.
@@ -248,6 +254,8 @@ export declare class Migrations {
         internalFile?: boolean;
     }): Promise<Models.Migration>;
     /**
+     * Import documents from a JSON file into your Appwrite database. This endpoint allows you to import documents from a JSON file uploaded to Appwrite Storage bucket.
+     *
      *
      * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
      * @param {string} fileId - File ID.

package/types/services/organizations.d.ts

@@ -1,6 +1,7 @@
 import { Client } from '../client';
 import type { Models } from '../models';
 import { Platform } from '../enums/platform';
+import { Addon } from '../enums/addon';
 import { Scopes } from '../enums/scopes';
 export declare class Organizations {
     client: Client;
@@ -125,6 +126,144 @@ export declare class Organizations {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     delete(organizationId: string): Promise<{}>;
+    /**
+     * List all billing addons for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonList>}
+     */
+    listAddons(params: {
+        organizationId: string;
+    }): Promise<Models.AddonList>;
+    /**
+     * List all billing addons for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listAddons(organizationId: string): Promise<Models.AddonList>;
+    /**
+     * Create the BAA billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     */
+    createBaaAddon(params: {
+        organizationId: string;
+    }): Promise<Models.Addon>;
+    /**
+     * Create the BAA billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createBaaAddon(organizationId: string): Promise<Models.Addon>;
+    /**
+     * Get the details of a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {string} params.addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     */
+    getAddon(params: {
+        organizationId: string;
+        addonId: string;
+    }): Promise<Models.Addon>;
+    /**
+     * Get the details of a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {string} addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getAddon(organizationId: string, addonId: string): Promise<Models.Addon>;
+    /**
+     * Delete a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {string} params.addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteAddon(params: {
+        organizationId: string;
+        addonId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {string} addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteAddon(organizationId: string, addonId: string): Promise<{}>;
+    /**
+     * Confirm payment for a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {string} params.addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     */
+    confirmAddonPayment(params: {
+        organizationId: string;
+        addonId: string;
+    }): Promise<Models.Addon>;
+    /**
+     * Confirm payment for a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {string} addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    confirmAddonPayment(organizationId: string, addonId: string): Promise<Models.Addon>;
+    /**
+     * Get the price details for a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {Addon} params.addon - Addon key identifier (e.g. baa).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonPrice>}
+     */
+    getAddonPrice(params: {
+        organizationId: string;
+        addon: Addon;
+    }): Promise<Models.AddonPrice>;
+    /**
+     * Get the price details for a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {Addon} addon - Addon key identifier (e.g. baa).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonPrice>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getAddonPrice(organizationId: string, addon: Addon): Promise<Models.AddonPrice>;
     /**
      * Get a list of all aggregations for an organization.
      *