crisp-api 8.3.1 → 8.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,6 +1,18 @@
1
1
  Changelog
2
2
  =========
3
3
 
4
+ ## v8.4.0
5
+
6
+ ### New Features
7
+
8
+ * Added the new `CrispClient.website.abortWebsiteDeletion` method.
9
+
10
+ ## v8.3.2
11
+
12
+ ### New Features
13
+
14
+ * Added the new `CrispClient.website.resolveHelpdeskLocaleArticlePage` method.
15
+
4
16
  ## v8.3.1
5
17
 
6
18
  ### New Features
package/EXAMPLES.md CHANGED
@@ -1053,6 +1053,17 @@ CrispClient.website.deleteHelpdeskLocaleArticle(websiteID, locale, articleId);
1053
1053
 
1054
1054
  =========================
1055
1055
 
1056
+ https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article-page
1057
+
1058
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1059
+
1060
+ var locale = "en";
1061
+ var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
1062
+
1063
+ CrispClient.website.resolveHelpdeskLocaleArticlePage(websiteID, locale, articleId);
1064
+
1065
+ =========================
1066
+
1056
1067
  https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article-category
1057
1068
 
1058
1069
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
@@ -1537,6 +1548,14 @@ CrispClient.website.deleteWebsite(websiteID, verify);
1537
1548
 
1538
1549
  =========================
1539
1550
 
1551
+ https://docs.crisp.chat/references/rest-api/v1/#abort-website-deletion
1552
+
1553
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1554
+
1555
+ CrispClient.website.abortWebsiteDeletion(websiteID);
1556
+
1557
+ =========================
1558
+
1540
1559
  https://docs.crisp.chat/references/rest-api/v1/#get-website-settings
1541
1560
 
1542
1561
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
@@ -1586,6 +1605,8 @@ var settings = {
1586
1605
  "ignore_privacy": false,
1587
1606
  "visitor_compose": false,
1588
1607
  "file_transfer": true,
1608
+ "overlay_search": true,
1609
+ "overlay_mode": false,
1589
1610
  "helpdesk_link": true,
1590
1611
  "helpdesk_only": false,
1591
1612
  "status_health_dead": true,
package/README.md CHANGED
@@ -6,7 +6,7 @@ The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, ac
6
6
 
7
7
  Copyright 2023 Crisp IM SAS. See LICENSE for copying information.
8
8
 
9
- * **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 17/07/2023
9
+ * **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 12/07/2024
10
10
  * **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
11
11
 
12
12
  ## Installation
@@ -1596,6 +1596,21 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1596
1596
  ```
1597
1597
  </details>
1598
1598
 
1599
+ * **Resolve Helpdesk Locale Article Page** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article-page)
1600
+ * `CrispClient.website.resolveHelpdeskLocaleArticlePage(websiteID, locale, articleId)`
1601
+ * <details>
1602
+ <summary>See Example</summary>
1603
+
1604
+ ```javascript
1605
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1606
+
1607
+ var locale = "en";
1608
+ var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
1609
+
1610
+ CrispClient.website.resolveHelpdeskLocaleArticlePage(websiteID, locale, articleId);
1611
+ ```
1612
+ </details>
1613
+
1599
1614
  * **Resolve Helpdesk Locale Article Category** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article-category)
1600
1615
  * `CrispClient.website.resolveHelpdeskLocaleArticleCategory(websiteID, locale, articleId)`
1601
1616
  * <details>
@@ -2245,6 +2260,18 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2245
2260
  ```
2246
2261
  </details>
2247
2262
 
2263
+ * **Abort Website Deletion** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#abort-website-deletion)
2264
+ * `CrispClient.website.abortWebsiteDeletion(websiteID)`
2265
+ * <details>
2266
+ <summary>See Example</summary>
2267
+
2268
+ ```javascript
2269
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2270
+
2271
+ CrispClient.website.abortWebsiteDeletion(websiteID);
2272
+ ```
2273
+ </details>
2274
+
2248
2275
 
2249
2276
  * #### **Website Settings**
2250
2277
  * **Get Website Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-website-settings)
@@ -2304,6 +2331,8 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2304
2331
  "ignore_privacy": false,
2305
2332
  "visitor_compose": false,
2306
2333
  "file_transfer": true,
2334
+ "overlay_search": true,
2335
+ "overlay_mode": false,
2307
2336
  "helpdesk_link": true,
2308
2337
  "helpdesk_only": false,
2309
2338
  "status_health_dead": true,
@@ -79,6 +79,20 @@ function WebsiteBase(service, crisp) {
79
79
  }
80
80
  );
81
81
  };
82
+
83
+ /**
84
+ * Abort Website Deletion
85
+ * @memberof WebsiteBase
86
+ * @public
87
+ * @method abortWebsiteDeletion
88
+ * @param {string} websiteID
89
+ * @return {Promise}
90
+ */
91
+ service.abortWebsiteDeletion = function(websiteID) {
92
+ return crisp.delete(
93
+ crisp._prepareRestUrl(["website", websiteID, "expunge"])
94
+ );
95
+ };
82
96
  }
83
97
 
84
98
 
@@ -328,6 +328,27 @@ function WebsiteHelpdesk(service, crisp) {
328
328
  );
329
329
  };
330
330
 
331
+ /**
332
+ * Resolve Helpdesk Locale Article Page
333
+ * @memberof WebsiteConversation
334
+ * @public
335
+ * @method resolveHelpdeskLocaleArticlePage
336
+ * @param {string} websiteID
337
+ * @param {string} locale
338
+ * @param {string} articleId
339
+ * @return {Promise}
340
+ */
341
+ service.resolveHelpdeskLocaleArticlePage = function(
342
+ websiteID, locale, articleId
343
+ ) {
344
+ return crisp.get(
345
+ crisp._prepareRestUrl([
346
+ "website", websiteID, "helpdesk", "locale", locale, "article",
347
+ articleId, "page"
348
+ ])
349
+ );
350
+ };
351
+
331
352
  /**
332
353
  * Resolve Helpdesk Locale Article Category
333
354
  * @memberof WebsiteConversation
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "crisp-api",
3
3
  "description": "Crisp API wrapper for Node - official, maintained by Crisp",
4
- "version": "8.3.1",
4
+ "version": "8.4.0",
5
5
  "homepage": "https://github.com/crisp-im/node-crisp-api",
6
6
  "license": "MIT",
7
7
  "author": {