crisp-api 10.8.1 → 10.8.3

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.3";
 // Base configuration
 const DEFAULT_REQUEST_TIMEOUT = 10000;
 const DEFAULT_SOCKET_TIMEOUT = 10000;

package/dist/resources/WebsiteConversation.d.ts

@@ -87,6 +87,7 @@ export interface ConversationParticipants {
 }
 export interface ConversationParticipantsSave {
     participants?: ConversationParticipant[];
+    user?: ConversationMessageUser;
 }
 export interface ConversationMeta {
     nickname?: string;
@@ -585,7 +586,7 @@ declare class WebsiteConversation extends BaseResource {
     /**
      * Change Conversation State
      */
-    changeConversationState(websiteID: string, sessionID: string, state: ConversationState): Promise<any>;
+    changeConversationState(websiteID: string, sessionID: string, state: ConversationState, user?: ConversationMessageUser): Promise<any>;
     /**
      * Get Conversation Relations
      */
@@ -605,7 +606,7 @@ declare class WebsiteConversation extends BaseResource {
     /**
      * Block Incoming Messages For Conversation
      */
-    blockIncomingMessagesForConversation(websiteID: string, sessionID: string, blocked: boolean): Promise<any>;
+    blockIncomingMessagesForConversation(websiteID: string, sessionID: string, blocked: boolean, user?: ConversationMessageUser): Promise<any>;
     /**
      * Get Verify Status For Conversation
      */
@@ -653,7 +654,7 @@ declare class WebsiteConversation extends BaseResource {
     /**
      * Initiate New Call Session For Conversation
      */
-    initiateNewCallSessionForConversation(websiteID: string, sessionID: string, mode: string): Promise<any>;
+    initiateNewCallSessionForConversation(websiteID: string, sessionID: string, mode: string, user?: ConversationMessageUser): Promise<any>;
     /**
      * Get Ongoing Call Session For Conversation
      */
@@ -661,7 +662,7 @@ declare class WebsiteConversation extends BaseResource {
     /**
      * Abort Ongoing Call Session For Conversation
      */
-    abortOngoingCallSessionForConversation(websiteID: string, sessionID: string, callID: string): Promise<any>;
+    abortOngoingCallSessionForConversation(websiteID: string, sessionID: string, callID: string, user?: ConversationMessageUser): Promise<any>;
     /**
      * Transmit Signaling On Ongoing Call Session
      */
@@ -681,7 +682,7 @@ declare class WebsiteConversation extends BaseResource {
     /**
      * Schedule A Reminder For Conversation
      */
-    scheduleReminderForConversation(websiteID: string, sessionID: string, date: string, note: string): Promise<any>;
+    scheduleReminderForConversation(websiteID: string, sessionID: string, date: string, note: string, user?: ConversationMessageUser): Promise<any>;
     /**
      * Report Conversation
      */

package/dist/resources/WebsiteConversation.js

@@ -334,11 +334,12 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Change Conversation State
      */
-    changeConversationState(websiteID, sessionID, state) {
+    changeConversationState(websiteID, sessionID, state, user) {
         return this.crisp.patch(this.crisp.prepareRestUrl([
             "website", websiteID, "conversation", sessionID, "state"
         ]), null, {
-            state: state
+            state: state,
+            user: user
         });
     }
     ;
@@ -381,11 +382,12 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Block Incoming Messages For Conversation
      */
-    blockIncomingMessagesForConversation(websiteID, sessionID, blocked) {
+    blockIncomingMessagesForConversation(websiteID, sessionID, blocked, user) {
         return this.crisp.patch(this.crisp.prepareRestUrl([
             "website", websiteID, "conversation", sessionID, "block"
         ]), null, {
-            blocked: (blocked || false)
+            blocked: (blocked || false),
+            user: user
         });
     }
     ;
@@ -505,11 +507,12 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Initiate New Call Session For Conversation
      */
-    initiateNewCallSessionForConversation(websiteID, sessionID, mode) {
+    initiateNewCallSessionForConversation(websiteID, sessionID, mode, user) {
         return this.crisp.post(this.crisp.prepareRestUrl([
             "website", websiteID, "conversation", sessionID, "call"
         ]), null, {
-            mode: (mode || "audio")
+            mode: (mode || "audio"),
+            user: user
         });
     }
     ;
@@ -525,10 +528,12 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Abort Ongoing Call Session For Conversation
      */
-    abortOngoingCallSessionForConversation(websiteID, sessionID, callID) {
+    abortOngoingCallSessionForConversation(websiteID, sessionID, callID, user) {
         return this.crisp.delete(this.crisp.prepareRestUrl([
             "website", websiteID, "conversation", sessionID, "call", callID
-        ]));
+        ]), null, {
+            user: user
+        });
     }
     ;
     /**
@@ -591,12 +596,13 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Schedule A Reminder For Conversation
      */
-    scheduleReminderForConversation(websiteID, sessionID, date, note) {
+    scheduleReminderForConversation(websiteID, sessionID, date, note, user) {
         return this.crisp.post(this.crisp.prepareRestUrl([
             "website", websiteID, "conversation", sessionID, "reminder"
         ]), null, {
             date: date,
-            note: note
+            note: note,
+            user: user
         });
     }
     ;

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/WebsiteConversation.ts

@@ -112,6 +112,7 @@ export interface ConversationParticipants {
 
 export interface ConversationParticipantsSave {
   participants?: ConversationParticipant[];
+  user?: ConversationMessageUser;
 }
 
 export interface ConversationMeta {
@@ -1057,7 +1058,8 @@ class WebsiteConversation extends BaseResource {
    * Change Conversation State
    */
   changeConversationState(
-    websiteID: string, sessionID: string, state: ConversationState
+    websiteID: string, sessionID: string, state: ConversationState,
+      user?: ConversationMessageUser
   ) {
     return this.crisp.patch(
       this.crisp.prepareRestUrl([
@@ -1067,7 +1069,8 @@ class WebsiteConversation extends BaseResource {
       null,
 
       {
-        state: state
+        state: state,
+        user: user
       }
     );
   };
@@ -1130,7 +1133,8 @@ class WebsiteConversation extends BaseResource {
    * Block Incoming Messages For Conversation
    */
   blockIncomingMessagesForConversation(
-    websiteID: string, sessionID: string, blocked: boolean
+    websiteID: string, sessionID: string, blocked: boolean,
+      user?: ConversationMessageUser
   ) {
     return this.crisp.patch(
       this.crisp.prepareRestUrl([
@@ -1140,7 +1144,8 @@ class WebsiteConversation extends BaseResource {
       null,
 
       {
-        blocked: (blocked || false)
+        blocked: (blocked || false),
+        user: user
       }
     );
   };
@@ -1334,7 +1339,8 @@ class WebsiteConversation extends BaseResource {
    * Initiate New Call Session For Conversation
    */
   initiateNewCallSessionForConversation(
-    websiteID: string, sessionID: string, mode: string
+    websiteID: string, sessionID: string, mode: string,
+      user?: ConversationMessageUser
   ) {
     return this.crisp.post(
       this.crisp.prepareRestUrl([
@@ -1344,7 +1350,8 @@ class WebsiteConversation extends BaseResource {
       null,
 
       {
-        mode: (mode || "audio")
+        mode: (mode || "audio"),
+        user: user
       }
     );
   };
@@ -1366,12 +1373,19 @@ class WebsiteConversation extends BaseResource {
    * Abort Ongoing Call Session For Conversation
    */
   abortOngoingCallSessionForConversation(
-    websiteID: string, sessionID: string, callID: string
+    websiteID: string, sessionID: string, callID: string,
+      user?: ConversationMessageUser
   ) {
     return this.crisp.delete(
       this.crisp.prepareRestUrl([
         "website", websiteID, "conversation", sessionID, "call", callID
-      ])
+      ]),
+
+      null,
+
+      {
+        user: user
+      }
     );
   };
 
@@ -1469,7 +1483,8 @@ class WebsiteConversation extends BaseResource {
    * Schedule A Reminder For Conversation
    */
   scheduleReminderForConversation(
-    websiteID: string, sessionID: string, date: string, note: string
+    websiteID: string, sessionID: string, date: string, note: string,
+      user?: ConversationMessageUser
   ) {
     return this.crisp.post(
       this.crisp.prepareRestUrl([
@@ -1480,7 +1495,8 @@ class WebsiteConversation extends BaseResource {
 
       {
         date: date,
-        note: note
+        note: note,
+        user: user
       }
     );
   };

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.3",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {