crisp-api 9.13.0 → 10.0.3

package/lib/resources/WebsiteBase.ts

@@ -0,0 +1,119 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+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
+ */
+class WebsiteBase extends BaseResource {
+  /**
+   * Check If Website Exists
+   * @memberof WebsiteBase
+   * @public
+   * @method checkWebsiteExists
+   * @param {string} domain
+   * @return {Promise}
+   */
+  checkWebsiteExists(domain: string) {
+    return this.crisp.head(
+      this.crisp.prepareRestUrl(["website"]),
+
+      {
+        domain: domain
+      }
+    );
+  };
+
+  /**
+   * Create Website
+   */
+  createWebsite(websiteData: WebsiteCreate): Promise<Website> {
+    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: string): Promise<Website> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["website", websiteID])
+    );
+  };
+
+  /**
+   * Delete A Website
+   */
+  deleteWebsite(websiteID: string, verify: WebsiteRemoveVerify) {
+    return this.crisp.delete(
+      this.crisp.prepareRestUrl(["website", websiteID]), undefined,
+
+      {
+        verify: verify
+      }
+    );
+  };
+
+  /**
+   * Abort Website Deletion
+   */
+  abortWebsiteDeletion(websiteID: string) {
+    return this.crisp.delete(
+      this.crisp.prepareRestUrl(["website", websiteID, "expunge"])
+    );
+  };
+}
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export default WebsiteBase;

package/lib/resources/WebsiteBatch.ts

@@ -0,0 +1,116 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Valerian Saliou <valerian@valeriansaliou.name>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
+
+type WebsiteBatchConversationsOperation = {
+  inbox_id?:  string;
+  sessions?:  string[];
+}
+
+type WebsiteBatchPeopleOperationInner = {
+  profiles?:  string[];
+  search?:    string;
+}
+
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
+/**
+ * Crisp WebsiteBatch Resource
+ */
+class WebsiteBatch extends BaseResource {
+  /**
+   * Batch Resolve Conversations
+   */
+  batchResolveConversations(
+    websiteID: string, operation: WebsiteBatchConversationsOperation
+  ) {
+    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: string, operation: WebsiteBatchConversationsOperation
+  ) {
+    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: string, operation: WebsiteBatchConversationsOperation
+  ) {
+    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: string, people: WebsiteBatchPeopleOperationInner
+  ) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl(["website", websiteID, "batch", "remove"]),
+
+      null,
+
+      {
+        people: people
+      }
+    );
+  };
+}
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export default WebsiteBatch;

package/lib/resources/WebsiteCampaign.ts

