crisp-api 10.10.0 → 10.10.2

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+## v10.10.2
+
+### Changes
+
+* Added `CrispClient.website.requestToolCallForConversation` method.
+
+## v10.10.1
+
+### Changes
+
+* Added `CrispClient.website.batchUpdateConversationsData`, `CrispClient.website.batchUpdatePeopleData`, `CrispClient.website.batchUpdateConversationsSegments` and `CrispClient.website.batchUpdatePeopleSegments` methods.
+
 ## v10.9.3
 
 ### Changes

package/EXAMPLES.md

@@ -602,6 +602,17 @@ CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID,
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#request-tool-call-for-conversation
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+
+var command = "list_tools";
+
+CrispClient.website.requestToolCallForConversation(websiteID, sessionID, command);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-button-action-for-conversation
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
@@ -1692,7 +1703,6 @@ var settings = {
   "emails": {
     "rating": true,
     "transcript": true,
-    "enrich": true,
     "junk_filter": true
   },
   "chatbox": {
@@ -1990,6 +2000,84 @@ CrispClient.website.batchRemovePeople(websiteID, people);
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#batch-data-items
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+var operation = {
+  "sessions": [
+    "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
+    "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+  ],
+
+  "data": {
+    "plan": "pro",
+    "subscribed": true
+  }
+};
+
+CrispClient.website.batchUpdateConversationsData(websiteID, operation);
+
+=========================
+
+https://docs.crisp.chat/references/rest-api/v1/#batch-data-items
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+var people = {
+  "profiles": [
+    "eee8759d-52db-48e5-982d-3426e3566ce0"
+  ]
+};
+
+var data = {
+  "plan": "pro",
+  "subscribed": true
+};
+
+CrispClient.website.batchUpdatePeopleData(websiteID, people, data);
+
+=========================
+
+https://docs.crisp.chat/references/rest-api/v1/#batch-segments-items
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+var operation = {
+  "sessions": [
+    "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
+    "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+  ],
+
+  "segments": [
+    "vip",
+    "lead"
+  ]
+};
+
+CrispClient.website.batchUpdateConversationsSegments(websiteID, operation);
+
+=========================
+
+https://docs.crisp.chat/references/rest-api/v1/#batch-segments-items
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+var people = {
+  "profiles": [
+    "eee8759d-52db-48e5-982d-3426e3566ce0"
+  ]
+};
+
+var segments = [
+  "vip",
+  "lead"
+];
+
+CrispClient.website.batchUpdatePeopleSegments(websiteID, people, segments);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#list-website-inboxes
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

package/README.md

@@ -1003,6 +1003,21 @@ All methods that you will most likely need when building a Crisp integration are
       ```
       </details>
 
+  * **Request Tool Call For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-tool-call-for-conversation)
+    * `CrispClient.website.requestToolCallForConversation(websiteID, sessionID, command, payload)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+
+      var command = "list_tools";
+
+      CrispClient.website.requestToolCallForConversation(websiteID, sessionID, command);
+      ```
+      </details>
+
   * **Deliver Widget Button Action For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-button-action-for-conversation)
     * `CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value)`
     * <details>
@@ -2468,7 +2483,6 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
         "emails": {
           "rating": true,
           "transcript": true,
-          "enrich": true,
           "junk_filter": true
         },
         "chatbox": {
@@ -2978,6 +2992,100 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       ```
       </details>
 
+  * **Batch Update Conversations Data**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-data-items)
+    * `CrispClient.website.batchUpdateConversationsData(websiteID, operation)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+      var operation = {
+        "sessions": [
+          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
+          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+        ],
+
+        "data": {
+          "plan": "pro",
+          "subscribed": true
+        }
+      };
+
+      CrispClient.website.batchUpdateConversationsData(websiteID, operation);
+      ```
+      </details>
+
+  * **Batch Update People Data**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-data-items)
+    * `CrispClient.website.batchUpdatePeopleData(websiteID, people, data)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+      var people = {
+        "profiles": [
+          "eee8759d-52db-48e5-982d-3426e3566ce0"
+        ]
+      };
+
+      var data = {
+        "plan": "pro",
+        "subscribed": true
+      };
+
+      CrispClient.website.batchUpdatePeopleData(websiteID, people, data);
+      ```
+      </details>
+
+  * **Batch Update Conversations Segments**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-segments-items)
+    * `CrispClient.website.batchUpdateConversationsSegments(websiteID, operation)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+      var operation = {
+        "sessions": [
+          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
+          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
+        ],
+
+        "segments": [
+          "vip",
+          "lead"
+        ]
+      };
+
+      CrispClient.website.batchUpdateConversationsSegments(websiteID, operation);
+      ```
+      </details>
+
+  * **Batch Update People Segments**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-segments-items)
+    * `CrispClient.website.batchUpdatePeopleSegments(websiteID, people, segments)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+      var people = {
+        "profiles": [
+          "eee8759d-52db-48e5-982d-3426e3566ce0"
+        ]
+      };
+
+      var segments = [
+        "vip",
+        "lead"
+      ];
+
+      CrispClient.website.batchUpdatePeopleSegments(websiteID, people, segments);
+      ```
+      </details>
+
 
 * #### **Website Inbox**
   * **List Inboxes**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-website-inboxes)

