@opens/gateways 1.16.24 → 1.17.0

package/dist/chat-config/contracts/index.d.ts

@@ -1,3 +1,5 @@
+export { C as CreateScreenRuleDTO, a as ScreenRuleBodyComponent, S as ScreenRuleHeaderComponent } from '../../_screen-rule-FlIJzVXA.js';
+
 /** Available provider options in the Chat Config API. */
 type ProviderName = 'whatsapp' | 'gmail' | 'outlook' | 'messenger' | 'direct' | 'yunique';
 interface Provider {
@@ -151,43 +153,84 @@ interface ProviderDisplayInfoResponse {
     channel: string | null;
 }
 
-/** A provider entity nested within a configuration response. */
+/**
+ * Provider entity nested in `GET /config/provider/:providerId` via the
+ * Sequelize association `providers` (`Configs.belongsTo(Providers)`).
+ * `id` is the integer primary key of the `Providers` table.
+ */
 interface ConfigProvider {
-    id: string;
+    /** Provider primary key (`Providers.id`, integer). */
+    id: number | string;
+    /** Provider name (e.g. `whatsapp`, `gmail`, `outlook`, `messenger`, `direct`, `yunique`). */
     name: string;
+    /** Provider channel type (e.g. `chat`, `email`). */
     type: string;
+    /** Default session TTL in seconds. */
     defaultSession: number;
+    /** JSON schema describing provider-specific `configurations` fields, when available. */
     configurationsSchema: Record<string, unknown> | null;
     createdAt: string;
     updatedAt: string;
 }
-/** A configuration entity returned by the Chat Config API. */
+/**
+ * A configuration row from the `Configs` table.
+ * Returned by `GET /config/:configId` and inside
+ * `GET /config/provider/:providerId` (`{ configurations: Config[] }`).
+ * When listed by provider, each item includes the nested `providers` association.
+ */
 interface Config {
+    /** Configuration UUID (`Configs.id`). */
     id: string;
     isAssistanceEnabled: boolean;
     rewind: number | null;
+    /** Company UUID resolved from the auth token on list-by-provider. */
     companyId: string;
     active: boolean;
+    /** Provider-specific settings JSON (shape varies by provider). */
     configurations: Record<string, unknown>;
     priority: number | null;
+    /** Foreign key to `Providers.id`. */
+    providerId: number | string;
     inbound: boolean;
     outbound: boolean;
     deletedAt: string | null;
+    csatConditionalRulesEnabled: boolean;
+    csatFeedbackTTL: number | null;
+    createdAt: string;
+    updatedAt: string;
+    /** Nested provider loaded by `GET /config/provider/:providerId`. */
     providers: ConfigProvider;
 }
-/** Response returned by the Chat Config API when listing configurations by provider. */
+/**
+ * Response of `GET /config/provider/:providerId`.
+ * Always wrapped as `{ configurations }` (empty array when none match).
+ */
 interface ConfigListByProviderResponse {
     configurations: Config[];
 }
-/** Query parameters for filtering configurations by provider. */
+/**
+ * Optional query filters for `GET /config/provider/:providerId`.
+ * Filters map to `Configs` columns, except `providerType` / `providerName`
+ * which filter the nested `providers` association (`type` / `name`).
+ * The backend applies filters with truthiness checks, so `false` / `0` values
+ * are ignored and do not filter.
+ */
 interface GetConfigsByProviderParams {
+    /** Filter by `Configs.isAssistanceEnabled`. */
     isAssistanceEnabled?: boolean;
+    /** Filter by `Configs.rewind`. */
     rewind?: number;
+    /** Filter by `Configs.active`. */
     active?: boolean;
+    /** Filter by `Configs.priority`. */
     priority?: number;
+    /** Filter by `Configs.inbound` (e.g. inbound WhatsApp channels). */
     inbound?: boolean;
+    /** Filter by `Configs.outbound`. */
     outbound?: boolean;
+    /** Filter by nested `providers.type` (e.g. `chat`, `email`). */
     providerType?: string;
+    /** Filter by nested `providers.name` (e.g. `whatsapp`). */
     providerName?: string;
 }
 

package/dist/chat-config/value-objects/index.d.mts

@@ -0,0 +1,25 @@
+import { C as CreateScreenRuleDTO } from '../../_screen-rule-FlIJzVXA.mjs';
+
+/** Value object representing a complete screen-rule payload. */
+declare class ScreenRuleVO {
+    readonly payload: CreateScreenRuleDTO;
+    /**
+     * Creates a screen-rule value object from a complete payload.
+     * @param payload - The screen-rule payload to snapshot.
+     */
+    constructor(payload: CreateScreenRuleDTO);
+    /**
+     * Creates a value object from its JSON representation.
+     * @param payload - The screen-rule JSON payload.
+     * @returns A screen-rule value object containing a defensive snapshot.
+     */
+    static fromJSON(payload: CreateScreenRuleDTO): ScreenRuleVO;
+    /**
+     * Converts a screen-rule value object to JSON.
+     * @param screenRuleVO - The screen-rule value object to serialize.
+     * @returns A defensive copy of the screen-rule payload.
+     */
+    static toJSON(screenRuleVO: ScreenRuleVO): CreateScreenRuleDTO;
+}
+
+export { ScreenRuleVO };

package/dist/chat-config/value-objects/index.d.ts

@@ -0,0 +1,25 @@
+import { C as CreateScreenRuleDTO } from '../../_screen-rule-FlIJzVXA.js';
+
+/** Value object representing a complete screen-rule payload. */
+declare class ScreenRuleVO {
+    readonly payload: CreateScreenRuleDTO;
+    /**
+     * Creates a screen-rule value object from a complete payload.
+     * @param payload - The screen-rule payload to snapshot.
+     */
+    constructor(payload: CreateScreenRuleDTO);
+    /**
+     * Creates a value object from its JSON representation.
+     * @param payload - The screen-rule JSON payload.
+     * @returns A screen-rule value object containing a defensive snapshot.
+     */
+    static fromJSON(payload: CreateScreenRuleDTO): ScreenRuleVO;
+    /**
+     * Converts a screen-rule value object to JSON.
+     * @param screenRuleVO - The screen-rule value object to serialize.
+     * @returns A defensive copy of the screen-rule payload.
+     */
+    static toJSON(screenRuleVO: ScreenRuleVO): CreateScreenRuleDTO;
+}
+
+export { ScreenRuleVO };

package/dist/chat-config/value-objects/index.js

@@ -0,0 +1,66 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/chat-config/value-objects/index.ts
+var value_objects_exports = {};
+__export(value_objects_exports, {
+  ScreenRuleVO: () => ScreenRuleVO
+});
+module.exports = __toCommonJS(value_objects_exports);
+
+// src/chat-config/value-objects/_screen-rule.ts
+var clonePayload = (payload) => ({
+  name: payload.name,
+  action: "screen",
+  settings: {
+    ...payload.settings.header !== void 0 ? { header: { ...payload.settings.header } } : {},
+    ...payload.settings.body !== void 0 ? { body: { ...payload.settings.body } } : {}
+  }
+});
+var ScreenRuleVO = class _ScreenRuleVO {
+  payload;
+  /**
+   * Creates a screen-rule value object from a complete payload.
+   * @param payload - The screen-rule payload to snapshot.
+   */
+  constructor(payload) {
+    this.payload = clonePayload(payload);
+  }
+  /**
+   * Creates a value object from its JSON representation.
+   * @param payload - The screen-rule JSON payload.
+   * @returns A screen-rule value object containing a defensive snapshot.
+   */
+  static fromJSON(payload) {
+    return new _ScreenRuleVO(payload);
+  }
+  /**
+   * Converts a screen-rule value object to JSON.
+   * @param screenRuleVO - The screen-rule value object to serialize.
+   * @returns A defensive copy of the screen-rule payload.
+   */
+  static toJSON(screenRuleVO) {
+    return clonePayload(screenRuleVO.payload);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ScreenRuleVO
+});
+//# sourceMappingURL=index.js.map

package/dist/chat-config/value-objects/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/chat-config/value-objects/index.ts","../../../src/chat-config/value-objects/_screen-rule.ts"],"sourcesContent":["export * from './_screen-rule';\n","import type { CreateScreenRuleDTO } from '../contracts';\n\nconst clonePayload = (payload: CreateScreenRuleDTO): CreateScreenRuleDTO => ({\n  name: payload.name,\n  action: 'screen',\n  settings: {\n    ...(payload.settings.header !== undefined ? { header: { ...payload.settings.header } } : {}),\n    ...(payload.settings.body !== undefined ? { body: { ...payload.settings.body } } : {}),\n  },\n});\n\n/** Value object representing a complete screen-rule payload. */\nexport class ScreenRuleVO {\n  readonly payload: CreateScreenRuleDTO;\n\n  /**\n   * Creates a screen-rule value object from a complete payload.\n   * @param payload - The screen-rule payload to snapshot.\n   */\n  constructor(payload: CreateScreenRuleDTO) {\n    this.payload = clonePayload(payload);\n  }\n\n  /**\n   * Creates a value object from its JSON representation.\n   * @param payload - The screen-rule JSON payload.\n   * @returns A screen-rule value object containing a defensive snapshot.\n   */\n  static fromJSON(payload: CreateScreenRuleDTO): ScreenRuleVO {\n    return new ScreenRuleVO(payload);\n  }\n\n  /**\n   * Converts a screen-rule value object to JSON.\n   * @param screenRuleVO - The screen-rule value object to serialize.\n   * @returns A defensive copy of the screen-rule payload.\n   */\n  static toJSON(screenRuleVO: ScreenRuleVO): CreateScreenRuleDTO {\n    return clonePayload(screenRuleVO.payload);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACEA,IAAM,eAAe,CAAC,aAAuD;AAAA,EAC3E,MAAM,QAAQ;AAAA,EACd,QAAQ;AAAA,EACR,UAAU;AAAA,IACR,GAAI,QAAQ,SAAS,WAAW,SAAY,EAAE,QAAQ,EAAE,GAAG,QAAQ,SAAS,OAAO,EAAE,IAAI,CAAC;AAAA,IAC1F,GAAI,QAAQ,SAAS,SAAS,SAAY,EAAE,MAAM,EAAE,GAAG,QAAQ,SAAS,KAAK,EAAE,IAAI,CAAC;AAAA,EACtF;AACF;AAGO,IAAM,eAAN,MAAM,cAAa;AAAA,EACf;AAAA;AAAA;AAAA;AAAA;AAAA,EAMT,YAAY,SAA8B;AACxC,SAAK,UAAU,aAAa,OAAO;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,SAAS,SAA4C;AAC1D,WAAO,IAAI,cAAa,OAAO;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,OAAO,cAAiD;AAC7D,WAAO,aAAa,aAAa,OAAO;AAAA,EAC1C;AACF;","names":[]}

package/dist/chat-config/value-objects/index.mjs

@@ -0,0 +1,39 @@
+// src/chat-config/value-objects/_screen-rule.ts
+var clonePayload = (payload) => ({
+  name: payload.name,
+  action: "screen",
+  settings: {
+    ...payload.settings.header !== void 0 ? { header: { ...payload.settings.header } } : {},
+    ...payload.settings.body !== void 0 ? { body: { ...payload.settings.body } } : {}
+  }
+});
+var ScreenRuleVO = class _ScreenRuleVO {
+  payload;
+  /**
+   * Creates a screen-rule value object from a complete payload.
+   * @param payload - The screen-rule payload to snapshot.
+   */
+  constructor(payload) {
+    this.payload = clonePayload(payload);
+  }
+  /**
+   * Creates a value object from its JSON representation.
+   * @param payload - The screen-rule JSON payload.
+   * @returns A screen-rule value object containing a defensive snapshot.
+   */
+  static fromJSON(payload) {
+    return new _ScreenRuleVO(payload);
+  }
+  /**
+   * Converts a screen-rule value object to JSON.
+   * @param screenRuleVO - The screen-rule value object to serialize.
+   * @returns A defensive copy of the screen-rule payload.
+   */
+  static toJSON(screenRuleVO) {
+    return clonePayload(screenRuleVO.payload);
+  }
+};
+export {
+  ScreenRuleVO
+};
+//# sourceMappingURL=index.mjs.map

package/dist/chat-config/value-objects/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/chat-config/value-objects/_screen-rule.ts"],"sourcesContent":["import type { CreateScreenRuleDTO } from '../contracts';\n\nconst clonePayload = (payload: CreateScreenRuleDTO): CreateScreenRuleDTO => ({\n  name: payload.name,\n  action: 'screen',\n  settings: {\n    ...(payload.settings.header !== undefined ? { header: { ...payload.settings.header } } : {}),\n    ...(payload.settings.body !== undefined ? { body: { ...payload.settings.body } } : {}),\n  },\n});\n\n/** Value object representing a complete screen-rule payload. */\nexport class ScreenRuleVO {\n  readonly payload: CreateScreenRuleDTO;\n\n  /**\n   * Creates a screen-rule value object from a complete payload.\n   * @param payload - The screen-rule payload to snapshot.\n   */\n  constructor(payload: CreateScreenRuleDTO) {\n    this.payload = clonePayload(payload);\n  }\n\n  /**\n   * Creates a value object from its JSON representation.\n   * @param payload - The screen-rule JSON payload.\n   * @returns A screen-rule value object containing a defensive snapshot.\n   */\n  static fromJSON(payload: CreateScreenRuleDTO): ScreenRuleVO {\n    return new ScreenRuleVO(payload);\n  }\n\n  /**\n   * Converts a screen-rule value object to JSON.\n   * @param screenRuleVO - The screen-rule value object to serialize.\n   * @returns A defensive copy of the screen-rule payload.\n   */\n  static toJSON(screenRuleVO: ScreenRuleVO): CreateScreenRuleDTO {\n    return clonePayload(screenRuleVO.payload);\n  }\n}\n"],"mappings":";AAEA,IAAM,eAAe,CAAC,aAAuD;AAAA,EAC3E,MAAM,QAAQ;AAAA,EACd,QAAQ;AAAA,EACR,UAAU;AAAA,IACR,GAAI,QAAQ,SAAS,WAAW,SAAY,EAAE,QAAQ,EAAE,GAAG,QAAQ,SAAS,OAAO,EAAE,IAAI,CAAC;AAAA,IAC1F,GAAI,QAAQ,SAAS,SAAS,SAAY,EAAE,MAAM,EAAE,GAAG,QAAQ,SAAS,KAAK,EAAE,IAAI,CAAC;AAAA,EACtF;AACF;AAGO,IAAM,eAAN,MAAM,cAAa;AAAA,EACf;AAAA;AAAA;AAAA;AAAA;AAAA,EAMT,YAAY,SAA8B;AACxC,SAAK,UAAU,aAAa,OAAO;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,SAAS,SAA4C;AAC1D,WAAO,IAAI,cAAa,OAAO;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,OAAO,cAAiD;AAC7D,WAAO,aAAa,aAAa,OAAO;AAAA,EAC1C;AACF;","names":[]}

package/dist/index.d.mts

@@ -26,6 +26,7 @@ export { AccessGroup, AccessPackageGroup } from './access-hub/contracts/index.mj
 import { GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserDevicesParams, GetUserDevicesResponse, RegisterUserDeviceRequest, RegisterUserDeviceResponse, DeleteUserDeviceResponse, GetUserPreferencesParams, UserPreference, CreateUserPreferenceRequest, DeleteUserPreferenceParams, DeleteUserPreferenceResponse } from './notifications/contracts/index.mjs';
 export { DeviceType, SystemNotification, SystemNotificationType, UserDevice, UserPreferenceDevice, UserPreferenceSystemNotification } from './notifications/contracts/index.mjs';
 export { Event } from './rh/contracts/index.mjs';
+export { C as CreateScreenRuleDTO, a as ScreenRuleBodyComponent, S as ScreenRuleHeaderComponent } from './_screen-rule-FlIJzVXA.mjs';
 
 /**
  * Gateway for interacting with the Customer Service API.
@@ -270,12 +271,14 @@ declare class ChatConfigGateway {
      */
     getProviderDisplayInfo(params: GetProviderDisplayInfoParams): Promise<ProviderDisplayInfoResponse>;
     /**
-     * Retrieves configurations filtered by provider.
-     * @param providerId - The unique identifier of the provider.
-     * @param params - Optional query parameters for filtering configurations.
-     * @returns The configurations for the given provider.
+     * Lists configurations for a provider (`GET /config/provider/:providerId`).
+     * Scoped to the authenticated company's `companyId` from the token.
+     * Each item includes the nested `providers` association.
+     * @param providerId - Provider primary key (`Providers.id`, e.g. `1` for WhatsApp).
+     * @param params - Optional filters on config columns and nested provider fields.
+     * @returns `{ configurations }` for the given provider (empty array when none match).
      */
-    getConfigsByProvider(providerId: string, params?: GetConfigsByProviderParams): Promise<ConfigListByProviderResponse>;
+    getConfigsByProvider(providerId: string | number, params?: GetConfigsByProviderParams): Promise<ConfigListByProviderResponse>;
     /**
      * Retrieves a queue by its ID.
      * @param queueId - The unique identifier of the queue.

package/dist/index.d.ts

@@ -26,6 +26,7 @@ export { AccessGroup, AccessPackageGroup } from './access-hub/contracts/index.js
 import { GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserDevicesParams, GetUserDevicesResponse, RegisterUserDeviceRequest, RegisterUserDeviceResponse, DeleteUserDeviceResponse, GetUserPreferencesParams, UserPreference, CreateUserPreferenceRequest, DeleteUserPreferenceParams, DeleteUserPreferenceResponse } from './notifications/contracts/index.js';
 export { DeviceType, SystemNotification, SystemNotificationType, UserDevice, UserPreferenceDevice, UserPreferenceSystemNotification } from './notifications/contracts/index.js';
 export { Event } from './rh/contracts/index.js';
+export { C as CreateScreenRuleDTO, a as ScreenRuleBodyComponent, S as ScreenRuleHeaderComponent } from './_screen-rule-FlIJzVXA.js';
 
 /**
  * Gateway for interacting with the Customer Service API.
@@ -270,12 +271,14 @@ declare class ChatConfigGateway {
      */
     getProviderDisplayInfo(params: GetProviderDisplayInfoParams): Promise<ProviderDisplayInfoResponse>;
     /**
-     * Retrieves configurations filtered by provider.
-     * @param providerId - The unique identifier of the provider.
-     * @param params - Optional query parameters for filtering configurations.
-     * @returns The configurations for the given provider.
+     * Lists configurations for a provider (`GET /config/provider/:providerId`).
+     * Scoped to the authenticated company's `companyId` from the token.
+     * Each item includes the nested `providers` association.
+     * @param providerId - Provider primary key (`Providers.id`, e.g. `1` for WhatsApp).
+     * @param params - Optional filters on config columns and nested provider fields.
+     * @returns `{ configurations }` for the given provider (empty array when none match).
      */
-    getConfigsByProvider(providerId: string, params?: GetConfigsByProviderParams): Promise<ConfigListByProviderResponse>;
+    getConfigsByProvider(providerId: string | number, params?: GetConfigsByProviderParams): Promise<ConfigListByProviderResponse>;
     /**
      * Retrieves a queue by its ID.
      * @param queueId - The unique identifier of the queue.

package/dist/index.js

@@ -460,10 +460,12 @@ var ChatConfigGateway = class {
     return data;
   }
   /**
-   * Retrieves configurations filtered by provider.
-   * @param providerId - The unique identifier of the provider.
-   * @param params - Optional query parameters for filtering configurations.
-   * @returns The configurations for the given provider.
+   * Lists configurations for a provider (`GET /config/provider/:providerId`).
+   * Scoped to the authenticated company's `companyId` from the token.
+   * Each item includes the nested `providers` association.
+   * @param providerId - Provider primary key (`Providers.id`, e.g. `1` for WhatsApp).
+   * @param params - Optional filters on config columns and nested provider fields.
+   * @returns `{ configurations }` for the given provider (empty array when none match).
    */
   async getConfigsByProvider(providerId, params) {
     const { data } = await this.httpClient.get(