@@ -0,0 +1,432 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Valerian Saliou <valerian@valeriansaliou.name>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+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
+ */
+class WebsiteCampaign extends BaseResource {
+  /**
+   * List Campaigns
+   */
+  listCampaigns(
+    websiteID: string, pageNumber: number = 1
+  ): Promise<WebsiteCampaignExcerpt[]> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaigns", "list", String(pageNumber)
+      ])
+    );
+  }
+
+  /**
+   * List Campaign Tags
+   */
+  listCampaignTags(websiteID: string): Promise<string[]> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["website", websiteID, "campaigns", "tags"])
+    );
+  }
+
+  /**
+   * List Campaign Templates
+   */
+  listCampaignTemplates(
+    websiteID: string, pageNumber: number = 1
+  ): Promise<WebsiteCampaignTemplateExcerpt[]> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaigns", "templates", String(pageNumber)
+      ])
+    );
+  }
+
+  /**
+   * Create A New Campaign Template
+   */
+  createNewCampaignTemplate(
+    websiteID: string, templateFormat: string, templateName: string
+  ): Promise<WebsiteCampaignTemplateNew> {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl(["website", websiteID, "campaigns", "template"]),
+
+      null,
+
+      {
+        format: templateFormat,
+        name: templateName
+      }
+    );
+  }
+
+  /**
+   * Check If Campaign Template Exists
+   */
+  checkCampaignTemplateExists(websiteID: string, templateID: string) {
+    return this.crisp.head(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaigns", "template", templateID
+      ])
+    );
+  }
+
+  /**
+   * Get A Campaign Template
+   */
+  getCampaignTemplate(
+    websiteID: string, templateID: string
+  ): Promise<WebsiteCampaignTemplateItem> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaigns", "template", templateID
+      ])
+    );
+  }
+
+  /**
+   * Save A Campaign Template
+   */
+  saveCampaignTemplate(
+    websiteID: string, templateID: string, template: WebsiteCampaignTemplateItem
+  ) {
+    return this.crisp.put(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaigns", "template", templateID
+      ]),
+
+      null, template
+    );
+  }
+
+  /**
+   * Update A Campaign Template
+   */
+  updateCampaignTemplate(
+    websiteID: string, templateID: string, template: WebsiteCampaignTemplateItem
+  ) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaigns", "template", templateID
+      ]),
+
+      null, template
+    );
+  }
+
+  /**
+   * Remove A Campaign Template
+   */
+  removeCampaignTemplate(websiteID: string, templateID: string) {
+    return this.crisp.delete(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaigns", "template", templateID
+      ])
+    );
+  }
+
+  /**
+   * Create A New Campaign
+   */
+  createNewCampaign(
+    websiteID: string, campaignType: string, campaignName: string
+  ) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl(["website", websiteID, "campaign"]),
+
+      null,
+
+      {
+        type: campaignType,
+        name: campaignName
+      }
+    );
+  };
+
+  /**
+   * Check If Campaign Exists
+   */
+  checkCampaignExists(websiteID: string, campaignID: string) {
+    return this.crisp.head(
+      this.crisp.prepareRestUrl(["website", websiteID, "campaign", campaignID])
+    );
+  };
+
+  /**
+   * Get A Campaign
+   */
+  getCampaign(
+    websiteID: string, campaignID: string
+  ): Promise<WebsiteCampaignItem> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["website", websiteID, "campaign", campaignID])
+    );
+  };
+
+  /**
+   * Save A Campaign
+   */
+  saveCampaign(
+    websiteID: string, campaignID: string, campaign: WebsiteCampaignItem
+  ) {
+    return this.crisp.put(
+      this.crisp.prepareRestUrl(["website", websiteID, "campaign", campaignID]),
+
+      null, campaign
+    );
+  };
+
+  /**
+   * Update A Campaign
+   */
+  updateCampaign(
+    websiteID: string, campaignID: string, campaign: WebsiteCampaignItem
+  ) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl(["website", websiteID, "campaign", campaignID]),
+
+      null, campaign
+    );
+  };
+
+  /**
+   * Remove A Campaign
+   */
+  removeCampaign(websiteID: string, campaignID: string) {
+    return this.crisp.delete(
+      this.crisp.prepareRestUrl(["website", websiteID, "campaign", campaignID])
+    );
+  };
+
+  /**
+   * Dispatch A Campaign
+   * @return {Promise}
+   */
+  dispatchCampaign(websiteID: string, campaignID: string) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaign", campaignID, "dispatch"
+      ]),
+
+      null,
+      null
+    );
+  };
+
+  /**
+   * Resume A Campaign
+   */
+  resumeCampaign(websiteID: string, campaignID: string) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaign", campaignID, "resume"
+      ]),
+
+      null,
+      null
+    );
+  };
+
+  /**
+   * Pause A Campaign
+   */
+  pauseCampaign(websiteID: string, campaignID: string) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaign", campaignID, "pause"
+      ]),
+
+      null,
+      null
+    );
+  };
+
+  /**
+   * Test A Campaign
+   */
+  testCampaign(websiteID: string, campaignID: string) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaign", campaignID, "test"
+      ]),
+
+      null,
+      null
+    );
+  };
+
+  /**
+   * List Campaign Recipients
+   */
+  listCampaignRecipients(
+    websiteID: string, campaignID: string, pageNumber: number = 1
+  ): Promise<WebsiteCampaignRecipient[]> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaign", campaignID, "recipients",
+        String(pageNumber)
+      ])
+    );
+  };
+
+  /**
+   * List Campaign Statistics
+   */
+  listCampaignStatistics(
+    websiteID: string,
+    campaignID: string,
+    action: string,
+    pageNumber: number = 1
+  ): Promise<WebsiteCampaignStatistic[]> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "campaign", campaignID, "statistics", action,
+        String(pageNumber)
+      ])
+    );
+  };
+}
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export default WebsiteCampaign;