crisp-api 9.12.1 → 10.0.2

package/lib/resources/BaseResource.ts

@@ -0,0 +1,29 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: MAIN
+import Crisp from "@/crisp";
+
+/**
+ * Crisp Base Resource
+ */
+class BaseResource {
+  protected crisp: Crisp;
+
+  /**
+   * Constructor
+   */
+  constructor(crisp: Crisp) {
+    this.crisp = crisp;
+  }
+}
+
+export default BaseResource;

package/lib/resources/BucketURL.ts

@@ -0,0 +1,49 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+// BucketURLRequestFile mapping
+export type BucketURLRequestFile = {
+  name?: string;
+  type?: string;
+};
+
+// BucketURLRequestResource mapping
+export type BucketURLRequestResource = {
+  type?: string;
+  id?: string;
+};
+
+// BucketURLRequest mapping
+export type BucketURLRequest = {
+  namespace?: string;
+  id?: string;
+  file?: BucketURLRequestFile;
+  resource?: BucketURLRequestResource;
+};
+
+/**
+ * Crisp BucketURL Resource
+ */
+class BucketURL extends BaseResource {
+  /**
+   * Generate Bucket URL
+   */
+  generateBucketURL(data: BucketURLRequest) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl(["bucket", "url", "generate"]), null, data
+    );
+  };
+}
+
+export default BucketURL;

package/lib/resources/MediaAnimation.ts

@@ -0,0 +1,34 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Valerian Saliou <valerian@valeriansaliou.name>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+/**
+ * Crisp MediaAnimation Resource
+ */
+class MediaAnimation extends BaseResource {
+  /**
+   * List Animation Medias
+   */
+  listAnimationMedias(pageNumber: number, listID: string, searchQuery: object) {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["media", "animation", "list", String(pageNumber)]),
+
+      {
+        list_id: listID,
+        search_query: searchQuery
+      }
+    );
+  };
+}
+
+export default MediaAnimation;

package/lib/resources/PluginConnect.ts

@@ -0,0 +1,128 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+// PluginConnectAccount mapping
+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;
+  settings?: object;
+  difference?: string;
+}
+
+// PluginConnectEndpoints mapping
+export type PluginConnectEndpoints = {
+  socket?: PluginConnectEndpointsSocket;
+}
+
+// PluginConnectEndpointsSocket mapping
+export type PluginConnectEndpointsSocket = {
+  app?: string;
+}
+
+/**
+ * Crisp PluginConnect Resource
+ */
+class PluginConnect extends BaseResource {
+  /**
+   * Get Connect Account
+   */
+  getConnectAccount(): Promise<PluginConnectAccount> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["plugin", "connect", "account"]), {}
+    );
+  };
+
+  /**
+   * Check Connect Session Validity
+   */
+  checkConnectSessionValidity() {
+    return this.crisp.head(
+      this.crisp.prepareRestUrl(["plugin", "connect", "session"]),
+
+      {}
+    );
+  };
+
+  /**
+   * List All Connect Websites
+   */
+  listAllConnectWebsites(
+    pageNumber: number, filterConfigured: boolean
+  ): Promise<PluginConnectAllWebsites> {
+    // Generate query
+    let query = {
+      filter_configured: (
+        (filterConfigured === true) ? "1" : "0"
+      )
+    };
+
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "plugin", "connect", "websites", "all", String(pageNumber)
+      ]),
+
+      query
+    );
+  };
+
+  /**
+   * List Connect Websites Since
+   */
+  listConnectWebsitesSince(
+    dateSince: string, filterConfigured: boolean
+  ): Promise<PluginConnectWebsitesSince> {
+    // Generate query
+    let query = {
+      filter_configured: (
+        (filterConfigured === true) ? "1" : "0"
+      )
+    };
+
+    if (dateSince) {
+      // @ts-ignore
+      query.date_since = dateSince;
+    }
+
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "plugin", "connect", "websites", "since"
+      ]),
+
+      query
+    );
+  };
+
+  /**
+   * Get Connect Endpoints
+   */
+  getConnectEndpoints(): Promise<PluginConnectEndpoints> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["plugin", "connect", "endpoints"]), {}
+    );
+  };
+}
+
+export default PluginConnect;

package/lib/resources/PluginSubscription.ts

