crisp-api 10.0.2 → 10.0.4

package/lib/resources/WebsiteSettings.ts

@@ -12,6 +12,10 @@
 // PROJECT: RESOURCES
 import BaseResource from "./BaseResource";
 
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
+
 export interface WebsiteSettings {
   websiteID?: string;
   name?: string;
@@ -165,6 +169,10 @@ export interface WebsiteSettingsUpdateChatbox {
   blocked_ips?: string[];
 }
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp WebsiteSettings Resource
  */
@@ -172,7 +180,7 @@ class WebsiteSettingsService extends BaseResource {
   /**
    * Get Website Settings
    */
-  getWebsiteSettings(websiteID: string) : Promise<WebsiteSettings> {
+  getWebsiteSettings(websiteID: string): Promise<WebsiteSettings> {
     return this.crisp.get(
       this.crisp.prepareRestUrl(["website", websiteID, "settings"])
     );
@@ -183,10 +191,17 @@ class WebsiteSettingsService extends BaseResource {
    */
   updateWebsiteSettings(websiteID: string, settings: WebsiteSettingsUpdate) {
     return this.crisp.patch(
-      this.crisp.prepareRestUrl(["website", websiteID, "settings"]), null, settings
+      this.crisp.prepareRestUrl(["website", websiteID, "settings"]),
+
+      null,
+      settings
     );
   };
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export default WebsiteSettingsService;
 

package/lib/resources/WebsiteVerify.ts

@@ -12,6 +12,10 @@
 // PROJECT: RESOURCES
 import BaseResource from "./BaseResource";
 
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
+
 export interface WebsiteVerifyKeyData {
   data?: WebsiteVerifyKey;
 }
@@ -28,6 +32,10 @@ export interface WebsiteVerifySettingsUpdate {
   enabled?: boolean;
 }
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp WebsiteVerify Resource
  */
@@ -35,7 +43,7 @@ class WebsiteVerify extends BaseResource {
   /**
    * Get Verify Settings
    */
-  getVerifySettings(websiteID: string) : Promise<WebsiteVerifySettings> {
+  getVerifySettings(websiteID: string): Promise<WebsiteVerifySettings> {
     return this.crisp.get(
       this.crisp.prepareRestUrl(["website", websiteID, "verify", "settings"])
     );
@@ -44,7 +52,9 @@ class WebsiteVerify extends BaseResource {
   /**
    * Update Verify Settings
    */
-  updateVerifySettings(websiteID: string, settings: WebsiteVerifySettingsUpdate) {
+  updateVerifySettings(
+    websiteID: string, settings: WebsiteVerifySettingsUpdate
+  ) {
     return this.crisp.patch(
       this.crisp.prepareRestUrl(["website", websiteID, "verify", "settings"]),
 
@@ -55,7 +65,7 @@ class WebsiteVerify extends BaseResource {
   /**
    * Get Verify Key
    */
-  getVerifyKey(websiteID: string) : Promise<WebsiteVerifyKey> {
+  getVerifyKey(websiteID: string): Promise<WebsiteVerifyKey> {
     return this.crisp.get(
       this.crisp.prepareRestUrl(["website", websiteID, "verify", "key"])
     );
@@ -73,4 +83,8 @@ class WebsiteVerify extends BaseResource {
   };
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export default WebsiteVerify;

package/lib/resources/WebsiteVisitors.ts

@@ -12,6 +12,10 @@
 // PROJECT: RESOURCES
 import BaseResource from "./BaseResource";
 
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
+
 export interface WebsiteVisitorCount {
   count?: number;
   active?: number;
@@ -100,6 +104,10 @@ export interface WebsiteVisitorsBlocked {
   blocked?: number;
 }
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp WebsiteVisitors Resource
  */
@@ -107,7 +115,7 @@ class WebsiteVisitors extends BaseResource {
   /**
    * Count Visitors
    */
-  countVisitors(websiteID: string) : Promise<WebsiteVisitorCount> {
+  countVisitors(websiteID: string): Promise<WebsiteVisitorCount> {
     return this.crisp.get(
       this.crisp.prepareRestUrl(["website", websiteID, "visitors", "count"])
     );
@@ -116,7 +124,9 @@ class WebsiteVisitors extends BaseResource {
   /**
    * List Visitors
    */
-  listVisitors(websiteID: string, pageNumber: number = 1) : Promise<WebsiteVisitor[]> {
+  listVisitors(
+    websiteID: string, pageNumber: number = 1
+  ): Promise<WebsiteVisitor[]> {
     return this.crisp.get(
       this.crisp.prepareRestUrl([
         "website", websiteID, "visitors", "list", String(pageNumber)
@@ -128,8 +138,9 @@ class WebsiteVisitors extends BaseResource {
    * Pinpoint Visitors On A Map
    */
   pinpointVisitorsOnMap(
-    websiteID: string, centerLongitude: number, centerLatitude: number, centerRadius: number
-  ) : Promise<WebsiteVisitorsMapPoint[]> {
+    websiteID: string, centerLongitude: number, centerLatitude: number,
+      centerRadius: number
+  ): Promise<WebsiteVisitorsMapPoint[]> {
     // Generate query
     const query: Record<string, string> = {};
 
@@ -157,7 +168,9 @@ class WebsiteVisitors extends BaseResource {
   /**
    * Get Session Identifier From Token
    */
-  getSessionIdentifierFromToken(websiteID: string, tokenID: string) : Promise<WebsiteVisitorsToken> {
+  getSessionIdentifierFromToken(
+    websiteID: string, tokenID: string
+  ): Promise<WebsiteVisitorsToken> {
     return this.crisp.get(
       this.crisp.prepareRestUrl([
         "website", websiteID, "visitors", "token", tokenID
@@ -168,7 +181,7 @@ class WebsiteVisitors extends BaseResource {
   /**
    * Count Blocked Visitors
    */
-  countBlockedVisitors(websiteID: string) : Promise<WebsiteVisitorsBlocked> {
+  countBlockedVisitors(websiteID: string): Promise<WebsiteVisitorsBlocked> {
     return this.crisp.get(
       this.crisp.prepareRestUrl(["website", websiteID, "visitors", "blocked"])
     );
@@ -177,9 +190,13 @@ class WebsiteVisitors extends BaseResource {
   /**
    * Count Blocked Visitors In Rule
    */
-  countBlockedVisitorsInRule(websiteID: string, rule: string) : Promise<number> {
+  countBlockedVisitorsInRule(
+    websiteID: string, rule: string
+  ): Promise<number> {
     return this.crisp.get(
-      this.crisp.prepareRestUrl(["website", websiteID, "visitors", "blocked", rule])
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "visitors", "blocked", rule
+      ])
     );
   };
 
@@ -188,9 +205,15 @@ class WebsiteVisitors extends BaseResource {
    */
   clearBlockedVisitorsInRule(websiteID: string, rule: string) {
     return this.crisp.delete(
-      this.crisp.prepareRestUrl(["website", websiteID, "visitors", "blocked", rule])
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "visitors", "blocked", rule
+      ])
     );
   };
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export default WebsiteVisitors;

package/lib/resources/index.ts

@@ -5,7 +5,10 @@
  * Author: Baptiste Jamin <baptiste@crisp.chat>
  */
 
-// Used to export all types
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export * from "./BaseResource";
 export * from "./BucketURL";
 export * from "./MediaAnimation";

package/lib/services/bucket.ts

@@ -12,6 +12,10 @@
 // PROJECT: RESOURCES
 import BucketURL from "@/resources/BucketURL";
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Bucket Service
  */
@@ -22,6 +26,10 @@ class BucketService {
   ];
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export interface BucketServiceInterface extends
   BucketURL {}
 

package/lib/services/media.ts

@@ -12,6 +12,10 @@
 // PROJECT: RESOURCES
 import MediaAnimation from "@/resources/MediaAnimation";
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp Media Service
  */
@@ -22,6 +26,10 @@ class MediaService {
   ];
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export interface MediaServiceInterface extends
   MediaAnimation {}
 

package/lib/services/plugin.ts

@@ -13,6 +13,10 @@
 import PluginConnect from "@/resources/PluginConnect";
 import PluginSubscription from "@/resources/PluginSubscription";
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp Plugin Service
  */
@@ -24,6 +28,10 @@ class PluginService {
   ];
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export interface PluginServiceInterface extends
   PluginConnect,
   PluginSubscription {

package/lib/services/website.ts

@@ -23,6 +23,10 @@ import WebsiteSettings from "@/resources/WebsiteSettings";
 import WebsiteVerify from "@/resources/WebsiteVerify";
 import WebsiteVisitors from "@/resources/WebsiteVisitors";
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Website Service
  */
@@ -44,6 +48,10 @@ class WebsiteService {
   ];
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export interface WebsiteServiceInterface extends
   WebsiteBase,
   WebsiteAnalytics,

package/package.json

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