crisp-api 10.8.3 → 10.8.5

package/README.md

@@ -680,7 +680,7 @@ All methods that you will most likely need when building a Crisp integration are
       </details>
 
   * **⭐ Change Conversation State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#change-conversation-state)
-    * `CrispClient.website.changeConversationState(websiteID, sessionID, state)`
+    * `CrispClient.website.changeConversationState(websiteID, sessionID, state, user, origin)`
     * <details>
       <summary>See Example</summary>
 
@@ -756,7 +756,7 @@ All methods that you will most likely need when building a Crisp integration are
       </details>
 
   * **Block Incoming Messages For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#block-incoming-messages-for-conversation)
-    * `CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked)`
+    * `CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked, user, origin)`
     * <details>
       <summary>See Example</summary>
 
@@ -942,7 +942,7 @@ All methods that you will most likely need when building a Crisp integration are
       </details>
 
   * **Initiate New Call Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-new-call-session-for-conversation)
-    * `CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode)`
+    * `CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode, user, origin)`
     * <details>
       <summary>See Example</summary>
 
@@ -970,7 +970,7 @@ All methods that you will most likely need when building a Crisp integration are
       </details>
 
   * **Abort Ongoing Call Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#abort-ongoing-call-session-for-conversation)
-    * `CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID)`
+    * `CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID, user, origin)`
     * <details>
       <summary>See Example</summary>
 
@@ -1073,7 +1073,7 @@ All methods that you will most likely need when building a Crisp integration are
       </details>
 
   * **Schedule A Reminder For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#schedule-a-reminder-for-conversation)
-    * `CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note)`
+    * `CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note, user, origin)`
     * <details>
       <summary>See Example</summary>
 

package/dist/crisp.js

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

package/dist/resources/WebsiteConversation.d.ts

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

package/dist/resources/WebsiteConversation.js

@@ -334,13 +334,19 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Change Conversation State
      */
