crisp-api 9.0.0 → 9.2.0

package/CHANGELOG.md

@@ -1,6 +1,21 @@
 Changelog
 =========
 
+## v9.2.0
+
+### New Features
+
+* Added support for the `spam:message` RTM API event.
+* Added support for the `spam:decision` RTM API event.
+
+## v9.1.0
+
+### New Features
+
+* Added the new `CrispClient.website.listSpamConversation` method.
+* Added the new `CrispClient.website.resolveSpamConversationContent` method.
+* Added the new `CrispClient.website.submitSpamConversationDecision` method.
+
 ## v9.0.0
 
 ### Breaking Changes

package/EXAMPLES.md

@@ -45,6 +45,35 @@ CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key);
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#list-spam-conversations
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var pageNumber = 1;
+
+CrispClient.website.listSpamConversations(websiteID, pageNumber);
+
+=========================
+
+https://docs.crisp.chat/references/rest-api/v1/#resolve-spam-conversation-content
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10";
+
+CrispClient.website.resolveSpamConversationContent(websiteID, spamID);
+
+=========================
+
+https://docs.crisp.chat/references/rest-api/v1/#submit-spam-conversation-decision
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10";
+
+var action = "reject";
+
+CrispClient.website.submitSpamConversationDecision(websiteID, spamID, action);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#create-a-new-conversation
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
@@ -1582,6 +1611,9 @@ var settings = {
   "name": "Crisp",
   "domain": "crisp.chat",
   "logo": "https://storage.crisp.chat/users/avatar/website/8c842203-7ed8-4e29-a608-7cf78a7d2fcc/b6c2948d-b061-405e-91a9-2fdf855d1cc0.png",
+  "audit": {
+    "log": true
+  },
   "contact": {
     "email": "contact@crisp.chat",
     "phone": "+33757905447"

package/README.md

@@ -234,6 +234,47 @@ All methods that you will most likely need when building a Crisp integration are
       ```
       </details>
 
+  * **List Spam Conversations** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-spam-conversations)
+    * `CrispClient.website.listSpamConversations(websiteID, pageNumber)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var pageNumber = 1;
+
+      CrispClient.website.listSpamConversations(websiteID, pageNumber);
+      ```
+      </details>
+
+  * **Resolve Spam Conversation Content** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-spam-conversation-content)
+    * `CrispClient.website.resolveSpamConversationContent(websiteID, spamID)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10";
+
+      CrispClient.website.resolveSpamConversationContent(websiteID, spamID);
+      ```
+      </details>
+
+  * **Submit Spam Conversation Decision** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#submit-spam-conversation-decision)
+    * `CrispClient.website.submitSpamConversationDecision(websiteID, spamID, action)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10";
+
+      var action = "reject";
+
+      CrispClient.website.submitSpamConversationDecision(websiteID, spamID, action);
+      ```
+      </details>
+
 
 * #### **Website Conversation**
   * **⭐ Create A New Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-conversation)
@@ -2312,6 +2353,9 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
         "name": "Crisp",
         "domain": "crisp.chat",
         "logo": "https://storage.crisp.chat/users/avatar/website/8c842203-7ed8-4e29-a608-7cf78a7d2fcc/b6c2948d-b061-405e-91a9-2fdf855d1cc0.png",
+        "audit": {
+          "log": true
+        },
         "contact": {
           "email": "contact@crisp.chat",
           "phone": "+33757905447"
@@ -3479,6 +3523,12 @@ Available events are listed below:
   * **Message Notify Unread Received** [`user`, `plugin`]:
     * `message:notify:unread:received`
 
+* #### **Spam Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#spam-events)
+  * **Spam Message** [`user`]:
+    * `spam:message`
+  * **Spam Decision** [`user`]:
+    * `spam:decision`
+
 * #### **People Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#people-events)
   * **People Profile Created** [`user`, `plugin`]:
     * `people:profile:created`

package/lib/crisp.js

@@ -95,6 +95,10 @@ Crisp.DEFAULT_RTM_EVENTS = [
   "message:notify:unread:send",
   "message:notify:unread:received",
 
+  // Spam Events
+  "spam:message",
+  "spam:decision",
+
   // People Events
   "people:profile:created",
   "people:profile:updated",

package/lib/resources/WebsiteConversation.js

@@ -110,6 +110,64 @@ function WebsiteConversation(service, crisp) {
     );
   };
 
+  /**
+   * List Spam Conversations
+   * @memberof WebsiteConversation
+   * @public
+   * @method listSpamConversations
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @return {Promise}
+   */
+  service.listSpamConversations = function(websiteID, pageNumber) {
+    return crisp.get(
+      crisp._prepareRestUrl([
+        "website", websiteID, "conversations", "spams", pageNumber
+      ])
+    );
+  };
+
+  /**
+   * Resolve Spam Conversation Content
+   * @memberof WebsiteConversation
+   * @public
+   * @method resolveSpamConversationContent
+   * @param {string} websiteID
+   * @param {string} spamID
+   * @return {Promise}
+   */
+  service.resolveSpamConversationContent = function(websiteID, spamID) {
+    return crisp.get(
+      crisp._prepareRestUrl([
+        "website", websiteID, "conversations", "spam", spamID, "content"
+      ])
+    );
+  };
+
+  /**
+   * Submit Spam Conversation Decision
+   * @memberof WebsiteConversation
+   * @public
+   * @method submitSpamConversationDecision
+   * @param {string} websiteID
+   * @param {string} spamID
+   * @param {string} action
+   * @return {Promise}
+   */
+  service.submitSpamConversationDecision = function(websiteID, spamID, action) {
+    return crisp.post(
+      crisp._prepareRestUrl([
+        "website", websiteID, "conversations", "spam", spamID, "decision"
+      ]),
+
+      null,
+
+      {
+        action : action
+      }
+    );
+  };
+
   /**
    * Create A New Conversation
    * @memberof WebsiteConversation

package/package.json

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