crisp-api 10.0.2 → 10.0.4

package/dist/resources/WebsiteAnalytics.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteAnalytics Resource
  */
@@ -11,4 +14,7 @@ declare class WebsiteAnalytics extends BaseResource {
      */
     generateAnalytics(websiteID: string, query: object): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsiteAnalytics;

package/dist/resources/WebsiteAnalytics.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteAnalytics Resource
  */
@@ -22,8 +25,13 @@ class WebsiteAnalytics extends BaseResource_1.default {
      * Generate Analytics
      */
     generateAnalytics(websiteID, query) {
-        return this.crisp.post(this.crisp.prepareRestUrl(["website", websiteID, "analytics", "generate"]), null, query);
+        return this.crisp.post(this.crisp.prepareRestUrl([
+            "website", websiteID, "analytics", "generate"
+        ]), null, query);
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsiteAnalytics;

package/dist/resources/WebsiteAvailability.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
 type WebsiteAvailabilityStatus = {
     status?: string;
     since?: number;
@@ -15,6 +18,9 @@ type WebsiteAvailabilityOperatorTime = {
     for?: number;
     since?: number;
 };
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteAvailability Resource
  */
@@ -28,4 +34,7 @@ declare class WebsiteAvailability extends BaseResource {
      */
     listWebsiteOperatorAvailabilities(websiteID: string): Promise<WebsiteAvailabilityOperator[]>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsiteAvailability;

package/dist/resources/WebsiteAvailability.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteAvailability Resource
  */
@@ -22,15 +25,22 @@ class WebsiteAvailability extends BaseResource_1.default {
      * Get Website Availability Status
      */
     getWebsiteAvailabilityStatus(websiteID) {
-        return this.crisp.get(this.crisp.prepareRestUrl(["website", websiteID, "availability", "status"]));
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "website", websiteID, "availability", "status"
+        ]));
     }
     ;
     /**
      * List Website Operator Availabilities
      */
     listWebsiteOperatorAvailabilities(websiteID) {
-        return this.crisp.get(this.crisp.prepareRestUrl(["website", websiteID, "availability", "operators"]));
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "website", websiteID, "availability", "operators"
+        ]));
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsiteAvailability;

package/dist/resources/WebsiteBase.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
 type Website = {
     website_id?: string;
     name?: string;
@@ -22,6 +25,9 @@ export type WebsiteFilter = {
     operator?: string;
     query?: Record<string, unknown>;
 };
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteBase Resource
  */
@@ -57,4 +63,7 @@ declare class WebsiteBase extends BaseResource {
      */
     abortWebsiteDeletion(websiteID: string): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsiteBase;

package/dist/resources/WebsiteBase.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteBase Resource
  */
@@ -68,4 +71,7 @@ class WebsiteBase extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsiteBase;

package/dist/resources/WebsiteBatch.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
 type WebsiteBatchConversationsOperation = {
     inbox_id?: string;
     sessions?: string[];
@@ -10,6 +13,9 @@ type WebsiteBatchPeopleOperationInner = {
     profiles?: string[];
     search?: string;
 };
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteBatch Resource
  */
@@ -49,4 +55,7 @@ declare class WebsiteBatch extends BaseResource {
      */
     batchRemovePeople(websiteID: string, people: WebsiteBatchPeopleOperationInner): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsiteBatch;

package/dist/resources/WebsiteBatch.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteBatch Resource
  */
@@ -67,4 +70,7 @@ class WebsiteBatch extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsiteBatch;

package/dist/resources/WebsiteCampaign.d.ts

@@ -3,6 +3,9 @@
  ***************************************************************************/
 import BaseResource from "./BaseResource";
 import { WebsiteFilter } from "./WebsiteBase";
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
 type WebsiteCampaignExcerpt = {
     campaign_id?: string;
     type?: string;
@@ -106,6 +109,9 @@ type WebsiteCampaignStatisticProfilePersonGeolocationCoordinates = {
     latitude?: number;
     longitude?: number;
 };
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteCampaign Resource
  */
@@ -196,4 +202,7 @@ declare class WebsiteCampaign extends BaseResource {
      */
     listCampaignStatistics(websiteID: string, campaignID: string, action: string, pageNumber?: number): Promise<WebsiteCampaignStatistic[]>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsiteCampaign;

package/dist/resources/WebsiteCampaign.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteCampaign Resource
  */
@@ -176,7 +179,8 @@ class WebsiteCampaign extends BaseResource_1.default {
      */
     listCampaignRecipients(websiteID, campaignID, pageNumber = 1) {
         return this.crisp.get(this.crisp.prepareRestUrl([
-            "website", websiteID, "campaign", campaignID, "recipients", String(pageNumber)
+            "website", websiteID, "campaign", campaignID, "recipients",
+            String(pageNumber)
         ]));
     }
     ;
@@ -191,4 +195,7 @@ class WebsiteCampaign extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsiteCampaign;

package/dist/resources/WebsiteConversation.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * TYPES + INTERFACES
+ ***************************************************************************/
 export interface Conversation {
     session_id: string;
     website_id: string;
@@ -460,6 +463,9 @@ export interface ConversationBrowsing {
 export interface ConversationCall {
     call_id?: string;
 }
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteConversation Resource
  * @class
@@ -698,4 +704,7 @@ declare class WebsiteConversation extends BaseResource {
      */
     reportConversation(websiteID: string, sessionID: string, flag: string): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsiteConversation;

package/dist/resources/WebsiteConversation.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteConversation Resource
  * @class
@@ -106,21 +109,27 @@ class WebsiteConversation extends BaseResource_1.default {
      * Check If Conversation Exists
      */
     checkConversationExists(websiteID, sessionID) {
-        return this.crisp.head(this.crisp.prepareRestUrl(["website", websiteID, "conversation", sessionID]));
+        return this.crisp.head(this.crisp.prepareRestUrl([
+            "website", websiteID, "conversation", sessionID
+        ]));
     }
     ;
     /**
      * Get A Conversation
      */
     getConversation(websiteID, sessionID) {
-        return this.crisp.get(this.crisp.prepareRestUrl(["website", websiteID, "conversation", sessionID]));
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "website", websiteID, "conversation", sessionID
+        ]));
     }
     ;
     /**
      * Remove A Conversation
      */
     removeConversation(websiteID, sessionID) {
-        return this.crisp.delete(this.crisp.prepareRestUrl(["website", websiteID, "conversation", sessionID]));
+        return this.crisp.delete(this.crisp.prepareRestUrl([
+            "website", websiteID, "conversation", sessionID
+        ]));
     }
     ;
     /**
@@ -592,4 +601,7 @@ class WebsiteConversation extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsiteConversation;

package/dist/resources/WebsiteHelpdesk.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
 export interface Helpdesk {
     name?: string;
     url?: string;
@@ -32,6 +35,10 @@ export interface HelpdeskLocaleArticleAlternate {
     locale?: string;
     article_id?: string;
 }
+export interface HelpdeskLocaleArticlePage {
+    title?: string;
+    url?: string;
+}
 export interface HelpdeskLocaleSection {
     section_id?: string;
     name?: string;
@@ -123,6 +130,9 @@ export interface HelpdeskDomain {
     custom?: string;
     verified?: boolean;
 }
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteHelpdesk Resource
  */
@@ -146,7 +156,7 @@ declare class WebsiteHelpdesk extends BaseResource {
     /**
      * List Helpdesk Locales
      */
-    listHelpdeskLocales(websiteID: string, pageNumber?: number): Promise<any>;
+    listHelpdeskLocales(websiteID: string, pageNumber?: number): Promise<HelpdeskLocale[]>;
     /**
      * Add Helpdesk Locale
      */
@@ -194,7 +204,7 @@ declare class WebsiteHelpdesk extends BaseResource {
     /**
      * Resolve Helpdesk Locale Article Page
      */
-    resolveHelpdeskLocaleArticlePage(websiteID: string, locale: string, articleId: string): Promise<any>;
+    resolveHelpdeskLocaleArticlePage(websiteID: string, locale: string, articleId: string): Promise<HelpdeskLocaleArticlePage>;
     /**
      * Resolve Helpdesk Locale Article Category
      */
@@ -344,4 +354,7 @@ declare class WebsiteHelpdesk extends BaseResource {
      */
     generateHelpdeskDomainSetupFlow(websiteID: string, custom?: string | null): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsiteHelpdesk;

package/dist/resources/WebsiteHelpdesk.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteHelpdesk Resource
  */
@@ -584,4 +587,7 @@ class WebsiteHelpdesk extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsiteHelpdesk;

package/dist/resources/WebsiteOperator.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
 export interface WebsiteOperatorListOne {
     type?: string;
     details?: WebsiteOperator;
@@ -39,6 +42,9 @@ export interface WebsiteOperatorEmailTarget {
     label?: string;
     url?: string;
 }
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteOperator Resource
  */
@@ -76,4 +82,7 @@ declare class WebsiteOperatorService extends BaseResource {
      */
     unlinkOperatorFromWebsite(websiteID: string, userID: string): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsiteOperatorService;

package/dist/resources/WebsiteOperator.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteOperator Resource
  */
@@ -90,4 +93,7 @@ class WebsiteOperatorService extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsiteOperatorService;

package/dist/resources/WebsitePeople.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
 export interface PeopleStatistics {
     total?: number;
 }
@@ -138,6 +141,9 @@ export interface PeopleProfileImportSetupOptions {
     column_separator?: string;
     skip_header?: boolean;
 }
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsitePeople Resource
  * @class
@@ -245,4 +251,7 @@ declare class WebsitePeople extends BaseResource {
      */
     importPeopleProfiles(websiteID: string, importSetup: PeopleProfileImportSetup): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsitePeople;

package/dist/resources/WebsitePeople.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsitePeople Resource
  * @class
@@ -273,4 +276,7 @@ class WebsitePeople extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsitePeople;

package/dist/resources/WebsiteSettings.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
 export interface WebsiteSettings {
     websiteID?: string;
     name?: string;
@@ -143,6 +146,9 @@ export interface WebsiteSettingsUpdateChatbox {
     blocked_locales?: string[];
     blocked_ips?: string[];
 }
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteSettings Resource
  */
@@ -156,4 +162,7 @@ declare class WebsiteSettingsService extends BaseResource {
      */
     updateWebsiteSettings(websiteID: string, settings: WebsiteSettingsUpdate): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsiteSettingsService;

package/dist/resources/WebsiteSettings.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteSettings Resource
  */
@@ -33,4 +36,7 @@ class WebsiteSettingsService extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsiteSettingsService;

package/dist/resources/WebsiteVerify.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
 export interface WebsiteVerifyKeyData {
     data?: WebsiteVerifyKey;
 }
@@ -14,6 +17,9 @@ export interface WebsiteVerifyKey {
 export interface WebsiteVerifySettingsUpdate {
     enabled?: boolean;
 }
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteVerify Resource
  */
@@ -35,4 +41,7 @@ declare class WebsiteVerify extends BaseResource {
      */
     rollVerifyKey(websiteID: string): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsiteVerify;

package/dist/resources/WebsiteVerify.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteVerify Resource
  */
@@ -47,4 +50,7 @@ class WebsiteVerify extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsiteVerify;

package/dist/resources/WebsiteVisitors.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
 export interface WebsiteVisitorCount {
     count?: number;
     active?: number;
@@ -77,6 +80,9 @@ export interface WebsiteVisitorsBlocked {
     rule?: string[];
     blocked?: number;
 }
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteVisitors Resource
  */
@@ -110,4 +116,7 @@ declare class WebsiteVisitors extends BaseResource {
      */
     clearBlockedVisitorsInRule(websiteID: string, rule: string): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default WebsiteVisitors;

package/dist/resources/WebsiteVisitors.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp WebsiteVisitors Resource
  */
@@ -74,15 +77,22 @@ class WebsiteVisitors extends BaseResource_1.default {
      * Count Blocked Visitors In Rule
      */
     countBlockedVisitorsInRule(websiteID, rule) {
-        return this.crisp.get(this.crisp.prepareRestUrl(["website", websiteID, "visitors", "blocked", rule]));
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "website", websiteID, "visitors", "blocked", rule
+        ]));
     }
     ;
     /**
      * Clear Blocked Visitors In Rule
      */
     clearBlockedVisitorsInRule(websiteID, rule) {
-        return this.crisp.delete(this.crisp.prepareRestUrl(["website", websiteID, "visitors", "blocked", rule]));
+        return this.crisp.delete(this.crisp.prepareRestUrl([
+            "website", websiteID, "visitors", "blocked", rule
+        ]));
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = WebsiteVisitors;

package/dist/resources/index.d.ts

@@ -1,3 +1,6 @@
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export * from "./BaseResource";
 export * from "./BucketURL";
 export * from "./MediaAnimation";