crisp-api 9.3.0 → 9.4.0

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 Changelog
 =========
 
+## 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
+
+* ⚠️ Restored the argument of the `CrispClient.website.inviteWebsiteOperator` method to its specification from pre-`v9.3.0`.
+
 ## v9.3.0
 
 ### 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,9 +1742,13 @@ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
 var email = "julien@crisp.chat";
 var role = "member";
-var token = "451930";
 
-CrispClient.website.inviteWebsiteOperator(websiteID, email, role, token);
+var verify = {
+  "method": "password",
+  "secret": "MySuperSecurePassword";
+};
+
+CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify);
 
 =========================
 

package/README.md

@@ -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);
       ```
@@ -2495,7 +2501,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       </details>
 
   * **Invite A Website Operator** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#invite-a-website-operator)
-    * `CrispClient.website.inviteWebsiteOperator(websiteID, email, role, token)`
+    * `CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify)`
     * <details>
       <summary>See Example</summary>
 
@@ -2504,9 +2510,13 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
 
       var email = "julien@crisp.chat";
       var role = "member";
-      var token = "451930";
 
-      CrispClient.website.inviteWebsiteOperator(websiteID, email, role, token);
+      var verify = {
+        "method": "password",
+        "secret": "MySuperSecurePassword";
+      };
+
+      CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify);
       ```
       </details>
 

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,19 +105,19 @@ function WebsiteOperator(service, crisp) {
    * @param {string} websiteID
    * @param {string} email
    * @param {string} role
-   * @param {string} token
+   * @param {object} verify
    * @return {Promise}
    */
-  service.inviteWebsiteOperator = function(websiteID, email, role, token) {
+  service.inviteWebsiteOperator = function(websiteID, email, role, verify) {
     return crisp.post(
       crisp._prepareRestUrl(["website", websiteID, "operator"]),
 
       null,
 
       {
-        email : email,
-        role  : role,
-        token : token
+        email  : email,
+        role   : role,
+        verify : verify
       }
     );
   };

package/package.json

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