crisp-api 9.6.0 → 9.8.0

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+## v9.8.0
+
+### New Features
+
+* Added the new `CrispClient.website.markConversationAsUnread` method.
+
+## v9.7.0
+
+### New Features
+
+* Added the new `CrispClient.website.reportConversation` method.
+
 ## v9.6.0
 
 ### New Features

package/EXAMPLES.md

@@ -207,6 +207,19 @@ CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read);
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#mark-conversation-as-unread
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+
+var unread = {
+  "from": "operator"
+};
+
+CrispClient.website.markConversationAsUnread(websiteID, sessionID, unread);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#mark-messages-as-delivered-in-conversation
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
@@ -611,6 +624,17 @@ CrispClient.website.deliverWidgetDataEditActionForConversation(websiteID, sessio
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#report-conversation
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+
+var flag = "spam";
+
+CrispClient.website.reportConversation(websiteID, sessionID, flag);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#schedule-a-reminder-for-conversation
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
@@ -1626,7 +1650,8 @@ var settings = {
   },
   "inbox": {
     "lock_removal": false,
-    "force_operator_token": false
+    "force_operator_token": false,
+    "locale": ""
   },
   "emails": {
     "rating": true,
@@ -1642,6 +1667,7 @@ var settings = {
     "ongoing_operator_face": true,
     "activity_metrics": true,
     "operator_privacy": false,
+    "visitor_privacy": false,
     "availability_tooltip": true,
     "hide_vacation": false,
     "hide_on_away": false,

package/README.md

@@ -6,7 +6,7 @@ The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, ac
 
 Copyright 2024 Crisp IM SAS. See LICENSE for copying information.
 
-* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 27/01/2025
+* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 14/03/2025
 * **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
 
 ## Installation
@@ -458,6 +458,23 @@ All methods that you will most likely need when building a Crisp integration are
       ```
       </details>
 
+  * **Mark Conversation As Unread** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-conversation-as-unread)
+    * `CrispClient.website.markConversationAsUnread(websiteID, sessionID, unread)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+
+      var unread = {
+        "from": "operator"
+      };
+
+      CrispClient.website.markConversationAsUnread(websiteID, sessionID, unread);
+      ```
+      </details>
+
   * **⭐ Mark Messages As Delivered In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-messages-as-delivered-in-conversation)
     * `CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered)`
     * <details>
@@ -1012,6 +1029,21 @@ All methods that you will most likely need when building a Crisp integration are
       ```
       </details>
 
+  * **Report Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#report-conversation)
+    * `CrispClient.website.reportConversation(websiteID, sessionID, flag)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+
+      var flag = "spam";
+
+      CrispClient.website.reportConversation(websiteID, sessionID, flag);
+      ```
+      </details>
+
 
 * ### **Website People** _(these are your end-users)_
   * **Get People Statistics** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-statistics)
@@ -2368,7 +2400,8 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
         },
         "inbox": {
           "lock_removal": false,
-          "force_operator_token": false
+          "force_operator_token": false,
+          "locale": ""
         },
         "emails": {
           "rating": true,
@@ -2384,6 +2417,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
           "ongoing_operator_face": true,
           "activity_metrics": true,
           "operator_privacy": false,
+          "visitor_privacy": false,
           "availability_tooltip": true,
           "hide_vacation": false,
           "hide_on_away": false,
@@ -3526,6 +3560,8 @@ Available events are listed below:
     * `message:acknowledge:read:send`
   * **Message Acknowledge Read Received** [`user`, `plugin`]:
     * `message:acknowledge:read:received`
+  * **Message Acknowledge Unread Send** [`user`, `plugin`]:
+    * `message:acknowledge:unread:send`
   * **Message Acknowledge Delivered** [`user`, `plugin`]:
     * `message:acknowledge:delivered`
   * **Message Acknowledge Ignored** [`user`, `plugin`]:

package/lib/resources/WebsiteConversation.js

@@ -406,6 +406,26 @@ function WebsiteConversation(service, crisp) {
     );
   };
 
+  /**
+   * Mark Conversation As Unread
+   * @memberof WebsiteConversation
+   * @public
+   * @method markConversationAsUnread
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {object} unread
+   * @return {Promise}
+   */
+  service.markConversationAsUnread = function(websiteID, sessionID, unread) {
+    return crisp.patch(
+      crisp._prepareRestUrl([
+        "website", websiteID, "conversation", sessionID, "unread"
+      ]),
+
+      null, unread
+    );
+  };
+
   /**
    * Mark Messages As Delivered In Conversation
    * @memberof WebsiteConversation
@@ -1164,6 +1184,32 @@ function WebsiteConversation(service, crisp) {
       }
     );
   };
+
+  /**
+   * Report Conversation
+   * @memberof WebsiteConversation
+   * @public
+   * @method reportConversation
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} flag
+   * @return {Promise}
+   */
+  service.reportConversation = function(
+    websiteID, sessionID, flag
+  ) {
+    return crisp.post(
+      crisp._prepareRestUrl([
+        "website", websiteID, "conversation", sessionID, "report"
+      ]),
+
+      null,
+
+      {
+        flag : flag
+      }
+    );
+  };
 }
 
 

package/package.json

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