crisp-api 9.13.0 → 10.0.2

package/lib/resources/WebsiteVerify.js

@@ -1,79 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Valerian Saliou <valerian@valeriansaliou.name>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp WebsiteVerify Resource
- * @class
- * @classdesc This is the Crisp Website Verify Resource
- */
-function WebsiteVerify(service, crisp) {
-  /**
-   * Get Verify Settings
-   * @memberof WebsiteVerify
-   * @public
-   * @method getVerifySettings
-   * @param {string} websiteID
-   * @return {Promise}
-   */
-  service.getVerifySettings = function(websiteID) {
-    return crisp.get(
-      crisp._prepareRestUrl(["website", websiteID, "verify", "settings"])
-    );
-  };
-
-  /**
-   * Update Verify Settings
-   * @memberof WebsiteVerify
-   * @public
-   * @method updateVerifySettings
-   * @param {string} websiteID
-   * @param {object} settings
-   * @return {Promise}
-   */
-  service.updateVerifySettings = function(websiteID, settings) {
-    return crisp.patch(
-      crisp._prepareRestUrl(["website", websiteID, "verify", "settings"]),
-
-      null, settings
-    );
-  };
-
-  /**
-   * Get Verify Key
-   * @memberof WebsiteVerify
-   * @public
-   * @method getVerifyKey
-   * @param {string} websiteID
-   * @return {Promise}
-   */
-  service.getVerifyKey = function(websiteID) {
-    return crisp.get(
-      crisp._prepareRestUrl(["website", websiteID, "verify", "key"])
-    );
-  };
-
-  /**
-   * Roll Verify Key
-   * @memberof WebsiteVerify
-   * @public
-   * @method rollVerifyKey
-   * @param {string} websiteID
-   * @return {Promise}
-   */
-  service.rollVerifyKey = function(websiteID) {
-    return crisp.post(
-      crisp._prepareRestUrl(["website", websiteID, "verify", "key"])
-    );
-  };
-}
-
-
-module.exports = WebsiteVerify;

package/lib/resources/WebsiteVisitors.js

@@ -1,148 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Valerian Saliou <valerian@valeriansaliou.name>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp WebsiteVisitors Resource
- * @class
- * @classdesc This is the Crisp Website Visitors Resource
- */
-function WebsiteVisitors(service, crisp) {
-  /**
-   * Count Visitors
-   * @memberof WebsiteVisitors
-   * @public
-   * @method countVisitors
-   * @param {string} websiteID
-   * @return {Promise}
-   */
-  service.countVisitors = function(websiteID) {
-    return crisp.get(
-      crisp._prepareRestUrl(["website", websiteID, "visitors", "count"])
-    );
-  };
-
-  /**
-   * List Visitors
-   * @memberof WebsiteVisitors
-   * @public
-   * @method listVisitors
-   * @param {string} websiteID
-   * @param {number} pageNumber
-   * @return {Promise}
-   */
-  service.listVisitors = function(websiteID, pageNumber) {
-    return crisp.get(
-      crisp._prepareRestUrl([
-        "website", websiteID, "visitors", "list", pageNumber
-      ])
-    );
-  };
-
-  /**
-   * Pinpoint Visitors On A Map
-   * @memberof WebsiteVisitors
-   * @public
-   * @method pinpointVisitorsOnMap
-   * @param {string} websiteID
-   * @param {number} [centerLongitude]
-   * @param {number} [centerLatitude]
-   * @param {number} [centerRadius]
-   * @return {Promise}
-   */
-  service.pinpointVisitorsOnMap = function(
-    websiteID, centerLongitude, centerLatitude, centerRadius
-  ) {
-    // Generate query
-    var _query = {};
-
-    if (typeof centerLongitude === "number") {
-      _query.center_longitude = ("" + centerLongitude);
-    }
-    if (typeof centerLatitude === "number") {
-      _query.center_latitude = ("" + centerLatitude);
-    }
-    if (typeof centerRadius === "number") {
-      _query.center_radius = ("" + centerRadius);
-    }
-
-    return crisp.get(
-      crisp._prepareRestUrl([
-        "website", websiteID, "visitors", "map"
-      ]),
-
-      _query
-    );
-  };
-
-  /**
-   * Get Session Identifier From Token
-   * @memberof WebsiteVisitors
-   * @public
-   * @method getSessionIdentifierFromToken
-   * @param {string} websiteID
-   * @param {string} tokenID
-   * @return {Promise}
-   */
-  service.getSessionIdentifierFromToken = function(websiteID, tokenID) {
-    return crisp.get(
-      crisp._prepareRestUrl([
-        "website", websiteID, "visitors", "token", tokenID
-      ])
-    );
-  };
-
-  /**
-   * Count Blocked Visitors
-   * @memberof WebsiteVisitors
-   * @public
-   * @method countBlockedVisitors
-   * @param {string} websiteID
-   * @return {Promise}
-   */
-  service.countBlockedVisitors = function(websiteID) {
-    return crisp.get(
-      crisp._prepareRestUrl(["website", websiteID, "visitors", "blocked"])
-    );
-  };
-
-  /**
-   * Count Blocked Visitors In Rule
-   * @memberof WebsiteVisitors
-   * @public
-   * @method countBlockedVisitorsInRule
-   * @param {string} websiteID
-   * @param {string} rule
-   * @return {Promise}
-   */
-  service.countBlockedVisitorsInRule = function(websiteID, rule) {
-    return crisp.get(
-      crisp._prepareRestUrl(["website", websiteID, "visitors", "blocked", rule])
-    );
-  };
-
-  /**
-   * Clear Blocked Visitors In Rule
-   * @memberof WebsiteVisitors
-   * @public
-   * @method clearBlockedVisitorsInRule
-   * @param {string} websiteID
-   * @param {string} rule
-   * @return {Promise}
-   */
-  service.clearBlockedVisitorsInRule = function(websiteID, rule) {
-    return crisp.delete(
-      crisp._prepareRestUrl(["website", websiteID, "visitors", "blocked", rule])
-    );
-  };
-}
-
-
-module.exports = WebsiteVisitors;

package/lib/services/Bucket.js

@@ -1,28 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Baptiste Jamin <baptiste@crisp.chat>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp Bucket Service
- * @class
- * @classdesc This is the Crisp Bucket Service
- */
-function Bucket() {
-  /**
-   * @private
-   * @type {Array}
-  */
-  this._resources = [
-    "BucketURL"
-  ];
-}
-
-
-module.exports = Bucket;

package/lib/services/Media.js

@@ -1,28 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Baptiste Jamin <baptiste@crisp.chat>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp Media Service
- * @class
- * @classdesc This is the Crisp Media Service
- */
-function Media() {
-  /**
-   * @private
-   * @type {Array}
-  */
-  this._resources = [
-    "MediaAnimation"
-  ];
-}
-
-
-module.exports = Media;

package/lib/services/Plugin.js

@@ -1,29 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Baptiste Jamin <baptiste@crisp.chat>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp Plugin Service
- * @class
- * @classdesc This is the Crisp Plugin Service
- */
-function Plugin() {
-  /**
-   * @private
-   * @type {Array}
-  */
-  this._resources = [
-    "PluginConnect",
-    "PluginSubscription"
-  ];
-}
-
-
-module.exports = Plugin;

package/lib/services/Website.js

@@ -1,39 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Baptiste Jamin <baptiste@crisp.chat>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp Website Service
- * @class
- * @classdesc This is the Crisp Website Service
- */
-function Website() {
-  /**
-   * @private
-   * @type {Array}
-  */
-  this._resources = [
-    "WebsiteBase",
-    "WebsiteAnalytics",
-    "WebsiteAvailability",
-    "WebsiteBatch",
-    "WebsiteCampaign",
-    "WebsiteConversation",
-    "WebsiteOperator",
-    "WebsitePeople",
-    "WebsiteHelpdesk",
-    "WebsiteSettings",
-    "WebsiteVerify",
-    "WebsiteVisitors"
-  ];
-}
-
-
-module.exports = Website;

package/types/crisp.d.ts

@@ -1,151 +0,0 @@
-export = Crisp;
-/**
- * Crisp API Library
- * @class
- * @classdesc This is the Crisp Library. Handles REST and RTM operations
- */
-declare function Crisp(): void;
-declare class Crisp {
-    /**
-     * @public
-     * @type {*}
-    */
-    public bucket: any;
-    /**
-     * @public
-     * @type {*}
-    */
-    public media: any;
-    /**
-     * @public
-     * @type {*}
-    */
-    public plugin: any;
-    /**
-     * @public
-     * @type {*}
-    */
-    public website: any;
-    /**
-     * @public
-     * @type {object}
-    */
-    public auth: object;
-    /**
-     * @private
-     * @type {object}
-    */
-    private _rest;
-    /**
-     * @private
-     * @type {object}
-    */
-    private _rtm;
-    /**
-     * @private
-     * @type {string}
-    */
-    private _useragent;
-    /**
-     * @private
-     * @type {object}
-    */
-    private _emitter;
-    /**
-     * @private
-     * @type {object|null}
-    */
-    private _socket;
-    /**
-     * @private
-     * @type {object|null}
-    */
-    private _loopback;
-    /**
-     * @private
-     * @type {number|null}
-    */
-    private _lastEventRebind;
-    /**
-     * @private
-     * @type {object|null}
-    */
-    private _brokerScheduler;
-    /**
-     * @private
-     * @type {Array}
-    */
-    private _brokerBindHooks;
-    /**
-     * @private
-     * @type {object}
-    */
-    private _boundEvents;
-    setRestHost: (host: string) => undefined;
-    setRtmHost: (host: string) => undefined;
-    setRtmMode: (mode: string) => undefined;
-    setTier: (tier: string) => undefined;
-    authenticate: (identifier: string, key: string) => undefined;
-    authenticateTier: (tier: string, identifier: string, key: string) => undefined;
-    head: (resource: string, query: object, body: object) => Promise<any>;
-    get: (resource: string, query: object) => Promise<any>;
-    post: (resource: string, query: object, body: object) => Promise<any>;
-    patch: (resource: string, query: object, body: object) => Promise<any>;
-    put: (resource: string, query: object, body: object) => Promise<any>;
-    delete: (resource: string, query: object, body: object) => Promise<any>;
-    on: (event: string, callback: Function) => Promise<any>;
-    receiveHook: (body: object) => undefined;
-    verifyHook: (secret: string, body: object, timestamp: string, signature: string) => boolean;
-    verifyWidget: (secret: string, body: object, timestamp: string, signature: string) => boolean;
-    rebindSocket: () => Promise<any>;
-    _prepareRestUrl: (paths: any[]) => string;
-    _prepareServices: () => undefined;
-    _prepareResources: (serviceMap: object, resources: any[]) => undefined;
-    _prepareBroker: (fnBindHook: Function) => Promise<any>;
-    _connectLoopback: () => Promise<any>;
-    _connectSocket: (rtmHostOverride: string) => Promise<any>;
-    _emitAuthenticateSocket: () => undefined;
-    _unstackBrokerBindHooks: (modeInstance: object) => undefined;
-    _request: (resource: string, method: string, query: object, body: object, resolve: Function, reject: Function) => undefined;
-    _readErrorResponseReason: (method: string, statusCode: number, response: object) => string;
-    _verifySignature: (secret: string, body: object, timestamp: string, signature: string) => boolean;
-}
-
-declare namespace RTM_MODES {
-    let WebSockets: string;
-    let WebHooks: string;
-}
-
-declare namespace Crisp {
-    import DEFAULT_RTM_MODE = RTM_MODES.WebSockets;
-
-    export {
-        RTM_MODES,
-        AVAILABLE_RTM_MODES,
-        DEFAULT_REQUEST_TIMEOUT,
-        DEFAULT_SOCKET_TIMEOUT,
-        DEFAULT_SOCKET_RECONNECT_DELAY,
-        DEFAULT_SOCKET_RECONNECT_DELAY_MAX,
-        DEFAULT_SOCKET_RECONNECT_FACTOR,
-        DEFAULT_BROKER_SCHEDULE,
-        DEFAULT_EVENT_REBIND_INTERVAL_MIN,
-        DEFAULT_USERAGENT_PREFIX,
-        DEFAULT_REST_HOST,
-        DEFAULT_REST_BASE_PATH,
-        DEFAULT_RTM_MODE,
-        DEFAULT_RTM_EVENTS, Crisp
-    };
-}
-
-declare var AVAILABLE_RTM_MODES: string[];
-declare var DEFAULT_REQUEST_TIMEOUT: number;
-declare var DEFAULT_SOCKET_TIMEOUT: number;
-declare var DEFAULT_SOCKET_RECONNECT_DELAY: number;
-declare var DEFAULT_SOCKET_RECONNECT_DELAY_MAX: number;
-declare var DEFAULT_SOCKET_RECONNECT_FACTOR: number;
-declare var DEFAULT_BROKER_SCHEDULE: number;
-declare var DEFAULT_EVENT_REBIND_INTERVAL_MIN: number;
-declare var DEFAULT_USERAGENT_PREFIX: string;
-declare var DEFAULT_REST_HOST: string;
-declare var DEFAULT_REST_BASE_PATH: string;
-declare var DEFAULT_RTM_EVENTS: string[];

package/types/resources/BucketURL.d.ts

@@ -1,15 +0,0 @@
-export = BucketURL;
-/**
- * Crisp BucketURL Resource
- * @class
- * @classdesc This is the Crisp Bucket URL Resource
- */
-declare function BucketURL(service: any, crisp: any): void;
-declare class BucketURL {
-    /**
-     * Crisp BucketURL Resource
-     * @class
-     * @classdesc This is the Crisp Bucket URL Resource
-     */
-    constructor(service: any, crisp: any);
-}

package/types/resources/MediaAnimation.d.ts

@@ -1,15 +0,0 @@
-export = MediaAnimation;
-/**
- * Crisp MediaAnimation Resource
- * @class
- * @classdesc This is the Crisp Media Animation Resource
- */
-declare function MediaAnimation(service: any, crisp: any): void;
-declare class MediaAnimation {
-    /**
-     * Crisp MediaAnimation Resource
-     * @class
-     * @classdesc This is the Crisp Media Animation Resource
-     */
-    constructor(service: any, crisp: any);
-}

package/types/resources/PluginConnect.d.ts

@@ -1,15 +0,0 @@
-export = PluginConnect;
-/**
- * Crisp PluginConnect Resource
- * @class
- * @classdesc This is the Crisp Plugin Connect Resource
- */
-declare function PluginConnect(service: any, crisp: any): void;
-declare class PluginConnect {
-    /**
-     * Crisp PluginConnect Resource
-     * @class
-     * @classdesc This is the Crisp Plugin Connect Resource
-     */
-    constructor(service: any, crisp: any);
-}

package/types/resources/PluginSubscription.d.ts

@@ -1,15 +0,0 @@
-export = PluginSubscription;
-/**
- * Crisp PluginSubscription Resource
- * @class
- * @classdesc This is the Crisp Plugin Subscription Resource
- */
-declare function PluginSubscription(service: any, crisp: any): void;
-declare class PluginSubscription {
-    /**
-     * Crisp PluginSubscription Resource
-     * @class
-     * @classdesc This is the Crisp Plugin Subscription Resource
-     */
-    constructor(service: any, crisp: any);
-}

package/types/resources/WebsiteAnalytics.d.ts

@@ -1,15 +0,0 @@
-export = WebsiteAnalytics;
-/**
- * Crisp WebsiteAnalytics Resource
- * @class
- * @classdesc This is the Crisp Website Analytics Resource
- */
-declare function WebsiteAnalytics(service: any, crisp: any): void;
-declare class WebsiteAnalytics {
-    /**
-     * Crisp WebsiteAnalytics Resource
-     * @class
-     * @classdesc This is the Crisp Website Analytics Resource
-     */
-    constructor(service: any, crisp: any);
-}

package/types/resources/WebsiteAvailability.d.ts

@@ -1,15 +0,0 @@
-export = WebsiteAvailability;
-/**
- * Crisp WebsiteAvailability Resource
- * @class
- * @classdesc This is the Crisp Website Availability Resource
- */
-declare function WebsiteAvailability(service: any, crisp: any): void;
-declare class WebsiteAvailability {
-    /**
-     * Crisp WebsiteAvailability Resource
-     * @class
-     * @classdesc This is the Crisp Website Availability Resource
-     */
-    constructor(service: any, crisp: any);
-}

package/types/resources/WebsiteBase.d.ts

@@ -1,15 +0,0 @@
-export = WebsiteBase;
-/**
- * Crisp WebsiteBase Resource
- * @class
- * @classdesc This is the Crisp Website Base Resource
- */
-declare function WebsiteBase(service: any, crisp: any): void;
-declare class WebsiteBase {
-    /**
-     * Crisp WebsiteBase Resource
-     * @class
-     * @classdesc This is the Crisp Website Base Resource
-     */
-    constructor(service: any, crisp: any);
-}

package/types/resources/WebsiteBatch.d.ts

@@ -1,15 +0,0 @@
-export = WebsiteBatch;
-/**
- * Crisp WebsiteBatch Resource
- * @class
- * @classdesc This is the Crisp Website Batch Resource
- */
-declare function WebsiteBatch(service: any, crisp: any): void;
-declare class WebsiteBatch {
-    /**
-     * Crisp WebsiteBatch Resource
-     * @class
-     * @classdesc This is the Crisp Website Batch Resource
-     */
-    constructor(service: any, crisp: any);
-}

package/types/resources/WebsiteCampaign.d.ts

@@ -1,15 +0,0 @@
-export = WebsiteCampaign;
-/**
- * Crisp WebsiteCampaign Resource
- * @class
- * @classdesc This is the Crisp Website Campaign Resource
- */
-declare function WebsiteCampaign(service: any, crisp: any): void;
-declare class WebsiteCampaign {
-    /**
-     * Crisp WebsiteCampaign Resource
-     * @class
-     * @classdesc This is the Crisp Website Campaign Resource
-     */
-    constructor(service: any, crisp: any);
-}

package/types/resources/WebsiteConversation.d.ts

@@ -1,15 +0,0 @@
-export = WebsiteConversation;
-/**
- * Crisp WebsiteConversation Resource
- * @class
- * @classdesc This is the Crisp Website Conversation Resource
- */
-declare function WebsiteConversation(service: any, crisp: any): void;
-declare class WebsiteConversation {
-    /**
-     * Crisp WebsiteConversation Resource
-     * @class
-     * @classdesc This is the Crisp Website Conversation Resource
-     */
-    constructor(service: any, crisp: any);
-}

package/types/resources/WebsiteHelpdesk.d.ts

@@ -1,15 +0,0 @@
-export = WebsiteHelpdesk;
-/**
- * Crisp WebsiteHelpdesk Resource
- * @class
- * @classdesc This is the Crisp Website Helpdesk Resource
- */
-declare function WebsiteHelpdesk(service: any, crisp: any): void;
-declare class WebsiteHelpdesk {
-    /**
-     * Crisp WebsiteHelpdesk Resource
-     * @class
-     * @classdesc This is the Crisp Website Helpdesk Resource
-     */
-    constructor(service: any, crisp: any);
-}