crisp-api 9.13.0 → 10.0.2

package/dist/resources/BaseResource.d.ts

@@ -0,0 +1,15 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import Crisp from "../crisp";
+/**
+ * Crisp Base Resource
+ */
+declare class BaseResource {
+    protected crisp: Crisp;
+    /**
+     * Constructor
+     */
+    constructor(crisp: Crisp);
+}
+export default BaseResource;

package/dist/resources/BaseResource.js

@@ -0,0 +1,20 @@
+"use strict";
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Crisp Base Resource
+ */
+class BaseResource {
+    /**
+     * Constructor
+     */
+    constructor(crisp) {
+        this.crisp = crisp;
+    }
+}
+exports.default = BaseResource;

package/dist/resources/BucketURL.d.ts

@@ -0,0 +1,28 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+export type BucketURLRequestFile = {
+    name?: string;
+    type?: string;
+};
+export type BucketURLRequestResource = {
+    type?: string;
+    id?: string;
+};
+export type BucketURLRequest = {
+    namespace?: string;
+    id?: string;
+    file?: BucketURLRequestFile;
+    resource?: BucketURLRequestResource;
+};
+/**
+ * Crisp BucketURL Resource
+ */
+declare class BucketURL extends BaseResource {
+    /**
+     * Generate Bucket URL
+     */
+    generateBucketURL(data: BucketURLRequest): Promise<any>;
+}
+export default BucketURL;

package/dist/resources/BucketURL.js

@@ -0,0 +1,29 @@
+"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 BucketURL Resource
+ */
+class BucketURL extends BaseResource_1.default {
+    /**
+     * Generate Bucket URL
+     */
+    generateBucketURL(data) {
+        return this.crisp.post(this.crisp.prepareRestUrl(["bucket", "url", "generate"]), null, data);
+    }
+    ;
+}
+exports.default = BucketURL;

package/dist/resources/MediaAnimation.d.ts

@@ -0,0 +1,14 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+/**
+ * Crisp MediaAnimation Resource
+ */
+declare class MediaAnimation extends BaseResource {
+    /**
+     * List Animation Medias
+     */
+    listAnimationMedias(pageNumber: number, listID: string, searchQuery: object): Promise<any>;
+}
+export default MediaAnimation;

package/dist/resources/MediaAnimation.js

@@ -0,0 +1,32 @@
+"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 MediaAnimation Resource
+ */
+class MediaAnimation extends BaseResource_1.default {
+    /**
+     * List Animation Medias
+     */
+    listAnimationMedias(pageNumber, listID, searchQuery) {
+        return this.crisp.get(this.crisp.prepareRestUrl(["media", "animation", "list", String(pageNumber)]), {
+            list_id: listID,
+            search_query: searchQuery
+        });
+    }
+    ;
+}
+exports.default = MediaAnimation;

package/dist/resources/PluginConnect.d.ts

@@ -0,0 +1,50 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+export type PluginConnectAccount = {
+    plugin_id?: string;
+};
+export type PluginConnectAllWebsites = {
+    website_id?: string;
+    token?: string;
+    settings?: object;
+};
+export type PluginConnectWebsitesSince = {
+    website_id?: string;
+    token?: string;
+    settings?: object;
+    difference?: string;
+};
+export type PluginConnectEndpoints = {
+    socket?: PluginConnectEndpointsSocket;
+};
+export type PluginConnectEndpointsSocket = {
+    app?: string;
+};
+/**
+ * Crisp PluginConnect Resource
+ */
+declare class PluginConnect extends BaseResource {
+    /**
+     * Get Connect Account
+     */
+    getConnectAccount(): Promise<PluginConnectAccount>;
+    /**
+     * Check Connect Session Validity
+     */
+    checkConnectSessionValidity(): Promise<any>;
+    /**
+     * List All Connect Websites
+     */
+    listAllConnectWebsites(pageNumber: number, filterConfigured: boolean): Promise<PluginConnectAllWebsites>;
+    /**
+     * List Connect Websites Since
+     */
+    listConnectWebsitesSince(dateSince: string, filterConfigured: boolean): Promise<PluginConnectWebsitesSince>;
+    /**
+     * Get Connect Endpoints
+     */
+    getConnectEndpoints(): Promise<PluginConnectEndpoints>;
+}
+export default PluginConnect;

package/dist/resources/PluginConnect.js

@@ -0,0 +1,73 @@
+"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 PluginConnect Resource
+ */
+class PluginConnect extends BaseResource_1.default {
+    /**
+     * Get Connect Account
+     */
+    getConnectAccount() {
+        return this.crisp.get(this.crisp.prepareRestUrl(["plugin", "connect", "account"]), {});
+    }
+    ;
+    /**
+     * Check Connect Session Validity
+     */
+    checkConnectSessionValidity() {
+        return this.crisp.head(this.crisp.prepareRestUrl(["plugin", "connect", "session"]), {});
+    }
+    ;
+    /**
+     * List All Connect Websites
+     */
+    listAllConnectWebsites(pageNumber, filterConfigured) {
+        // Generate query
+        let query = {
+            filter_configured: ((filterConfigured === true) ? "1" : "0")
+        };
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "plugin", "connect", "websites", "all", String(pageNumber)
+        ]), query);
+    }
+    ;
+    /**
+     * List Connect Websites Since
+     */
+    listConnectWebsitesSince(dateSince, filterConfigured) {
+        // Generate query
+        let query = {
+            filter_configured: ((filterConfigured === true) ? "1" : "0")
+        };
+        if (dateSince) {
+            // @ts-ignore
+            query.date_since = dateSince;
+        }
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "plugin", "connect", "websites", "since"
+        ]), query);
+    }
+    ;
+    /**
+     * Get Connect Endpoints
+     */
+    getConnectEndpoints() {
+        return this.crisp.get(this.crisp.prepareRestUrl(["plugin", "connect", "endpoints"]), {});
+    }
+    ;
+}
+exports.default = PluginConnect;

package/dist/resources/PluginSubscription.d.ts

@@ -0,0 +1,103 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+type PluginSubscription = {
+    id?: string;
+    urn?: string;
+    type?: string;
+    category?: string;
+    name?: string;
+    summary?: string;
+    price?: number;
+    plans?: PluginSubscriptionPlan[];
+    icon?: string;
+    website_url?: string;
+    contact_url?: string;
+    terms_url?: string;
+    privacy_url?: string;
+    help_url?: string;
+    video_url?: string;
+    configurable?: boolean;
+    since?: string;
+    active?: boolean;
+    website_id?: string;
+    card_id?: string;
+};
+type PluginSubscriptionPlan = {
+    id?: string;
+    name?: string;
+    price?: number;
+};
+type PluginSubscriptionSettings = {
+    plugin_id?: string;
+    website_id?: string;
+    token?: string;
+    schema?: object;
+    settings?: object;
+    settings_form_url?: string;
+    callback_url?: string;
+};
+type PluginSubscriptionChannelForward = {
+    namespace?: string;
+    identifier?: string;
+    payload?: object;
+};
+type PluginSubscriptionEventDispatch = {
+    name?: string;
+    data?: object;
+};
+/**
+ * Crisp PluginSubscription Resource
+ */
+declare class PluginSubscriptionService extends BaseResource {
+    /**
+     * List All Active Subscriptions
+     */
+    listAllActiveSubscriptions(): Promise<PluginSubscription[]>;
+    /**
+     * List Subscriptions For A Website
+     */
+    listSubscriptionsForWebsite(websiteID: string): Promise<PluginSubscription[]>;
+    /**
+     * Get Subscription Details
+     */
+    getSubscriptionDetails(websiteID: string, pluginID: string): Promise<PluginSubscription>;
+    /**
+     * Subscribe Website To Plugin
+     */
+    subscribeWebsiteToPlugin(websiteID: string, pluginID: string): Promise<any>;
+    /**
+     * Unsubscribe Plugin From Website
+     */
+    unsubscribePluginFromWebsite(websiteID: string, pluginID: string): Promise<any>;
+    /**
+     * Get Subscription Settings
+     */
+    getSubscriptionSettings(websiteID: string, pluginID: string): Promise<PluginSubscriptionSettings>;
+    /**
+     * Save Subscription Settings
+     */
+    saveSubscriptionSettings(websiteID: string, pluginID: string, settings: object): Promise<any>;
+    /**
+     * Update Subscription Settings
+     */
+    updateSubscriptionSettings(websiteID: string, pluginID: string, settings: object): Promise<any>;
+    /**
+     * Get Plugin Usage Bills
+     */
+    getPluginUsageBills(websiteID: string, pluginID: string): Promise<any>;
+    /**
+     * Report Plugin Usage To Bill
+     */
+    reportPluginUsageToBill(websiteID: string, pluginID: string, usage: object): Promise<any>;
+    /**
+     * Forward Plugin Payload To Channel
+     */
+    forwardPluginPayloadToChannel(websiteID: string, pluginID: string, payload: PluginSubscriptionChannelForward): Promise<any>;
+    /**
+     * Dispatch Plugin Event
+     */
+    dispatchPluginEvent(websiteID: string, pluginID: string, payload: PluginSubscriptionEventDispatch): Promise<any>;
+}
+export default PluginSubscriptionService;

package/dist/resources/PluginSubscription.js

@@ -0,0 +1,122 @@
+"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 PluginSubscription Resource
+ */
+class PluginSubscriptionService extends BaseResource_1.default {
+    /**
+     * List All Active Subscriptions
+     */
+    listAllActiveSubscriptions() {
+        return this.crisp.get(this.crisp.prepareRestUrl(["plugins", "subscription"]));
+    }
+    ;
+    /**
+     * List Subscriptions For A Website
+     */
+    listSubscriptionsForWebsite(websiteID) {
+        return this.crisp.get(this.crisp.prepareRestUrl(["plugins", "subscription", websiteID]));
+    }
+    ;
+    /**
+     * Get Subscription Details
+     */
+    getSubscriptionDetails(websiteID, pluginID) {
+        return this.crisp.get(this.crisp.prepareRestUrl(["plugins", "subscription", websiteID, pluginID]));
+    }
+    ;
+    /**
+     * Subscribe Website To Plugin
+     */
+    subscribeWebsiteToPlugin(websiteID, pluginID) {
+        return this.crisp.post(this.crisp.prepareRestUrl(["plugins", "subscription", websiteID]), null, {
+            plugin_id: pluginID
+        });
+    }
+    ;
+    /**
+     * Unsubscribe Plugin From Website
+     */
+    unsubscribePluginFromWebsite(websiteID, pluginID) {
+        return this.crisp.delete(this.crisp.prepareRestUrl(["plugins", "subscription", websiteID, pluginID]));
+    }
+    ;
+    /**
+     * Get Subscription Settings
+     */
+    getSubscriptionSettings(websiteID, pluginID) {
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "plugins", "subscription", websiteID, pluginID, "settings"
+        ]));
+    }
+    ;
+    /**
+     * Save Subscription Settings
+     */
+    saveSubscriptionSettings(websiteID, pluginID, settings) {
+        return this.crisp.put(this.crisp.prepareRestUrl([
+            "plugins", "subscription", websiteID, pluginID, "settings"
+        ]), null, settings);
+    }
+    ;
+    /**
+     * Update Subscription Settings
+     */
+    updateSubscriptionSettings(websiteID, pluginID, settings) {
+        return this.crisp.patch(this.crisp.prepareRestUrl([
+            "plugins", "subscription", websiteID, pluginID, "settings"
+        ]), null, settings);
+    }
+    ;
+    /**
+     * Get Plugin Usage Bills
+     */
+    getPluginUsageBills(websiteID, pluginID) {
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "plugins", "subscription", websiteID, pluginID, "bill", "usage"
+        ]));
+    }
+    ;
+    /**
+     * Report Plugin Usage To Bill
+     */
+    reportPluginUsageToBill(websiteID, pluginID, usage) {
+        return this.crisp.post(this.crisp.prepareRestUrl([
+            "plugins", "subscription", websiteID, pluginID, "bill", "usage"
+        ]), null, usage);
+    }
+    ;
+    /**
+     * Forward Plugin Payload To Channel
+     */
+    forwardPluginPayloadToChannel(websiteID, pluginID, payload) {
+        return this.crisp.post(this.crisp.prepareRestUrl([
+            "plugins", "subscription", websiteID, pluginID, "channel"
+        ]), null, payload);
+    }
+    ;
+    /**
+     * Dispatch Plugin Event
+     */
+    dispatchPluginEvent(websiteID, pluginID, payload) {
+        return this.crisp.post(this.crisp.prepareRestUrl([
+            "plugins", "subscription", websiteID, pluginID, "event"
+        ]), null, payload);
+    }
+    ;
+}
+exports.default = PluginSubscriptionService;

package/dist/resources/WebsiteAnalytics.d.ts

@@ -0,0 +1,14 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+/**
+ * Crisp WebsiteAnalytics Resource
+ */
+declare class WebsiteAnalytics extends BaseResource {
+    /**
+     * Generate Analytics
+     */
+    generateAnalytics(websiteID: string, query: object): Promise<any>;
+}
+export default WebsiteAnalytics;

package/dist/resources/WebsiteAnalytics.js

@@ -0,0 +1,29 @@
+"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 WebsiteAnalytics Resource
+ */
+class WebsiteAnalytics extends BaseResource_1.default {
+    /**
+     * Generate Analytics
+     */
+    generateAnalytics(websiteID, query) {
+        return this.crisp.post(this.crisp.prepareRestUrl(["website", websiteID, "analytics", "generate"]), null, query);
+    }
+    ;
+}
+exports.default = WebsiteAnalytics;

package/dist/resources/WebsiteAvailability.d.ts

@@ -0,0 +1,31 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+type WebsiteAvailabilityStatus = {
+    status?: string;
+    since?: number;
+};
+type WebsiteAvailabilityOperator = {
+    user_id?: string;
+    type?: string;
+    time?: WebsiteAvailabilityOperatorTime;
+};
+type WebsiteAvailabilityOperatorTime = {
+    for?: number;
+    since?: number;
+};
+/**
+ * Crisp WebsiteAvailability Resource
+ */
+declare class WebsiteAvailability extends BaseResource {
+    /**
+     * Get Website Availability Status
+     */
+    getWebsiteAvailabilityStatus(websiteID: string): Promise<WebsiteAvailabilityStatus>;
+    /**
+     * List Website Operator Availabilities
+     */
+    listWebsiteOperatorAvailabilities(websiteID: string): Promise<WebsiteAvailabilityOperator[]>;
+}
+export default WebsiteAvailability;

package/dist/resources/WebsiteAvailability.js

@@ -0,0 +1,36 @@
+"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 WebsiteAvailability Resource
+ */
+class WebsiteAvailability extends BaseResource_1.default {
+    /**
+     * Get Website Availability Status
+     */
+    getWebsiteAvailabilityStatus(websiteID) {
+        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"]));
+    }
+    ;
+}
+exports.default = WebsiteAvailability;

package/dist/resources/WebsiteBase.d.ts

@@ -0,0 +1,60 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+type Website = {
+    website_id?: string;
+    name?: string;
+    domain?: string;
+    logo?: string;
+};
+type WebsiteCreate = {
+    name?: string;
+    domain?: string;
+};
+type WebsiteRemoveVerify = {
+    method?: string;
+    secret?: string;
+};
+export type WebsiteFilter = {
+    model?: string;
+    criterion?: string;
+    operator?: string;
+    query?: Record<string, unknown>;
+};
+/**
+ * Crisp WebsiteBase Resource
+ */
+declare class WebsiteBase extends BaseResource {
+    /**
+     * Check If Website Exists
+     * @memberof WebsiteBase
+     * @public
+     * @method checkWebsiteExists
+     * @param {string} domain
+     * @return {Promise}
+     */
+    checkWebsiteExists(domain: string): Promise<any>;
+    /**
+     * Create Website
+     */
+    createWebsite(websiteData: WebsiteCreate): Promise<Website>;
+    /**
+     * Get A Website
+     * @memberof WebsiteBase
+     * @public
+     * @method getWebsite
+     * @param {string} websiteID
+     * @return {Promise}
+     */
+    getWebsite(websiteID: string): Promise<Website>;
+    /**
+     * Delete A Website
+     */
+    deleteWebsite(websiteID: string, verify: WebsiteRemoveVerify): Promise<any>;
+    /**
+     * Abort Website Deletion
+     */
+    abortWebsiteDeletion(websiteID: string): Promise<any>;
+}
+export default WebsiteBase;