crisp-api 9.13.0 → 10.0.2

package/dist/resources/WebsiteSettings.d.ts

@@ -0,0 +1,159 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+export interface WebsiteSettings {
+    websiteID?: string;
+    name?: string;
+    domain?: string;
+    logo?: string;
+    audit?: WebsiteSettingsAudit;
+    contact?: WebsiteSettingsContact;
+    inbox?: WebsiteSettingsInbox;
+    emails?: WebsiteSettingsEmails;
+    chatbox?: WebsiteSettingsChatbox;
+}
+export interface WebsiteSettingsAudit {
+    log?: boolean;
+}
+export interface WebsiteSettingsContact {
+    email?: string;
+    phone?: string;
+    messenger?: string;
+    telegram?: string;
+    twitter?: string;
+    whatsapp?: string;
+    instagram?: string;
+}
+export interface WebsiteSettingsInbox {
+    lock_removal?: boolean;
+    force_operator_token?: boolean;
+    locale?: string;
+}
+export interface WebsiteSettingsEmails {
+    rating?: boolean;
+    transcript?: boolean;
+    enrich?: boolean;
+    junk_filter?: boolean;
+}
+export interface WebsiteSettingsChatbox {
+    tile?: string;
+    wait_game?: boolean;
+    website_logo?: boolean;
+    last_operator_face?: boolean;
+    ongoing_operator_face?: boolean;
+    activity_metrics?: boolean;
+    operator_privacy?: boolean;
+    visitor_privacy?: boolean;
+    availability_tooltip?: boolean;
+    hide_vacation?: boolean;
+    hide_on_away?: boolean;
+    hide_on_mobile?: boolean;
+    position_reverse?: boolean;
+    email_visitors?: boolean;
+    phone_visitors?: boolean;
+    force_identify?: boolean;
+    ignore_privacy?: boolean;
+    visitor_compose?: boolean;
+    file_transfer?: boolean;
+    audio_record?: boolean;
+    overlay_search?: boolean;
+    overlay_mode?: boolean;
+    helpdesk_link?: boolean;
+    helpdesk_only?: boolean;
+    status_health_dead?: boolean;
+    check_domain?: boolean;
+    color_theme?: string;
+    text_theme?: string;
+    welcome_message?: string;
+    locale?: string;
+    allowed_pages?: string[];
+    blocked_pages?: string[];
+    blocked_countries?: string[];
+    blocked_locales?: string[];
+}
+export interface WebsiteSettingsUpdate {
+    websiteID?: string;
+    name?: string;
+    domain?: string;
+    logo?: string;
+    audit?: WebsiteSettingsUpdateAudit;
+    contact?: WebsiteSettingsUpdateContact;
+    inbox?: WebsiteSettingsUpdateInbox;
+    emails?: WebsiteSettingsUpdateEmails;
+    chatbox?: WebsiteSettingsUpdateChatbox;
+}
+export interface WebsiteSettingsUpdateAudit {
+    log?: boolean;
+}
+export interface WebsiteSettingsUpdateContact {
+    email?: string;
+    phone?: string;
+    messenger?: string;
+    telegram?: string;
+    twitter?: string;
+    whatsapp?: string;
+    instagram?: string;
+}
+export interface WebsiteSettingsUpdateInbox {
+    lock_removal?: boolean;
+    force_operator_token?: boolean;
+    locale?: string;
+}
+export interface WebsiteSettingsUpdateEmails {
+    rating?: boolean;
+    transcript?: boolean;
+    enrich?: boolean;
+    junk_filter?: boolean;
+}
+export interface WebsiteSettingsUpdateChatbox {
+    tile?: string;
+    wait_game?: boolean;
+    website_logo?: boolean;
+    last_operator_face?: boolean;
+    ongoing_operator_face?: boolean;
+    activity_metrics?: boolean;
+    operator_privacy?: boolean;
+    visitor_privacy?: boolean;
+    availability_tooltip?: boolean;
+    hide_vacation?: boolean;
+    hide_on_away?: boolean;
+    hide_on_mobile?: boolean;
+    position_reverse?: boolean;
+    email_visitors?: boolean;
+    phone_visitors?: boolean;
+    force_identify?: boolean;
+    ignore_privacy?: boolean;
+    visitor_compose?: boolean;
+    file_transfer?: boolean;
+    audio_record?: boolean;
+    overlay_search?: boolean;
+    overlay_mode?: boolean;
+    helpdesk_link?: boolean;
+    helpdesk_only?: boolean;
+    status_health_dead?: boolean;
+    check_domain?: boolean;
+    color_theme?: string;
+    text_theme?: string;
+    welcome_message?: string;
+    locale?: string;
+    allowed_pages?: string[];
+    blocked_pages?: string[];
+    blocked_countries?: string[];
+    blocked_locales?: string[];
+    blocked_ips?: string[];
+}
+/**
+ * Crisp WebsiteSettings Resource
+ */
+declare class WebsiteSettingsService extends BaseResource {
+    /**
+     * Get Website Settings
+     */
+    getWebsiteSettings(websiteID: string): Promise<WebsiteSettings>;
+    /**
+     * Update Website Settings
+     */
+    updateWebsiteSettings(websiteID: string, settings: WebsiteSettingsUpdate): Promise<any>;
+}
+export default WebsiteSettingsService;

package/dist/resources/WebsiteSettings.js

@@ -0,0 +1,36 @@
+"use strict";
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+// PROJECT: RESOURCES
+const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**
+ * Crisp WebsiteSettings Resource
+ */
+class WebsiteSettingsService extends BaseResource_1.default {
+    /**
+     * Get Website Settings
+     */
+    getWebsiteSettings(websiteID) {
+        return this.crisp.get(this.crisp.prepareRestUrl(["website", websiteID, "settings"]));
+    }
+    ;
+    /**
+     * Update Website Settings
+     */
+    updateWebsiteSettings(websiteID, settings) {
+        return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "settings"]), null, settings);
+    }
+    ;
+}
+exports.default = WebsiteSettingsService;

package/dist/resources/WebsiteVerify.d.ts

@@ -0,0 +1,38 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+export interface WebsiteVerifyKeyData {
+    data?: WebsiteVerifyKey;
+}
+export interface WebsiteVerifySettings {
+    enabled?: boolean;
+}
+export interface WebsiteVerifyKey {
+    secret?: string;
+}
+export interface WebsiteVerifySettingsUpdate {
+    enabled?: boolean;
+}
+/**
+ * Crisp WebsiteVerify Resource
+ */
+declare class WebsiteVerify extends BaseResource {
+    /**
+     * Get Verify Settings
+     */
+    getVerifySettings(websiteID: string): Promise<WebsiteVerifySettings>;
+    /**
+     * Update Verify Settings
+     */
+    updateVerifySettings(websiteID: string, settings: WebsiteVerifySettingsUpdate): Promise<any>;
+    /**
+     * Get Verify Key
+     */
+    getVerifyKey(websiteID: string): Promise<WebsiteVerifyKey>;
+    /**
+     * Roll Verify Key
+     */
+    rollVerifyKey(websiteID: string): Promise<any>;
+}
+export default WebsiteVerify;

package/dist/resources/WebsiteVerify.js

@@ -0,0 +1,50 @@
+"use strict";
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Valerian Saliou <valerian@valeriansaliou.name>
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+// PROJECT: RESOURCES
+const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**
+ * Crisp WebsiteVerify Resource
+ */
+class WebsiteVerify extends BaseResource_1.default {
+    /**
+     * Get Verify Settings
+     */
+    getVerifySettings(websiteID) {
+        return this.crisp.get(this.crisp.prepareRestUrl(["website", websiteID, "verify", "settings"]));
+    }
+    ;
+    /**
+     * Update Verify Settings
+     */
+    updateVerifySettings(websiteID, settings) {
+        return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "verify", "settings"]), null, settings);
+    }
+    ;
+    /**
+     * Get Verify Key
+     */
+    getVerifyKey(websiteID) {
+        return this.crisp.get(this.crisp.prepareRestUrl(["website", websiteID, "verify", "key"]));
+    }
+    ;
+    /**
+     * Roll Verify Key
+     */
+    rollVerifyKey(websiteID) {
+        return this.crisp.post(this.crisp.prepareRestUrl(["website", websiteID, "verify", "key"]), null, null);
+    }
+    ;
+}
+exports.default = WebsiteVerify;

package/dist/resources/WebsiteVisitors.d.ts

@@ -0,0 +1,113 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+export interface WebsiteVisitorCount {
+    count?: number;
+    active?: number;
+    limited?: boolean;
+}
+export interface WebsiteVisitor {
+    session_id?: string;
+    inbox_id?: string;
+    nickname?: string;
+    email?: string;
+    avatar?: string;
+    useragent?: string;
+    initiated?: boolean;
+    active?: boolean;
+    last_page?: WebsiteVisitorLastPage;
+    geolocation?: WebsiteVisitorGeolocation;
+    timezone?: number;
+    capabilities?: string[];
+    locales?: string[];
+}
+export interface WebsiteVisitorLastPage {
+    page_title?: string;
+    page_url?: string;
+}
+export interface WebsiteVisitorGeolocation {
+    coordinates?: WebsiteVisitorGeolocationCoordinates;
+    city?: string;
+    region?: string;
+    country?: string;
+}
+export interface WebsiteVisitorGeolocationCoordinates {
+    latitude?: number;
+    longitude?: number;
+}
+export interface WebsiteVisitorsMapPointsData {
+    data?: WebsiteVisitorsMapPoint[];
+}
+export interface WebsiteVisitorsMapPoint {
+    visitors?: WebsiteVisitorsMapPointVisitors;
+    geolocation?: WebsiteVisitorsMapPointGeolocation;
+}
+export interface WebsiteVisitorsMapPointGeolocation {
+    coordinates?: WebsiteVisitorsMapPointGeolocationCoordinates;
+    city?: string;
+    region?: string;
+    country?: string;
+}
+export interface WebsiteVisitorsMapPointGeolocationCoordinates {
+    latitude?: number;
+    longitude?: number;
+}
+export interface WebsiteVisitorsMapPointVisitors {
+    count?: number;
+    threshold?: number;
+    sessions?: WebsiteVisitorsMapPointVisitorsSession[];
+}
+export interface WebsiteVisitorsMapPointVisitorsSession {
+    session_id?: string;
+    nickname?: string;
+    email?: string;
+    avatar?: string;
+    initiated?: boolean;
+    active?: boolean;
+    last_page?: WebsiteVisitorLastPage;
+    timezone?: number;
+    capabilities?: string[];
+    locales?: string[];
+}
+export interface WebsiteVisitorsToken {
+    session_id?: string;
+}
+export interface WebsiteVisitorsBlocked {
+    rule?: string[];
+    blocked?: number;
+}
+/**
+ * Crisp WebsiteVisitors Resource
+ */
+declare class WebsiteVisitors extends BaseResource {
+    /**
+     * Count Visitors
+     */
+    countVisitors(websiteID: string): Promise<WebsiteVisitorCount>;
+    /**
+     * List Visitors
+     */
+    listVisitors(websiteID: string, pageNumber?: number): Promise<WebsiteVisitor[]>;
+    /**
+     * Pinpoint Visitors On A Map
+     */
+    pinpointVisitorsOnMap(websiteID: string, centerLongitude: number, centerLatitude: number, centerRadius: number): Promise<WebsiteVisitorsMapPoint[]>;
+    /**
+     * Get Session Identifier From Token
+     */
+    getSessionIdentifierFromToken(websiteID: string, tokenID: string): Promise<WebsiteVisitorsToken>;
+    /**
+     * Count Blocked Visitors
+     */
+    countBlockedVisitors(websiteID: string): Promise<WebsiteVisitorsBlocked>;
+    /**
+     * Count Blocked Visitors In Rule
+     */
+    countBlockedVisitorsInRule(websiteID: string, rule: string): Promise<number>;
+    /**
+     * Clear Blocked Visitors In Rule
+     */
+    clearBlockedVisitorsInRule(websiteID: string, rule: string): Promise<any>;
+}
+export default WebsiteVisitors;

package/dist/resources/WebsiteVisitors.js

@@ -0,0 +1,88 @@
+"use strict";
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Valerian Saliou <valerian@valeriansaliou.name>
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+// PROJECT: RESOURCES
+const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**
+ * Crisp WebsiteVisitors Resource
+ */
+class WebsiteVisitors extends BaseResource_1.default {
+    /**
+     * Count Visitors
+     */
+    countVisitors(websiteID) {
+        return this.crisp.get(this.crisp.prepareRestUrl(["website", websiteID, "visitors", "count"]));
+    }
+    ;
+    /**
+     * List Visitors
+     */
+    listVisitors(websiteID, pageNumber = 1) {
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "website", websiteID, "visitors", "list", String(pageNumber)
+        ]));
+    }
+    ;
+    /**
+     * Pinpoint Visitors On A Map
+     */
+    pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius) {
+        // Generate query
+        const query = {};
+        if (typeof centerLongitude === "number") {
+            query.center_longitude = String(centerLongitude);
+        }
+        if (typeof centerLatitude === "number") {
+            query.center_latitude = String(centerLatitude);
+        }
+        if (typeof centerRadius === "number") {
+            query.center_radius = String(centerRadius);
+        }
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "website", websiteID, "visitors", "map"
+        ]), query);
+    }
+    ;
+    /**
+     * Get Session Identifier From Token
+     */
+    getSessionIdentifierFromToken(websiteID, tokenID) {
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "website", websiteID, "visitors", "token", tokenID
+        ]));
+    }
+    ;
+    /**
+     * Count Blocked Visitors
+     */
+    countBlockedVisitors(websiteID) {
+        return this.crisp.get(this.crisp.prepareRestUrl(["website", websiteID, "visitors", "blocked"]));
+    }
+    ;
+    /**
+     * Count Blocked Visitors In Rule
+     */
+    countBlockedVisitorsInRule(websiteID, 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]));
+    }
+    ;
+}
+exports.default = WebsiteVisitors;

package/dist/resources/index.d.ts

@@ -0,0 +1,17 @@
+export * from "./BaseResource";
+export * from "./BucketURL";
+export * from "./MediaAnimation";
+export * from "./PluginConnect";
+export * from "./PluginSubscription";
+export * from "./WebsiteAnalytics";
+export * from "./WebsiteAvailability";
+export * from "./WebsiteBase";
+export * from "./WebsiteBatch";
+export * from "./WebsiteCampaign";
+export * from "./WebsiteConversation";
+export * from "./WebsiteHelpdesk";
+export * from "./WebsiteOperator";
+export * from "./WebsitePeople";
+export * from "./WebsiteSettings";
+export * from "./WebsiteVerify";
+export * from "./WebsiteVisitors";

package/dist/resources/index.js

@@ -0,0 +1,40 @@
+"use strict";
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Used to export all types
+__exportStar(require("./BaseResource"), exports);
+__exportStar(require("./BucketURL"), exports);
+__exportStar(require("./MediaAnimation"), exports);
+__exportStar(require("./PluginConnect"), exports);
+__exportStar(require("./PluginSubscription"), exports);
+__exportStar(require("./WebsiteAnalytics"), exports);
+__exportStar(require("./WebsiteAvailability"), exports);
+__exportStar(require("./WebsiteBase"), exports);
+__exportStar(require("./WebsiteBatch"), exports);
+__exportStar(require("./WebsiteCampaign"), exports);
+__exportStar(require("./WebsiteConversation"), exports);
+__exportStar(require("./WebsiteHelpdesk"), exports);
+__exportStar(require("./WebsiteOperator"), exports);
+__exportStar(require("./WebsitePeople"), exports);
+__exportStar(require("./WebsiteSettings"), exports);
+__exportStar(require("./WebsiteVerify"), exports);
+__exportStar(require("./WebsiteVisitors"), exports);

package/dist/services/bucket.d.ts

@@ -0,0 +1,13 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BucketURL from "../resources/BucketURL";
+/**
+ * Bucket Service
+ */
+declare class BucketService {
+    __resources: any[];
+}
+export interface BucketServiceInterface extends BucketURL {
+}
+export default BucketService;

package/dist/services/bucket.js

@@ -0,0 +1,28 @@
+"use strict";
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+// PROJECT: RESOURCES
+const BucketURL_1 = __importDefault(require("../resources/BucketURL"));
+/**
+ * Bucket Service
+ */
+class BucketService {
+    constructor() {
+        /* eslint-disable @typescript-eslint/no-explicit-any */
+        this.__resources = [
+            BucketURL_1.default
+        ];
+    }
+}
+exports.default = BucketService;

package/dist/services/media.d.ts

@@ -0,0 +1,13 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import MediaAnimation from "../resources/MediaAnimation";
+/**
+ * Crisp Media Service
+ */
+declare class MediaService {
+    __resources: any[];
+}
+export interface MediaServiceInterface extends MediaAnimation {
+}
+export default MediaService;

package/dist/services/media.js

@@ -0,0 +1,28 @@
+"use strict";
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+// PROJECT: RESOURCES
+const MediaAnimation_1 = __importDefault(require("../resources/MediaAnimation"));
+/**
+ * Crisp Media Service
+ */
+class MediaService {
+    constructor() {
+        /* eslint-disable @typescript-eslint/no-explicit-any */
+        this.__resources = [
+            MediaAnimation_1.default
+        ];
+    }
+}
+exports.default = MediaService;

package/dist/services/plugin.d.ts

@@ -0,0 +1,14 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import PluginConnect from "../resources/PluginConnect";
+import PluginSubscription from "../resources/PluginSubscription";
+/**
+ * Crisp Plugin Service
+ */
+declare class PluginService {
+    __resources: any[];
+}
+export interface PluginServiceInterface extends PluginConnect, PluginSubscription {
+}
+export default PluginService;

package/dist/services/plugin.js

@@ -0,0 +1,30 @@
+"use strict";
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+// PROJECT: RESOURCES
+const PluginConnect_1 = __importDefault(require("../resources/PluginConnect"));
+const PluginSubscription_1 = __importDefault(require("../resources/PluginSubscription"));
+/**
+ * Crisp Plugin Service
+ */
+class PluginService {
+    constructor() {
+        /* eslint-disable @typescript-eslint/no-explicit-any */
+        this.__resources = [
+            PluginConnect_1.default,
+            PluginSubscription_1.default
+        ];
+    }
+}
+exports.default = PluginService;