-    changeConversationState(websiteID, sessionID, state, user) {
-        return this.crisp.patch(this.crisp.prepareRestUrl([
-            "website", websiteID, "conversation", sessionID, "state"
-        ]), null, {
+    changeConversationState(websiteID, sessionID, state, user, origin) {
+        // Generate body
+        let body = {
             state: state,
             user: user
-        });
+        };
+        if (origin) {
+            // @ts-ignore
+            body.origin = origin;
+        }
+        return this.crisp.patch(this.crisp.prepareRestUrl([
+            "website", websiteID, "conversation", sessionID, "state"
+        ]), null, body);
     }
     ;
     /**
@@ -382,13 +388,19 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Block Incoming Messages For Conversation
      */
-    blockIncomingMessagesForConversation(websiteID, sessionID, blocked, user) {
-        return this.crisp.patch(this.crisp.prepareRestUrl([
-            "website", websiteID, "conversation", sessionID, "block"
-        ]), null, {
+    blockIncomingMessagesForConversation(websiteID, sessionID, blocked, user, origin) {
+        // Generate body
+        let body = {
             blocked: (blocked || false),
             user: user
-        });
+        };
+        if (origin) {
+            // @ts-ignore
+            body.origin = origin;
+        }
+        return this.crisp.patch(this.crisp.prepareRestUrl([
+            "website", websiteID, "conversation", sessionID, "block"
+        ]), null, body);
     }
     ;
     /**
@@ -507,13 +519,19 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Initiate New Call Session For Conversation
      */
-    initiateNewCallSessionForConversation(websiteID, sessionID, mode, user) {
-        return this.crisp.post(this.crisp.prepareRestUrl([
-            "website", websiteID, "conversation", sessionID, "call"
-        ]), null, {
+    initiateNewCallSessionForConversation(websiteID, sessionID, mode, user, origin) {
+        // Generate body
+        let body = {
             mode: (mode || "audio"),
             user: user
-        });
+        };
+        if (origin) {
+            // @ts-ignore
+            body.origin = origin;
+        }
+        return this.crisp.post(this.crisp.prepareRestUrl([
+            "website", websiteID, "conversation", sessionID, "call"
+        ]), null, body);
     }
     ;
     /**
@@ -528,12 +546,18 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Abort Ongoing Call Session For Conversation
      */
-    abortOngoingCallSessionForConversation(websiteID, sessionID, callID, user) {
+    abortOngoingCallSessionForConversation(websiteID, sessionID, callID, user, origin) {
+        // Generate body
+        let body = {
+            user: user
+        };
+        if (origin) {
+            // @ts-ignore
+            body.origin = origin;
+        }
         return this.crisp.delete(this.crisp.prepareRestUrl([
             "website", websiteID, "conversation", sessionID, "call", callID
-        ]), null, {
-            user: user
-        });
+        ]), null, body);
     }
     ;
     /**
@@ -596,14 +620,20 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Schedule A Reminder For Conversation
      */
-    scheduleReminderForConversation(websiteID, sessionID, date, note, user) {
-        return this.crisp.post(this.crisp.prepareRestUrl([
-            "website", websiteID, "conversation", sessionID, "reminder"
-        ]), null, {
+    scheduleReminderForConversation(websiteID, sessionID, date, note, user, origin) {
+        // Generate body
+        let body = {
             date: date,
             note: note,
             user: user
-        });
+        };
+        if (origin) {
+            // @ts-ignore
+            body.origin = origin;
+        }
+        return this.crisp.post(this.crisp.prepareRestUrl([
+            "website", websiteID, "conversation", sessionID, "reminder"
+        ]), null, body);
     }
     ;
     /**

package/dist/resources/WebsitePeople.d.ts

@@ -193,7 +193,7 @@ declare class WebsitePeople extends BaseResource {
     /**
      * Save People Profile
      */
-    getPeopleProfile(websiteID: string, peopleID: string): Promise<any>;
+    getPeopleProfile(websiteID: string, peopleID: string): Promise<PeopleProfile>;
     /**
      * Get People Profile
      */

package/lib/resources/WebsiteConversation.ts

@@ -113,6 +113,7 @@ export interface ConversationParticipants {
 export interface ConversationParticipantsSave {
   participants?: ConversationParticipant[];
   user?: ConversationMessageUser;
+  origin?: string;
 }
 
 export interface ConversationMeta {
@@ -1059,19 +1060,25 @@ class WebsiteConversation extends BaseResource {
    */
   changeConversationState(
     websiteID: string, sessionID: string, state: ConversationState,
-      user?: ConversationMessageUser
+      user?: ConversationMessageUser, origin?: string
   ) {
+    // Generate body
+    let body = {
+      state: state,
+      user: user
+    };
+
+    if (origin) {
+      // @ts-ignore
+      body.origin = origin;
+    }
+
     return this.crisp.patch(
       this.crisp.prepareRestUrl([
         "website", websiteID, "conversation", sessionID, "state"
       ]),
 
-      null,
-
-      {
-        state: state,
-        user: user
-      }
+      null, body
     );
   };
 
@@ -1134,19 +1141,25 @@ class WebsiteConversation extends BaseResource {
    */
   blockIncomingMessagesForConversation(
     websiteID: string, sessionID: string, blocked: boolean,
-      user?: ConversationMessageUser
+      user?: ConversationMessageUser, origin?: string
   ) {
+    // Generate body
+    let body = {
+      blocked: (blocked || false),
+      user: user
+    };
+
+    if (origin) {
+      // @ts-ignore
+      body.origin = origin;
+    }
+
     return this.crisp.patch(
       this.crisp.prepareRestUrl([
         "website", websiteID, "conversation", sessionID, "block"
       ]),
 
-      null,
-
-      {
-        blocked: (blocked || false),
-        user: user
-      }
+      null, body
     );
   };
 
@@ -1340,19 +1353,25 @@ class WebsiteConversation extends BaseResource {
    */
   initiateNewCallSessionForConversation(
     websiteID: string, sessionID: string, mode: string,
-      user?: ConversationMessageUser
+      user?: ConversationMessageUser, origin?: string
   ) {
+    // Generate body
+    let body = {
+      mode: (mode || "audio"),
+      user: user
+    };
+
+    if (origin) {
+      // @ts-ignore
+      body.origin = origin;
+    }
+
     return this.crisp.post(
       this.crisp.prepareRestUrl([
         "website", websiteID, "conversation", sessionID, "call"
       ]),
 
-      null,
-
-      {
-        mode: (mode || "audio"),
-        user: user
-      }
+      null, body
     );
   };
 
@@ -1374,18 +1393,24 @@ class WebsiteConversation extends BaseResource {
    */
   abortOngoingCallSessionForConversation(
     websiteID: string, sessionID: string, callID: string,
-      user?: ConversationMessageUser
+      user?: ConversationMessageUser, origin?: string
   ) {
+    // Generate body
+    let body = {
+      user: user
+    };
+
+    if (origin) {
+      // @ts-ignore
+      body.origin = origin;
+    }
+
     return this.crisp.delete(
       this.crisp.prepareRestUrl([
         "website", websiteID, "conversation", sessionID, "call", callID
       ]),
 
-      null,
-
-      {
-        user: user
-      }
+      null, body
     );
   };
 
@@ -1484,20 +1509,26 @@ class WebsiteConversation extends BaseResource {
    */
   scheduleReminderForConversation(
     websiteID: string, sessionID: string, date: string, note: string,
-      user?: ConversationMessageUser
+      user?: ConversationMessageUser, origin?: string
   ) {
+    // Generate body
+    let body = {
+      date: date,
+      note: note,
+      user: user
+    };
+
+    if (origin) {
+      // @ts-ignore
+      body.origin = origin;
+    }
+
     return this.crisp.post(
       this.crisp.prepareRestUrl([
         "website", websiteID, "conversation", sessionID, "reminder"
       ]),
 
-      null,
-
-      {
-        date: date,
-        note: note,
-        user: user
-      }
+      null, body
     );
   };
 

package/lib/resources/WebsitePeople.ts

@@ -355,7 +355,7 @@ class WebsitePeople extends BaseResource {
   /**
    * Save People Profile
    */
-  getPeopleProfile(websiteID: string, peopleID: string) {
+  getPeopleProfile(websiteID: string, peopleID: string): Promise<PeopleProfile> {
     return this.crisp.get(
       this.crisp.prepareRestUrl([
         "website", websiteID, "people", "profile", peopleID

package/package.json

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