crisp-api 9.13.0 → 10.0.3

package/dist/resources/WebsiteAvailability.js

@@ -0,0 +1,46 @@
+"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"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+/**
+ * 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
+ ***************************************************************************/
+exports.default = WebsiteAvailability;

package/dist/resources/WebsiteBase.d.ts

@@ -0,0 +1,69 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
+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>;
+};
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+/**
+ * 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>;
+}
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+export default WebsiteBase;

package/dist/resources/WebsiteBase.js

@@ -0,0 +1,77 @@
+"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"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+/**
+ * Crisp WebsiteBase Resource
+ */
+class WebsiteBase extends BaseResource_1.default {
+    /**
+     * Check If Website Exists
+     * @memberof WebsiteBase
+     * @public
+     * @method checkWebsiteExists
+     * @param {string} domain
+     * @return {Promise}
+     */
+    checkWebsiteExists(domain) {
+        return this.crisp.head(this.crisp.prepareRestUrl(["website"]), {
+            domain: domain
+        });
+    }
+    ;
+    /**
+     * Create Website
+     */
+    createWebsite(websiteData) {
+        return this.crisp.post(this.crisp.prepareRestUrl(["website"]), null, websiteData);
+    }
+    ;
+    /**
+     * Get A Website
+     * @memberof WebsiteBase
+     * @public
+     * @method getWebsite
+     * @param {string} websiteID
+     * @return {Promise}
+     */
+    getWebsite(websiteID) {
+        return this.crisp.get(this.crisp.prepareRestUrl(["website", websiteID]));
+    }
+    ;
+    /**
+     * Delete A Website
+     */
+    deleteWebsite(websiteID, verify) {
+        return this.crisp.delete(this.crisp.prepareRestUrl(["website", websiteID]), undefined, {
+            verify: verify
+        });
+    }
+    ;
+    /**
+     * Abort Website Deletion
+     */
+    abortWebsiteDeletion(websiteID) {
+        return this.crisp.delete(this.crisp.prepareRestUrl(["website", websiteID, "expunge"]));
+    }
+    ;
+}
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+exports.default = WebsiteBase;

package/dist/resources/WebsiteBatch.d.ts

@@ -0,0 +1,61 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
+type WebsiteBatchConversationsOperation = {
+    inbox_id?: string;
+    sessions?: string[];
+};
+type WebsiteBatchPeopleOperationInner = {
+    profiles?: string[];
+    search?: string;
+};
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+/**
+ * Crisp WebsiteBatch Resource
+ */
+declare class WebsiteBatch extends BaseResource {
+    /**
+     * Batch Resolve Conversations
+     */
+    batchResolveConversations(websiteID: string, operation: WebsiteBatchConversationsOperation): Promise<any>;
+    /**
+     * Batch Read Conversations
+     * @memberof WebsiteBatch
+     * @public
+     * @method batchReadConversations
+     * @param {string} websiteID
+     * @param {object} operation
+     * @return {Promise}
+     */
+    batchReadConversations(websiteID: string, operation: WebsiteBatchConversationsOperation): Promise<any>;
+    /**
+     * Batch Remove Conversations
+     * @memberof WebsiteBatch
+     * @public
+     * @method batchRemoveConversations
+     * @param {string} websiteID
+     * @param {object} operation
+     * @return {Promise}
+     */
+    batchRemoveConversations(websiteID: string, operation: WebsiteBatchConversationsOperation): Promise<any>;
+    /**
+     * Batch Remove People
+     * @memberof WebsiteBatch
+     * @public
+     * @method batchRemovePeople
+     * @param {string} websiteID
+     * @param {object} people
+     * @return {Promise}
+     */
+    batchRemovePeople(websiteID: string, people: WebsiteBatchPeopleOperationInner): Promise<any>;
+}
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+export default WebsiteBatch;

package/dist/resources/WebsiteBatch.js

@@ -0,0 +1,76 @@
+"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"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+/**
+ * Crisp WebsiteBatch Resource
+ */
+class WebsiteBatch extends BaseResource_1.default {
+    /**
+     * Batch Resolve Conversations
+     */
+    batchResolveConversations(websiteID, operation) {
+        return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "resolve"]), null, operation);
+    }
+    ;
+    /**
+     * Batch Read Conversations
+     * @memberof WebsiteBatch
+     * @public
+     * @method batchReadConversations
+     * @param {string} websiteID
+     * @param {object} operation
+     * @return {Promise}
+     */
+    batchReadConversations(websiteID, operation) {
+        return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "read"]), null, operation);
+    }
+    ;
+    /**
+     * Batch Remove Conversations
+     * @memberof WebsiteBatch
+     * @public
+     * @method batchRemoveConversations
+     * @param {string} websiteID
+     * @param {object} operation
+     * @return {Promise}
+     */
+    batchRemoveConversations(websiteID, operation) {
+        return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "remove"]), null, operation);
+    }
+    ;
+    /**
+     * Batch Remove People
+     * @memberof WebsiteBatch
+     * @public
+     * @method batchRemovePeople
+     * @param {string} websiteID
+     * @param {object} people
+     * @return {Promise}
+     */
+    batchRemovePeople(websiteID, people) {
+        return this.crisp.patch(this.crisp.prepareRestUrl(["website", websiteID, "batch", "remove"]), null, {
+            people: people
+        });
+    }
+    ;
+}
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+exports.default = WebsiteBatch;

package/dist/resources/WebsiteCampaign.d.ts

@@ -0,0 +1,208 @@
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+import BaseResource from "./BaseResource";
+import { WebsiteFilter } from "./WebsiteBase";
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
+type WebsiteCampaignExcerpt = {
+    campaign_id?: string;
+    type?: string;
+    format?: string;
+    name?: string;
+    subject?: string;
+    tag?: string;
+    ready?: boolean;
+    dispatched?: boolean;
+    running?: boolean;
+    progress?: number;
+    targets?: number;
+    reached?: number;
+    created_at: number;
+    updated_at: number;
+    dispatched_at?: number;
+};
+type WebsiteCampaignTemplateExcerpt = {
+    template_id?: string;
+    type?: string;
+    name?: string;
+    format?: string;
+    created_at?: number;
+    updated_at?: number;
+};
+type WebsiteCampaignTemplateNew = {
+    template_id?: string;
+};
+interface WebsiteCampaignTemplateItem extends WebsiteCampaignTemplateExcerpt {
+    content?: string;
+}
+interface WebsiteCampaignItem extends WebsiteCampaignExcerpt {
+    sender?: WebsiteCampaignItemSender;
+    recipients?: WebsiteCampaignItemRecipients;
+    flow?: WebsiteCampaignItemFlow;
+    message?: string;
+    options?: WebsiteCampaignItemOptions;
+    statistics?: WebsiteCampaignItemStatistics;
+}
+type WebsiteCampaignItemSender = {
+    user_id?: string;
+};
+type WebsiteCampaignItemRecipients = {
+    type?: string;
+    segments?: string[];
+    people?: string[];
+    filter?: WebsiteFilter[];
+};
+type WebsiteCampaignItemFlow = {
+    launch_event?: string;
+    assert_filter?: WebsiteFilter[];
+    assert_delay?: number;
+    deliver_once?: boolean;
+    deliver_delay?: number;
+};
+type WebsiteCampaignItemOptions = {
+    deliver_to_chatbox?: boolean;
+    deliver_to_email?: boolean;
+    sender_name_website?: boolean;
+    sender_email_reply?: boolean;
+    tracking?: boolean;
+};
+type WebsiteCampaignItemStatistics = {
+    opened?: number;
+    clicked?: number;
+    unsubscribed?: number;
+};
+type WebsiteCampaignRecipient = {
+    people_id?: string;
+    email?: string;
+    person?: WebsiteCampaignRecipientPerson;
+    subscribed?: boolean;
+};
+type WebsiteCampaignRecipientPerson = {
+    nickname?: string;
+    avatar?: string;
+};
+type WebsiteCampaignStatistic = {
+    profile?: WebsiteCampaignStatisticProfile;
+    data?: Record<string, unknown>;
+    created_at?: number;
+    updated_at?: number;
+};
+type WebsiteCampaignStatisticProfile = {
+    people_id?: string;
+    email?: string;
+    person?: WebsiteCampaignStatisticProfilePerson;
+};
+type WebsiteCampaignStatisticProfilePerson = {
+    nickname?: string;
+    avatar?: string;
+    geolocation?: WebsiteCampaignStatisticProfilePersonGeolocation;
+};
+type WebsiteCampaignStatisticProfilePersonGeolocation = {
+    country?: string;
+    region?: string;
+    city?: string;
+    coordinates?: WebsiteCampaignStatisticProfilePersonGeolocationCoordinates;
+};
+type WebsiteCampaignStatisticProfilePersonGeolocationCoordinates = {
+    latitude?: number;
+    longitude?: number;
+};
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+/**
+ * Crisp WebsiteCampaign Resource
+ */
+declare class WebsiteCampaign extends BaseResource {
+    /**
+     * List Campaigns
+     */
+    listCampaigns(websiteID: string, pageNumber?: number): Promise<WebsiteCampaignExcerpt[]>;
+    /**
+     * List Campaign Tags
+     */
+    listCampaignTags(websiteID: string): Promise<string[]>;
+    /**
+     * List Campaign Templates
+     */
+    listCampaignTemplates(websiteID: string, pageNumber?: number): Promise<WebsiteCampaignTemplateExcerpt[]>;
+    /**
+     * Create A New Campaign Template
+     */
+    createNewCampaignTemplate(websiteID: string, templateFormat: string, templateName: string): Promise<WebsiteCampaignTemplateNew>;
+    /**
+     * Check If Campaign Template Exists
+     */
+    checkCampaignTemplateExists(websiteID: string, templateID: string): Promise<any>;
+    /**
+     * Get A Campaign Template
+     */
+    getCampaignTemplate(websiteID: string, templateID: string): Promise<WebsiteCampaignTemplateItem>;
+    /**
+     * Save A Campaign Template
+     */
+    saveCampaignTemplate(websiteID: string, templateID: string, template: WebsiteCampaignTemplateItem): Promise<any>;
+    /**
+     * Update A Campaign Template
+     */
+    updateCampaignTemplate(websiteID: string, templateID: string, template: WebsiteCampaignTemplateItem): Promise<any>;
+    /**
+     * Remove A Campaign Template
+     */
+    removeCampaignTemplate(websiteID: string, templateID: string): Promise<any>;
+    /**
+     * Create A New Campaign
+     */
+    createNewCampaign(websiteID: string, campaignType: string, campaignName: string): Promise<any>;
+    /**
+     * Check If Campaign Exists
+     */
+    checkCampaignExists(websiteID: string, campaignID: string): Promise<any>;
+    /**
+     * Get A Campaign
+     */
+    getCampaign(websiteID: string, campaignID: string): Promise<WebsiteCampaignItem>;
+    /**
+     * Save A Campaign
+     */
+    saveCampaign(websiteID: string, campaignID: string, campaign: WebsiteCampaignItem): Promise<any>;
+    /**
+     * Update A Campaign
+     */
+    updateCampaign(websiteID: string, campaignID: string, campaign: WebsiteCampaignItem): Promise<any>;
+    /**
+     * Remove A Campaign
+     */
+    removeCampaign(websiteID: string, campaignID: string): Promise<any>;
+    /**
+     * Dispatch A Campaign
+     * @return {Promise}
+     */
+    dispatchCampaign(websiteID: string, campaignID: string): Promise<any>;
+    /**
+     * Resume A Campaign
+     */
+    resumeCampaign(websiteID: string, campaignID: string): Promise<any>;
+    /**
+     * Pause A Campaign
+     */
+    pauseCampaign(websiteID: string, campaignID: string): Promise<any>;
+    /**
+     * Test A Campaign
+     */
+    testCampaign(websiteID: string, campaignID: string): Promise<any>;
+    /**
+     * List Campaign Recipients
+     */
+    listCampaignRecipients(websiteID: string, campaignID: string, pageNumber?: number): Promise<WebsiteCampaignRecipient[]>;
+    /**
+     * List Campaign Statistics
+     */
+    listCampaignStatistics(websiteID: string, campaignID: string, action: string, pageNumber?: number): Promise<WebsiteCampaignStatistic[]>;
+}
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+export default WebsiteCampaign;