crisp-api 9.5.0 → 9.7.0

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+## v9.7.0
+
+### New Features
+
+* Added the new `CrispClient.website.reportConversation` method.
+
+## v9.6.0
+
+### New Features
+
+* Added support for the `session:error` RTM API event.
+
 ## v9.5.0
 
 ### New Features

package/EXAMPLES.md

@@ -611,6 +611,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";
@@ -1642,6 +1653,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

@@ -1,12 +1,12 @@
 # Crisp API Wrapper
 
-[![Test and Build](https://github.com/crisp-im/node-crisp-api/workflows/Test%20and%20Build/badge.svg?branch=master)](https://github.com/crisp-im/node-crisp-api/actions?query=workflow%3A%22Test+and+Build%22) [![Build and Release](https://github.com/crisp-im/node-crisp-api/workflows/Build%20and%20Release/badge.svg)](https://github.com/crisp-im/node-crisp-api/actions?query=workflow%3A%22Build+and+Release%22) [![Version](https://img.shields.io/npm/v/crisp-api.svg)](https://www.npmjs.com/package/crisp-api) [![Downloads](https://img.shields.io/npm/dt/crisp-api.svg)](https://www.npmjs.com/package/crisp-api)
+[![Test and Build](https://github.com/crisp-im/node-crisp-api/actions/workflows/test.yml/badge.svg)](https://github.com/crisp-im/node-crisp-api/actions/workflows/test.yml) [![Build and Release](https://github.com/crisp-im/node-crisp-api/actions/workflows/build.yml/badge.svg)](https://github.com/crisp-im/node-crisp-api/actions/workflows/build.yml) [![Version](https://img.shields.io/npm/v/crisp-api.svg)](https://www.npmjs.com/package/crisp-api) [![Downloads](https://img.shields.io/npm/dt/crisp-api.svg)](https://www.npmjs.com/package/crisp-api)
 
 The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, access your agent accounts from your JavaScript code.
 
 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: 17/10/2024
+* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 30/01/2025
 * **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
 
 ## Installation
@@ -1012,6 +1012,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)
@@ -2384,6 +2399,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,
@@ -3506,6 +3522,8 @@ Available events are listed below:
     * `session:set_inbox`
   * **Session Removed** [`user`, `plugin`]:
     * `session:removed`
+  * **Session Error** [`user`, `plugin`]:
+    * `session:error`
 
 * #### **Message Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#message-events)
   * **Message Updated** [`user`, `plugin`]:

package/lib/crisp.js

@@ -81,6 +81,7 @@ Crisp.DEFAULT_RTM_EVENTS = [
   "session:set_routing",
   "session:set_inbox",
   "session:removed",
+  "session:error",
 
   // Message Events
   "message:updated",

package/lib/resources/WebsiteConversation.js

@@ -1164,6 +1164,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.5.0",
+  "version": "9.7.0",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {