crisp-api 10.0.2 → 10.0.4

package/lib/resources/MediaAnimation.ts

@@ -12,6 +12,10 @@
 // PROJECT: RESOURCES
 import BaseResource from "./BaseResource";
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp MediaAnimation Resource
  */
@@ -21,7 +25,9 @@ class MediaAnimation extends BaseResource {
    */
   listAnimationMedias(pageNumber: number, listID: string, searchQuery: object) {
     return this.crisp.get(
-      this.crisp.prepareRestUrl(["media", "animation", "list", String(pageNumber)]),
+      this.crisp.prepareRestUrl([
+        "media", "animation", "list", String(pageNumber)
+      ]),
 
       {
         list_id: listID,
@@ -31,4 +37,8 @@ class MediaAnimation extends BaseResource {
   };
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export default MediaAnimation;

package/lib/resources/PluginConnect.ts

@@ -12,19 +12,20 @@
 // PROJECT: RESOURCES
 import BaseResource from "./BaseResource";
 
-// PluginConnectAccount mapping
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
+
 export type PluginConnectAccount = {
   plugin_id?: string;
 };
 
-// PluginConnectAllWebsites mapping
 export type PluginConnectAllWebsites = {
   website_id?: string;
   token?: string;
   settings?: object;
 }
 
-// PluginConnectWebsitesSince mapping
 export type PluginConnectWebsitesSince = {
   website_id?: string;
   token?: string;
@@ -32,16 +33,18 @@ export type PluginConnectWebsitesSince = {
   difference?: string;
 }
 
-// PluginConnectEndpoints mapping
 export type PluginConnectEndpoints = {
   socket?: PluginConnectEndpointsSocket;
 }
 
-// PluginConnectEndpointsSocket mapping
 export type PluginConnectEndpointsSocket = {
   app?: string;
 }
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp PluginConnect Resource
  */
@@ -125,4 +128,8 @@ class PluginConnect extends BaseResource {
   };
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export default PluginConnect;

package/lib/resources/PluginSubscription.ts

@@ -12,6 +12,10 @@
 // PROJECT: RESOURCES
 import BaseResource from "./BaseResource";
 
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
+
 type PluginSubscription = {
   id?:            string;
   urn?:           string;
@@ -62,6 +66,10 @@ type PluginSubscriptionEventDispatch = {
   data?:   object;
 }
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp PluginSubscription Resource
  */
@@ -78,7 +86,9 @@ class PluginSubscriptionService extends BaseResource {
   /**
    * List Subscriptions For A Website
    */
-  listSubscriptionsForWebsite(websiteID: string) : Promise<PluginSubscription[]> {
+  listSubscriptionsForWebsite(
+    websiteID: string
+  ): Promise<PluginSubscription[]> {
     return this.crisp.get(
       this.crisp.prepareRestUrl(["plugins", "subscription", websiteID])
     );
@@ -87,7 +97,9 @@ class PluginSubscriptionService extends BaseResource {
   /**
    * Get Subscription Details
    */
-  getSubscriptionDetails(websiteID: string, pluginID: string) : Promise<PluginSubscription> {
+  getSubscriptionDetails(
+    websiteID: string, pluginID: string
+  ): Promise<PluginSubscription> {
     return this.crisp.get(
       this.crisp.prepareRestUrl(["plugins", "subscription", websiteID, pluginID])
     );
@@ -113,14 +125,18 @@ class PluginSubscriptionService extends BaseResource {
    */
   unsubscribePluginFromWebsite(websiteID: string, pluginID: string) {
     return this.crisp.delete(
-      this.crisp.prepareRestUrl(["plugins", "subscription", websiteID, pluginID])
+      this.crisp.prepareRestUrl([
+        "plugins", "subscription", websiteID, pluginID
+      ])
     );
   };
 
   /**
    * Get Subscription Settings
    */
-  getSubscriptionSettings(websiteID: string, pluginID: string) : Promise<PluginSubscriptionSettings> {
+  getSubscriptionSettings(
+    websiteID: string, pluginID: string
+  ): Promise<PluginSubscriptionSettings> {
     return this.crisp.get(
       this.crisp.prepareRestUrl([
         "plugins", "subscription", websiteID, pluginID, "settings"
@@ -131,7 +147,9 @@ class PluginSubscriptionService extends BaseResource {
   /**
    * Save Subscription Settings
    */
-  saveSubscriptionSettings(websiteID: string, pluginID: string, settings: object) {
+  saveSubscriptionSettings(
+    websiteID: string, pluginID: string, settings: object
+  ) {
     return this.crisp.put(
       this.crisp.prepareRestUrl([
         "plugins", "subscription", websiteID, pluginID, "settings"
@@ -144,7 +162,9 @@ class PluginSubscriptionService extends BaseResource {
   /**
    * Update Subscription Settings
    */
-  updateSubscriptionSettings(websiteID: string, pluginID: string, settings: object) {
+  updateSubscriptionSettings(
+    websiteID: string, pluginID: string, settings: object
+  ) {
     return this.crisp.patch(
       this.crisp.prepareRestUrl([
         "plugins", "subscription", websiteID, pluginID, "settings"
@@ -181,7 +201,9 @@ class PluginSubscriptionService extends BaseResource {
   /**
    * Forward Plugin Payload To Channel
    */
-  forwardPluginPayloadToChannel(websiteID: string, pluginID: string, payload: PluginSubscriptionChannelForward) {
+  forwardPluginPayloadToChannel(
+    websiteID: string, pluginID: string, payload: PluginSubscriptionChannelForward
+  ) {
     return this.crisp.post(
       this.crisp.prepareRestUrl([
         "plugins", "subscription", websiteID, pluginID, "channel"
@@ -194,7 +216,9 @@ class PluginSubscriptionService extends BaseResource {
   /**
    * Dispatch Plugin Event
    */
-  dispatchPluginEvent(websiteID: string, pluginID: string, payload: PluginSubscriptionEventDispatch) {
+  dispatchPluginEvent(
+    websiteID: string, pluginID: string, payload: PluginSubscriptionEventDispatch
+  ) {
     return this.crisp.post(
       this.crisp.prepareRestUrl([
         "plugins", "subscription", websiteID, pluginID, "event"
@@ -205,4 +229,8 @@ class PluginSubscriptionService extends BaseResource {
   };
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export default PluginSubscriptionService;

package/lib/resources/WebsiteAnalytics.ts

@@ -12,6 +12,10 @@
 // PROJECT: RESOURCES
 import BaseResource from "./BaseResource";
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp WebsiteAnalytics Resource
  */
@@ -21,11 +25,17 @@ class WebsiteAnalytics extends BaseResource {
    */
   generateAnalytics(websiteID: string, query: object) {
     return this.crisp.post(
-      this.crisp.prepareRestUrl(["website", websiteID, "analytics", "generate"]),
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "analytics", "generate"
+      ]),
 
       null, query
     );
   };
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export default WebsiteAnalytics;

package/lib/resources/WebsiteAvailability.ts

@@ -12,6 +12,10 @@
 // PROJECT: RESOURCES
 import BaseResource from "./BaseResource";
 
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
+
 type WebsiteAvailabilityStatus = {
   status?:  string;
   since?:   number;
@@ -28,6 +32,10 @@ type WebsiteAvailabilityOperatorTime = {
   since?: number;
 }
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp WebsiteAvailability Resource
  */
@@ -35,20 +43,32 @@ class WebsiteAvailability extends BaseResource {
   /**
    * Get Website Availability Status
    */
-  getWebsiteAvailabilityStatus(websiteID: string) : Promise<WebsiteAvailabilityStatus> {
+  getWebsiteAvailabilityStatus(
+    websiteID: string
+  ): Promise<WebsiteAvailabilityStatus> {
     return this.crisp.get(
-      this.crisp.prepareRestUrl(["website", websiteID, "availability", "status"])
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "availability", "status"
+      ])
     );
   };
 
   /**
    * List Website Operator Availabilities
    */
-  listWebsiteOperatorAvailabilities(websiteID: string) : Promise<WebsiteAvailabilityOperator[]> {
+  listWebsiteOperatorAvailabilities(
+    websiteID: string
+  ): Promise<WebsiteAvailabilityOperator[]> {
     return this.crisp.get(
-      this.crisp.prepareRestUrl(["website", websiteID, "availability", "operators"])
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "availability", "operators"
+      ])
     );
   };
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export default WebsiteAvailability;

package/lib/resources/WebsiteBase.ts

@@ -12,7 +12,10 @@
 // PROJECT: RESOURCES
 import BaseResource from "./BaseResource";
 
-// Website mapping
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
+
 type Website = {
   website_id?:  string;
   name?:        string;
@@ -37,6 +40,10 @@ export type WebsiteFilter = {
   query?:      Record<string, unknown>;
 }
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp WebsiteBase Resource
  */
@@ -62,7 +69,7 @@ class WebsiteBase extends BaseResource {
   /**
    * Create Website
    */
-  createWebsite(websiteData: WebsiteCreate) : Promise<Website> {
+  createWebsite(websiteData: WebsiteCreate): Promise<Website> {
     return this.crisp.post(
       this.crisp.prepareRestUrl(["website"]), null, websiteData
     );
@@ -76,7 +83,7 @@ class WebsiteBase extends BaseResource {
    * @param {string} websiteID
    * @return {Promise}
    */
-  getWebsite(websiteID: string) : Promise<Website> {
+  getWebsite(websiteID: string): Promise<Website> {
     return this.crisp.get(
       this.crisp.prepareRestUrl(["website", websiteID])
     );
@@ -105,4 +112,8 @@ class WebsiteBase extends BaseResource {
   };
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export default WebsiteBase;

package/lib/resources/WebsiteBatch.ts

@@ -12,6 +12,10 @@
 // PROJECT: RESOURCES
 import BaseResource from "./BaseResource";
 
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
+
 type WebsiteBatchConversationsOperation = {
   inbox_id?:  string;
   sessions?:  string[];
@@ -22,6 +26,10 @@ type WebsiteBatchPeopleOperationInner = {
   search?:    string;
 }
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp WebsiteBatch Resource
  */
@@ -29,7 +37,9 @@ class WebsiteBatch extends BaseResource {
   /**
    * Batch Resolve Conversations
    */
-  batchResolveConversations(websiteID: string, operation: WebsiteBatchConversationsOperation) {
+  batchResolveConversations(
+    websiteID: string, operation: WebsiteBatchConversationsOperation
+  ) {
     return this.crisp.patch(
       this.crisp.prepareRestUrl(["website", websiteID, "batch", "resolve"]),
 
@@ -46,7 +56,9 @@ class WebsiteBatch extends BaseResource {
    * @param {object} operation
    * @return {Promise}
    */
-  batchReadConversations(websiteID: string, operation: WebsiteBatchConversationsOperation) {
+  batchReadConversations(
+    websiteID: string, operation: WebsiteBatchConversationsOperation
+  ) {
     return this.crisp.patch(
       this.crisp.prepareRestUrl(["website", websiteID, "batch", "read"]),
 
@@ -63,7 +75,9 @@ class WebsiteBatch extends BaseResource {
    * @param {object} operation
    * @return {Promise}
    */
-  batchRemoveConversations(websiteID: string, operation: WebsiteBatchConversationsOperation) {
+  batchRemoveConversations(
+    websiteID: string, operation: WebsiteBatchConversationsOperation
+  ) {
     return this.crisp.patch(
       this.crisp.prepareRestUrl(["website", websiteID, "batch", "remove"]),
 
@@ -80,7 +94,9 @@ class WebsiteBatch extends BaseResource {
    * @param {object} people
    * @return {Promise}
    */
-  batchRemovePeople(websiteID: string, people: WebsiteBatchPeopleOperationInner) {
+  batchRemovePeople(
+    websiteID: string, people: WebsiteBatchPeopleOperationInner
+  ) {
     return this.crisp.patch(
       this.crisp.prepareRestUrl(["website", websiteID, "batch", "remove"]),
 
@@ -93,4 +109,8 @@ class WebsiteBatch extends BaseResource {
   };
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export default WebsiteBatch;

package/lib/resources/WebsiteCampaign.ts

@@ -13,7 +13,10 @@
 import BaseResource from "./BaseResource";
 import { WebsiteFilter } from "./WebsiteBase";
 
-// WebsiteCampaignExcerpt mapping
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
+
 type WebsiteCampaignExcerpt = {
   campaign_id?:  string;
   type?:         string;
@@ -62,7 +65,6 @@ type WebsiteCampaignItemSender = {
   user_id?:  string;
 }
 
-// WebsiteCampaignItemRecipients mapping
 type WebsiteCampaignItemRecipients = {
   type?:         string;
   segments?:     string[];
@@ -135,6 +137,10 @@ type WebsiteCampaignStatisticProfilePersonGeolocationCoordinates = {
   longitude?: number;
 }
 
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
 /**
  * Crisp WebsiteCampaign Resource
  */
@@ -142,7 +148,9 @@ class WebsiteCampaign extends BaseResource {
   /**
    * List Campaigns
    */
-  listCampaigns(websiteID: string, pageNumber: number = 1) : Promise<WebsiteCampaignExcerpt[]> {
+  listCampaigns(
+    websiteID: string, pageNumber: number = 1
+  ): Promise<WebsiteCampaignExcerpt[]> {
     return this.crisp.get(
       this.crisp.prepareRestUrl([
         "website", websiteID, "campaigns", "list", String(pageNumber)
@@ -153,7 +161,7 @@ class WebsiteCampaign extends BaseResource {
   /**
    * List Campaign Tags
    */
-  listCampaignTags(websiteID: string) : Promise<string[]> {
+  listCampaignTags(websiteID: string): Promise<string[]> {
     return this.crisp.get(
       this.crisp.prepareRestUrl(["website", websiteID, "campaigns", "tags"])
     );
@@ -162,7 +170,9 @@ class WebsiteCampaign extends BaseResource {
   /**
    * List Campaign Templates
    */
-  listCampaignTemplates(websiteID: string, pageNumber: number = 1) : Promise<WebsiteCampaignTemplateExcerpt[]> {
+  listCampaignTemplates(
+    websiteID: string, pageNumber: number = 1
+  ): Promise<WebsiteCampaignTemplateExcerpt[]> {
     return this.crisp.get(
       this.crisp.prepareRestUrl([
         "website", websiteID, "campaigns", "templates", String(pageNumber)
@@ -173,7 +183,9 @@ class WebsiteCampaign extends BaseResource {
   /**
    * Create A New Campaign Template
    */
-  createNewCampaignTemplate(websiteID: string, templateFormat: string, templateName: string) : Promise<WebsiteCampaignTemplateNew> {
+  createNewCampaignTemplate(
+    websiteID: string, templateFormat: string, templateName: string
+  ): Promise<WebsiteCampaignTemplateNew> {
     return this.crisp.post(
       this.crisp.prepareRestUrl(["website", websiteID, "campaigns", "template"]),
 
@@ -200,7 +212,9 @@ class WebsiteCampaign extends BaseResource {
   /**
    * Get A Campaign Template
    */
-  getCampaignTemplate(websiteID: string, templateID: string) : Promise<WebsiteCampaignTemplateItem> {
+  getCampaignTemplate(
+    websiteID: string, templateID: string
+  ): Promise<WebsiteCampaignTemplateItem> {
     return this.crisp.get(
       this.crisp.prepareRestUrl([
         "website", websiteID, "campaigns", "template", templateID
@@ -211,7 +225,9 @@ class WebsiteCampaign extends BaseResource {
   /**
    * Save A Campaign Template
    */
-  saveCampaignTemplate(websiteID: string, templateID: string, template: WebsiteCampaignTemplateItem) {
+  saveCampaignTemplate(
+    websiteID: string, templateID: string, template: WebsiteCampaignTemplateItem
+  ) {
     return this.crisp.put(
       this.crisp.prepareRestUrl([
         "website", websiteID, "campaigns", "template", templateID
@@ -224,7 +240,9 @@ class WebsiteCampaign extends BaseResource {
   /**
    * Update A Campaign Template
    */
-  updateCampaignTemplate(websiteID: string, templateID: string, template: WebsiteCampaignTemplateItem) {
+  updateCampaignTemplate(
+    websiteID: string, templateID: string, template: WebsiteCampaignTemplateItem
+  ) {
     return this.crisp.patch(
       this.crisp.prepareRestUrl([
         "website", websiteID, "campaigns", "template", templateID
@@ -248,7 +266,9 @@ class WebsiteCampaign extends BaseResource {
   /**
    * Create A New Campaign
    */
-  createNewCampaign(websiteID: string, campaignType: string, campaignName: string) {
+  createNewCampaign(
+    websiteID: string, campaignType: string, campaignName: string
+  ) {
     return this.crisp.post(
       this.crisp.prepareRestUrl(["website", websiteID, "campaign"]),
 
@@ -273,7 +293,9 @@ class WebsiteCampaign extends BaseResource {
   /**
    * Get A Campaign
    */
-  getCampaign(websiteID: string, campaignID: string) : Promise<WebsiteCampaignItem> {
+  getCampaign(
+    websiteID: string, campaignID: string
+  ): Promise<WebsiteCampaignItem> {
     return this.crisp.get(
       this.crisp.prepareRestUrl(["website", websiteID, "campaign", campaignID])
     );
@@ -282,7 +304,9 @@ class WebsiteCampaign extends BaseResource {
   /**
    * Save A Campaign
    */
-  saveCampaign(websiteID: string, campaignID: string, campaign: WebsiteCampaignItem) {
+  saveCampaign(
+    websiteID: string, campaignID: string, campaign: WebsiteCampaignItem
+  ) {
     return this.crisp.put(
       this.crisp.prepareRestUrl(["website", websiteID, "campaign", campaignID]),
 
@@ -293,7 +317,9 @@ class WebsiteCampaign extends BaseResource {
   /**
    * Update A Campaign
    */
-  updateCampaign(websiteID: string, campaignID: string, campaign: WebsiteCampaignItem) {
+  updateCampaign(
+    websiteID: string, campaignID: string, campaign: WebsiteCampaignItem
+  ) {
     return this.crisp.patch(
       this.crisp.prepareRestUrl(["website", websiteID, "campaign", campaignID]),
 
@@ -370,10 +396,13 @@ class WebsiteCampaign extends BaseResource {
   /**
    * List Campaign Recipients
    */
-  listCampaignRecipients(websiteID: string, campaignID: string, pageNumber: number = 1) : Promise<WebsiteCampaignRecipient[]> {
+  listCampaignRecipients(
+    websiteID: string, campaignID: string, pageNumber: number = 1
+  ): Promise<WebsiteCampaignRecipient[]> {
     return this.crisp.get(
       this.crisp.prepareRestUrl([
-        "website", websiteID, "campaign", campaignID, "recipients", String(pageNumber)
+        "website", websiteID, "campaign", campaignID, "recipients",
+        String(pageNumber)
       ])
     );
   };
@@ -386,7 +415,7 @@ class WebsiteCampaign extends BaseResource {
     campaignID: string,
     action: string,
     pageNumber: number = 1
-  ) : Promise<WebsiteCampaignStatistic[]> {
+  ): Promise<WebsiteCampaignStatistic[]> {
     return this.crisp.get(
       this.crisp.prepareRestUrl([
         "website", websiteID, "campaign", campaignID, "statistics", action,
@@ -396,4 +425,8 @@ class WebsiteCampaign extends BaseResource {
   };
 }
 
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
 export default WebsiteCampaign;