crisp-api 10.10.6 → 10.11.0

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+## v10.11.0
+
+### Changes
+
+* Added now-public `WebsiteTeams` service to the `CrispClient.website` prefix.
+
 ## v10.10.6
 
 ### Changes
@@ -8,7 +14,6 @@ Changelog
 * Added missing `url` field on `PeopleProfileCardPersonProfile` type.
 * Adding missing fields on RTM events
 
-
 ## v10.10.5
 
 ### Changes

package/EXAMPLES.md

@@ -1689,6 +1689,7 @@ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 var settings = {
   "name": "Crisp",
   "domain": "crisp.chat",
+  "domain_alternates": [],
   "logo": "https://storage.crisp.chat/users/avatar/website/8c842203-7ed8-4e29-a608-7cf78a7d2fcc/b6c2948d-b061-405e-91a9-2fdf855d1cc0.png",
   "audit": {
     "log": true
@@ -1705,6 +1706,7 @@ var settings = {
   "emails": {
     "rating": true,
     "transcript": true,
+    "trackers": true,
     "junk_filter": true
   },
   "chatbox": {
@@ -1729,6 +1731,7 @@ var settings = {
     "visitor_compose": false,
     "file_transfer": true,
     "audio_record": true,
+    "guard_level": "default",
     "mode_initial": "chat",
     "home": true,
     "overlay_search": true,
@@ -2203,6 +2206,77 @@ CrispClient.website.deleteInbox(websiteID, inboxID);
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#list-teams
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var pageNumber = 1;
+
+CrispClient.website.listTeams(websiteID, pageNumber);
+
+=========================
+
+https://docs.crisp.chat/references/rest-api/v1/#create-a-new-team
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+var team = {
+  "name": "Sales",
+  "emoji": "💰",
+
+  "operators": [
+    "a4c32c68-be91-4e29-8a05-976e93abbe3f"
+  ]
+};
+
+CrispClient.website.createNewTeam(websiteID, team);
+
+=========================
+
+https://docs.crisp.chat/references/rest-api/v1/#check-if-team-exists
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
+
+CrispClient.website.checkTeamExists(websiteID, teamID);
+
+=========================
+
+https://docs.crisp.chat/references/rest-api/v1/#get-a-team
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
+
+CrispClient.website.getTeam(websiteID, teamID);
+
+=========================
+
+https://docs.crisp.chat/references/rest-api/v1/#save-a-team
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
+
+var team = {
+  "name": "Sales",
+  "emoji": "💰",
+
+  "operators": [
+    "a4c32c68-be91-4e29-8a05-976e93abbe3f"
+  ]
+};
+
+CrispClient.website.saveTeam(websiteID, teamID, team);
+
+=========================
+
+https://docs.crisp.chat/references/rest-api/v1/#remove-a-team
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
+
+CrispClient.website.deleteTeam(websiteID, teamID);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#get-verify-settings
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

package/README.md

@@ -112,6 +112,7 @@ All methods that you will most likely need when building a Crisp integration are
     <li><a href="#website-analytics">Website Analytics</a></li>
     <li><a href="#website-batch">Website Batch</a></li>
     <li><a href="#website-inbox">Website Inbox</a></li>
+    <li><a href="#website-teams">Website Teams</a></li>
     <li><a href="#website-verify">Website Verify</a></li>
     <li><a href="#website-campaigns">Website Campaigns</a></li>
     <li><a href="#website-campaign">Website Campaign</a></li>
@@ -2469,6 +2470,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       var settings = {
         "name": "Crisp",
         "domain": "crisp.chat",
+        "domain_alternates": [],
         "logo": "https://storage.crisp.chat/users/avatar/website/8c842203-7ed8-4e29-a608-7cf78a7d2fcc/b6c2948d-b061-405e-91a9-2fdf855d1cc0.png",
         "audit": {
           "log": true
@@ -2485,6 +2487,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
         "emails": {
           "rating": true,
           "transcript": true,
+          "trackers": true,
           "junk_filter": true
         },
         "chatbox": {
@@ -2509,6 +2512,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
           "visitor_compose": false,
           "file_transfer": true,
           "audio_record": true,
+          "guard_level": "default",
           "mode_initial": "chat",
           "home": true,
           "overlay_search": true,
@@ -3242,6 +3246,103 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       </details>
 
 
+* #### **Website Teams**
+  * **List Teams**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-teams)
+    * `CrispClient.website.listTeams(websiteID, pageNumber)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var pageNumber = 1;
+
+      CrispClient.website.listTeams(websiteID, pageNumber);
+      ```
+      </details>
+
+  * **Create A New Team**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-team)
+    * `CrispClient.website.createNewTeam(websiteID, team)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+
+      var team = {
+        "name": "Sales",
+        "emoji": "💰",
+
+        "operators": [
+          "a4c32c68-be91-4e29-8a05-976e93abbe3f"
+        ]
+      };
+
+      CrispClient.website.createNewTeam(websiteID, team);
+      ```
+      </details>
+
+  * **Check If Team Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-team-exists)
+    * `CrispClient.website.checkTeamExists(websiteID, teamID)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
+
+      CrispClient.website.checkTeamExists(websiteID, teamID);
+      ```
+      </details>
+
+  * **Get Team**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-team)
+    * `CrispClient.website.getTeam(websiteID, teamID)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
+
+      CrispClient.website.getTeam(websiteID, teamID);
+      ```
+      </details>
+
+  * **Save Team**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-a-team)
+    * `CrispClient.website.saveTeam(websiteID, teamID, team)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
+
+      var team = {
+        "name": "Sales",
+        "emoji": "💰",
+
+        "operators": [
+          "a4c32c68-be91-4e29-8a05-976e93abbe3f"
+        ]
+      };
+
+      CrispClient.website.saveTeam(websiteID, teamID, team);
+      ```
+      </details>
+
+  * **Delete Team**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-team)
+    * `CrispClient.website.deleteTeam(websiteID, teamID)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
+
+      CrispClient.website.deleteTeam(websiteID, teamID);
+      ```
+      </details>
+
+
 * #### **Website Verify**
   * **Get Verify Settings**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-verify-settings)
     * `CrispClient.website.getVerifySettings(websiteID)`

package/dist/crisp.js

@@ -46,7 +46,7 @@ const AVAILABLE_RTM_MODES = [
     "websockets",
     "webhooks"
 ];
-const VERSION = "10.10.6";
+const VERSION = "10.11.0";
 // Base configuration
 const DEFAULT_REQUEST_TIMEOUT = 10000;
 const DEFAULT_SOCKET_TIMEOUT = 10000;
@@ -204,7 +204,7 @@ class Crisp {
         this._loopback = null;
         this._lastEventRebind = null;
         this._brokerScheduler = null;
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any, no-unused-vars
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         this._brokerBindHooks = [];
         this._boundEvents = {};
         this._prepareServices();
@@ -329,7 +329,7 @@ class Crisp {
     /**
      * Binds RTM event
      */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, no-unused-vars
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     on(event, callback) {
         // Ensure all input arguments are set
         if (typeof event !== "string") {
@@ -355,7 +355,7 @@ class Crisp {
         this._emitter.on(event, callback);
         // Subscribe event on the broker
         if (this._boundEvents[event] !== true) {
-            let rtmMode = this._rtm.mode;
+            const rtmMode = this._rtm.mode;
             // Mark event as bound
             this._boundEvents[event] = true;
             // Broker not connected? Connect now.
@@ -499,7 +499,7 @@ class Crisp {
      * Binds broker to the main object
      */
     __prepareBroker(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, no-unused-vars
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     fnBindHook) {
         return new Promise((resolve, reject) => {
             const rtmMode = this._rtm.mode;
@@ -515,7 +515,7 @@ class Crisp {
                 if (this._socket || this._loopback) {
                     throw new Error("[Crisp] prepareBroker: illegal call to prepare broker (tie break)");
                 }
-                // @ts-ignore
+                // @ts-expect-error - rtmMode is a string
                 this._brokerScheduler = setTimeout(() => {
                     switch (rtmMode) {
                         case "websockets": {
@@ -535,7 +535,7 @@ class Crisp {
                         }
                         default: {
                             const unsupportedError = new Error("[Crisp] prepareBroker: mode of RTM broker unsupported " +
-                                "('" + rtmMode + "')");
+                                "('" + String(rtmMode) + "')");
                             reject(unsupportedError);
                         }
                     }
@@ -597,7 +597,6 @@ class Crisp {
         })
             .then((endpoints) => {
             var _a, _b, _c;
-            // @ts-ignore
             const rtmHostAffinity = (((_a = endpoints === null || endpoints === void 0 ? void 0 : endpoints.socket) === null || _a === void 0 ? void 0 : _a.app) || null);
             // No RTM API host acquired?
             if (rtmHostAffinity === null) {
@@ -607,7 +606,6 @@ class Crisp {
             // Parse target RTM API host as an URL object
             const rtmHostUrl = new url_1.URL(rtmHostAffinity);
             // Connect to socket
-            // @ts-ignore
             this._socket = (0, socket_io_client_1.io)(rtmHostUrl.origin, {
                 path: (rtmHostUrl.pathname || "/"),
                 transports: ["websocket"],
@@ -670,12 +668,8 @@ class Crisp {
     /**
      * Performs a request to REST API
      */
-    __request(resource, method, query, body, 
-    // eslint-disable-next-line no-unused-vars
-    resolve, 
-    // eslint-disable-next-line no-unused-vars
-    reject) {
-        let requestParameters = {
+    __request(resource, method, query, body, resolve, reject) {
+        const requestParameters = {
             responseType: "json",
             timeout: DEFAULT_REQUEST_TIMEOUT,
             headers: Object.assign({ "User-Agent": this._useragent, "X-Crisp-Tier": this.auth.tier }, this._customHeaders),
@@ -683,12 +677,12 @@ class Crisp {
         };
         // Add authorization?
         if (this.auth.token) {
-            // @ts-ignore
+            // @ts-expect-error - requestParameters.headers is a Record<string, string>
             requestParameters.headers.Authorization = ("Basic " + this.auth.token);
         }
         // Add body?
         if (body) {
-            // @ts-ignore
+            // @ts-expect-error - requestParameters.json is a Record<string, unknown>
             requestParameters.json = body;
         }
         // Add query?
@@ -705,7 +699,7 @@ class Crisp {
                     params.append(key, String(value));
                 }
             });
-            // @ts-ignore
+            // @ts-expect-error - requestParameters.searchParams is a URLSearchParams
             requestParameters.searchParams = params;
         }
         // Proceed request
@@ -729,7 +723,7 @@ class Crisp {
             }
             // Response error?
             if (response.statusCode >= 400) {
-                let reasonMessage = this.__readErrorResponseReason(method, response.statusCode, response);
+                const reasonMessage = this.__readErrorResponseReason(method, response.statusCode, response);
                 const dataMessage = (((_b = (_a = response === null || response === void 0 ? void 0 : response.body) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message) || "");
                 return reject({
                     reason: "error",
@@ -764,7 +758,6 @@ class Crisp {
         }
         // Other methods must hold a response body, therefore we can fallback on \
         //   an HTTP error if we fail to acquire any reason at all.
-        // @ts-ignore
         return ((((_a = response === null || response === void 0 ? void 0 : response.body) === null || _a === void 0 ? void 0 : _a.reason) || "http_error"));
     }
     /**
@@ -777,12 +770,12 @@ class Crisp {
             return false;
         }
         // Compute local trace
-        let localTrace = ("[" + timestamp + ";" + JSON.stringify(body) + "]");
+        const localTrace = ("[" + timestamp + ";" + JSON.stringify(body) + "]");
         // Create local HMAC
-        let localMac = crypto_1.default.createHmac("sha256", secret);
+        const localMac = crypto_1.default.createHmac("sha256", secret);
         localMac.update(localTrace);
         // Compute local signature, and compare
-        let localSignature = localMac.digest("hex");
+        const localSignature = localMac.digest("hex");
         return ((signature === localSignature) ? true : false);
     }
 }

package/dist/events/Events.d.ts

@@ -496,7 +496,7 @@ export interface EventsPlanSubscriptionUpdated extends EventsWebsiteGeneric {
  * EVENT MAP
  ***************************************************************************/
 /**
- * Maps each event name to the shape of the payload delivered to its listener,
+ * Maps each event name to the shape of the payload delivered to its listener, \
  *   whether received over WebSockets or Web Hooks.
  */
 export interface EventsMap {
@@ -588,7 +588,7 @@ export interface EventsMap {
  */
 export type EventName = keyof EventsMap;
 /**
- * Shape of a Web Hook body, as received on the HTTP endpoint before being
+ * Shape of a Web Hook body, as received on the HTTP endpoint before being \
  *   dispatched with 'receiveHook'.
  */
 export type EventsWebHookBody<Name extends EventName = EventName> = {

package/dist/resources/PluginConnect.js

@@ -40,7 +40,7 @@ class PluginConnect extends BaseResource_1.default {
      */
     listAllConnectWebsites(pageNumber, filterConfigured, includePlan) {
         // Generate query
-        let query = {
+        const query = {
             filter_configured: ((filterConfigured === true) ? "1" : "0"),
             include_plan: ((includePlan === true) ? "1" : "0")
         };
@@ -54,12 +54,12 @@ class PluginConnect extends BaseResource_1.default {
      */
     listConnectWebsitesSince(dateSince, filterConfigured, includePlan) {
         // Generate query
-        let query = {
+        const query = {
             filter_configured: ((filterConfigured === true) ? "1" : "0"),
             include_plan: ((includePlan === true) ? "1" : "0")
         };
         if (dateSince) {
-            // @ts-ignore
+            // @ts-expect-error - dateSince is a string
             query.date_since = dateSince;
         }
         return this.crisp.get(this.crisp.prepareRestUrl([

package/dist/resources/WebsiteBase.d.ts

@@ -36,11 +36,6 @@ export type WebsiteFilter = {
 declare class WebsiteBase extends BaseResource {
     /**
      * Check If Website Exists
-     * @memberof WebsiteBase
-     * @public
-     * @method checkWebsiteExists
-     * @param {string} domain
-     * @return {Promise}
      */
     checkWebsiteExists(domain: string): Promise<any>;
     /**
@@ -49,11 +44,6 @@ declare class WebsiteBase extends BaseResource {
     createWebsite(websiteData: WebsiteCreate): Promise<Website>;
     /**
      * Get A Website
-     * @memberof WebsiteBase
-     * @public
-     * @method getWebsite
-     * @param {string} websiteID
-     * @return {Promise}
      */
     getWebsite(websiteID: string): Promise<Website>;
     /**

package/dist/resources/WebsiteBase.js

@@ -23,11 +23,6 @@ const BaseResource_1 = __importDefault(require("./BaseResource"));
 class WebsiteBase extends BaseResource_1.default {
     /**
      * Check If Website Exists
-     * @memberof WebsiteBase
-     * @public
-     * @method checkWebsiteExists
-     * @param {string} domain
-     * @return {Promise}
      */
     checkWebsiteExists(domain) {
         return this.crisp.head(this.crisp.prepareRestUrl(["website"]), {
@@ -44,11 +39,6 @@ class WebsiteBase extends BaseResource_1.default {
     ;
     /**
      * Get A Website
-     * @memberof WebsiteBase
-     * @public
-     * @method getWebsite
-     * @param {string} websiteID
-     * @return {Promise}
      */
     getWebsite(websiteID) {
         return this.crisp.get(this.crisp.prepareRestUrl(["website", websiteID]));

package/dist/resources/WebsiteBatch.d.ts

@@ -58,12 +58,6 @@ declare class WebsiteBatch extends BaseResource {
     batchUnresolveConversations(websiteID: string, operation: WebsiteBatchConversationsOperation): Promise<any>;
     /**
      * Batch Read Conversations
-     * @memberof WebsiteBatch
-     * @public
-     * @method batchReadConversations
-     * @param {string} websiteID
-     * @param {object} operation
-     * @return {Promise}
      */
     batchReadConversations(websiteID: string, operation: WebsiteBatchConversationsOperation): Promise<any>;
     /**
@@ -72,22 +66,10 @@ declare class WebsiteBatch extends BaseResource {
     batchUnreadConversations(websiteID: string, operation: WebsiteBatchConversationsOperation): Promise<any>;
     /**
      * Batch Remove Conversations
-     * @memberof WebsiteBatch
-     * @public
-     * @method batchRemoveConversations
-     * @param {string} websiteID
-     * @param {object} operation
-     * @return {Promise}
      */
     batchRemoveConversations(websiteID: string, operation: WebsiteBatchConversationsOperation): Promise<any>;
     /**
      * Batch Remove People
-     * @memberof WebsiteBatch
-     * @public
-     * @method batchRemovePeople
-     * @param {string} websiteID
-     * @param {object} people
-     * @return {Promise}
      */
     batchRemovePeople(websiteID: string, people: WebsiteBatchPeopleOperationInner): Promise<any>;
     /**

package/dist/resources/WebsiteBatch.js

@@ -37,12 +37,6 @@ class WebsiteBatch extends BaseResource_1.default {
     ;
     /**
      * Batch Read Conversations
-     * @memberof WebsiteBatch
-     * @public
-     * @method batchReadConversations
-     * @param {string} websiteID
-     * @param {object} operation
-     * @return {Promise}
      */
     batchReadConversations(websiteID, operation) {
         return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "read"]), null, operation);
@@ -57,12 +51,6 @@ class WebsiteBatch extends BaseResource_1.default {
     ;
     /**
      * Batch Remove Conversations
-     * @memberof WebsiteBatch
-     * @public
-     * @method batchRemoveConversations
-     * @param {string} websiteID
-     * @param {object} operation
-     * @return {Promise}
      */
     batchRemoveConversations(websiteID, operation) {
         return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "remove"]), null, operation);
@@ -70,12 +58,6 @@ class WebsiteBatch extends BaseResource_1.default {
     ;
     /**
      * Batch Remove People
-     * @memberof WebsiteBatch
-     * @public
-     * @method batchRemovePeople
-     * @param {string} websiteID
-     * @param {object} people
-     * @return {Promise}
      */
     batchRemovePeople(websiteID, people) {
         return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "remove"]), null, {

package/dist/resources/WebsiteCampaign.d.ts

@@ -179,7 +179,6 @@ declare class WebsiteCampaign extends BaseResource {
     removeCampaign(websiteID: string, campaignID: string): Promise<any>;
     /**
      * Dispatch A Campaign
-     * @return {Promise}
      */
     dispatchCampaign(websiteID: string, campaignID: string): Promise<any>;
     /**

package/dist/resources/WebsiteCampaign.js

@@ -139,7 +139,6 @@ class WebsiteCampaign extends BaseResource_1.default {
     ;
     /**
      * Dispatch A Campaign
-     * @return {Promise}
      */
     dispatchCampaign(websiteID, campaignID) {
         return this.crisp.post(this.crisp.prepareRestUrl([