crisp-api 8.0.0 → 8.0.1

package/EXAMPLES.md

@@ -1174,8 +1174,9 @@ https://docs.crisp.chat/references/rest-api/v1/#add-helpdesk-locale-category
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
 var locale = "en";
+var name = "Chatbox";
 
-CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale);
+CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale, name);
 
 =========================
 
@@ -1585,6 +1586,7 @@ var settings = {
     "visitor_compose": false,
     "file_transfer": true,
     "helpdesk_link": true,
+    "helpdesk_only": false,
     "status_health_dead": true,
     "check_domain": false,
     "color_theme": "blue",
@@ -2125,7 +2127,15 @@ https://docs.crisp.chat/references/rest-api/v1/#list-all-connect-websites
 
 var pageNumber = 1;
 
-CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured, dateSince);
+CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured);
+
+=========================
+
+https://docs.crisp.chat/references/rest-api/v1/#list-connect-websites-since
+
+var dateSince = "2023-08-16T09:00:00Z";
+
+CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured);
 
 =========================
 
@@ -2264,4 +2274,3 @@ https://docs.crisp.chat/references/rest-api/v1/#bucket-url
 CrispClient.bucket.generateBucketURL(data);
 
 =========================
-

package/README.md

@@ -6,7 +6,7 @@ The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, ac
 
 Copyright 2023 Crisp IM SAS. See LICENSE for copying information.
 
-* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 16/01/2023
+* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 17/07/2023
 * **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
 
 ## Installation
@@ -1751,7 +1751,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       </details>
 
   * **Add Helpdesk Locale Category** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-helpdesk-locale-category)
-    * `CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale)`
+    * `CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale, name)`
     * <details>
       <summary>See Example</summary>
 
@@ -1759,8 +1759,9 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
 
       var locale = "en";
+      var name = "Chatbox";
 
-      CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale);
+      CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale, name);
       ```
       </details>
 
@@ -2301,6 +2302,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
           "visitor_compose": false,
           "file_transfer": true,
           "helpdesk_link": true,
+          "helpdesk_only": false,
           "status_health_dead": true,
           "check_domain": false,
           "color_theme": "blue",
@@ -3052,14 +3054,26 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       </details>
 
   * **⭐ List All Connect Websites** [`plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-all-connect-websites)
-    * `CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured, dateSince)`
+    * `CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured)`
     * <details>
       <summary>See Example</summary>
 
       ```javascript
       var pageNumber = 1;
 
-      CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured, dateSince);
+      CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured);
+      ```
+      </details>
+
+  * **⭐ List Connect Websites Since** [`plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-connect-websites-since)
+    * `CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var dateSince = "2023-08-16T09:00:00Z";
+
+      CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured);
       ```
       </details>
 

package/lib/resources/PluginConnect.js

@@ -46,16 +46,41 @@ function PluginConnect(service, crisp) {
    * @memberof PluginConnect
    * @public
    * @method listAllConnectWebsites
-   * @param {number} pageNumber
+   * @param {number}  pageNumber
    * @param {boolean} [filterConfigured]
-   * @param {string} [dateSince]
    * @return {Promise}
    */
   service.listAllConnectWebsites = function(
-    pageNumber, filterConfigured, dateSince
+    pageNumber, filterConfigured
   ) {
-    dateSince = (dateSince || null);
+    // Generate query
+    var _query = {
+      filter_configured : (
+        (filterConfigured === true) ? "1" : "0"
+      )
+    };
+
+    return crisp.get(
+      crisp._prepareRestUrl([
+        "plugin", "connect", "websites", "all", pageNumber
+      ]),
 
+      _query
+    );
+  };
+
+  /**
+   * List Connect Websites Since
+   * @memberof PluginConnect
+   * @public
+   * @method listConnectWebsitesSince
+   * @param  {string}  [dateSince]
+   * @param  {boolean} [filterConfigured]
+   * @return {Promise}
+   */
+  service.listConnectWebsitesSince = function(
+    dateSince, filterConfigured
+  ) {
     // Generate query
     var _query = {
       filter_configured : (
@@ -63,13 +88,13 @@ function PluginConnect(service, crisp) {
       )
     };
 
-    if (dateSince !== null) {
+    if (dateSince) {
       _query.date_since = dateSince;
     }
 
     return crisp.get(
       crisp._prepareRestUrl([
-        "plugin", "connect", "websites", "all", pageNumber
+        "plugin", "connect", "websites", "since"
       ]),
 
       _query

package/lib/resources/WebsiteHelpdesk.js

@@ -563,13 +563,20 @@ function WebsiteHelpdesk(service, crisp) {
    * @method addHelpdeskLocaleCategory
    * @param {string} websiteID
    * @param {string} locale
+   * @param {string} name
    * @return {Promise}
    */
-  service.addHelpdeskLocaleCategory = function(websiteID, locale) {
+  service.addHelpdeskLocaleCategory = function(websiteID, locale, name) {
     return crisp.post(
       crisp._prepareRestUrl([
         "website", websiteID, "helpdesk", "locale", locale, "category"
-      ])
+      ]),
+
+      null,
+
+      {
+        name : name
+      }
     );
   };
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "crisp-api",
   "description": "Crisp API wrapper for Node - official, maintained by Crisp",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "check-build": "2.8.2",
-    "typescript": "4.9.5"
+    "typescript": "5.1.6"
   },
   "dependencies": {
     "socket.io-client": "4.4.1",

package/types/crisp.d.ts

@@ -114,8 +114,8 @@ declare namespace Crisp {
     export { RTM_MODES, AVAILABLE_RTM_MODES, DEFAULT_REQUEST_TIMEOUT, DEFAULT_SOCKET_TIMEOUT, DEFAULT_SOCKET_RECONNECT_DELAY, DEFAULT_SOCKET_RECONNECT_DELAY_MAX, DEFAULT_SOCKET_RECONNECT_FACTOR, DEFAULT_BROKER_SCHEDULE, DEFAULT_EVENT_REBIND_INTERVAL_MIN, DEFAULT_USERAGENT_PREFIX, DEFAULT_REST_HOST, DEFAULT_REST_BASE_PATH, WebSockets as DEFAULT_RTM_MODE, DEFAULT_RTM_EVENTS, Crisp };
 }
 declare namespace RTM_MODES {
-    const WebSockets: string;
-    const WebHooks: string;
+    let WebSockets: string;
+    let WebHooks: string;
 }
 declare var AVAILABLE_RTM_MODES: string[];
 declare var DEFAULT_REQUEST_TIMEOUT: number;