crisp-api 10.8.1 → 10.8.2

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+## v10.8.2
+
+### Changes
+
+* Added `mode_initial` and `home` properties on `chatbox` options in website settings.
+
 ## v10.8.1
 
 ### Changes

package/EXAMPLES.md

@@ -1717,6 +1717,8 @@ var settings = {
     "visitor_compose": false,
     "file_transfer": true,
     "audio_record": true,
+    "mode_initial": "chat",
+    "home": true,
     "overlay_search": true,
     "overlay_mode": false,
     "helpdesk_link": true,

package/README.md

@@ -22,7 +22,7 @@ To authenticate against the API, obtain your authentication token keypair by fol
 Then, add authentication parameters to your `client` instance right after you create it:
 
 ```javascript
-var Crisp = require("crisp-api");
+var { Crisp } = require("crisp-api");
 var CrispClient = new Crisp();
 
 // Authenticate to API with your plugin token (identifier, key)
@@ -37,7 +37,7 @@ CrispClient.authenticateTier("plugin", identifier, key);
 You may follow the [REST API Quickstart](https://docs.crisp.chat/guides/rest-api/quickstart/) guide, which will get you running with the REST API in minutes.
 
 ```javascript
-var Crisp = require("crisp-api");
+var { Crisp } = require("crisp-api");
 var CrispClient = new Crisp();
 
 CrispClient.authenticateTier("plugin", identifier, key);
@@ -56,7 +56,7 @@ CrispClient.website.listConversations(websiteID, 1)
 ### Create your own bot!
 
 ```javascript
-var Crisp = require("crisp-api");
+var { Crisp } = require("crisp-api");
 var CrispClient = new Crisp();
 
 CrispClient.authenticateTier("plugin", identifier, key);
@@ -2492,6 +2492,8 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
           "visitor_compose": false,
           "file_transfer": true,
           "audio_record": true,
+          "mode_initial": "chat",
+          "home": true,
           "overlay_search": true,
           "overlay_mode": false,
           "helpdesk_link": true,

package/dist/crisp.js

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

package/dist/resources/WebsiteHelpdesk.d.ts

@@ -21,11 +21,19 @@ export interface HelpdeskLocale {
     categories?: number;
 }
 export interface HelpdeskLocaleArticle {
-    locale_id?: string;
-    locale?: string;
+    article_id?: string;
+    title?: string;
+    description?: string | null;
+    content?: string;
+    status?: "published" | "draft";
+    visibility?: "visible" | "hidden";
+    featured?: boolean;
+    visits?: number;
+    order?: number;
     url?: string;
-    articles?: number;
-    categories?: number;
+    created_at?: number;
+    updated_at?: number;
+    published_at?: number;
 }
 export interface HelpdeskLocaleArticleCategory {
     category_id?: string;

package/dist/resources/WebsiteSettings.d.ts

@@ -61,6 +61,8 @@ export interface WebsiteSettingsChatbox {
     visitor_compose?: boolean;
     file_transfer?: boolean;
     audio_record?: boolean;
+    mode_initial?: string;
+    home?: boolean;
     overlay_search?: boolean;
     overlay_mode?: boolean;
     helpdesk_link?: boolean;
@@ -78,6 +80,7 @@ export interface WebsiteSettingsChatbox {
     blocked_pages?: string[];
     blocked_countries?: string[];
     blocked_locales?: string[];
+    blocked_ips?: string[];
 }
 export interface WebsiteSettingsUpdate {
     websiteID?: string;
@@ -135,6 +138,8 @@ export interface WebsiteSettingsUpdateChatbox {
     visitor_compose?: boolean;
     file_transfer?: boolean;
     audio_record?: boolean;
+    mode_initial?: string;
+    home?: boolean;
     overlay_search?: boolean;
     overlay_mode?: boolean;
     helpdesk_link?: boolean;

package/lib/resources/WebsiteHelpdesk.ts

@@ -35,11 +35,19 @@ export interface HelpdeskLocale {
 }
 
 export interface HelpdeskLocaleArticle {
-  locale_id?: string;
-  locale?: string;
+  article_id?: string;
+  title?: string;
+  description?: string | null;
+  content?: string;
+  status?: "published" | "draft";
+  visibility?: "visible" | "hidden";
+  featured?: boolean;
+  visits?: number;
+  order?: number;
   url?: string;
-  articles?: number;
-  categories?: number;
+  created_at?: number;
+  updated_at?: number;
+  published_at?: number;
 }
 
 export interface HelpdeskLocaleArticleCategory {

package/lib/resources/WebsiteSettings.ts

@@ -77,6 +77,8 @@ export interface WebsiteSettingsChatbox {
   visitor_compose?: boolean;
   file_transfer?: boolean;
   audio_record?: boolean;
+  mode_initial?: string;
+  home?: boolean;
   overlay_search?: boolean;
   overlay_mode?: boolean;
   helpdesk_link?: boolean;
@@ -94,6 +96,7 @@ export interface WebsiteSettingsChatbox {
   blocked_pages?: string[];
   blocked_countries?: string[];
   blocked_locales?: string[];
+  blocked_ips?: string[];
 }
 
 export interface WebsiteSettingsUpdate {
@@ -157,6 +160,8 @@ export interface WebsiteSettingsUpdateChatbox {
   visitor_compose?: boolean;
   file_transfer?: boolean;
   audio_record?: boolean;
+  mode_initial?: string;
+  home?: boolean;
   overlay_search?: boolean;
   overlay_mode?: boolean;
   helpdesk_link?: boolean;

package/package.json

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