package/dist/crisp.js

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

package/dist/resources/WebsiteBatch.d.ts

@@ -32,6 +32,15 @@ export type WebsiteBatchPeopleOperationInner = {
     profiles?: string[];
     search?: string;
 };
+export type WebsiteBatchDataPayload = Record<string, string | number | boolean>;
+export type WebsiteBatchConversationsDataOperation = {
+    sessions: string[];
+    data: WebsiteBatchDataPayload;
+};
+export type WebsiteBatchConversationsSegmentsOperation = {
+    sessions: string[];
+    segments: string[];
+};
 /**************************************************************************
  * CLASSES
  ***************************************************************************/
@@ -97,6 +106,22 @@ declare class WebsiteBatch extends BaseResource {
      * Batch Inbox Conversations
      */
     batchInboxConversations(websiteID: string, operation: WebsiteBatchInboxOperation): Promise<any>;
+    /**
+     * Batch Update Conversations Data
+     */
+    batchUpdateConversationsData(websiteID: string, operation: WebsiteBatchConversationsDataOperation): Promise<any>;
+    /**
+     * Batch Update People Data
+     */
+    batchUpdatePeopleData(websiteID: string, people: WebsiteBatchPeopleOperationInner, data: WebsiteBatchDataPayload): Promise<any>;
+    /**
+     * Batch Update Conversations Segments
+     */
+    batchUpdateConversationsSegments(websiteID: string, operation: WebsiteBatchConversationsSegmentsOperation): Promise<any>;
+    /**
+     * Batch Update People Segments
+     */
+    batchUpdatePeopleSegments(websiteID: string, people: WebsiteBatchPeopleOperationInner, segments: string[]): Promise<any>;
 }
 /**************************************************************************
  * EXPORTS

package/dist/resources/WebsiteBatch.js

@@ -111,6 +111,40 @@ class WebsiteBatch extends BaseResource_1.default {
         return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "inbox"]), null, operation);
     }
     ;
+    /**
+     * Batch Update Conversations Data
+     */
+    batchUpdateConversationsData(websiteID, operation) {
+        return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "data"]), null, operation);
+    }
+    ;
+    /**
+     * Batch Update People Data
+     */
+    batchUpdatePeopleData(websiteID, people, data) {
+        return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "data"]), null, {
+            people: people,
+            data: data
+        });
+    }
+    ;
+    /**
+     * Batch Update Conversations Segments
+     */
+    batchUpdateConversationsSegments(websiteID, operation) {
+        return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "segments"]), null, operation);
+    }
+    ;
+    /**
+     * Batch Update People Segments
+     */
+    batchUpdatePeopleSegments(websiteID, people, segments) {
+        return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "segments"]), null, {
+            people: people,
+            segments: segments
+        });
+    }
+    ;
 }
 /**************************************************************************
  * EXPORTS

package/dist/resources/WebsiteConversation.d.ts

@@ -668,6 +668,10 @@ declare class WebsiteConversation extends BaseResource {
      * Transmit Signaling On Ongoing Call Session
      */
     transmitSignalingOnOngoingCallSession(websiteID: string, sessionID: string, callID: string, payload: object): Promise<any>;
+    /**
+     * Request Tool Call For Conversation
+     */
+    requestToolCallForConversation(websiteID: string, sessionID: string, command: string, payload?: object): Promise<any>;
     /**
      * Deliver Widget Button Action For Conversation
      */

package/dist/resources/WebsiteConversation.js

@@ -569,6 +569,23 @@ class WebsiteConversation extends BaseResource_1.default {
         ]), null, payload);
     }
     ;
