crisp-api 9.13.0 → 10.0.3

package/lib/resources/WebsiteSettings.ts

@@ -0,0 +1,207 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
+
+export interface WebsiteSettings {
+  websiteID?: string;
+  name?: string;
+  domain?: string;
+  logo?: string;
+  audit?: WebsiteSettingsAudit;
+  contact?: WebsiteSettingsContact;
+  inbox?: WebsiteSettingsInbox;
+  emails?: WebsiteSettingsEmails;
+  chatbox?: WebsiteSettingsChatbox;
+}
+
+export interface WebsiteSettingsAudit {
+  log?: boolean;
+}
+
+export interface WebsiteSettingsContact {
+  email?: string;
+  phone?: string;
+  messenger?: string;
+  telegram?: string;
+  twitter?: string;
+  whatsapp?: string;
+  instagram?: string;
+}
+
+export interface WebsiteSettingsInbox {
+  lock_removal?: boolean;
+  force_operator_token?: boolean;
+  locale?: string;
+}
+
+export interface WebsiteSettingsEmails {
+  rating?: boolean;
+  transcript?: boolean;
+  enrich?: boolean;
+  junk_filter?: boolean;
+}
+
+export interface WebsiteSettingsChatbox {
+  tile?: string;
+  wait_game?: boolean;
+  website_logo?: boolean;
+  last_operator_face?: boolean;
+  ongoing_operator_face?: boolean;
+  activity_metrics?: boolean;
+  operator_privacy?: boolean;
+  visitor_privacy?: boolean;
+  availability_tooltip?: boolean;
+  hide_vacation?: boolean;
+  hide_on_away?: boolean;
+  hide_on_mobile?: boolean;
+  position_reverse?: boolean;
+  email_visitors?: boolean;
+  phone_visitors?: boolean;
+  force_identify?: boolean;
+  ignore_privacy?: boolean;
+  visitor_compose?: boolean;
+  file_transfer?: boolean;
+  audio_record?: boolean;
+  overlay_search?: boolean;
+  overlay_mode?: boolean;
+  helpdesk_link?: boolean;
+  helpdesk_only?: boolean;
+  status_health_dead?: boolean;
+  check_domain?: boolean;
+  color_theme?: string;
+  text_theme?: string;
+  welcome_message?: string;
+  locale?: string;
+  allowed_pages?: string[];
+  blocked_pages?: string[];
+  blocked_countries?: string[];
+  blocked_locales?: string[];
+}
+
+export interface WebsiteSettingsUpdate {
+  websiteID?: string;
+  name?: string;
+  domain?: string;
+  logo?: string;
+  audit?: WebsiteSettingsUpdateAudit;
+  contact?: WebsiteSettingsUpdateContact;
+  inbox?: WebsiteSettingsUpdateInbox;
+  emails?: WebsiteSettingsUpdateEmails;
+  chatbox?: WebsiteSettingsUpdateChatbox;
+}
+
+export interface WebsiteSettingsUpdateAudit {
+  log?: boolean;
+}
+
+export interface WebsiteSettingsUpdateContact {
+  email?: string;
+  phone?: string;
+  messenger?: string;
+  telegram?: string;
+  twitter?: string;
+  whatsapp?: string;
+  instagram?: string;
+}
+
+export interface WebsiteSettingsUpdateInbox {
+  lock_removal?: boolean;
+  force_operator_token?: boolean;
+  locale?: string;
+}
+
+export interface WebsiteSettingsUpdateEmails {
+  rating?: boolean;
+  transcript?: boolean;
+  enrich?: boolean;
+  junk_filter?: boolean;
+}
+
+export interface WebsiteSettingsUpdateChatbox {
+  tile?: string;
+  wait_game?: boolean;
+  website_logo?: boolean;
+  last_operator_face?: boolean;
+  ongoing_operator_face?: boolean;
+  activity_metrics?: boolean;
+  operator_privacy?: boolean;
+  visitor_privacy?: boolean;
+  availability_tooltip?: boolean;
+  hide_vacation?: boolean;
+  hide_on_away?: boolean;
+  hide_on_mobile?: boolean;
+  position_reverse?: boolean;
+  email_visitors?: boolean;
+  phone_visitors?: boolean;
+  force_identify?: boolean;
+  ignore_privacy?: boolean;
+  visitor_compose?: boolean;
+  file_transfer?: boolean;
+  audio_record?: boolean;
+  overlay_search?: boolean;
+  overlay_mode?: boolean;
+  helpdesk_link?: boolean;
+  helpdesk_only?: boolean;
+  status_health_dead?: boolean;
+  check_domain?: boolean;
+  color_theme?: string;
+  text_theme?: string;
+  welcome_message?: string;
+  locale?: string;
+  allowed_pages?: string[];
+  blocked_pages?: string[];
+  blocked_countries?: string[];
+  blocked_locales?: string[];
+  blocked_ips?: string[];
+}
+
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
+/**
+ * Crisp WebsiteSettings Resource
+ */
+class WebsiteSettingsService extends BaseResource {
+  /**
+   * Get Website Settings
+   */
+  getWebsiteSettings(websiteID: string): Promise<WebsiteSettings> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["website", websiteID, "settings"])
+    );
+  };
+
+  /**
+   * Update Website Settings
+   */
+  updateWebsiteSettings(websiteID: string, settings: WebsiteSettingsUpdate) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl(["website", websiteID, "settings"]),
+
+      null,
+      settings
+    );
+  };
+}
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export default WebsiteSettingsService;
+

