crisp-api 7.3.0 → 7.4.1

package/lib/resources/PluginSubscription.js

@@ -18,8 +18,9 @@ function PluginSubscription(service, crisp) {
   /**
    * List All Active Subscriptions
    * @memberof PluginSubscription
+   * @public
    * @method listAllActiveSubscriptions
-   * @return Promise
+   * @return {Promise}
    */
   service.listAllActiveSubscriptions = function() {
     return crisp.get(
@@ -30,8 +31,10 @@ function PluginSubscription(service, crisp) {
   /**
    * List Subscriptions For A Website
    * @memberof PluginSubscription
+   * @public
    * @method listSubscriptionsForWebsite
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.listSubscriptionsForWebsite = function(websiteID) {
     return crisp.get(
@@ -42,8 +45,11 @@ function PluginSubscription(service, crisp) {
   /**
    * Get Subscription Details
    * @memberof PluginSubscription
+   * @public
    * @method getSubscriptionDetails
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} pluginID
+   * @return {Promise}
    */
   service.getSubscriptionDetails = function(websiteID, pluginID) {
     return crisp.get(
@@ -54,8 +60,11 @@ function PluginSubscription(service, crisp) {
   /**
    * Subscribe Website To Plugin
    * @memberof PluginSubscription
+   * @public
    * @method subscribeWebsiteToPlugin
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} pluginID
+   * @return {Promise}
    */
   service.subscribeWebsiteToPlugin = function(websiteID, pluginID) {
     return crisp.post(
@@ -72,8 +81,11 @@ function PluginSubscription(service, crisp) {
   /**
    * Unsubscribe Plugin From Website
    * @memberof PluginSubscription
+   * @public
    * @method unsubscribePluginFromWebsite
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} pluginID
+   * @return {Promise}
    */
   service.unsubscribePluginFromWebsite = function(websiteID, pluginID) {
     return crisp.delete(
@@ -84,8 +96,11 @@ function PluginSubscription(service, crisp) {
   /**
    * Get Subscription Settings
    * @memberof PluginSubscription
+   * @public
    * @method getSubscriptionSettings
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} pluginID
+   * @return {Promise}
    */
   service.getSubscriptionSettings = function(websiteID, pluginID) {
     return crisp.get(
@@ -98,8 +113,12 @@ function PluginSubscription(service, crisp) {
   /**
    * Save Subscription Settings
    * @memberof PluginSubscription
+   * @public
    * @method saveSubscriptionSettings
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} pluginID
+   * @param {object} settings
+   * @return {Promise}
    */
   service.saveSubscriptionSettings = function(websiteID, pluginID, settings) {
     return crisp.put(
@@ -114,8 +133,12 @@ function PluginSubscription(service, crisp) {
   /**
    * Update Subscription Settings
    * @memberof PluginSubscription
+   * @public
    * @method updateSubscriptionSettings
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} pluginID
+   * @param {object} settings
+   * @return {Promise}
    */
   service.updateSubscriptionSettings = function(websiteID, pluginID, settings) {
     return crisp.patch(
@@ -130,8 +153,12 @@ function PluginSubscription(service, crisp) {
   /**
    * Forward Plugin Payload To Channel
    * @memberof PluginSubscription
+   * @public
    * @method forwardPluginPayloadToChannel
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} pluginID
+   * @param {object} payload
+   * @return {Promise}
    */
   service.forwardPluginPayloadToChannel = function(
     websiteID, pluginID, payload
@@ -148,8 +175,12 @@ function PluginSubscription(service, crisp) {
   /**
    * Dispatch Plugin Event
    * @memberof PluginSubscription
+   * @public
    * @method dispatchPluginEvent
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} pluginID
+   * @param {object} payload
+   * @return {Promise}
    */
   service.dispatchPluginEvent = function(websiteID, pluginID, payload) {
     return crisp.post(

package/lib/resources/WebsiteAnalytics.js

@@ -18,8 +18,18 @@ function WebsiteAnalytics(service, crisp) {
   /**
    * Acquire Analytics Points
    * @memberof WebsiteAnalytics
+   * @public
    * @method acquireAnalyticsPoints
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} pointType
+   * @param {string} pointMetric
+   * @param {string} dateFrom
+   * @param {string} dateTo
+   * @param {string} dateSplit
+   * @param {string} classifier
+   * @param {string} filterSecondary
+   * @param {string} filterTertiary
+   * @return {Promise}
    */
   service.acquireAnalyticsPoints = function(
     websiteID, pointType, pointMetric, dateFrom, dateTo, dateSplit, classifier,
@@ -45,8 +55,15 @@ function WebsiteAnalytics(service, crisp) {
   /**
    * List Analytics Filters
    * @memberof WebsiteAnalytics
+   * @public
    * @method listAnalyticsFilters
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @param {string} pointType
+   * @param {string} pointMetric
+   * @param {string} dateFrom
+   * @param {string} dateTo
+   * @return {Promise}
    */
   service.listAnalyticsFilters = function(
     websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo
@@ -58,7 +75,7 @@ function WebsiteAnalytics(service, crisp) {
 
       {
         date_from : dateFrom,
-        date_to          : dateTo
+        date_to   : dateTo
       }
     );
   };
@@ -66,8 +83,15 @@ function WebsiteAnalytics(service, crisp) {
   /**
    * List Analytics Classifiers
    * @memberof WebsiteAnalytics
+   * @public
    * @method listAnalyticsClassifiers
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @param {string} pointType
+   * @param {string} pointMetric
+   * @param {string} dateFrom
+   * @param {string} dateTo
+   * @return {Promise}
    */
   service.listAnalyticsClassifiers = function(
     websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo

package/lib/resources/WebsiteAvailability.js

@@ -18,8 +18,10 @@ function WebsiteAvailability(service, crisp) {
   /**
    * Get Website Availability Status
    * @memberof WebsiteAvailability
+   * @public
    * @method getWebsiteAvailabilityStatus
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.getWebsiteAvailabilityStatus = function(websiteID) {
     return crisp.get(
@@ -30,8 +32,10 @@ function WebsiteAvailability(service, crisp) {
   /**
    * List Website Operator Availabilities
    * @memberof WebsiteAvailability
+   * @public
    * @method listWebsiteOperatorAvailabilities
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.listWebsiteOperatorAvailabilities = function(websiteID) {
     return crisp.get(

package/lib/resources/WebsiteBase.js

@@ -18,8 +18,10 @@ function WebsiteBase(service, crisp) {
   /**
    * Check If Website Exists
    * @memberof WebsiteBase
+   * @public
    * @method checkWebsiteExists
-   * @return Promise
+   * @param {string} domain
+   * @return {Promise}
    */
   service.checkWebsiteExists = function(domain) {
     return crisp.head(
@@ -34,8 +36,10 @@ function WebsiteBase(service, crisp) {
   /**
    * Create Website
    * @memberof WebsiteBase
+   * @public
    * @method createWebsite
-   * @return Promise
+   * @param {object} websiteData
+   * @return {Promise}
    */
   service.createWebsite = function(websiteData) {
     return crisp.post(
@@ -46,8 +50,10 @@ function WebsiteBase(service, crisp) {
   /**
    * Get A Website
    * @memberof WebsiteBase
+   * @public
    * @method getWebsite
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.getWebsite = function(websiteID) {
     return crisp.get(
@@ -58,8 +64,11 @@ function WebsiteBase(service, crisp) {
   /**
    * Delete A Website
    * @memberof WebsiteBase
+   * @public
    * @method deleteWebsite
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} verify
+   * @return {Promise}
    */
   service.deleteWebsite = function(websiteID, verify) {
     return crisp.delete(

package/lib/resources/WebsiteBatch.js

@@ -18,8 +18,11 @@ function WebsiteBatch(service, crisp) {
   /**
    * Batch Resolve Conversations
    * @memberof WebsiteBatch
+   * @public
    * @method batchResolveConversations
-   * @return Promise
+   * @param {string} websiteID
+   * @param {object} sessions
+   * @return {Promise}
    */
   service.batchResolveConversations = function(websiteID, sessions) {
     return crisp.patch(
@@ -36,8 +39,11 @@ function WebsiteBatch(service, crisp) {
   /**
    * Batch Read Conversations
    * @memberof WebsiteBatch
+   * @public
    * @method batchReadConversations
-   * @return Promise
+   * @param {string} websiteID
+   * @param {object} sessions
+   * @return {Promise}
    */
   service.batchReadConversations = function(websiteID, sessions) {
     return crisp.patch(
@@ -54,8 +60,11 @@ function WebsiteBatch(service, crisp) {
   /**
    * Batch Remove Conversations
    * @memberof WebsiteBatch
+   * @public
    * @method batchRemoveConversations
-   * @return Promise
+   * @param {string} websiteID
+   * @param {object} sessions
+   * @return {Promise}
    */
   service.batchRemoveConversations = function(websiteID, sessions) {
     return crisp.patch(
@@ -72,8 +81,11 @@ function WebsiteBatch(service, crisp) {
   /**
    * Batch Remove People
    * @memberof WebsiteBatch
+   * @public
    * @method batchRemovePeople
-   * @return Promise
+   * @param {string} websiteID
+   * @param {object} people
+   * @return {Promise}
    */
   service.batchRemovePeople = function(websiteID, people) {
     return crisp.patch(

package/lib/resources/WebsiteCampaign.js

@@ -18,8 +18,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * List Campaigns
    * @memberof WebsiteCampaign
+   * @public
    * @method listCampaigns
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listCampaigns = function(websiteID, pageNumber) {
     return crisp.get(
@@ -32,8 +35,10 @@ function WebsiteCampaign(service, crisp) {
   /**
    * List Campaign Tags
    * @memberof WebsiteCampaign
+   * @public
    * @method listCampaignTags
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.listCampaignTags = function(websiteID) {
     return crisp.get(
@@ -44,8 +49,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * List Campaign Templates
    * @memberof WebsiteCampaign
+   * @public
    * @method listCampaignTemplates
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listCampaignTemplates = function(websiteID, pageNumber) {
     return crisp.get(
@@ -58,8 +66,12 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Create A New Campaign Template
    * @memberof WebsiteCampaign
+   * @public
    * @method createNewCampaignTemplate
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} templateFormat
+   * @param {string} templateName
+   * @return {Promise}
    */
   service.createNewCampaignTemplate = function(
     websiteID, templateFormat, templateName
@@ -79,8 +91,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Check If Campaign Template Exists
    * @memberof WebsiteCampaign
+   * @public
    * @method checkCampaignTemplateExists
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} templateID
+   * @return {Promise}
    */
   service.checkCampaignTemplateExists = function(websiteID, templateID) {
     return crisp.head(
@@ -93,8 +108,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Get A Campaign Template
    * @memberof WebsiteCampaign
+   * @public
    * @method getCampaignTemplate
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} templateID
+   * @return {Promise}
    */
   service.getCampaignTemplate = function(websiteID, templateID) {
     return crisp.get(
@@ -107,8 +125,12 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Save A Campaign Template
    * @memberof WebsiteCampaign
+   * @public
    * @method saveCampaignTemplate
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} templateID
+   * @param {object} template
+   * @return {Promise}
    */
   service.saveCampaignTemplate = function(websiteID, templateID, template) {
     return crisp.put(
@@ -123,8 +145,12 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Update A Campaign Template
    * @memberof WebsiteCampaign
+   * @public
    * @method updateCampaignTemplate
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} templateID
+   * @param {object} template
+   * @return {Promise}
    */
   service.updateCampaignTemplate = function(websiteID, templateID, template) {
     return crisp.patch(
@@ -139,8 +165,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Remove A Campaign Template
    * @memberof WebsiteCampaign
+   * @public
    * @method removeCampaignTemplate
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} templateID
+   * @return {Promise}
    */
   service.removeCampaignTemplate = function(websiteID, templateID) {
     return crisp.delete(
@@ -153,8 +182,12 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Create A New Campaign
    * @memberof WebsiteCampaign
+   * @public
    * @method createNewCampaign
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignType
+   * @param {string} campaignName
+   * @return {Promise}
    */
   service.createNewCampaign = function(websiteID, campaignType, campaignName) {
     return crisp.post(
@@ -172,8 +205,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Check If Campaign Exists
    * @memberof WebsiteCampaign
+   * @public
    * @method checkCampaignExists
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignID
+   * @return {Promise}
    */
   service.checkCampaignExists = function(websiteID, campaignID) {
     return crisp.head(
@@ -184,8 +220,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Get A Campaign
    * @memberof WebsiteCampaign
+   * @public
    * @method getCampaign
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignID
+   * @return {Promise}
    */
   service.getCampaign = function(websiteID, campaignID) {
     return crisp.get(
@@ -196,8 +235,12 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Save A Campaign
    * @memberof WebsiteCampaign
+   * @public
    * @method saveCampaign
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignID
+   * @param {object} campaign
+   * @return {Promise}
    */
   service.saveCampaign = function(websiteID, campaignID, campaign) {
     return crisp.put(
@@ -210,8 +253,12 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Update A Campaign
    * @memberof WebsiteCampaign
+   * @public
    * @method updateCampaign
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignID
+   * @param {object} campaign
+   * @return {Promise}
    */
   service.updateCampaign = function(websiteID, campaignID, campaign) {
     return crisp.patch(
@@ -224,8 +271,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Remove A Campaign
    * @memberof WebsiteCampaign
+   * @public
    * @method removeCampaign
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignID
+   * @return {Promise}
    */
   service.removeCampaign = function(websiteID, campaignID) {
     return crisp.delete(
@@ -236,8 +286,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Dispatch A Campaign
    * @memberof WebsiteCampaign
+   * @public
    * @method dispatchCampaign
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignID
+   * @return {Promise}
    */
   service.dispatchCampaign = function(websiteID, campaignID) {
     return crisp.post(
@@ -250,8 +303,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Resume A Campaign
    * @memberof WebsiteCampaign
+   * @public
    * @method resumeCampaign
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignID
+   * @return {Promise}
    */
   service.resumeCampaign = function(websiteID, campaignID) {
     return crisp.post(
@@ -264,8 +320,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Pause A Campaign
    * @memberof WebsiteCampaign
+   * @public
    * @method pauseCampaign
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignID
+   * @return {Promise}
    */
   service.pauseCampaign = function(websiteID, campaignID) {
     return crisp.post(
@@ -278,8 +337,11 @@ function WebsiteCampaign(service, crisp) {
   /**
    * Test A Campaign
    * @memberof WebsiteCampaign
+   * @public
    * @method testCampaign
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignID
+   * @return {Promise}
    */
   service.testCampaign = function(websiteID, campaignID) {
     return crisp.post(
@@ -292,8 +354,12 @@ function WebsiteCampaign(service, crisp) {
   /**
    * List Campaign Recipients
    * @memberof WebsiteCampaign
+   * @public
    * @method listCampaignRecipients
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listCampaignRecipients = function(websiteID, campaignID, pageNumber) {
     return crisp.get(
@@ -306,8 +372,13 @@ function WebsiteCampaign(service, crisp) {
   /**
    * List Campaign Statistics
    * @memberof WebsiteCampaign
+   * @public
    * @method listCampaignStatistics
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} campaignID
+   * @param {string} action
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listCampaignStatistics = function(
     websiteID, campaignID, action, pageNumber