+    /**
+     * Request Tool Call For Conversation
+     */
+    requestToolCallForConversation(websiteID, sessionID, command, payload) {
+        // Generate body
+        let body = {
+            command: command
+        };
+        if (payload) {
+            // @ts-ignore
+            body.payload = payload;
+        }
+        return this.crisp.post(this.crisp.prepareRestUrl([
+            "website", websiteID, "conversation", sessionID, "tool"
+        ]), null, body);
+    }
+    ;
     /**
      * Deliver Widget Button Action For Conversation
      */

package/dist/resources/WebsiteSettings.d.ts

@@ -36,7 +36,6 @@ export interface WebsiteSettingsInbox {
 export interface WebsiteSettingsEmails {
     rating?: boolean;
     transcript?: boolean;
-    enrich?: boolean;
     junk_filter?: boolean;
 }
 export interface WebsiteSettingsChatbox {
@@ -113,7 +112,6 @@ export interface WebsiteSettingsUpdateInbox {
 export interface WebsiteSettingsUpdateEmails {
     rating?: boolean;
     transcript?: boolean;
-    enrich?: boolean;
     junk_filter?: boolean;
 }
 export interface WebsiteSettingsUpdateChatbox {

package/lib/resources/WebsiteBatch.ts

@@ -50,6 +50,18 @@ export type WebsiteBatchPeopleOperationInner = {
   search?: string;
 }
 
+export type WebsiteBatchDataPayload = Record<string, string | number | boolean>;
+
+export type WebsiteBatchConversationsDataOperation = {
+  sessions: string[];
+  data: WebsiteBatchDataPayload;
+}
+
+export type WebsiteBatchConversationsSegmentsOperation = {
+  sessions: string[];
+  segments: string[];
+}
+
 /**************************************************************************
  * CLASSES
  ***************************************************************************/
@@ -209,6 +221,70 @@ class WebsiteBatch extends BaseResource {
       null, operation
     );
   };
+
+  /**
+   * Batch Update Conversations Data
+   */
+  batchUpdateConversationsData(
+    websiteID: string, operation: WebsiteBatchConversationsDataOperation
+  ) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl(["website", websiteID, "batch", "data"]),
+
+      null, operation
+    );
+  };
+
+  /**
+   * Batch Update People Data
+   */
+  batchUpdatePeopleData(
+    websiteID: string, people: WebsiteBatchPeopleOperationInner,
+      data: WebsiteBatchDataPayload
+  ) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl(["website", websiteID, "batch", "data"]),
+
+      null,
+
+      {
+        people: people,
+        data: data
+      }
+    );
+  };
+
+  /**
+   * Batch Update Conversations Segments
+   */
+  batchUpdateConversationsSegments(
+    websiteID: string, operation: WebsiteBatchConversationsSegmentsOperation
+  ) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl(["website", websiteID, "batch", "segments"]),
+
+      null, operation
+    );
+  };
+
+  /**
+   * Batch Update People Segments
+   */
+  batchUpdatePeopleSegments(
+    websiteID: string, people: WebsiteBatchPeopleOperationInner,
+      segments: string[]
+  ) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl(["website", websiteID, "batch", "segments"]),
+
+      null,
+
+      {
+        people: people,
+        segments: segments
+      }
+    );
+  };
 }
 
 /**************************************************************************

package/lib/resources/WebsiteConversation.ts

@@ -1429,6 +1429,31 @@ class WebsiteConversation extends BaseResource {
     );
   };
 
+  /**
+   * Request Tool Call For Conversation
+   */
+  requestToolCallForConversation(
+    websiteID: string, sessionID: string, command: string, payload?: object
+  ) {
+    // Generate body
+    let body = {
+      command: command
+    };
+
+    if (payload) {
+      // @ts-ignore
+      body.payload = payload;
+    }
+
+    return this.crisp.post(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "conversation", sessionID, "tool"
+      ]),
+
+      null, body
+    );
+  };
+
   /**
    * Deliver Widget Button Action For Conversation
    */

package/lib/resources/WebsiteSettings.ts

@@ -51,7 +51,6 @@ export interface WebsiteSettingsInbox {
 export interface WebsiteSettingsEmails {
   rating?: boolean;
   transcript?: boolean;
-  enrich?: boolean;
   junk_filter?: boolean;
 }
 
@@ -134,7 +133,6 @@ export interface WebsiteSettingsUpdateInbox {
 export interface WebsiteSettingsUpdateEmails {
   rating?: boolean;
   transcript?: boolean;
-  enrich?: boolean;
   junk_filter?: boolean;
 }
 

package/package.json

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