crisp-api 9.3.1 → 9.5.0

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 Changelog
 =========
 
+## v9.5.0
+
+### New Features
+
+* Added support for the `message:acknowledge:ignored` RTM API event.
+
+## v9.4.0
+
+### Breaking Changes
+
+* ⚠️ Changed the `verify` argument of the `CrispClient.website.inviteWebsiteOperator` method (to be a verification challenge).
+* ⚠️ Changed the `verify` argument of the `CrispClient.website.deleteHelpdesk` method (to be a verification challenge).
+* ⚠️ Changed the `verify` argument of the `CrispClient.website.deleteWebsite` method (to be a verification challenge).
+
 ## v9.3.1
 
 ### Breaking Changes

package/EXAMPLES.md

@@ -948,7 +948,10 @@ https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
-var verify = "MySuperSecurePassword";
+var verify = {
+  "method": "password",
+  "secret": "MySuperSecurePassword";
+};
 
 CrispClient.website.deleteHelpdesk(websiteID, verify);
 
@@ -1581,7 +1584,10 @@ https://docs.crisp.chat/references/rest-api/v1/#delete-a-website
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
-var verify = "MySuperSecurePassword";
+var verify = {
+  "method": "password",
+  "secret": "MySuperSecurePassword";
+};
 
 CrispClient.website.deleteWebsite(websiteID, verify);
 
@@ -1736,7 +1742,11 @@ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
 var email = "julien@crisp.chat";
 var role = "member";
-var verify = "MySuperSecurePassword";
+
+var verify = {
+  "method": "password",
+  "secret": "MySuperSecurePassword";
+};
 
 CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify);
 

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Crisp
+Copyright (c) 2024 Crisp
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -4,9 +4,9 @@
 
 The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, access your agent accounts from your JavaScript code.
 
-Copyright 2023 Crisp IM SAS. See LICENSE for copying information.
+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/08/2024
+* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 17/10/2024
 * **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
 
 ## Installation
@@ -1457,7 +1457,10 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       ```javascript
       var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
-      var verify = "MySuperSecurePassword";
+      var verify = {
+        "method": "password",
+        "secret": "MySuperSecurePassword";
+      };
 
       CrispClient.website.deleteHelpdesk(websiteID, verify);
       ```
@@ -2309,7 +2312,10 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       ```javascript
       var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
-      var verify = "MySuperSecurePassword";
+      var verify = {
+        "method": "password",
+        "secret": "MySuperSecurePassword";
+      };
 
       CrispClient.website.deleteWebsite(websiteID, verify);
       ```
@@ -2504,7 +2510,11 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
 
       var email = "julien@crisp.chat";
       var role = "member";
-      var verify = "MySuperSecurePassword";
+
+      var verify = {
+        "method": "password",
+        "secret": "MySuperSecurePassword";
+      };
 
       CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify);
       ```
@@ -3516,6 +3526,8 @@ Available events are listed below:
     * `message:acknowledge:read:received`
   * **Message Acknowledge Delivered** [`user`, `plugin`]:
     * `message:acknowledge:delivered`
+  * **Message Acknowledge Ignored** [`user`, `plugin`]:
+    * `message:acknowledge:ignored`
   * **Message Notify Unread Send** [`user`, `plugin`]:
     * `message:notify:unread:send`
   * **Message Notify Unread Received** [`user`, `plugin`]:

package/lib/crisp.js

@@ -92,6 +92,7 @@ Crisp.DEFAULT_RTM_EVENTS = [
   "message:acknowledge:read:send",
   "message:acknowledge:read:received",
   "message:acknowledge:delivered",
+  "message:acknowledge:ignored",
   "message:notify:unread:send",
   "message:notify:unread:received",
 

package/lib/resources/WebsiteBase.js

@@ -67,7 +67,7 @@ function WebsiteBase(service, crisp) {
    * @public
    * @method deleteWebsite
    * @param {string} websiteID
-   * @param {string} verify
+   * @param {object} verify
    * @return {Promise}
    */
   service.deleteWebsite = function(websiteID, verify) {

package/lib/resources/WebsiteHelpdesk.js

@@ -70,7 +70,7 @@ function WebsiteHelpdesk(service, crisp) {
    * @public
    * @method deleteHelpdesk
    * @param {string} websiteID
-   * @param {string} verify
+   * @param {object} verify
    * @return {Promise}
    */
   service.deleteHelpdesk = function(websiteID, verify) {

package/lib/resources/WebsiteOperator.js

@@ -105,7 +105,7 @@ function WebsiteOperator(service, crisp) {
    * @param {string} websiteID
    * @param {string} email
    * @param {string} role
-   * @param {string} verify
+   * @param {object} verify
    * @return {Promise}
    */
   service.inviteWebsiteOperator = function(websiteID, email, role, verify) {

package/package.json

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