package/lib/resources/WebsiteVerify.ts

@@ -0,0 +1,90 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Valerian Saliou <valerian@valeriansaliou.name>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
+
+export interface WebsiteVerifyKeyData {
+  data?: WebsiteVerifyKey;
+}
+
+export interface WebsiteVerifySettings {
+  enabled?: boolean;
+}
+
+export interface WebsiteVerifyKey {
+  secret?: string;
+}
+
+export interface WebsiteVerifySettingsUpdate {
+  enabled?: boolean;
+}
+
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
+/**
+ * Crisp WebsiteVerify Resource
+ */
+class WebsiteVerify extends BaseResource {
+  /**
+   * Get Verify Settings
+   */
+  getVerifySettings(websiteID: string): Promise<WebsiteVerifySettings> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["website", websiteID, "verify", "settings"])
+    );
+  };
+
+  /**
+   * Update Verify Settings
+   */
+  updateVerifySettings(
+    websiteID: string, settings: WebsiteVerifySettingsUpdate
+  ) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl(["website", websiteID, "verify", "settings"]),
+
+      null, settings
+    );
+  };
+
+  /**
+   * Get Verify Key
+   */
+  getVerifyKey(websiteID: string): Promise<WebsiteVerifyKey> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["website", websiteID, "verify", "key"])
+    );
+  };
+
+  /**
+   * Roll Verify Key
+   */
+  rollVerifyKey(websiteID: string) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl(["website", websiteID, "verify", "key"]),
+
+      null, null
+    );
+  };
+}
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export default WebsiteVerify;

package/lib/resources/WebsiteVisitors.ts

@@ -0,0 +1,219 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Valerian Saliou <valerian@valeriansaliou.name>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
+
+export interface WebsiteVisitorCount {
+  count?: number;
+  active?: number;
+  limited?: boolean;
+}
+
+export interface WebsiteVisitor {
+  session_id?: string;
+  inbox_id?: string;
+  nickname?: string;
+  email?: string;
+  avatar?: string;
+  useragent?: string;
+  initiated?: boolean;
+  active?: boolean;
+  last_page?: WebsiteVisitorLastPage;
+  geolocation?: WebsiteVisitorGeolocation;
+  timezone?: number;
+  capabilities?: string[];
+  locales?: string[];
+}
+
+export interface WebsiteVisitorLastPage {
+  page_title?: string;
+  page_url?: string;
+}
+
+export interface WebsiteVisitorGeolocation {
+  coordinates?: WebsiteVisitorGeolocationCoordinates;
+  city?: string;
+  region?: string;
+  country?: string;
+}
+
+export interface WebsiteVisitorGeolocationCoordinates {
+  latitude?: number;
+  longitude?: number;
+}
+
+export interface WebsiteVisitorsMapPointsData {
+  data?: WebsiteVisitorsMapPoint[];
+}
+
+export interface WebsiteVisitorsMapPoint {
+  visitors?: WebsiteVisitorsMapPointVisitors;
+  geolocation?: WebsiteVisitorsMapPointGeolocation;
+}
+
+export interface WebsiteVisitorsMapPointGeolocation {
+  coordinates?: WebsiteVisitorsMapPointGeolocationCoordinates;
+  city?: string;
+  region?: string;
+  country?: string;
+}
+
+export interface WebsiteVisitorsMapPointGeolocationCoordinates {
+  latitude?: number;
+  longitude?: number;
+}
+
+export interface WebsiteVisitorsMapPointVisitors {
+  count?: number;
+  threshold?: number;
+  sessions?: WebsiteVisitorsMapPointVisitorsSession[];
+}
+
+export interface WebsiteVisitorsMapPointVisitorsSession {
+  session_id?: string;
+  nickname?: string;
+  email?: string;
+  avatar?: string;
+  initiated?: boolean;
+  active?: boolean;
+  last_page?: WebsiteVisitorLastPage;
+  timezone?: number;
+  capabilities?: string[];
+  locales?: string[];
+}
+
+export interface WebsiteVisitorsToken {
+  session_id?: string;
+}
+
+export interface WebsiteVisitorsBlocked {
+  rule?: string[];
+  blocked?: number;
+}
+
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
+/**
+ * Crisp WebsiteVisitors Resource
+ */
+class WebsiteVisitors extends BaseResource {
+  /**
+   * Count Visitors
+   */
+  countVisitors(websiteID: string): Promise<WebsiteVisitorCount> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["website", websiteID, "visitors", "count"])
+    );
+  };
+
+  /**
+   * List Visitors
+   */
+  listVisitors(
+    websiteID: string, pageNumber: number = 1
+  ): Promise<WebsiteVisitor[]> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "visitors", "list", String(pageNumber)
+      ])
+    );
+  };
+
+  /**
+   * Pinpoint Visitors On A Map
+   */
+  pinpointVisitorsOnMap(
+    websiteID: string, centerLongitude: number, centerLatitude: number,
+      centerRadius: number
+  ): Promise<WebsiteVisitorsMapPoint[]> {
+    // Generate query
+    const query: Record<string, string> = {};
+
+    if (typeof centerLongitude === "number") {
+      query.center_longitude = String(centerLongitude);
+    }
+
+    if (typeof centerLatitude === "number") {
+      query.center_latitude = String(centerLatitude);
+    }
+
+    if (typeof centerRadius === "number") {
+      query.center_radius = String(centerRadius);
+    }
+
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "visitors", "map"
+      ]),
+
+      query
+    );
+  };
+
+  /**
+   * Get Session Identifier From Token
+   */
+  getSessionIdentifierFromToken(
+    websiteID: string, tokenID: string
+  ): Promise<WebsiteVisitorsToken> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "visitors", "token", tokenID
+      ])
+    );
+  };
+
+  /**
+   * Count Blocked Visitors
+   */
+  countBlockedVisitors(websiteID: string): Promise<WebsiteVisitorsBlocked> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["website", websiteID, "visitors", "blocked"])
+    );
+  };
+
+  /**
+   * Count Blocked Visitors In Rule
+   */
+  countBlockedVisitorsInRule(
+    websiteID: string, rule: string
+  ): Promise<number> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "visitors", "blocked", rule
+      ])
+    );
+  };
+
+  /**
+   * Clear Blocked Visitors In Rule
+   */
+  clearBlockedVisitorsInRule(websiteID: string, rule: string) {
+    return this.crisp.delete(
+      this.crisp.prepareRestUrl([
+        "website", websiteID, "visitors", "blocked", rule
+      ])
+    );
+  };
+}
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export default WebsiteVisitors;

