crisp-api 10.2.0 → 10.4.0

package/lib/resources/PlanSubscription.ts

@@ -0,0 +1,171 @@
+/*
+ * This file is part of node-crisp-api
+ *
+ * Copyright (c) 2026 Crisp IM SAS
+ * All rights belong to Crisp IM SAS
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import BaseResource from "./BaseResource";
+
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
+
+export type PlanSubscription = {
+  id?: string;
+  name?: string;
+  price?: number;
+  since?: string;
+  trialing?: boolean;
+  trial_end?: string;
+  trial_end_date?: string;
+  bill_period?: PlanSubscriptionBillPeriod;
+  bill_valid_until?: string;
+  active?: boolean;
+  sandbox?: boolean;
+  website?: PlanSubscriptionWebsite;
+  coupon_redeemed?: boolean;
+  card_id?: string;
+  owner?: PlanSubscriptionOwner;
+}
+
+export type PlanSubscriptionBillPeriod = "monthly" | "yearly";
+
+export type PlanSubscriptionWebsite = {
+  id?: string;
+  name?: string;
+  domain?: string;
+  logo?: string;
+}
+
+export type PlanSubscriptionOwner = {
+  user_id?: string;
+  email?: string;
+  first_name?: string;
+  last_name?: string;
+}
+
+export type PlanSubscriptionCoupon = {
+  code?: string;
+  policy?: PlanSubscriptionCouponPolicy;
+  redeem_limit?: number;
+  expire_at?: string;
+}
+
+export type PlanSubscriptionCouponPolicy = {
+  rebate_percent?: number;
+  trial_days?: number;
+}
+
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
+/**
+ * Crisp PlanSubscription Resource
+ */
+class PlanSubscriptionService extends BaseResource {
+  /**
+   * List All Active Plan Subscriptions
+   */
+  listAllActiveSubscriptions(): Promise<PlanSubscription[]> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["plans", "subscription"])
+    );
+  };
+
+  /**
+   * Get Plan Subscription For A Website
+   */
+  getPlanSubscriptionForWebsite(websiteID: string): Promise<PlanSubscription> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["plans", "subscription", websiteID])
+    );
+  };
+
+  /**
+   * Subscribe Website To Plan
+   */
+  subscribeWebsiteToPlan(websiteID: string, planID: string) {
+    return this.crisp.post(
+      this.crisp.prepareRestUrl(["plans", "subscription", websiteID]),
+
+      null,
+
+      {
+        plan_id: planID
+      }
+    );
+  };
+
+  /**
+   * Unsubscribe Plan From Website
+   */
+  unsubscribePlanFromWebsite(websiteID: string) {
+    return this.crisp.delete(
+      this.crisp.prepareRestUrl(["plans", "subscription", websiteID])
+    );
+  };
+
+  /**
+   * Change Bill Period For Website Plan Subscription
+   */
+  changeBillPeriodForWebsitePlanSubscription(
+    websiteID: string,
+    period: PlanSubscriptionBillPeriod
+  ) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl([
+        "plans", "subscription", websiteID, "bill", "period"
+      ]),
+
+      null,
+
+      {
+        period
+      }
+    );
+  };
+
+  /**
+   * Check Coupon Availability For Website Plan Subscription
+   */
+  checkCouponAvailabilityForWebsitePlanSubscription(
+    websiteID: string,
+    code: string
+  ): Promise<PlanSubscriptionCoupon> {
+    return this.crisp.get(
+      this.crisp.prepareRestUrl(["plans", "subscription", websiteID, "coupon"]),
+
+      {
+        code
+      }
+    );
+  };
+
+  /**
+   * Redeem Coupon For Website Plan Subscription
+   */
+  redeemCouponForWebsitePlanSubscription(websiteID: string, code: string) {
+    return this.crisp.patch(
+      this.crisp.prepareRestUrl(["plans", "subscription", websiteID, "coupon"]),
+
+      null,
+
+      {
+        code
+      }
+    );
+  };
+}
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export default PlanSubscriptionService;

package/lib/resources/PluginConnect.ts

