crisp-api 8.3.2 → 8.5.0

package/CHANGELOG.md

@@ -1,6 +1,24 @@
 Changelog
 =========
 
+## v8.5.0
+
+### Breaking Changes
+
+* ⚠️ Changed the argument of the `CrispClient.website.batchResolveConversations` method.
+* ⚠️ Changed the argument of the `CrispClient.website.batchReadConversations` method.
+* ⚠️ Changed the argument of the `CrispClient.website.batchRemoveConversations` method.
+
+### New Features
+
+* Added the new `CrispClient.website.updateConversationInbox` method.
+
+## v8.4.0
+
+### New Features
+
+* Added the new `CrispClient.website.abortWebsiteDeletion` method.
+
 ## v8.3.2
 
 ### New Features

package/EXAMPLES.md

@@ -230,6 +230,16 @@ CrispClient.website.assignConversationRouting(websiteID, sessionID, assign);
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#update-conversation-inbox
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+var inboxID = "bf6935c9-43b3-4f8e-87ea-175c1e1ed1a9";
+
+CrispClient.website.updateConversationInbox(websiteID, sessionID, inboxID);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#get-conversation-metas
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
@@ -1548,6 +1558,14 @@ CrispClient.website.deleteWebsite(websiteID, verify);
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#abort-website-deletion
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+CrispClient.website.abortWebsiteDeletion(websiteID);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#get-website-settings
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
@@ -1597,6 +1615,8 @@ var settings = {
     "ignore_privacy": false,
     "visitor_compose": false,
     "file_transfer": true,
+    "overlay_search": true,
+    "overlay_mode": false,
     "helpdesk_link": true,
     "helpdesk_only": false,
     "status_health_dead": true,
@@ -1819,7 +1839,16 @@ https://docs.crisp.chat/references/rest-api/v1/#batch-resolve-items
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
-CrispClient.website.batchResolveConversations(websiteID, sessions);
+var operation = {
+  "inbox_id": null,
+
+  "sessions": [
+    "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
+    "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+  ]
+};
+
+CrispClient.website.batchResolveConversations(websiteID, operation);
 
 =========================
 
@@ -1827,7 +1856,16 @@ https://docs.crisp.chat/references/rest-api/v1/#batch-read-items
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
-CrispClient.website.batchReadConversations(websiteID, sessions);
+var operation = {
+  "inbox_id": null,
+
+  "sessions": [
+    "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
+    "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+  ]
+};
+
+CrispClient.website.batchReadConversations(websiteID, operation);
 
 =========================
 
@@ -1835,12 +1873,16 @@ https://docs.crisp.chat/references/rest-api/v1/#batch-remove-items
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
-var sessions = [
-  "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
-  "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
-];
+var operation = {
+  "inbox_id": null,
+
+  "sessions": [
+    "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
+    "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+  ]
+};
 
-CrispClient.website.batchRemoveConversations(websiteID, sessions);
+CrispClient.website.batchRemoveConversations(websiteID, operation);
 
 =========================
 

package/README.md

@@ -6,7 +6,7 @@ The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, ac
 
 Copyright 2023 Crisp IM SAS. See LICENSE for copying information.
 
-* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 10/04/2024
+* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 12/07/2024
 * **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
 
 ## Installation
@@ -485,6 +485,20 @@ All methods that you will most likely need when building a Crisp integration are
       ```
       </details>
 
+  * **Update Conversation Inbox** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-conversation-inbox)
+    * `CrispClient.website.updateConversationInbox(websiteID, sessionID, inboxID)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+      var inboxID = "bf6935c9-43b3-4f8e-87ea-175c1e1ed1a9";
+
+      CrispClient.website.updateConversationInbox(websiteID, sessionID, inboxID);
+      ```
+      </details>
+
   * **⭐ Get Conversation Metas** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-metas)
     * `CrispClient.website.getConversationMetas(websiteID, sessionID)`
     * <details>
@@ -2260,6 +2274,18 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       ```
       </details>
 
+  * **Abort Website Deletion** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#abort-website-deletion)
+    * `CrispClient.website.abortWebsiteDeletion(websiteID)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+      CrispClient.website.abortWebsiteDeletion(websiteID);
+      ```
+      </details>
+
 
 * #### **Website Settings**
   * **Get Website Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-website-settings)
@@ -2319,6 +2345,8 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
           "ignore_privacy": false,
           "visitor_compose": false,
           "file_transfer": true,
+          "overlay_search": true,
+          "overlay_mode": false,
           "helpdesk_link": true,
           "helpdesk_only": false,
           "status_health_dead": true,
@@ -2618,43 +2646,65 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
 
 * #### **Website Batch**
   * **Batch Resolve Conversations** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-resolve-items)
-    * `CrispClient.website.batchResolveConversations(websiteID, sessions)`
+    * `CrispClient.website.batchResolveConversations(websiteID, operation)`
     * <details>
       <summary>See Example</summary>
 
       ```javascript
       var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
-      CrispClient.website.batchResolveConversations(websiteID, sessions);
+      var operation = {
+        "inbox_id": null,
+
+        "sessions": [
+          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
+          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+        ]
+      };
+
+      CrispClient.website.batchResolveConversations(websiteID, operation);
       ```
       </details>
 
   * **Batch Read Conversations** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-read-items)
-    * `CrispClient.website.batchReadConversations(websiteID, sessions)`
+    * `CrispClient.website.batchReadConversations(websiteID, operation)`
     * <details>
       <summary>See Example</summary>
 
       ```javascript
       var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
-      CrispClient.website.batchReadConversations(websiteID, sessions);
+      var operation = {
+        "inbox_id": null,
+
+        "sessions": [
+          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
+          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+        ]
+      };
+
+      CrispClient.website.batchReadConversations(websiteID, operation);
       ```
       </details>
 
   * **Batch Remove Conversations** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-remove-items)
