crisp-api 6.3.2 → 6.4.1

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+## v6.4.1
+
+### Bug Fixes
+
+* Return more informative error reasons for non `2xx / 3xx` response codes on `HEAD` requests.
+
+## v6.4.0
+
+### New Features
+
+* Added the new `CrispClient.website.requestUserFeedbackForConversation` method.
+
 ## v6.3.2
 
 ### Bug Fixes

package/EXAMPLES.md

@@ -402,6 +402,15 @@ CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, session
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#request-user-feedback-for-conversation
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+
+CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#list-browsing-sessions-for-conversation
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

package/README.md

@@ -716,6 +716,19 @@ All methods that you will most likely need when building a Crisp integration are
       ```
       </details>
 
+  * **Request User Feedback For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-user-feedback-for-conversation)
+    * `CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+
+      CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID);
+      ```
+      </details>
+
   * **List Browsing Sessions For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-browsing-sessions-for-conversation)
     * `CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)`
     * <details>

package/lib/crisp.js

@@ -29,8 +29,8 @@ Crisp.DEFAULT_USERAGENT_PREFIX           = "node-crisp-api/";
 
 
 // REST API defaults
-Crisp.DEFAULT_REST_HOST        = "https://api.crisp.chat";
-Crisp.DEFAULT_REST_BASE_PATH   = "/v1/";
+Crisp.DEFAULT_REST_HOST      = "https://api.crisp.chat";
+Crisp.DEFAULT_REST_BASE_PATH = "/v1/";
 
 
 // RTM API defaults
@@ -666,21 +666,23 @@ Crisp.prototype = {
    * @param {function} reject
    */
   _request : function(resource, method, query, body, resolve, reject) {
+    var self = this;
+
     var requestParameters = {
       responseType    : "json",
       timeout         : Crisp.DEFAULT_REQUEST_TIMEOUT,
 
       headers         : {
-        "User-Agent"   : this._useragent,
-        "X-Crisp-Tier" : this._tier
+        "User-Agent"   : self._useragent,
+        "X-Crisp-Tier" : self._tier
       },
 
       throwHttpErrors : false
     };
 
     // Add authorization?
-    if (this.auth.token) {
-      requestParameters.headers.Authorization = ("Basic " + this.auth.token);
+    if (self.auth.token) {
+      requestParameters.headers.Authorization = ("Basic " + self.auth.token);
     }
 
     // Add body?
@@ -720,7 +722,9 @@ Crisp.prototype = {
 
         // Response error?
         if (response.statusCode >= 400) {
-          var reason_message = ((response.body || {}).reason || "http_error");
+          var reason_message = self._readErrorResponseReason(
+            method, response.statusCode, response
+          );
           var data_message   = ((response.body || {}).data || {}).message;
 
           return reject({
@@ -780,6 +784,35 @@ Crisp.prototype = {
       tier     : tier,
       events   : this._boundEvents
     });
+  },
+
+  /**
+   * Reads reason for error response
+   * @memberof Crisp
+   * @private
+   * @method _readErrorResponseReason
+   * @param {string} method
+   * @param {number} statusCode
+   * @param {object} response
+   */
+  _readErrorResponseReason : function(method, statusCode, response) {
+    // HEAD method? As HEAD requests do not expect any response body, then we \
+    //   cannot map a reason from the response.
+    if (method === "head") {
+      // 5xx errors?
+      if (statusCode >= 500) {
+        return "server_error";
+      }
+
+      // 4xx errors?
+      if (statusCode >= 400) {
+        return "route_error";
+      }
+    }
+
+    // Other methods must hold a response body, therefore we can fallback on \
+    //   an HTTP error if we fail to acquire any reason at all.
+    return ((response.body || {}).reason || "http_error");
   }
 };
 

package/lib/resources/WebsiteConversation.js

@@ -613,6 +613,22 @@ function WebsiteConversation(service, crisp) {
     );
   };
 
+  /**
+   * Request User Feedback For Conversation
+   * @memberof WebsiteConversation
+   * @method requestUserFeedbackForConversation
+   * @return Promise
+   */
+  service.requestUserFeedbackForConversation = function(
+    websiteID, sessionID
+  ) {
+    return crisp.post(
+      crisp._prepareRestUrl([
+        "website", websiteID, "conversation", sessionID, "feedback"
+      ])
+    );
+  };
+
   /**
    * List Browsing Sessions For Conversation
    * @memberof WebsiteConversation

package/package.json

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