@@ -78,12 +78,16 @@ class PluginConnect extends BaseResource {
    * List All Connect Websites
    */
   listAllConnectWebsites(
-    pageNumber: number, filterConfigured: boolean
+    pageNumber: number, filterConfigured: boolean, includePlan: boolean
   ): Promise<PluginConnectAllWebsite[]> {
     // Generate query
     let query = {
       filter_configured: (
         (filterConfigured === true) ? "1" : "0"
+      ),
+
+      include_plan: (
+        (includePlan === true) ? "1" : "0"
       )
     };
 
@@ -100,12 +104,16 @@ class PluginConnect extends BaseResource {
    * List Connect Websites Since
    */
   listConnectWebsitesSince(
-    dateSince: string, filterConfigured: boolean
+    dateSince: string, filterConfigured: boolean, includePlan: boolean
   ): Promise<PluginConnectWebsitesSince[]> {
     // Generate query
     let query = {
       filter_configured: (
         (filterConfigured === true) ? "1" : "0"
+      ),
+
+      include_plan: (
+        (includePlan === true) ? "1" : "0"
       )
     };
 

package/lib/resources/PluginSubscription.ts

@@ -17,53 +17,53 @@ import BaseResource from "./BaseResource";
  ***************************************************************************/
 
 export 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;
+  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;
 }
 
 export type PluginSubscriptionPlan = {
-  id?:     string;
-  name?:   string;
-  price?:  number;
+  id?: string;
+  name?: string;
+  price?: number;
 }
 
 export type PluginSubscriptionSettings = {
-  plugin_id?:       string;
-  website_id?:      string;
-  token?:           string;
-  schema?:          object;
-  settings?:        object;
+  plugin_id?: string;
+  website_id?: string;
+  token?: string;
+  schema?: object;
+  settings?: object;
   settings_form_url?: string;
-  callback_url?:    string;
+  callback_url?: string;
 }
 
 export type PluginSubscriptionChannelForward = {
-  namespace?:   string;
-  identifier?:  string;
-  payload?:     object;
+  namespace?: string;
+  identifier?: string;
+  payload?: object;
 }
 
 export type PluginSubscriptionEventDispatch = {
-  name?:   string;
-  data?:   object;
+  name?: string;
+  data?: object;
 }
 
 /**************************************************************************

package/lib/resources/WebsiteAvailability.ts

@@ -17,18 +17,18 @@ import BaseResource from "./BaseResource";
  ***************************************************************************/
 
 export type WebsiteAvailabilityStatus = {
-  status?:  string;
-  since?:   number;
+  status?: string;
+  since?: number;
 }
 
 export type WebsiteAvailabilityOperator = {
-  user_id?:  string;
-  type?:     string;
-  time?:     WebsiteAvailabilityOperatorTime;
+  user_id?: string;
+  type?: string;
+  time?: WebsiteAvailabilityOperatorTime;
 }
 
 export type WebsiteAvailabilityOperatorTime = {
-  for?:   number;
+  for?: number;
   since?: number;
 }
 

package/lib/resources/WebsiteBase.ts

@@ -17,27 +17,27 @@ import BaseResource from "./BaseResource";
  ***************************************************************************/
 
 export type Website = {
-  website_id?:  string;
-  name?:        string;
-  domain?:      string;
-  logo?:        string;
+  website_id?: string;
+  name?: string;
+  domain?: string;
+  logo?: string;
 }
 
 export type WebsiteCreate = {
-  name?:        string;
-  domain?:      string;
+  name?: string;
+  domain?: string;
 }
 
 export type WebsiteRemoveVerify = {
-  method?:  string;
-  secret?:  string;
+  method?: string;
+  secret?: string;
 }
 
 export type WebsiteFilter = {
-  model?:      string;
-  criterion?:  string;
-  operator?:   string;
-  query?:      Record<string, unknown>;
+  model?: string;
+  criterion?: string;
+  operator?: string;
+  query?: Record<string, unknown>;
 }
 
 /**************************************************************************

package/lib/resources/WebsiteBatch.ts

@@ -17,13 +17,13 @@ import BaseResource from "./BaseResource";
  ***************************************************************************/
 
 export type WebsiteBatchConversationsOperation = {
-  inbox_id?:  string;
-  sessions?:  string[];
+  inbox_id?: string;
+  sessions?: string[];
 }
 
 export type WebsiteBatchPeopleOperationInner = {
-  profiles?:  string[];
-  search?:    string;
+  profiles?: string[];
+  search?: string;
 }
 
 /**************************************************************************

package/lib/resources/WebsiteCampaign.ts

@@ -18,122 +18,122 @@ import { WebsiteFilter } from "./WebsiteBase";
  ***************************************************************************/
 
 export 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;
+  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;
 }
 
 export type WebsiteCampaignTemplateExcerpt = {
-  template_id?:  string;
-  type?:         string;
-  name?:         string;
-  format?:       string;
-  created_at?:   number;
-  updated_at?:   number;
+  template_id?: string;
+  type?: string;
+  name?: string;
+  format?: string;
+  created_at?: number;
+  updated_at?: number;
 }
 
 export type WebsiteCampaignTemplateNew = {
-  template_id?:  string;
+  template_id?: string;
 }
 
 export interface WebsiteCampaignTemplateItem extends WebsiteCampaignTemplateExcerpt {
-  content?:  string;
+  content?: string;
 }
 
 export interface WebsiteCampaignItem extends WebsiteCampaignExcerpt {
-  sender?:      WebsiteCampaignItemSender;
-  recipients?:  WebsiteCampaignItemRecipients;
-  flow?:        WebsiteCampaignItemFlow;
-  message?:     string;
-  options?:     WebsiteCampaignItemOptions;
-  statistics?:  WebsiteCampaignItemStatistics;
+  sender?: WebsiteCampaignItemSender;
+  recipients?: WebsiteCampaignItemRecipients;
+  flow?: WebsiteCampaignItemFlow;
+  message?: string;
+  options?: WebsiteCampaignItemOptions;
+  statistics?: WebsiteCampaignItemStatistics;
 }
 
 export type WebsiteCampaignItemSender = {
-  user_id?:  string;
+  user_id?: string;
 }
 
 export type WebsiteCampaignItemRecipients = {
-  type?:         string;
-  segments?:     string[];
-  people?:       string[];
-  filter?:       WebsiteFilter[];
+  type?: string;
+  segments?: string[];
+  people?: string[];
+  filter?: WebsiteFilter[];
 }
 
 export type WebsiteCampaignItemFlow = {
-  launch_event?:   string;
-  assert_filter?:  WebsiteFilter[];
-  assert_delay?:   number;
-  deliver_once?:   boolean;
-  deliver_delay?:  number;
+  launch_event?: string;
+  assert_filter?: WebsiteFilter[];
+  assert_delay?: number;
+  deliver_once?: boolean;
+  deliver_delay?: number;
 }
 
 export type WebsiteCampaignItemOptions = {
-  deliver_to_chatbox?:  boolean;
-  deliver_to_email?:    boolean;
-  sender_name_website?:  boolean;
-  sender_email_reply?:   boolean;
-  tracking?:             boolean;
+  deliver_to_chatbox?: boolean;
+  deliver_to_email?: boolean;
+  sender_name_website?: boolean;
+  sender_email_reply?: boolean;
+  tracking?: boolean;
 }
 
 export type WebsiteCampaignItemStatistics = {
-  opened?:        number;
-  clicked?:       number;
-  unsubscribed?:  number;
+  opened?: number;
+  clicked?: number;
+  unsubscribed?: number;
 }
 
 export type WebsiteCampaignRecipient = {
-  people_id?:  string;
-  email?:      string;
-  person?:     WebsiteCampaignRecipientPerson;
-  subscribed?:  boolean;
+  people_id?: string;
+  email?: string;
+  person?: WebsiteCampaignRecipientPerson;
+  subscribed?: boolean;
 }
 
 export type WebsiteCampaignRecipientPerson = {
-  nickname?:  string;
-  avatar?:    string;
+  nickname?: string;
+  avatar?: string;
 }
 
 export type WebsiteCampaignStatistic = {
-  profile?:    WebsiteCampaignStatisticProfile;
-  data?:       Record<string, unknown>;
-  created_at?:  number;
-  updated_at?:  number;
+  profile?: WebsiteCampaignStatisticProfile;
+  data?: Record<string, unknown>;
+  created_at?: number;
+  updated_at?: number;
 }
 
 export type WebsiteCampaignStatisticProfile = {
-  people_id?:  string;
-  email?:      string;
-  person?:     WebsiteCampaignStatisticProfilePerson;
+  people_id?: string;
+  email?: string;
+  person?: WebsiteCampaignStatisticProfilePerson;
 }
 
 export type WebsiteCampaignStatisticProfilePerson = {
-  nickname?:  string;
-  avatar?:    string;
-  geolocation?:  WebsiteCampaignStatisticProfilePersonGeolocation;
+  nickname?: string;
+  avatar?: string;
+  geolocation?: WebsiteCampaignStatisticProfilePersonGeolocation;
 }
 
 export type WebsiteCampaignStatisticProfilePersonGeolocation = {
-  country?:      string;
-  region?:      string;
-  city?:        string;
-  coordinates?:  WebsiteCampaignStatisticProfilePersonGeolocationCoordinates;
+  country?: string;
+  region?: string;
+  city?: string;
+  coordinates?: WebsiteCampaignStatisticProfilePersonGeolocationCoordinates;
 }
 
 export type WebsiteCampaignStatisticProfilePersonGeolocationCoordinates = {
-  latitude?:  number;
+  latitude?: number;
   longitude?: number;
 }
 

package/lib/resources/WebsiteConversation.ts

@@ -398,21 +398,21 @@ export interface ConversationComposeMessageNew {
 }
 
 export interface ConversationSuggestedSegment {
-  segment?:  string;
-  count?:    number;
+  segment?: string;
+  count?: number;
 }
 
 export interface ConversationSuggestedData {
-  key?:  string;
+  key?: string;
   count?: number;
 }
 
 export interface ConversationSpam {
-  spam_id?:   string;
-  type?:      string;
-  reason?:    string;
-  metadata?:  Record<string, unknown>;
-  headers?:   Record<string, unknown>;
+  spam_id?: string;
+  type?: string;
+  reason?: string;
+  metadata?: Record<string, unknown>;
+  headers?: Record<string, unknown>;
   timestamp?: number;
 }
 

package/lib/resources/WebsiteSettings.ts

@@ -80,9 +80,11 @@ export interface WebsiteSettingsChatbox {
   overlay_mode?: boolean;
   helpdesk_link?: boolean;
   helpdesk_only?: boolean;
+  helpdesk_navigate?: string;
   status_health_dead?: boolean;
   check_domain?: boolean;
   color_theme?: string;
+  color_mode?: string;
   layout_theme?: string;
   text_theme?: string;
   welcome_message?: string;
@@ -157,9 +159,11 @@ export interface WebsiteSettingsUpdateChatbox {
   overlay_mode?: boolean;
   helpdesk_link?: boolean;
   helpdesk_only?: boolean;
+  helpdesk_navigate?: string;
   status_health_dead?: boolean;
   check_domain?: boolean;
   color_theme?: string;
+  color_mode?: string;
   layout_theme?: string;
   text_theme?: string;
   welcome_message?: string;

package/lib/resources/index.ts

@@ -14,6 +14,7 @@ export * from "./BucketURL";
 export * from "./MediaAnimation";
 export * from "./PluginConnect";
 export * from "./PluginSubscription";
+export * from "./PlanSubscription";
 export * from "./WebsiteAnalytics";
 export * from "./WebsiteAvailability";
 export * from "./WebsiteBase";

package/lib/services/plan.ts

@@ -0,0 +1,36 @@
+/*
+ * This file is part of node-crisp-api
+ *
+ * Copyright (c) 2026 Crisp IM SAS
+ * All rights belong to Crisp IM SAS
+ */
+
+/**************************************************************************
+ * IMPORTS
+ ***************************************************************************/
+
+// PROJECT: RESOURCES
+import PlanSubscription from "@/resources/PlanSubscription";
+
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
+
+/**
+ * Crisp Plan Service
+ */
+class PlanService {
+  /* eslint-disable @typescript-eslint/no-explicit-any */
+  public __resources: any[] = [
+    PlanSubscription
+  ];
+}
+
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+
+export interface PlanServiceInterface extends PlanSubscription {
+}
+
+export default PlanService;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "crisp-api",
   "description": "Crisp API wrapper for Node - official, maintained by Crisp",
-  "version": "10.2.0",
+  "version": "10.4.0",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {