crisp-api 9.12.1 → 10.0.2

package/lib/resources/BucketURL.js

@@ -1,34 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Baptiste Jamin <baptiste@crisp.chat>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp BucketURL Resource
- * @class
- * @classdesc This is the Crisp Bucket URL Resource
- */
-function BucketURL(service, crisp) {
-  /**
-   * Generate Bucket URL
-   * @memberof BucketURL
-   * @public
-   * @method generateBucketURL
-   * @param {object} data
-   * @return {Promise}
-   */
-  service.generateBucketURL = function(data) {
-    return crisp.post(
-      crisp._prepareRestUrl(["bucket", "url", "generate"]), null, data
-    );
-  };
-}
-
-
-module.exports = BucketURL;

package/lib/resources/MediaAnimation.js

@@ -1,41 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Valerian Saliou <valerian@valeriansaliou.name>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp MediaAnimation Resource
- * @class
- * @classdesc This is the Crisp Media Animation Resource
- */
-function MediaAnimation(service, crisp) {
-  /**
-   * List Animation Medias
-   * @memberof MediaAnimation
-   * @public
-   * @method listAnimationMedias
-   * @param {number} pageNumber
-   * @param {string} listID
-   * @param {object} searchQuery
-   * @return {Promise}
-   */
-  service.listAnimationMedias = function(pageNumber, listID, searchQuery) {
-    return crisp.get(
-      crisp._prepareRestUrl(["media", "animation", "list", pageNumber]),
-
-      {
-        list_id      : listID,
-        search_query : searchQuery
-      }
-    );
-  };
-}
-
-
-module.exports = MediaAnimation;

package/lib/resources/PluginConnect.js

@@ -1,119 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Baptiste Jamin <baptiste@crisp.chat>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp PluginConnect Resource
- * @class
- * @classdesc This is the Crisp Plugin Connect Resource
- */
-function PluginConnect(service, crisp) {
-  /**
-   * Get Connect Account
-   * @memberof PluginConnect
-   * @public
-   * @method getConnectAccount
-   * @return {Promise}
-   */
-  service.getConnectAccount = function() {
-    return crisp.get(
-      crisp._prepareRestUrl(["plugin", "connect", "account"]), {}
-    );
-  };
-
-  /**
-   * Check Connect Session Validity
-   * @memberof PluginConnect
-   * @public
-   * @method checkConnectSessionValidity
-   * @return {Promise}
-   */
-  service.checkConnectSessionValidity = function() {
-    return crisp.head(
-      crisp._prepareRestUrl(["plugin", "connect", "session"]), {}
-    );
-  };
-
-  /**
-   * List All Connect Websites
-   * @memberof PluginConnect
-   * @public
-   * @method listAllConnectWebsites
-   * @param {number}  pageNumber
-   * @param {boolean} [filterConfigured]
-   * @return {Promise}
-   */
-  service.listAllConnectWebsites = function(
-    pageNumber, filterConfigured
-  ) {
-    // Generate query
-    var _query = {
-      filter_configured : (
-        (filterConfigured === true) ? "1" : "0"
-      )
-    };
-
-    return crisp.get(
-      crisp._prepareRestUrl([
-        "plugin", "connect", "websites", "all", pageNumber
-      ]),
-
-      _query
-    );
-  };
-
-  /**
-   * List Connect Websites Since
-   * @memberof PluginConnect
-   * @public
-   * @method listConnectWebsitesSince
-   * @param  {string}  [dateSince]
-   * @param  {boolean} [filterConfigured]
-   * @return {Promise}
-   */
-  service.listConnectWebsitesSince = function(
-    dateSince, filterConfigured
-  ) {
-    // Generate query
-    var _query = {
-      filter_configured : (
-        (filterConfigured === true) ? "1" : "0"
-      )
-    };
-
-    if (dateSince) {
-      _query.date_since = dateSince;
-    }
-
-    return crisp.get(
-      crisp._prepareRestUrl([
-        "plugin", "connect", "websites", "since"
-      ]),
-
-      _query
-    );
-  };
-
-  /**
-   * Get Connect Endpoints
-   * @memberof PluginConnect
-   * @public
-   * @method getConnectEndpoints
-   * @return {Promise}
-   */
-  service.getConnectEndpoints = function() {
-    return crisp.get(
-      crisp._prepareRestUrl(["plugin", "connect", "endpoints"]), {}
-    );
-  };
-}
-
-
-module.exports = PluginConnect;

package/lib/resources/PluginSubscription.js

@@ -1,234 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Baptiste Jamin <baptiste@crisp.chat>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp PluginSubscription Resource
- * @class
- * @classdesc This is the Crisp Plugin Subscription Resource
- */
-function PluginSubscription(service, crisp) {
-  /**
-   * List All Active Subscriptions
-   * @memberof PluginSubscription
-   * @public
-   * @method listAllActiveSubscriptions
-   * @return {Promise}
-   */
-  service.listAllActiveSubscriptions = function() {
-    return crisp.get(
-      crisp._prepareRestUrl(["plugins", "subscription"]), {}
-    );
-  };
-
-  /**
-   * List Subscriptions For A Website
-   * @memberof PluginSubscription
-   * @public
-   * @method listSubscriptionsForWebsite
-   * @param {string} websiteID
-   * @return {Promise}
-   */
-  service.listSubscriptionsForWebsite = function(websiteID) {
-    return crisp.get(
-      crisp._prepareRestUrl(["plugins", "subscription", websiteID]), {}
-    );
-  };
-
-  /**
-   * Get Subscription Details
-   * @memberof PluginSubscription
-   * @public
-   * @method getSubscriptionDetails
-   * @param {string} websiteID
-   * @param {string} pluginID
-   * @return {Promise}
-   */
-  service.getSubscriptionDetails = function(websiteID, pluginID) {
-    return crisp.get(
-      crisp._prepareRestUrl(["plugins", "subscription", websiteID, pluginID])
-    );
-  };
-
-  /**
-   * Subscribe Website To Plugin
-   * @memberof PluginSubscription
-   * @public
-   * @method subscribeWebsiteToPlugin
-   * @param {string} websiteID
-   * @param {string} pluginID
-   * @return {Promise}
-   */
-  service.subscribeWebsiteToPlugin = function(websiteID, pluginID) {
-    return crisp.post(
-      crisp._prepareRestUrl(["plugins", "subscription", websiteID]),
-
-      null,
-
-      {
-        plugin_id : pluginID
-      }
-    );
-  };
-
-  /**
-   * Unsubscribe Plugin From Website
-   * @memberof PluginSubscription
-   * @public
-   * @method unsubscribePluginFromWebsite
-   * @param {string} websiteID
-   * @param {string} pluginID
-   * @return {Promise}
-   */
-  service.unsubscribePluginFromWebsite = function(websiteID, pluginID) {
-    return crisp.delete(
-      crisp._prepareRestUrl(["plugins", "subscription", websiteID, pluginID])
-    );
-  };
-
-  /**
-   * Get Subscription Settings
-   * @memberof PluginSubscription
-   * @public
-   * @method getSubscriptionSettings
-   * @param {string} websiteID
-   * @param {string} pluginID
-   * @return {Promise}
-   */
-  service.getSubscriptionSettings = function(websiteID, pluginID) {
-    return crisp.get(
-      crisp._prepareRestUrl([
-        "plugins", "subscription", websiteID, pluginID, "settings"
-      ])
-    );
-  };
-
-  /**
-   * Save Subscription Settings
-   * @memberof PluginSubscription
-   * @public
-   * @method saveSubscriptionSettings
-   * @param {string} websiteID
-   * @param {string} pluginID
-   * @param {object} settings
-   * @return {Promise}
-   */
-  service.saveSubscriptionSettings = function(websiteID, pluginID, settings) {
-    return crisp.put(
-      crisp._prepareRestUrl([
-        "plugins", "subscription", websiteID, pluginID, "settings"
-      ]),
-
-      null, settings
-    );
-  };
-
-  /**
-   * Update Subscription Settings
-   * @memberof PluginSubscription
-   * @public
-   * @method updateSubscriptionSettings
-   * @param {string} websiteID
-   * @param {string} pluginID
-   * @param {object} settings
-   * @return {Promise}
-   */
-  service.updateSubscriptionSettings = function(websiteID, pluginID, settings) {
-    return crisp.patch(
-      crisp._prepareRestUrl([
-        "plugins", "subscription", websiteID, pluginID, "settings"
-      ]),
-
-      null, settings
-    );
-  };
-
-  /**
-   * Get Plugin Usage Bills
-   * @memberof PluginSubscription
-   * @public
-   * @method getPluginUsageBills
-   * @param {string} websiteID
-   * @param {string} pluginID
-   * @return {Promise}
-   */
-  service.getPluginUsageBills = function(websiteID, pluginID) {
-    return crisp.get(
-      crisp._prepareRestUrl([
-        "plugins", "subscription", websiteID, pluginID, "bill", "usage"
-      ])
-    );
-  };
-
-  /**
-   * Report Plugin Usage To Bill
-   * @memberof PluginSubscription
-   * @public
-   * @method reportPluginUsageToBill
-   * @param {string} websiteID
-   * @param {string} pluginID
-   * @param {object} usage
-   * @return {Promise}
-   */
-  service.reportPluginUsageToBill = function(websiteID, pluginID, usage) {
-    return crisp.post(
-      crisp._prepareRestUrl([
-        "plugins", "subscription", websiteID, pluginID, "bill", "usage"
-      ]),
-
-      null, usage
-    );
-  };
-
-  /**
-   * Forward Plugin Payload To Channel
-   * @memberof PluginSubscription
-   * @public
-   * @method forwardPluginPayloadToChannel
-   * @param {string} websiteID
-   * @param {string} pluginID
-   * @param {object} payload
-   * @return {Promise}
-   */
-  service.forwardPluginPayloadToChannel = function(
-    websiteID, pluginID, payload
-  ) {
-    return crisp.post(
-      crisp._prepareRestUrl([
-        "plugins", "subscription", websiteID, pluginID, "channel"
-      ]),
-
-      null, payload
-    );
-  };
-
-  /**
-   * Dispatch Plugin Event
-   * @memberof PluginSubscription
-   * @public
-   * @method dispatchPluginEvent
-   * @param {string} websiteID
-   * @param {string} pluginID
-   * @param {object} payload
-   * @return {Promise}
-   */
-  service.dispatchPluginEvent = function(websiteID, pluginID, payload) {
-    return crisp.post(
-      crisp._prepareRestUrl([
-        "plugins", "subscription", websiteID, pluginID, "event"
-      ]),
-
-      null, payload
-    );
-  };
-}
-
-
-module.exports = PluginSubscription;

package/lib/resources/WebsiteAnalytics.js

@@ -1,37 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Valerian Saliou <valerian@valeriansaliou.name>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp WebsiteAnalytics Resource
- * @class
- * @classdesc This is the Crisp Website Analytics Resource
- */
-function WebsiteAnalytics(service, crisp) {
-  /**
-   * Generate Analytics
-   * @memberof WebsiteAnalytics
-   * @public
-   * @method generateAnalytics
-   * @param {string} websiteID
-   * @param {object} query
-   * @return {Promise}
-   */
-  service.generateAnalytics = function(websiteID, query) {
-    return crisp.post(
-      crisp._prepareRestUrl(["website", websiteID, "analytics", "generate"]),
-
-      null, query
-    );
-  };
-}
-
-
-module.exports = WebsiteAnalytics;

package/lib/resources/WebsiteAvailability.js

@@ -1,48 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Valerian Saliou <valerian@valeriansaliou.name>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp WebsiteAvailability Resource
- * @class
- * @classdesc This is the Crisp Website Availability Resource
- */
-function WebsiteAvailability(service, crisp) {
-  /**
-   * Get Website Availability Status
-   * @memberof WebsiteAvailability
-   * @public
-   * @method getWebsiteAvailabilityStatus
-   * @param {string} websiteID
-   * @return {Promise}
-   */
-  service.getWebsiteAvailabilityStatus = function(websiteID) {
-    return crisp.get(
-      crisp._prepareRestUrl(["website", websiteID, "availability", "status"])
-    );
-  };
-
-  /**
-   * List Website Operator Availabilities
-   * @memberof WebsiteAvailability
-   * @public
-   * @method listWebsiteOperatorAvailabilities
-   * @param {string} websiteID
-   * @return {Promise}
-   */
-  service.listWebsiteOperatorAvailabilities = function(websiteID) {
-    return crisp.get(
-      crisp._prepareRestUrl(["website", websiteID, "availability", "operators"])
-    );
-  };
-}
-
-
-module.exports = WebsiteAvailability;

package/lib/resources/WebsiteBase.js

@@ -1,100 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Baptiste Jamin <baptiste@crisp.chat>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp WebsiteBase Resource
- * @class
- * @classdesc This is the Crisp Website Base Resource
- */
-function WebsiteBase(service, crisp) {
-  /**
-   * Check If Website Exists
-   * @memberof WebsiteBase
-   * @public
-   * @method checkWebsiteExists
-   * @param {string} domain
-   * @return {Promise}
-   */
-  service.checkWebsiteExists = function(domain) {
-    return crisp.head(
-      crisp._prepareRestUrl(["website"]),
-
-      {
-        domain : domain
-      }
-    );
-  };
-
-  /**
-   * Create Website
-   * @memberof WebsiteBase
-   * @public
-   * @method createWebsite
-   * @param {object} websiteData
-   * @return {Promise}
-   */
-  service.createWebsite = function(websiteData) {
-    return crisp.post(
-      crisp._prepareRestUrl(["website"]), null, websiteData
-    );
-  };
-
-  /**
-   * Get A Website
-   * @memberof WebsiteBase
-   * @public
-   * @method getWebsite
-   * @param {string} websiteID
-   * @return {Promise}
-   */
-  service.getWebsite = function(websiteID) {
-    return crisp.get(
-      crisp._prepareRestUrl(["website", websiteID])
-    );
-  };
-
-  /**
-   * Delete A Website
-   * @memberof WebsiteBase
-   * @public
-   * @method deleteWebsite
-   * @param {string} websiteID
-   * @param {object} verify
-   * @return {Promise}
-   */
-  service.deleteWebsite = function(websiteID, verify) {
-    return crisp.delete(
-      crisp._prepareRestUrl(["website", websiteID]), null,
-
-      {
-        verify : verify
-      }
-    );
-  };
-
-  /**
-   * Abort Website Deletion
-   * @memberof WebsiteBase
-   * @public
-   * @method abortWebsiteDeletion
-   * @param {string} websiteID
-   * @return {Promise}
-   */
-  service.abortWebsiteDeletion = function(websiteID) {
-    return crisp.delete(
-      crisp._prepareRestUrl(["website", websiteID, "expunge"])
-    );
-  };
-}
-
-
-module.exports = WebsiteBase;
-

package/lib/resources/WebsiteBatch.js

@@ -1,92 +0,0 @@
-/*
- * node-crisp-api
- *
- * Copyright 2022, Crisp IM SAS
- * Author: Valerian Saliou <valerian@valeriansaliou.name>
- */
-
-
-"use strict";
-
-
-/**
- * Crisp WebsiteBatch Resource
- * @class
- * @classdesc This is the Crisp Website Batch Resource
- */
-function WebsiteBatch(service, crisp) {
-  /**
-   * Batch Resolve Conversations
-   * @memberof WebsiteBatch
-   * @public
-   * @method batchResolveConversations
-   * @param {string} websiteID
-   * @param {object} operation
-   * @return {Promise}
-   */
-  service.batchResolveConversations = function(websiteID, operation) {
-    return crisp.patch(
-      crisp._prepareRestUrl(["website", websiteID, "batch", "resolve"]),
-
-      null, operation
-    );
-  };
-
-  /**
-   * Batch Read Conversations
-   * @memberof WebsiteBatch
-   * @public
-   * @method batchReadConversations
-   * @param {string} websiteID
-   * @param {object} operation
-   * @return {Promise}
-   */
-  service.batchReadConversations = function(websiteID, operation) {
-    return crisp.patch(
-      crisp._prepareRestUrl(["website", websiteID, "batch", "read"]),
-
-      null, operation
-    );
-  };
-
-  /**
-   * Batch Remove Conversations
-   * @memberof WebsiteBatch
-   * @public
-   * @method batchRemoveConversations
-   * @param {string} websiteID
-   * @param {object} operation
-   * @return {Promise}
-   */
-  service.batchRemoveConversations = function(websiteID, operation) {
-    return crisp.patch(
-      crisp._prepareRestUrl(["website", websiteID, "batch", "remove"]),
-
-      null, operation
-    );
-  };
-
-  /**
-   * Batch Remove People
-   * @memberof WebsiteBatch
-   * @public
-   * @method batchRemovePeople
-   * @param {string} websiteID
-   * @param {object} people
-   * @return {Promise}
-   */
-  service.batchRemovePeople = function(websiteID, people) {
-    return crisp.patch(
-      crisp._prepareRestUrl(["website", websiteID, "batch", "remove"]),
-
-      null,
-
-      {
-        people : people
-      }
-    );
-  };
-}
-
-
-module.exports = WebsiteBatch;