-    * `CrispClient.website.batchRemoveConversations(websiteID, sessions)`
+    * `CrispClient.website.batchRemoveConversations(websiteID, operation)`
     * <details>
       <summary>See Example</summary>
 
       ```javascript
       var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
-      var sessions = [
-        "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
-        "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
-      ];
+      var operation = {
+        "inbox_id": null,
 
-      CrispClient.website.batchRemoveConversations(websiteID, sessions);
+        "sessions": [
+          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
+          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+        ]
+      };
+
+      CrispClient.website.batchRemoveConversations(websiteID, operation);
       ```
       </details>
 
@@ -3426,6 +3476,8 @@ Available events are listed below:
     * `session:set_mentions`
   * **Session Set Routing** [`user`, `plugin`]:
     * `session:set_routing`
+  * **Session Set Inbox** [`user`, `plugin`]:
+    * `session:set_inbox`
   * **Session Removed** [`user`, `plugin`]:
     * `session:removed`
 

package/lib/crisp.js

@@ -79,6 +79,7 @@ Crisp.DEFAULT_RTM_EVENTS = [
   "session:set_participants",
   "session:set_mentions",
   "session:set_routing",
+  "session:set_inbox",
   "session:removed",
 
   // Message Events

package/lib/resources/WebsiteBase.js

@@ -79,6 +79,20 @@ function WebsiteBase(service, crisp) {
       }
     );
   };
+
+  /**
+   * Abort Website Deletion
+   * @memberof WebsiteBase
+   * @public
+   * @method abortWebsiteDeletion
+   * @param {string} websiteID
+   * @return {Promise}
+   */
+  service.abortWebsiteDeletion = function(websiteID) {
+    return crisp.delete(
+      crisp._prepareRestUrl(["website", websiteID, "expunge"])
+    );
+  };
 }
 
 

package/lib/resources/WebsiteBatch.js

@@ -21,18 +21,14 @@ function WebsiteBatch(service, crisp) {
    * @public
    * @method batchResolveConversations
    * @param {string} websiteID
-   * @param {object} sessions
+   * @param {object} operation
    * @return {Promise}
    */
-  service.batchResolveConversations = function(websiteID, sessions) {
+  service.batchResolveConversations = function(websiteID, operation) {
     return crisp.patch(
       crisp._prepareRestUrl(["website", websiteID, "batch", "resolve"]),
 
-      null,
-
-      {
-        sessions : sessions
-      }
+      null, operation
     );
   };
 
@@ -42,18 +38,14 @@ function WebsiteBatch(service, crisp) {
    * @public
    * @method batchReadConversations
    * @param {string} websiteID
-   * @param {object} sessions
+   * @param {object} operation
    * @return {Promise}
    */
-  service.batchReadConversations = function(websiteID, sessions) {
+  service.batchReadConversations = function(websiteID, operation) {
     return crisp.patch(
       crisp._prepareRestUrl(["website", websiteID, "batch", "read"]),
 
-      null,
-
-      {
-        sessions : sessions
-      }
+      null, operation
     );
   };
 
@@ -63,18 +55,14 @@ function WebsiteBatch(service, crisp) {
    * @public
    * @method batchRemoveConversations
    * @param {string} websiteID
-   * @param {object} sessions
+   * @param {object} operation
    * @return {Promise}
    */
-  service.batchRemoveConversations = function(websiteID, sessions) {
+  service.batchRemoveConversations = function(websiteID, operation) {
     return crisp.patch(
       crisp._prepareRestUrl(["website", websiteID, "batch", "remove"]),
 
-      null,
-
-      {
-        sessions : sessions
-      }
+      null, operation
     );
   };
 

package/lib/resources/WebsiteConversation.js

@@ -431,6 +431,30 @@ function WebsiteConversation(service, crisp) {
     );
   };
 
+  /**
+   * Update Conversation Inbox
+   * @memberof WebsiteConversation
+   * @public
+   * @method updateConversationInbox
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} inboxID
+   * @return {Promise}
+   */
+  service.updateConversationInbox = function(websiteID, sessionID, inboxID) {
+    return crisp.patch(
+      crisp._prepareRestUrl([
+        "website", websiteID, "conversation", sessionID, "inbox"
+      ]),
+
+      null,
+
+      {
+        inbox_id : inboxID
+      }
+    );
+  };
+
   /**
    * Get Conversation Metas
    * @memberof WebsiteConversation

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "crisp-api",
   "description": "Crisp API wrapper for Node - official, maintained by Crisp",
-  "version": "8.3.2",
+  "version": "8.5.0",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {