crisp-api 10.8.2 → 10.8.4

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.2";
+const VERSION = "10.8.4";
 // Base configuration
 const DEFAULT_REQUEST_TIMEOUT = 10000;
 const DEFAULT_SOCKET_TIMEOUT = 10000;

package/dist/resources/WebsiteConversation.d.ts

@@ -87,6 +87,8 @@ export interface ConversationParticipants {
 }
 export interface ConversationParticipantsSave {
     participants?: ConversationParticipant[];
+    user?: ConversationMessageUser;
+    origin?: string;
 }
 export interface ConversationMeta {
     nickname?: string;
@@ -585,7 +587,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, origin?: string): Promise<any>;
     /**
      * Get Conversation Relations
      */
@@ -605,7 +607,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, origin?: string): Promise<any>;
     /**
      * Get Verify Status For Conversation
      */
@@ -653,7 +655,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, origin?: string): Promise<any>;
     /**
      * Get Ongoing Call Session For Conversation
      */
@@ -661,7 +663,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, origin?: string): Promise<any>;
     /**
      * Transmit Signaling On Ongoing Call Session
      */
@@ -681,7 +683,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, origin?: string): Promise<any>;
     /**
      * Report Conversation
      */

package/dist/resources/WebsiteConversation.js

@@ -334,12 +334,19 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Change Conversation State
      */
-    changeConversationState(websiteID, sessionID, state) {
+    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, {
-            state: state
-        });
+        ]), null, body);
     }
     ;
     /**
@@ -381,12 +388,19 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Block Incoming Messages For Conversation
      */
-    blockIncomingMessagesForConversation(websiteID, sessionID, blocked) {
+    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, {
-            blocked: (blocked || false)
-        });
+        ]), null, body);
     }
     ;
     /**
@@ -505,12 +519,19 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Initiate New Call Session For Conversation
      */
-    initiateNewCallSessionForConversation(websiteID, sessionID, mode) {
+    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, {
-            mode: (mode || "audio")
-        });
+        ]), null, body);
     }
     ;
     /**
@@ -525,10 +546,18 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Abort Ongoing Call Session For Conversation
      */
-    abortOngoingCallSessionForConversation(websiteID, sessionID, callID) {
+    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, body);
     }
     ;
     /**
@@ -591,13 +620,20 @@ class WebsiteConversation extends BaseResource_1.default {
     /**
      * Schedule A Reminder For Conversation
      */
-    scheduleReminderForConversation(websiteID, sessionID, date, note) {
+    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, {
-            date: date,
-            note: note
-        });
+        ]), null, body);
     }
     ;
     /**

package/lib/resources/WebsiteConversation.ts

@@ -112,6 +112,8 @@ export interface ConversationParticipants {
 
 export interface ConversationParticipantsSave {
   participants?: ConversationParticipant[];
+  user?: ConversationMessageUser;
+  origin?: string;
 }
 
 export interface ConversationMeta {
@@ -1057,18 +1059,26 @@ class WebsiteConversation extends BaseResource {
    * Change Conversation State
    */
   changeConversationState(
-    websiteID: string, sessionID: string, state: ConversationState
+    websiteID: string, sessionID: string, state: ConversationState,
+      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
-      }
+      null, body
     );
   };
 
@@ -1130,18 +1140,26 @@ class WebsiteConversation extends BaseResource {
    * Block Incoming Messages For Conversation
    */
   blockIncomingMessagesForConversation(
-    websiteID: string, sessionID: string, blocked: boolean
+    websiteID: string, sessionID: string, blocked: boolean,
+      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)
-      }
+      null, body
     );
   };
 
@@ -1334,18 +1352,26 @@ 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, 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")
-      }
+      null, body
     );
   };
 
@@ -1366,12 +1392,25 @@ 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, 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, body
     );
   };
 
@@ -1469,19 +1508,27 @@ 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, 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
-      }
+      null, body
     );
   };
 

package/package.json

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