@@ -0,0 +1,208 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+type PluginSubscription = {
+  id?:            string;
+  urn?:           string;
+  type?:          string;
+  category?:      string;
+  name?:          string;
+  summary?:       string;
+  price?:         number;
+  plans?:         PluginSubscriptionPlan[];
+  icon?:          string;
+  website_url?:   string;
+  contact_url?:   string;
+  terms_url?:     string;
+  privacy_url?:   string;
+  help_url?:      string;
+  video_url?:     string;
+  configurable?:  boolean;
+  since?:         string;
+  active?:        boolean;
+  website_id?:    string;
+  card_id?:       string;
+}
+
+type PluginSubscriptionPlan = {
+  id?:     string;
+  name?:   string;
+  price?:  number;
+}
+
+type PluginSubscriptionSettings = {
+  plugin_id?:       string;
+  website_id?:      string;
+  token?:           string;
+  schema?:          object;
+  settings?:        object;
+  settings_form_url?: string;
+  callback_url?:    string;
+}
+
+type PluginSubscriptionChannelForward = {
+  namespace?:   string;
+  identifier?:  string;
+  payload?:     object;
+}
+
+type PluginSubscriptionEventDispatch = {
+  name?:   string;
+  data?:   object;
+}
+
+/**
+ * Crisp PluginSubscription Resource
+ */
+class PluginSubscriptionService extends BaseResource {
+  /**
+   * List All Active Subscriptions
+   */
+  listAllActiveSubscriptions(): Promise<PluginSubscription[]> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["plugins", "subscription"])
+    );
+  };
+
+  /**
+   * List Subscriptions For A Website
+   */
+  listSubscriptionsForWebsite(websiteID: string) : Promise<PluginSubscription[]> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["plugins", "subscription", websiteID])
+    );
+  };
+
+  /**
+   * Get Subscription Details
+   */
+  getSubscriptionDetails(websiteID: string, pluginID: string) : Promise<PluginSubscription> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["plugins", "subscription", websiteID, pluginID])
+    );
+  };
+
+  /**
+   * Subscribe Website To Plugin
+   */
+  subscribeWebsiteToPlugin(websiteID: string, pluginID: string) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl(["plugins", "subscription", websiteID]),
+
+      null,
+
+      {
+        plugin_id: pluginID
+      }
+    );
+  };
+
+  /**
+   * Unsubscribe Plugin From Website
+   */
+  unsubscribePluginFromWebsite(websiteID: string, pluginID: string) {
+    return this.crisp.delete(
+      this.crisp.prepareRestUrl(["plugins", "subscription", websiteID, pluginID])
+    );
+  };
+
+  /**
+   * Get Subscription Settings
+   */
+  getSubscriptionSettings(websiteID: string, pluginID: string) : Promise<PluginSubscriptionSettings> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "plugins", "subscription", websiteID, pluginID, "settings"
+      ])
+    );
+  };
+
+  /**
+   * Save Subscription Settings
+   */
+  saveSubscriptionSettings(websiteID: string, pluginID: string, settings: object) {
+    return this.crisp.put(
+      this.crisp.prepareRestUrl([
+        "plugins", "subscription", websiteID, pluginID, "settings"
+      ]),
+
+      null, settings
+    );
+  };
+
+  /**
+   * Update Subscription Settings
+   */
+  updateSubscriptionSettings(websiteID: string, pluginID: string, settings: object) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl([
+        "plugins", "subscription", websiteID, pluginID, "settings"
+      ]),
+
+      null, settings
+    );
+  };
+
+  /**
+   * Get Plugin Usage Bills
+   */
+  getPluginUsageBills(websiteID: string, pluginID: string) {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "plugins", "subscription", websiteID, pluginID, "bill", "usage"
+      ])
+    );
+  };
+
+  /**
+   * Report Plugin Usage To Bill
+   */
+  reportPluginUsageToBill(websiteID: string, pluginID: string, usage: object) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl([
+        "plugins", "subscription", websiteID, pluginID, "bill", "usage"
+      ]),
+
+      null, usage
+    );
+  };
+
+  /**
+   * Forward Plugin Payload To Channel
+   */
+  forwardPluginPayloadToChannel(websiteID: string, pluginID: string, payload: PluginSubscriptionChannelForward) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl([
+        "plugins", "subscription", websiteID, pluginID, "channel"
+      ]),
+
+      null, payload
+    );
+  };
+
+  /**
+   * Dispatch Plugin Event
+   */
+  dispatchPluginEvent(websiteID: string, pluginID: string, payload: PluginSubscriptionEventDispatch) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl([
+        "plugins", "subscription", websiteID, pluginID, "event"
+      ]),
+
+      null, payload
+    );
+  };
+}
+
+export default PluginSubscriptionService;

package/lib/resources/WebsiteAnalytics.ts

@@ -0,0 +1,31 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Valerian Saliou <valerian@valeriansaliou.name>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+/**
+ * Crisp WebsiteAnalytics Resource
+ */
+class WebsiteAnalytics extends BaseResource {
+  /**
+   * Generate Analytics
+   */
+  generateAnalytics(websiteID: string, query: object) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl(["website", websiteID, "analytics", "generate"]),
+
+      null, query
+    );
+  };
+}
+
+export default WebsiteAnalytics;

package/lib/resources/WebsiteAvailability.ts

@@ -0,0 +1,54 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Valerian Saliou <valerian@valeriansaliou.name>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+type WebsiteAvailabilityStatus = {
+  status?:  string;
+  since?:   number;
+}
+
+type WebsiteAvailabilityOperator = {
+  user_id?:  string;
+  type?:     string;
+  time?:     WebsiteAvailabilityOperatorTime;
+}
+
+type WebsiteAvailabilityOperatorTime = {
+  for?:   number;
+  since?: number;
+}
+
+/**
+ * Crisp WebsiteAvailability Resource
+ */
+class WebsiteAvailability extends BaseResource {
+  /**
+   * Get Website Availability Status
+   */
+  getWebsiteAvailabilityStatus(websiteID: string) : Promise<WebsiteAvailabilityStatus> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["website", websiteID, "availability", "status"])
+    );
+  };
+
+  /**
+   * List Website Operator Availabilities
+   */
+  listWebsiteOperatorAvailabilities(websiteID: string) : Promise<WebsiteAvailabilityOperator[]> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["website", websiteID, "availability", "operators"])
+    );
+  };
+}
+
+export default WebsiteAvailability;

package/lib/resources/WebsiteBase.ts

@@ -0,0 +1,108 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+// Website mapping
+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>;
+}
+
+/**
+ * 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"])
+    );
+  };
+}
+
+export default WebsiteBase;