crisp-api 7.3.0 → 7.4.0

package/lib/resources/WebsiteOperator.js

@@ -18,8 +18,10 @@ function WebsiteOperator(service, crisp) {
   /**
    * List Website Operators
    * @memberof WebsiteOperator
+   * @public
    * @method listWebsiteOperators
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.listWebsiteOperators = function(websiteID) {
     return crisp.get(
@@ -32,8 +34,10 @@ function WebsiteOperator(service, crisp) {
   /**
    * List Last Active Website Operators
    * @memberof WebsiteOperator
+   * @public
    * @method listLastActiveWebsiteOperators
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.listLastActiveWebsiteOperators = function(websiteID) {
     return crisp.get(
@@ -46,8 +50,10 @@ function WebsiteOperator(service, crisp) {
   /**
    * Flush Last Active Website Operators
    * @memberof WebsiteOperator
+   * @public
    * @method flushLastActiveWebsiteOperators
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.flushLastActiveWebsiteOperators = function(websiteID) {
     return crisp.delete(
@@ -60,8 +66,11 @@ function WebsiteOperator(service, crisp) {
   /**
    * Send Email To Website Operators
    * @memberof WebsiteOperator
+   * @public
    * @method sendEmailToWebsiteOperators
-   * @return Promise
+   * @param {string} websiteID
+   * @param {object} emailData
+   * @return {Promise}
    */
   service.sendEmailToWebsiteOperators = function(websiteID, emailData) {
     return crisp.post(
@@ -74,8 +83,11 @@ function WebsiteOperator(service, crisp) {
   /**
    * Get A Website Operator
    * @memberof WebsiteOperator
+   * @public
    * @method getWebsiteOperator
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} userID
+   * @return {Promise}
    */
   service.getWebsiteOperator = function(websiteID, userID) {
     return crisp.get(
@@ -88,8 +100,13 @@ function WebsiteOperator(service, crisp) {
   /**
    * Invite A Website Operator
    * @memberof WebsiteOperator
+   * @public
    * @method inviteWebsiteOperator
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} email
+   * @param {string} role
+   * @param {string} verify
+   * @return {Promise}
    */
   service.inviteWebsiteOperator = function(websiteID, email, role, verify) {
     return crisp.post(
@@ -108,8 +125,13 @@ function WebsiteOperator(service, crisp) {
   /**
    * Change Operator Membership
    * @memberof WebsiteOperator
+   * @public
    * @method changeOperatorMembership
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} userID
+   * @param {string} role
+   * @param {string} title
+   * @return {Promise}
    */
   service.changeOperatorMembership = function(websiteID, userID, role, title) {
     return crisp.patch(
@@ -127,8 +149,11 @@ function WebsiteOperator(service, crisp) {
   /**
    * Unlink Operator From Website
    * @memberof WebsiteOperator
+   * @public
    * @method unlinkOperatorFromWebsite
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} userID
+   * @return {Promise}
    */
   service.unlinkOperatorFromWebsite = function(websiteID, userID) {
     return crisp.delete(

package/lib/resources/WebsitePeople.js

@@ -18,8 +18,10 @@ function WebsitePeople(service, crisp) {
   /**
    * Get People Statistics
    * @memberof WebsitePeople
+   * @public
    * @method getPeopleStatistics
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.getPeopleStatistics = function(websiteID) {
     return crisp.get(
@@ -30,8 +32,11 @@ function WebsitePeople(service, crisp) {
   /**
    * List Suggested People Segments
    * @memberof WebsitePeople
+   * @public
    * @method listSuggestedPeopleSegments
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listSuggestedPeopleSegments = function(websiteID, pageNumber) {
     return crisp.get(
@@ -44,8 +49,11 @@ function WebsitePeople(service, crisp) {
   /**
    * Delete Suggested People Segment
    * @memberof WebsitePeople
+   * @public
    * @method deleteSuggestedPeopleSegment
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} segment
+   * @return {Promise}
    */
   service.deleteSuggestedPeopleSegment = function(websiteID, segment) {
     return crisp.delete(
@@ -64,8 +72,11 @@ function WebsitePeople(service, crisp) {
   /**
    * List Suggested People Data Keys
    * @memberof WebsitePeople
+   * @public
    * @method listSuggestedPeopleDataKeys
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listSuggestedPeopleDataKeys = function(websiteID, pageNumber) {
     return crisp.get(
@@ -78,8 +89,11 @@ function WebsitePeople(service, crisp) {
   /**
    * Delete Suggested People Data Key
    * @memberof WebsitePeople
+   * @public
    * @method deleteSuggestedPeopleDataKey
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} key
+   * @return {Promise}
    */
   service.deleteSuggestedPeopleDataKey = function(websiteID, key) {
     return crisp.delete(
@@ -98,8 +112,11 @@ function WebsitePeople(service, crisp) {
   /**
    * List Suggested People Events
    * @memberof WebsitePeople
+   * @public
    * @method listSuggestedPeopleEvents
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listSuggestedPeopleEvents = function(websiteID, pageNumber) {
     return crisp.get(
@@ -112,8 +129,11 @@ function WebsitePeople(service, crisp) {
   /**
    * Delete Suggested People Event
    * @memberof WebsitePeople
+   * @public
    * @method deleteSuggestedPeopleEvent
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} text
+   * @return {Promise}
    */
   service.deleteSuggestedPeopleEvent = function(websiteID, text) {
     return crisp.delete(
@@ -132,8 +152,16 @@ function WebsitePeople(service, crisp) {
   /**
    * List People Profiles
    * @memberof WebsitePeople
+   * @public
    * @method listPeopleProfiles
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @param {string} [searchField]
+   * @param {string} [searchOrder]
+   * @param {string} [searchOperator]
+   * @param {string} [searchFilter]
+   * @param {string} [searchText]
+   * @return {Promise}
    */
   service.listPeopleProfiles = function(
     websiteID, pageNumber, searchField, searchOrder, searchOperator,
@@ -170,8 +198,11 @@ function WebsitePeople(service, crisp) {
   /**
    * Add New People Profile
    * @memberof WebsitePeople
+   * @public
    * @method addNewPeopleProfile
-   * @return Promise
+   * @param {string} websiteID
+   * @param {object} profile
+   * @return {Promise}
    */
   service.addNewPeopleProfile = function(websiteID, profile) {
     return crisp.post(
@@ -184,8 +215,11 @@ function WebsitePeople(service, crisp) {
   /**
    * Check If People Profile Exists
    * @memberof WebsitePeople
+   * @public
    * @method checkPeopleProfileExists
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @return {Promise}
    */
   service.checkPeopleProfileExists = function(websiteID, peopleID) {
     return crisp.head(
@@ -198,8 +232,11 @@ function WebsitePeople(service, crisp) {
   /**
    * Save People Profile
    * @memberof WebsitePeople
+   * @public
    * @method getPeopleProfile
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @return {Promise}
    */
   service.getPeopleProfile = function(websiteID, peopleID) {
     return crisp.get(
@@ -212,8 +249,12 @@ function WebsitePeople(service, crisp) {
   /**
    * Get People Profile
    * @memberof WebsitePeople
+   * @public
    * @method savePeopleProfile
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @param {object} profile
+   * @return {Promise}
    */
   service.savePeopleProfile = function(websiteID, peopleID, profile) {
     return crisp.put(
@@ -228,8 +269,12 @@ function WebsitePeople(service, crisp) {
   /**
    * Update People Profile
    * @memberof WebsitePeople
+   * @public
    * @method updatePeopleProfile
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @param {object} profile
+   * @return {Promise}
    */
   service.updatePeopleProfile = function(websiteID, peopleID, profile) {
     return crisp.patch(
@@ -244,8 +289,11 @@ function WebsitePeople(service, crisp) {
   /**
    * Remove People Profile
    * @memberof WebsitePeople
+   * @public
    * @method removePeopleProfile
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @return {Promise}
    */
   service.removePeopleProfile = function(websiteID, peopleID) {
     return crisp.delete(
@@ -258,8 +306,12 @@ function WebsitePeople(service, crisp) {
   /**
    * List People Conversations
    * @memberof WebsitePeople
+   * @public
    * @method listPeopleConversations
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listPeopleConversations = function(websiteID, peopleID, pageNumber) {
     return crisp.get(
@@ -273,8 +325,12 @@ function WebsitePeople(service, crisp) {
   /**
    * List People Campaigns
    * @memberof WebsitePeople
+   * @public
    * @method listPeopleCampaigns
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listPeopleCampaigns = function(websiteID, peopleID, pageNumber) {
     return crisp.get(
@@ -288,8 +344,12 @@ function WebsitePeople(service, crisp) {
   /**
    * Add A People Event
    * @memberof WebsitePeople
+   * @public
    * @method addPeopleEvent
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @param {object} peopleEvent
+   * @return {Promise}
    */
   service.addPeopleEvent = function(websiteID, peopleID, peopleEvent) {
     return crisp.post(
@@ -304,8 +364,12 @@ function WebsitePeople(service, crisp) {
   /**
    * List People Events
    * @memberof WebsitePeople
+   * @public
    * @method listPeopleEvents
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listPeopleEvents = function(websiteID, peopleID, pageNumber) {
     return crisp.get(
@@ -319,8 +383,11 @@ function WebsitePeople(service, crisp) {
   /**
    * Get People Data
    * @memberof WebsitePeople
+   * @public
    * @method getPeopleData
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @return {Promise}
    */
   service.getPeopleData = function(websiteID, peopleID) {
     return crisp.get(
@@ -333,8 +400,12 @@ function WebsitePeople(service, crisp) {
   /**
    * Save People Data
    * @memberof WebsitePeople
+   * @public
    * @method savePeopleData
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @param {object} peopleData
+   * @return {Promise}
    */
   service.savePeopleData = function(websiteID, peopleID, peopleData) {
     return crisp.put(
@@ -349,8 +420,12 @@ function WebsitePeople(service, crisp) {
   /**
    * Update People Data
    * @memberof WebsitePeople
+   * @public
    * @method updatePeopleData
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @param {object} peopleData
+   * @return {Promise}
    */
   service.updatePeopleData = function(websiteID, peopleID, peopleData) {
     return crisp.patch(
@@ -365,8 +440,11 @@ function WebsitePeople(service, crisp) {
   /**
    * Get People Subscription Status
    * @memberof WebsitePeople
+   * @public
    * @method getPeopleSubscriptionStatus
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @return {Promise}
    */
   service.getPeopleSubscriptionStatus = function(websiteID, peopleID) {
     return crisp.get(
@@ -379,8 +457,12 @@ function WebsitePeople(service, crisp) {
   /**
    * Update People Subscription Status
    * @memberof WebsitePeople
+   * @public
    * @method updatePeopleSubscriptionStatus
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} peopleID
+   * @param {object} peopleSubscription
+   * @return {Promise}
    */
   service.updatePeopleSubscriptionStatus = function(
     websiteID, peopleID, peopleSubscription
@@ -397,8 +479,10 @@ function WebsitePeople(service, crisp) {
   /**
    * Export People Profiles
    * @memberof WebsitePeople
+   * @public
    * @method exportPeopleProfiles
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.exportPeopleProfiles = function(websiteID) {
     return crisp.post(
@@ -411,8 +495,11 @@ function WebsitePeople(service, crisp) {
   /**
    * Import People Profiles
    * @memberof WebsitePeople
+   * @public
    * @method importPeopleProfiles
-   * @return Promise
+   * @param {string} websiteID
+   * @param {object} importSetup
+   * @return {Promise}
    */
   service.importPeopleProfiles = function(websiteID, importSetup) {
     return crisp.post(

package/lib/resources/WebsiteSettings.js

@@ -18,8 +18,10 @@ function WebsiteSettings(service, crisp) {
   /**
    * Get Website Settings
    * @memberof WebsiteSettings
+   * @public
    * @method getWebsiteSettings
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.getWebsiteSettings = function(websiteID) {
     return crisp.get(
@@ -30,8 +32,11 @@ function WebsiteSettings(service, crisp) {
   /**
    * Update Website Settings
    * @memberof WebsiteSettings
+   * @public
    * @method updateWebsiteSettings
-   * @return Promise
+   * @param {string} websiteID
+   * @param {object} settings
+   * @return {Promise}
    */
   service.updateWebsiteSettings = function(websiteID, settings) {
     return crisp.patch(

package/lib/resources/WebsiteVerify.js

@@ -18,8 +18,10 @@ function WebsiteVerify(service, crisp) {
   /**
    * Get Verify Settings
    * @memberof WebsiteVerify
+   * @public
    * @method getVerifySettings
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.getVerifySettings = function(websiteID) {
     return crisp.get(
@@ -30,8 +32,11 @@ function WebsiteVerify(service, crisp) {
   /**
    * Update Verify Settings
    * @memberof WebsiteVerify
+   * @public
    * @method updateVerifySettings
-   * @return Promise
+   * @param {string} websiteID
+   * @param {object} settings
+   * @return {Promise}
    */
   service.updateVerifySettings = function(websiteID, settings) {
     return crisp.patch(
@@ -44,8 +49,10 @@ function WebsiteVerify(service, crisp) {
   /**
    * Get Verify Key
    * @memberof WebsiteVerify
+   * @public
    * @method getVerifyKey
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.getVerifyKey = function(websiteID) {
     return crisp.get(
@@ -56,8 +63,10 @@ function WebsiteVerify(service, crisp) {
   /**
    * Roll Verify Key
    * @memberof WebsiteVerify
+   * @public
    * @method rollVerifyKey
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.rollVerifyKey = function(websiteID) {
     return crisp.post(

package/lib/resources/WebsiteVisitors.js

@@ -18,8 +18,10 @@ function WebsiteVisitors(service, crisp) {
   /**
    * Count Visitors
    * @memberof WebsiteVisitors
+   * @public
    * @method countVisitors
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.countVisitors = function(websiteID) {
     return crisp.get(
@@ -30,8 +32,11 @@ function WebsiteVisitors(service, crisp) {
   /**
    * List Visitors
    * @memberof WebsiteVisitors
+   * @public
    * @method listVisitors
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} pageNumber
+   * @return {Promise}
    */
   service.listVisitors = function(websiteID, pageNumber) {
     return crisp.get(
@@ -44,8 +49,13 @@ function WebsiteVisitors(service, crisp) {
   /**
    * Pinpoint Visitors On A Map
    * @memberof WebsiteVisitors
+   * @public
    * @method pinpointVisitorsOnMap
-   * @return Promise
+   * @param {string} websiteID
+   * @param {number} [centerLongitude]
+   * @param {number} [centerLatitude]
+   * @param {number} [centerRadius]
+   * @return {Promise}
    */
   service.pinpointVisitorsOnMap = function(
     websiteID, centerLongitude, centerLatitude, centerRadius
@@ -75,8 +85,11 @@ function WebsiteVisitors(service, crisp) {
   /**
    * Get Session Identifier From Token
    * @memberof WebsiteVisitors
+   * @public
    * @method getSessionIdentifierFromToken
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} tokenID
+   * @return {Promise}
    */
   service.getSessionIdentifierFromToken = function(websiteID, tokenID) {
     return crisp.get(
@@ -89,8 +102,10 @@ function WebsiteVisitors(service, crisp) {
   /**
    * Count Blocked Visitors
    * @memberof WebsiteVisitors
+   * @public
    * @method countBlockedVisitors
-   * @return Promise
+   * @param {string} websiteID
+   * @return {Promise}
    */
   service.countBlockedVisitors = function(websiteID) {
     return crisp.get(
@@ -101,8 +116,11 @@ function WebsiteVisitors(service, crisp) {
   /**
    * Count Blocked Visitors In Rule
    * @memberof WebsiteVisitors
+   * @public
    * @method countBlockedVisitorsInRule
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} rule
+   * @return {Promise}
    */
   service.countBlockedVisitorsInRule = function(websiteID, rule) {
     return crisp.get(
@@ -113,8 +131,11 @@ function WebsiteVisitors(service, crisp) {
   /**
    * Clear Blocked Visitors In Rule
    * @memberof WebsiteVisitors
+   * @public
    * @method clearBlockedVisitorsInRule
-   * @return Promise
+   * @param {string} websiteID
+   * @param {string} rule
+   * @return {Promise}
    */
   service.clearBlockedVisitorsInRule = function(websiteID, rule) {
     return crisp.delete(

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "crisp-api",
   "description": "Crisp API wrapper for Node - official, maintained by Crisp",
-  "version": "7.3.0",
+  "version": "7.4.0",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {
@@ -34,18 +34,18 @@
       "url": "https://github.com/crisp-im/node-crisp-api/blob/master/LICENSE"
     }
   ],
-  "main": "./lib/crisp",
-  "types": "./types/crisp.d.ts",
+  "main": "lib/crisp.js",
+  "types": "types/crisp.d.ts",
   "engines": {
     "node": ">= 10.19.0"
   },
   "scripts": {
     "test": "check-build",
-    "gen-types": "tsc"
+    "generate:types": "rm -rf ./types/* && tsc"
   },
   "devDependencies": {
     "check-build": "2.8.2",
-    "typescript": "4.4.4"
+    "typescript": "4.9.5"
   },
   "dependencies": {
     "socket.io-client": "4.4.1",

package/tsconfig.json

@@ -5,6 +5,6 @@
     "allowJs": true,
     "declaration": true,
     "emitDeclarationOnly": true,
-    "outDir": "types"
+    "outDir": "types/"
   }
 }