crisp-api 7.2.0 → 7.4.0

package/lib/resources/WebsiteConversation.js

@@ -18,8 +18,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * List Conversations
    * @memberof WebsiteConversation
+   * @public
    * @method listConversations
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listConversations = function(websiteID, pageNumber) {
     return crisp.get(
@@ -30,8 +33,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * List Suggested Conversation Segments
    * @memberof WebsiteConversation
+   * @public
    * @method listSuggestedConversationSegments
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listSuggestedConversationSegments = function(websiteID, pageNumber) {
     return crisp.get(
@@ -44,8 +50,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Delete Suggested Conversation Segment
    * @memberof WebsiteConversation
+   * @public
    * @method deleteSuggestedConversationSegment
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} segment
+   * @return {Promise}
    */
   service.deleteSuggestedConversationSegment = function(websiteID, segment) {
     return crisp.delete(
@@ -64,8 +73,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * List Suggested Conversation Data Keys
    * @memberof WebsiteConversation
+   * @public
    * @method listSuggestedConversationDataKeys
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listSuggestedConversationDataKeys = function(websiteID, pageNumber) {
     return crisp.get(
@@ -78,8 +90,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Delete Suggested Conversation Data Key
    * @memberof WebsiteConversation
+   * @public
    * @method deleteSuggestedConversationDataKey
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} key
+   * @return {Promise}
    */
   service.deleteSuggestedConversationDataKey = function(websiteID, key) {
     return crisp.delete(
@@ -98,8 +113,10 @@ function WebsiteConversation(service, crisp) {
   /**
    * Create A New Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method createNewConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.createNewConversation = function(websiteID) {
     return crisp.post(
@@ -110,8 +127,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Check If Conversation Exists
    * @memberof WebsiteConversation
+   * @public
    * @method checkConversationExists
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.checkConversationExists = function(websiteID, sessionID) {
     return crisp.head(
@@ -122,8 +142,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Get A Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method getConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.getConversation = function(websiteID, sessionID) {
     return crisp.get(
@@ -134,8 +157,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Remove A Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method removeConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.removeConversation = function(websiteID, sessionID) {
     return crisp.delete(
@@ -146,8 +172,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Initiate A Conversation With Existing Session
    * @memberof WebsiteConversation
+   * @public
    * @method initiateConversationWithExistingSession
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.initiateConversationWithExistingSession = function(
     websiteID, sessionID
@@ -162,8 +191,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Get Messages In Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method getMessagesInConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} [timestampBefore]
+   * @return {Promise}
    */
   service.getMessagesInConversation = function(
     websiteID, sessionID, timestampBefore
@@ -187,8 +220,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Send A Message In Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method sendMessageInConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {object} message
+   * @return {Promise}
    */
   service.sendMessageInConversation = function(websiteID, sessionID, message) {
     return crisp.post(
@@ -203,8 +240,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Get A Message In Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method getMessageInConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {number} fingerprint
+   * @return {Promise}
    */
   service.getMessageInConversation = function(
     websiteID, sessionID, fingerprint
@@ -219,8 +260,13 @@ function WebsiteConversation(service, crisp) {
   /**
    * Update A Message In Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method updateMessageInConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {number} fingerprint
+   * @param {object} content
+   * @return {Promise}
    */
   service.updateMessageInConversation = function(
     websiteID, sessionID, fingerprint, content
@@ -241,8 +287,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Remove A Message In Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method removeMessageInConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {number} fingerprint
+   * @return {Promise}
    */
   service.removeMessageInConversation = function(
     websiteID, sessionID, fingerprint
@@ -257,8 +307,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Compose A Message In Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method composeMessageInConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {object} compose
+   * @return {Promise}
    */
   service.composeMessageInConversation = function(
     websiteID, sessionID, compose
@@ -275,8 +329,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Mark Messages As Read In Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method markMessagesReadInConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {object} read
+   * @return {Promise}
    */
   service.markMessagesReadInConversation = function(
     websiteID, sessionID, read
@@ -293,8 +351,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Mark Messages As Delivered In Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method markMessagesDeliveredInConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {object} delivered
+   * @return {Promise}
    */
   service.markMessagesDeliveredInConversation = function(
     websiteID, sessionID, delivered
@@ -311,8 +373,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Update Conversation Open State
    * @memberof WebsiteConversation
+   * @public
    * @method updateConversationOpenState
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {boolean} [opened]
+   * @return {Promise}
    */
   service.updateConversationOpenState = function(websiteID, sessionID, opened) {
     return crisp.patch(
@@ -331,8 +397,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Get Conversation Routing Assign
    * @memberof WebsiteConversation
+   * @public
    * @method getConversationRoutingAssign
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.getConversationRoutingAssign = function(websiteID, sessionID) {
     return crisp.get(
@@ -345,8 +414,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Assign Conversation Routing
    * @memberof WebsiteConversation
+   * @public
    * @method assignConversationRouting
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {object} assign
+   * @return {Promise}
    */
   service.assignConversationRouting = function(websiteID, sessionID, assign) {
     return crisp.patch(
@@ -361,8 +434,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Get Conversation Metas
    * @memberof WebsiteConversation
+   * @public
    * @method getConversationMetas
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.getConversationMetas = function(websiteID, sessionID) {
     return crisp.get(
@@ -375,8 +451,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Update Conversation Metas
    * @memberof WebsiteConversation
+   * @public
    * @method updateConversationMetas
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {object} metas
+   * @return {Promise}
    */
   service.updateConversationMetas = function(websiteID, sessionID, metas) {
     return crisp.patch(
@@ -391,8 +471,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Get An Original Message In Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method getOriginalMessageInConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} originalID
+   * @return {Promise}
    */
   service.getOriginalMessageInConversation = function(
     websiteID, sessionID, originalID
@@ -407,8 +491,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * List Conversation Pages
    * @memberof WebsiteConversation
+   * @public
    * @method listConversationPages
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listConversationPages = function(websiteID, sessionID, pageNumber) {
     return crisp.get(
@@ -421,8 +509,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * List Conversation Events
    * @memberof WebsiteConversation
+   * @public
    * @method listConversationEvents
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listConversationEvents = function(websiteID, sessionID, pageNumber) {
     return crisp.get(
@@ -432,11 +524,32 @@ function WebsiteConversation(service, crisp) {
     );
   };
 
+  /**
+   * List Conversation Files
+   * @memberof WebsiteConversation
+   * @public
+   * @method listConversationFiles
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {number} pageNumber
+   * @return {Promise}
+   */
+  service.listConversationFiles = function(websiteID, sessionID, pageNumber) {
+    return crisp.get(
+      crisp._prepareRestUrl([
+        "website", websiteID, "conversation", sessionID, "files", pageNumber
+      ])
+    );
+  };
+
   /**
    * Get Conversation State
    * @memberof WebsiteConversation
+   * @public
    * @method getConversationState
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.getConversationState = function(websiteID, sessionID) {
     return crisp.get(
@@ -449,8 +562,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Change Conversation State
    * @memberof WebsiteConversation
+   * @public
    * @method changeConversationState
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} state
+   * @return {Promise}
    */
   service.changeConversationState = function(websiteID, sessionID, state) {
     return crisp.patch(
@@ -469,8 +586,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Get Conversation Participants
    * @memberof WebsiteConversation
+   * @public
    * @method getConversationParticipants
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.getConversationParticipants = function(websiteID, sessionID) {
     return crisp.get(
@@ -483,8 +603,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Save Conversation Participants
    * @memberof WebsiteConversation
+   * @public
    * @method saveConversationParticipants
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {object} participants
+   * @return {Promise}
    */
   service.saveConversationParticipants = function(
     websiteID, sessionID, participants
@@ -501,8 +625,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Get Block Status For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method getBlockStatusForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.getBlockStatusForConversation = function(websiteID, sessionID) {
     return crisp.get(
@@ -515,8 +642,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Block Incoming Messages For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method blockIncomingMessagesForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {boolean} [blocked]
+   * @return {Promise}
    */
   service.blockIncomingMessagesForConversation = function(
     websiteID, sessionID, blocked
@@ -537,8 +668,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Get Verify Status For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method getVerifyStatusForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.getVerifyStatusForConversation = function(websiteID, sessionID) {
     return crisp.get(
@@ -551,8 +685,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Update Verify Status For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method updateVerifyStatusForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {boolean} [verified]
+   * @return {Promise}
    */
   service.updateVerifyStatusForConversation = function(
     websiteID, sessionID, verified
@@ -573,8 +711,13 @@ function WebsiteConversation(service, crisp) {
   /**
    * Request Email Transcript For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method requestEmailTranscriptForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} to
+   * @param {string} [email]
+   * @return {Promise}
    */
   service.requestEmailTranscriptForConversation = function(
     websiteID, sessionID, to, email
@@ -600,8 +743,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Request Chatbox Binding Purge For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method requestChatboxBindingPurgeForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.requestChatboxBindingPurgeForConversation = function(
     websiteID, sessionID
@@ -616,8 +762,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Request User Feedback For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method requestUserFeedbackForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.requestUserFeedbackForConversation = function(
     websiteID, sessionID
@@ -632,8 +781,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * List Browsing Sessions For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method listBrowsingSessionsForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.listBrowsingSessionsForConversation = function(websiteID, sessionID) {
     return crisp.get(
@@ -646,8 +798,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Initiate Browsing Session For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method initiateBrowsingSessionForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.initiateBrowsingSessionForConversation = function(
     websiteID, sessionID
@@ -662,8 +817,13 @@ function WebsiteConversation(service, crisp) {
   /**
    * Send Action To An Existing Browsing Session
    * @memberof WebsiteConversation
+   * @public
    * @method sendActionToExistingBrowsingSession
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {object} browsingID
+   * @param {string} action
+   * @return {Promise}
    */
   service.sendActionToExistingBrowsingSession = function(
     websiteID, sessionID, browsingID, action
@@ -684,8 +844,13 @@ function WebsiteConversation(service, crisp) {
   /**
    * Assist Existing Browsing Session
    * @memberof WebsiteConversation
+   * @public
    * @method assistExistingBrowsingSession
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {object} browsingID
+   * @param {object} assist
+   * @return {Promise}
    */
   service.assistExistingBrowsingSession = function(
     websiteID, sessionID, browsingID, assist
@@ -703,8 +868,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Initiate New Call Session For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method initiateNewCallSessionForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} mode
+   * @return {Promise}
    */
   service.initiateNewCallSessionForConversation = function(
     websiteID, sessionID, mode
@@ -725,8 +894,11 @@ function WebsiteConversation(service, crisp) {
   /**
    * Get Ongoing Call Session For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method getOngoingCallSessionForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @return {Promise}
    */
   service.getOngoingCallSessionForConversation = function(
     websiteID, sessionID
@@ -741,8 +913,12 @@ function WebsiteConversation(service, crisp) {
   /**
    * Abort Ongoing Call Session For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method abortOngoingCallSessionForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} callID
+   * @return {Promise}
    */
   service.abortOngoingCallSessionForConversation = function(
     websiteID, sessionID, callID
@@ -757,8 +933,13 @@ function WebsiteConversation(service, crisp) {
   /**
    * Transmit Signaling On Ongoing Call Session
    * @memberof WebsiteConversation
+   * @public
    * @method transmitSignalingOnOngoingCallSession
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} callID
+   * @param {object} payload
+   * @return {Promise}
    */
   service.transmitSignalingOnOngoingCallSession = function(
     websiteID, sessionID, callID, payload
@@ -775,8 +956,16 @@ function WebsiteConversation(service, crisp) {
   /**
    * Deliver Widget Button Action For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method deliverWidgetButtonActionForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} pluginID
+   * @param {string} sectionID
+   * @param {string} itemID
+   * @param {object} data
+   * @param {object} value
+   * @return {Promise}
    */
   service.deliverWidgetButtonActionForConversation = function(
     websiteID, sessionID, pluginID, sectionID, itemID, data, value
@@ -805,8 +994,15 @@ function WebsiteConversation(service, crisp) {
   /**
    * Deliver Widget Data Fetch Action For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method deliverWidgetDataFetchActionForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} pluginID
+   * @param {string} sectionID
+   * @param {string} itemID
+   * @param {object} data
+   * @return {Promise}
    */
   service.deliverWidgetDataFetchActionForConversation = function(
     websiteID, sessionID, pluginID, sectionID, itemID, data
@@ -830,8 +1026,15 @@ function WebsiteConversation(service, crisp) {
   /**
    * Deliver Widget Data Edit Action For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method deliverWidgetDataEditActionForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} pluginID
+   * @param {string} sectionID
+   * @param {string} itemID
+   * @param {string} value
+   * @return {Promise}
    */
   service.deliverWidgetDataEditActionForConversation = function(
     websiteID, sessionID, pluginID, sectionID, itemID, value
@@ -855,8 +1058,13 @@ function WebsiteConversation(service, crisp) {
   /**
    * Schedule A Reminder For Conversation
    * @memberof WebsiteConversation
+   * @public
    * @method scheduleReminderForConversation
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} sessionID
+   * @param {string} date
+   * @param {string} note
+   * @return {Promise}
    */
   service.scheduleReminderForConversation = function(
     websiteID, sessionID, date, note