crisp-api 10.6.1 → 10.7.0

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+## v10.7.0
+
+### New Features
+
+* Added the new `CrispClient.website.getConversationRelations` method.
+
+### Changes
+
+* Added optional `properties` on all message types.
+
 ## v10.6.1
 
 ### Changes

package/EXAMPLES.md

@@ -374,6 +374,15 @@ CrispClient.website.changeConversationState(websiteID, sessionID, state);
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#get-conversation-relations
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+
+CrispClient.website.getConversationRelations(websiteID, sessionID);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#get-conversation-participants
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

package/README.md

@@ -694,6 +694,19 @@ All methods that you will most likely need when building a Crisp integration are
       ```
       </details>
 
+  * **Get Conversation Relations** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-relations)
+    * `CrispClient.website.getConversationRelations(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.getConversationRelations(websiteID, sessionID);
+      ```
+      </details>
+
   * **Get Conversation Participants** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-participants)
     * `CrispClient.website.getConversationParticipants(websiteID, sessionID)`
     * <details>

package/dist/crisp.js

@@ -46,7 +46,7 @@ const AVAILABLE_RTM_MODES = [
     "websockets",
     "webhooks"
 ];
-const VERSION = "10.6.1";
+const VERSION = "10.7.0";
 // Base configuration
 const DEFAULT_REQUEST_TIMEOUT = 10000;
 const DEFAULT_SOCKET_TIMEOUT = 10000;

package/dist/resources/WebsiteConversation.d.ts

@@ -71,6 +71,13 @@ export interface ConversationVerification {
     method?: string;
     annotation?: string;
 }
+export interface ConversationRelations {
+    conversations?: ConversationRelationsConversations;
+}
+export interface ConversationRelationsConversations {
+    parent?: string | null;
+    children?: string[];
+}
 export interface ConversationParticipant {
     type?: string;
     target?: string;
@@ -159,6 +166,9 @@ export interface ConversationMessage {
     user?: ConversationMessageUser;
     references?: ConversationMessageReference[];
     original?: ConversationMessageOriginal;
+    properties?: {
+        [key: string]: string | number | boolean;
+    };
 }
 export interface ConversationFileMessageContent {
     name?: string;
@@ -256,6 +266,9 @@ export interface ConversationMessageNewBase {
     user?: ConversationMessageUser;
     references?: ConversationMessageReference[];
     original?: ConversationMessageOriginal;
+    properties?: {
+        [key: string]: string | number | boolean;
+    };
     timestamp?: number;
     stealth?: boolean;
     translated?: boolean;
@@ -573,6 +586,10 @@ declare class WebsiteConversation extends BaseResource {
      * Change Conversation State
      */
     changeConversationState(websiteID: string, sessionID: string, state: ConversationState): Promise<any>;
+    /**
+     * Get Conversation Relations
+     */
+    getConversationRelations(websiteID: string, sessionID: string): Promise<ConversationRelations>;
     /**
      * Get Conversation Participants
      */

package/dist/resources/WebsiteConversation.js

@@ -342,6 +342,15 @@ class WebsiteConversation extends BaseResource_1.default {
         });
     }
     ;
+    /**
+     * Get Conversation Relations
+     */
+    getConversationRelations(websiteID, sessionID) {
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "website", websiteID, "conversation", sessionID, "relations"
+        ]));
+    }
+    ;
     /**
      * Get Conversation Participants
      */

package/lib/resources/WebsiteConversation.ts

@@ -92,6 +92,15 @@ export interface ConversationVerification {
   annotation?: string;
 }
 
+export interface ConversationRelations {
+  conversations?: ConversationRelationsConversations;
+}
+
+export interface ConversationRelationsConversations {
+  parent?: string|null;
+  children?: string[];
+}
+
 export interface ConversationParticipant {
   type?: string;
   target?: string;
@@ -213,6 +222,7 @@ export interface ConversationMessage {
   user?: ConversationMessageUser;
   references?: ConversationMessageReference[];
   original?: ConversationMessageOriginal;
+  properties?: { [key: string]: string|number|boolean };
 }
 
 export interface ConversationFileMessageContent {
@@ -338,6 +348,7 @@ export interface ConversationMessageNewBase {
   user?: ConversationMessageUser;
   references?: ConversationMessageReference[];
   original?: ConversationMessageOriginal;
+  properties?: { [key: string]: string|number|boolean };
   timestamp?: number;
   stealth?: boolean;
   translated?: boolean;
@@ -1061,6 +1072,19 @@ class WebsiteConversation extends BaseResource {
     );
   };
 
+  /**
+   * Get Conversation Relations
+   */
+  getConversationRelations(
+    websiteID: string, sessionID: string
+  ): Promise<ConversationRelations> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "conversation", sessionID, "relations"
+      ])
+    );
+  };
+
   /**
    * Get Conversation Participants
    */

package/package.json

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