package/lib/resources/index.ts

@@ -0,0 +1,28 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export * from "./BaseResource";
+export * from "./BucketURL";
+export * from "./MediaAnimation";
+export * from "./PluginConnect";
+export * from "./PluginSubscription";
+export * from "./WebsiteAnalytics";
+export * from "./WebsiteAvailability";
+export * from "./WebsiteBase";
+export * from "./WebsiteBatch";
+export * from "./WebsiteCampaign";
+export * from "./WebsiteConversation";
+export * from "./WebsiteHelpdesk";
+export * from "./WebsiteOperator";
+export * from "./WebsitePeople";
+export * from "./WebsiteSettings";
+export * from "./WebsiteVerify";
+export * from "./WebsiteVisitors";

package/lib/services/bucket.ts

@@ -0,0 +1,36 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BucketURL from "@/resources/BucketURL";
+
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
+/**
+ * Bucket Service
+ */
+class BucketService {
+  /* eslint-disable @typescript-eslint/no-explicit-any */
+  public __resources: any[] = [
+    BucketURL
+  ];
+}
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export interface BucketServiceInterface extends
+  BucketURL {}
+
+export default BucketService;

package/lib/services/media.ts

@@ -0,0 +1,36 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import MediaAnimation from "@/resources/MediaAnimation";
+
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
+/**
+ * Crisp Media Service
+ */
+class MediaService {
+  /* eslint-disable @typescript-eslint/no-explicit-any */
+  public __resources: any[] = [
+    MediaAnimation
+  ];
+}
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export interface MediaServiceInterface extends
+  MediaAnimation {}
+
+export default MediaService;

package/lib/services/plugin.ts

@@ -0,0 +1,40 @@
+/*
+ * node-crisp-api
+ *
+ * Copyright 2022, Crisp IM SAS
+ * Author: Baptiste Jamin <baptiste@crisp.chat>
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import PluginConnect from "@/resources/PluginConnect";
+import PluginSubscription from "@/resources/PluginSubscription";
+
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
+/**
+ * Crisp Plugin Service
+ */
+class PluginService {
+  /* eslint-disable @typescript-eslint/no-explicit-any */
+  public __resources: any[] = [
+    PluginConnect,
+    PluginSubscription
+  ];
+}
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export interface PluginServiceInterface extends
+  PluginConnect,
+  PluginSubscription {
+}
+
+export default PluginService;