crisp-api/lib/resources/PluginConnect.ts

Crisp API wrapper for Node - official, maintained by Crisp

/*
 * This file is part of node-crisp-api
 *
 * Copyright (c) 2025 Crisp IM SAS
 * All rights belong to Crisp IM SAS
 */

/**************************************************************************
 * IMPORTS
 ***************************************************************************/

// PROJECT: RESOURCES
import BaseResource from "./BaseResource";

/**************************************************************************
 * TYPES
 ***************************************************************************/

export type PluginConnectAccount = {
  plugin_id?: string;
};

export type PluginConnectWebsite = {
  website_id?: string;
  token?: string;
  settings?: object;
  plan?: PluginConnectWebsitePlan;
  difference?: string;
}

export type PluginConnectWebsitePlan = {
  id?: string;
  name?: string;
  trialing?: boolean;
};

export type PluginConnectEndpoints = {
  socket?: PluginConnectEndpointsSocket;
  rescue?: PluginConnectEndpointsRescue;
}

export type PluginConnectEndpointsSocket = {
  app?: string;
}

export type PluginConnectEndpointsRescue = {
  socket?: PluginConnectEndpointsSocket;
}

/**************************************************************************
 * CLASSES
 ***************************************************************************/

/**
 * 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, includePlan: boolean
  ): Promise<PluginConnectWebsite[]> {
    // Generate query
    let query = {
      filter_configured: (
        (filterConfigured === true) ? "1" : "0"
      ),

      include_plan: (
        (includePlan === 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, includePlan: boolean
  ): Promise<PluginConnectWebsite[]> {
    // Generate query
    let query = {
      filter_configured: (
        (filterConfigured === true) ? "1" : "0"
      ),

      include_plan: (
        (includePlan === 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"]), {}
    );
  };
}

/**************************************************************************
 * EXPORTS
 ***************************************************************************/

export default PluginConnect;