node-appwrite 22.1.2 → 23.0.0

package/dist/services/tables-db.d.mts

@@ -2,7 +2,7 @@ import { Client } from '../client.mjs';
 import { Models } from '../models.mjs';
 import { RelationshipType } from '../enums/relationship-type.mjs';
 import { RelationMutate } from '../enums/relation-mutate.mjs';
-import { IndexType } from '../enums/index-type.mjs';
+import { TablesDBIndexType } from '../enums/tables-db-index-type.mjs';
 import { OrderBy } from '../enums/order-by.mjs';
 import '../query.mjs';
 import '../enums/database-type.mjs';
@@ -1773,7 +1773,7 @@ declare class TablesDB {
      * @param {string} params.databaseId - Database ID.
      * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
      * @param {string} params.key - Index Key.
-     * @param {IndexType} params.type - Index type.
+     * @param {TablesDBIndexType} params.type - Index type.
      * @param {string[]} params.columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
      * @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
      * @param {number[]} params.lengths - Length of index. Maximum of 100
@@ -1784,7 +1784,7 @@ declare class TablesDB {
         databaseId: string;
         tableId: string;
         key: string;
-        type: IndexType;
+        type: TablesDBIndexType;
         columns: string[];
         orders?: OrderBy[];
         lengths?: number[];
@@ -1796,7 +1796,7 @@ declare class TablesDB {
      * @param {string} databaseId - Database ID.
      * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
      * @param {string} key - Index Key.
-     * @param {IndexType} type - Index type.
+     * @param {TablesDBIndexType} type - Index type.
      * @param {string[]} columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
      * @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
      * @param {number[]} lengths - Length of index. Maximum of 100
@@ -1804,7 +1804,7 @@ declare class TablesDB {
      * @returns {Promise<Models.ColumnIndex>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createIndex(databaseId: string, tableId: string, key: string, type: IndexType, columns: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.ColumnIndex>;
+    createIndex(databaseId: string, tableId: string, key: string, type: TablesDBIndexType, columns: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.ColumnIndex>;
     /**
      * Get index by ID.
      *
@@ -1863,6 +1863,7 @@ declare class TablesDB {
      * @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).
      * @throws {AppwriteException}
      * @returns {Promise<Models.RowList<Row>>}
      */
@@ -1872,6 +1873,7 @@ declare class TablesDB {
         queries?: string[];
         transactionId?: string;
         total?: boolean;
+        ttl?: number;
     }): Promise<Models.RowList<Row>>;
     /**
      * Get a list of all the user's rows in a given table. You can use the query params to filter your results.
@@ -1881,11 +1883,12 @@ declare class TablesDB {
      * @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).
      * @throws {AppwriteException}
      * @returns {Promise<Models.RowList<Row>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.RowList<Row>>;
+    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.RowList<Row>>;
     /**
      * Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
      *

package/dist/services/tables-db.d.ts

@@ -2,7 +2,7 @@ import { Client } from '../client.js';
 import { Models } from '../models.js';
 import { RelationshipType } from '../enums/relationship-type.js';
 import { RelationMutate } from '../enums/relation-mutate.js';
-import { IndexType } from '../enums/index-type.js';
+import { TablesDBIndexType } from '../enums/tables-db-index-type.js';
 import { OrderBy } from '../enums/order-by.js';
 import '../query.js';
 import '../enums/database-type.js';
@@ -1773,7 +1773,7 @@ declare class TablesDB {
      * @param {string} params.databaseId - Database ID.
      * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
      * @param {string} params.key - Index Key.
-     * @param {IndexType} params.type - Index type.
+     * @param {TablesDBIndexType} params.type - Index type.
      * @param {string[]} params.columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
      * @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
      * @param {number[]} params.lengths - Length of index. Maximum of 100
@@ -1784,7 +1784,7 @@ declare class TablesDB {
         databaseId: string;
         tableId: string;
         key: string;
-        type: IndexType;
+        type: TablesDBIndexType;
         columns: string[];
         orders?: OrderBy[];
         lengths?: number[];
@@ -1796,7 +1796,7 @@ declare class TablesDB {
      * @param {string} databaseId - Database ID.
      * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
      * @param {string} key - Index Key.
-     * @param {IndexType} type - Index type.
+     * @param {TablesDBIndexType} type - Index type.
      * @param {string[]} columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
      * @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
      * @param {number[]} lengths - Length of index. Maximum of 100
@@ -1804,7 +1804,7 @@ declare class TablesDB {
      * @returns {Promise<Models.ColumnIndex>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createIndex(databaseId: string, tableId: string, key: string, type: IndexType, columns: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.ColumnIndex>;
+    createIndex(databaseId: string, tableId: string, key: string, type: TablesDBIndexType, columns: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.ColumnIndex>;
     /**
      * Get index by ID.
      *
@@ -1863,6 +1863,7 @@ declare class TablesDB {
      * @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).
      * @throws {AppwriteException}
      * @returns {Promise<Models.RowList<Row>>}
      */
@@ -1872,6 +1873,7 @@ declare class TablesDB {
         queries?: string[];
         transactionId?: string;
         total?: boolean;
+        ttl?: number;
     }): Promise<Models.RowList<Row>>;
     /**
      * Get a list of all the user's rows in a given table. You can use the query params to filter your results.
@@ -1881,11 +1883,12 @@ declare class TablesDB {
      * @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).
      * @throws {AppwriteException}
      * @returns {Promise<Models.RowList<Row>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.RowList<Row>>;
+    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.RowList<Row>>;
     /**
      * Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
      *

package/dist/services/tables-db.js

@@ -2865,7 +2865,8 @@ class TablesDB {
         tableId: rest[0],
         queries: rest[1],
         transactionId: rest[2],
-        total: rest[3]
+        total: rest[3],
+        ttl: rest[4]
       };
     }
     const databaseId = params.databaseId;
@@ -2873,6 +2874,7 @@ class TablesDB {
     const queries = params.queries;
     const transactionId = params.transactionId;
     const total = params.total;
+    const ttl = params.ttl;
     if (typeof databaseId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "databaseId"');
     }
@@ -2890,6 +2892,9 @@ class TablesDB {
     if (typeof total !== "undefined") {
       payload["total"] = total;
     }
+    if (typeof ttl !== "undefined") {
+      payload["ttl"] = ttl;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {};
     return this.client.call(