@opens/gateways 1.16.24 → 1.16.25

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

@@ -151,43 +151,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/contracts/index.d.ts

@@ -151,43 +151,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/index.d.mts

@@ -270,12 +270,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.
-     */
-    getConfigsByProvider(providerId: string, params?: GetConfigsByProviderParams): Promise<ConfigListByProviderResponse>;
+     * 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 | number, params?: GetConfigsByProviderParams): Promise<ConfigListByProviderResponse>;
     /**
      * Retrieves a queue by its ID.
      * @param queueId - The unique identifier of the queue.

package/dist/index.d.ts

@@ -270,12 +270,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.
-     */
-    getConfigsByProvider(providerId: string, params?: GetConfigsByProviderParams): Promise<ConfigListByProviderResponse>;
+     * 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 | 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(