node-appwrite 22.1.2 → 23.0.0

package/dist/services/databases.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 { DatabasesIndexType } from '../enums/databases-index-type.js';
 import { OrderBy } from '../enums/order-by.js';
 import '../query.js';
 import '../enums/database-type.js';
@@ -447,7 +447,7 @@ declare class Databases {
      *
      *
      * @param {string} params.databaseId - Database ID.
-     * @param {string} params.collectionId - Collection ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @param {string} params.key - Attribute Key.
      * @param {boolean} params.required - Is attribute required?
      * @param {boolean} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
@@ -469,7 +469,7 @@ declare class Databases {
      *
      *
      * @param {string} databaseId - Database ID.
-     * @param {string} collectionId - Collection ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @param {string} key - Attribute Key.
      * @param {boolean} required - Is attribute required?
      * @param {boolean} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
@@ -1378,6 +1378,40 @@ declare class Databases {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: RelationshipType, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
+    /**
+     * Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {string} params.key - Attribute Key.
+     * @param {RelationMutate} params.onDelete - Constraints option
+     * @param {string} params.newKey - New Attribute Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AttributeRelationship>}
+     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateRelationshipColumn` instead.
+     */
+    updateRelationshipAttribute(params: {
+        databaseId: string;
+        collectionId: string;
+        key: string;
+        onDelete?: RelationMutate;
+        newKey?: string;
+    }): Promise<Models.AttributeRelationship>;
+    /**
+     * Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {string} key - Attribute Key.
+     * @param {RelationMutate} onDelete - Constraints option
+     * @param {string} newKey - New Attribute Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AttributeRelationship>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string): Promise<Models.AttributeRelationship>;
     /**
      * Create a string attribute.
      *
@@ -1743,40 +1777,6 @@ declare class Databases {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
-    /**
-     * Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
-     *
-     *
-     * @param {string} params.databaseId - Database ID.
-     * @param {string} params.collectionId - Collection ID.
-     * @param {string} params.key - Attribute Key.
-     * @param {RelationMutate} params.onDelete - Constraints option
-     * @param {string} params.newKey - New Attribute Key.
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.AttributeRelationship>}
-     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateRelationshipColumn` instead.
-     */
-    updateRelationshipAttribute(params: {
-        databaseId: string;
-        collectionId: string;
-        key: string;
-        onDelete?: RelationMutate;
-        newKey?: string;
-    }): Promise<Models.AttributeRelationship>;
-    /**
-     * Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
-     *
-     *
-     * @param {string} databaseId - Database ID.
-     * @param {string} collectionId - Collection ID.
-     * @param {string} key - Attribute Key.
-     * @param {RelationMutate} onDelete - Constraints option
-     * @param {string} newKey - New Attribute Key.
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.AttributeRelationship>}
-     * @deprecated Use the object parameter style method for a better developer experience.
-     */
-    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string): Promise<Models.AttributeRelationship>;
     /**
      * Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
      *
@@ -1785,6 +1785,7 @@ 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).
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listRows` instead.
@@ -1795,6 +1796,7 @@ declare class Databases {
         queries?: string[];
         transactionId?: string;
         total?: boolean;
+        ttl?: number;
     }): Promise<Models.DocumentList<Document>>;
     /**
      * Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
@@ -1804,11 +1806,12 @@ 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).
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.DocumentList<Document>>;
+    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.DocumentList<Document>>;
     /**
      * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
@@ -2208,7 +2211,7 @@ declare class Databases {
      * @param {string} params.databaseId - Database ID.
      * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @param {string} params.key - Index Key.
-     * @param {IndexType} params.type - Index type.
+     * @param {DatabasesIndexType} params.type - Index type.
      * @param {string[]} params.attributes - Array of attributes to index. Maximum of 100 attributes 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
@@ -2220,7 +2223,7 @@ declare class Databases {
         databaseId: string;
         collectionId: string;
         key: string;
-        type: IndexType;
+        type: DatabasesIndexType;
         attributes: string[];
         orders?: OrderBy[];
         lengths?: number[];
@@ -2232,7 +2235,7 @@ declare class Databases {
      * @param {string} databaseId - Database ID.
      * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @param {string} key - Index Key.
-     * @param {IndexType} type - Index type.
+     * @param {DatabasesIndexType} type - Index type.
      * @param {string[]} attributes - Array of attributes to index. Maximum of 100 attributes 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
@@ -2240,7 +2243,7 @@ declare class Databases {
      * @returns {Promise<Models.Index>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.Index>;
+    createIndex(databaseId: string, collectionId: string, key: string, type: DatabasesIndexType, attributes: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.Index>;
     /**
      * Get an index by its unique ID.
      *

package/dist/services/databases.js

@@ -2068,6 +2068,52 @@ class Databases {
       payload
     );
   }
+  updateRelationshipAttribute(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        databaseId: paramsOrFirst,
+        collectionId: rest[0],
+        key: rest[1],
+        onDelete: rest[2],
+        newKey: rest[3]
+      };
+    }
+    const databaseId = params.databaseId;
+    const collectionId = params.collectionId;
+    const key = params.key;
+    const onDelete = params.onDelete;
+    const newKey = params.newKey;
+    if (typeof databaseId === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "databaseId"');
+    }
+    if (typeof collectionId === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "collectionId"');
+    }
+    if (typeof key === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "key"');
+    }
+    const apiPath = "/databases/{databaseId}/collections/{collectionId}/attributes/relationship/{key}".replace("{databaseId}", databaseId).replace("{collectionId}", collectionId).replace("{key}", key);
+    const payload = {};
+    if (typeof onDelete !== "undefined") {
+      payload["onDelete"] = onDelete;
+    }
+    if (typeof newKey !== "undefined") {
+      payload["newKey"] = newKey;
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {
+      "content-type": "application/json"
+    };
+    return this.client.call(
+      "patch",
+      uri,
+      apiHeaders,
+      payload
+    );
+  }
   createStringAttribute(paramsOrFirst, ...rest) {
     let params;
     if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
@@ -2635,52 +2681,6 @@ class Databases {
       payload
     );
   }
-  updateRelationshipAttribute(paramsOrFirst, ...rest) {
-    let params;
-    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
-      params = paramsOrFirst || {};
-    } else {
-      params = {
-        databaseId: paramsOrFirst,
-        collectionId: rest[0],
-        key: rest[1],
-        onDelete: rest[2],
-        newKey: rest[3]
-      };
-    }
-    const databaseId = params.databaseId;
-    const collectionId = params.collectionId;
-    const key = params.key;
-    const onDelete = params.onDelete;
-    const newKey = params.newKey;
-    if (typeof databaseId === "undefined") {
-      throw new client.AppwriteException('Missing required parameter: "databaseId"');
-    }
-    if (typeof collectionId === "undefined") {
-      throw new client.AppwriteException('Missing required parameter: "collectionId"');
-    }
-    if (typeof key === "undefined") {
-      throw new client.AppwriteException('Missing required parameter: "key"');
-    }
-    const apiPath = "/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship".replace("{databaseId}", databaseId).replace("{collectionId}", collectionId).replace("{key}", key);
-    const payload = {};
-    if (typeof onDelete !== "undefined") {
-      payload["onDelete"] = onDelete;
-    }
-    if (typeof newKey !== "undefined") {
-      payload["newKey"] = newKey;
-    }
-    const uri = new URL(this.client.config.endpoint + apiPath);
-    const apiHeaders = {
-      "content-type": "application/json"
-    };
-    return this.client.call(
-      "patch",
-      uri,
-      apiHeaders,
-      payload
-    );
-  }
   listDocuments(paramsOrFirst, ...rest) {
     let params;
     if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
@@ -2691,7 +2691,8 @@ class Databases {
         collectionId: rest[0],
         queries: rest[1],
         transactionId: rest[2],
-        total: rest[3]
+        total: rest[3],
+        ttl: rest[4]
       };
     }
     const databaseId = params.databaseId;
@@ -2699,6 +2700,7 @@ class Databases {
     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"');
     }
@@ -2716,6 +2718,9 @@ class Databases {
     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(