node-appwrite 17.0.0 → 17.1.0

package/dist/services/databases.d.mts

@@ -452,7 +452,9 @@ declare class Databases {
      */
     createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document>;
     /**
-     * Create new Documents. 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.
+     * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+
+Create new Documents. 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.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -462,8 +464,9 @@ declare class Databases {
      */
     createDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, documents: object[]): Promise<Models.DocumentList<Document>>;
     /**
-     * Create or update Documents. 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.
+     * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
 
+Create or update Documents. 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.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -471,9 +474,11 @@ declare class Databases {
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      */
-    upsertDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, documents?: object[]): Promise<Models.DocumentList<Document>>;
+    upsertDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, documents: object[]): Promise<Models.DocumentList<Document>>;
     /**
-     * Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.
+     * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+
+Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -484,7 +489,9 @@ declare class Databases {
      */
     updateDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, data?: object, queries?: string[]): Promise<Models.DocumentList<Document>>;
     /**
-     * Bulk delete documents using queries, if no queries are passed then all documents are deleted.
+     * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+
+Bulk delete documents using queries, if no queries are passed then all documents are deleted.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -504,6 +511,20 @@ declare class Databases {
      * @returns {Promise<Document>}
      */
     getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
+    /**
+     * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+
+Create or update a 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.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {object} data
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     */
+    upsertDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: object, permissions?: string[]): Promise<Document>;
     /**
      * Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
      *

package/dist/services/databases.d.ts

@@ -452,7 +452,9 @@ declare class Databases {
      */
     createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document>;
     /**
-     * Create new Documents. 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.
+     * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+
+Create new Documents. 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.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -462,8 +464,9 @@ declare class Databases {
      */
     createDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, documents: object[]): Promise<Models.DocumentList<Document>>;
     /**
-     * Create or update Documents. 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.
+     * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
 
+Create or update Documents. 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.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -471,9 +474,11 @@ declare class Databases {
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      */
-    upsertDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, documents?: object[]): Promise<Models.DocumentList<Document>>;
+    upsertDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, documents: object[]): Promise<Models.DocumentList<Document>>;
     /**
-     * Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.
+     * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+
+Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -484,7 +489,9 @@ declare class Databases {
      */
     updateDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, data?: object, queries?: string[]): Promise<Models.DocumentList<Document>>;
     /**
-     * Bulk delete documents using queries, if no queries are passed then all documents are deleted.
+     * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+
+Bulk delete documents using queries, if no queries are passed then all documents are deleted.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -504,6 +511,20 @@ declare class Databases {
      * @returns {Promise<Document>}
      */
     getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
+    /**
+     * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+
+Create or update a 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.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {object} data
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     */
+    upsertDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: object, permissions?: string[]): Promise<Document>;
     /**
      * Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
      *

package/dist/services/databases.js

@@ -1578,14 +1578,16 @@ class Databases {
     );
   }
   /**
-   * Create new Documents. 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.
-   *
-   * @param {string} databaseId
-   * @param {string} collectionId
-   * @param {object[]} documents
-   * @throws {AppwriteException}
-   * @returns {Promise<Models.DocumentList<Document>>}
-   */
+       * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+  
+  Create new Documents. 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.
+       *
+       * @param {string} databaseId
+       * @param {string} collectionId
+       * @param {object[]} documents
+       * @throws {AppwriteException}
+       * @returns {Promise<Models.DocumentList<Document>>}
+       */
   createDocuments(databaseId, collectionId, documents) {
     if (typeof databaseId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "databaseId"');
@@ -1613,8 +1615,9 @@ class Databases {
     );
   }
   /**
-       * Create or update Documents. 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.
+       * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
   
+  Create or update Documents. 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.
        *
        * @param {string} databaseId
        * @param {string} collectionId
@@ -1629,6 +1632,9 @@ class Databases {
     if (typeof collectionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "collectionId"');
     }
+    if (typeof documents === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "documents"');
+    }
     const apiPath = "/databases/{databaseId}/collections/{collectionId}/documents".replace("{databaseId}", databaseId).replace("{collectionId}", collectionId);
     const payload = {};
     if (typeof documents !== "undefined") {
@@ -1646,15 +1652,17 @@ class Databases {
     );
   }
   /**
-   * Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.
-   *
-   * @param {string} databaseId
-   * @param {string} collectionId
-   * @param {object} data
-   * @param {string[]} queries
-   * @throws {AppwriteException}
-   * @returns {Promise<Models.DocumentList<Document>>}
-   */
+       * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+  
+  Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.
+       *
+       * @param {string} databaseId
+       * @param {string} collectionId
+       * @param {object} data
+       * @param {string[]} queries
+       * @throws {AppwriteException}
+       * @returns {Promise<Models.DocumentList<Document>>}
+       */
   updateDocuments(databaseId, collectionId, data, queries) {
     if (typeof databaseId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "databaseId"');
@@ -1682,14 +1690,16 @@ class Databases {
     );
   }
   /**
-   * Bulk delete documents using queries, if no queries are passed then all documents are deleted.
-   *
-   * @param {string} databaseId
-   * @param {string} collectionId
-   * @param {string[]} queries
-   * @throws {AppwriteException}
-   * @returns {Promise<Models.DocumentList<Document>>}
-   */
+       * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+  
+  Bulk delete documents using queries, if no queries are passed then all documents are deleted.
+       *
+       * @param {string} databaseId
+       * @param {string} collectionId
+       * @param {string[]} queries
+       * @throws {AppwriteException}
+       * @returns {Promise<Models.DocumentList<Document>>}
+       */
   deleteDocuments(databaseId, collectionId, queries) {
     if (typeof databaseId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "databaseId"');
@@ -1747,6 +1757,51 @@ class Databases {
       payload
     );
   }
+  /**
+       * **WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.
+  
+  Create or update a 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.
+       *
+       * @param {string} databaseId
+       * @param {string} collectionId
+       * @param {string} documentId
+       * @param {object} data
+       * @param {string[]} permissions
+       * @throws {AppwriteException}
+       * @returns {Promise<Document>}
+       */
+  upsertDocument(databaseId, collectionId, documentId, data, permissions) {
+    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 documentId === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "documentId"');
+    }
+    if (typeof data === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "data"');
+    }
+    const apiPath = "/databases/{databaseId}/collections/{collectionId}/documents/{documentId}".replace("{databaseId}", databaseId).replace("{collectionId}", collectionId).replace("{documentId}", documentId);
+    const payload = {};
+    if (typeof data !== "undefined") {
+      payload["data"] = data;
+    }
+    if (typeof permissions !== "undefined") {
+      payload["permissions"] = permissions;
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {
+      "content-type": "application/json"
+    };
+    return this.client.call(
+      "put",
+      uri,
+      apiHeaders,
+      payload
+    );
+  }
   /**
    * Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
    *