@cleardu/types 1.0.551 → 1.0.552

package/constants/brokerMessages/index.d.ts

@@ -82,6 +82,10 @@ export declare const BrokerMessages: {
             MIGRATE_CLIENT_PRODUCT_TYPE: string;
             GET_X_API_KEY: string;
             GET_X_API_KEY_BY_CLIENT_ID: string;
+            GET_LEGAL_PORTAL_API_KEY: string;
+            GET_LEGAL_PORTAL_API_KEY_BY_CLIENT_ID: string;
+            GENERATE_LEGAL_PORTAL_API_KEY: string;
+            GET_LEGAL_CLIENT_VIA_INTEGRATION: string;
             GET_META_ONBOARD_DETAILS_BY_CLIENT_UID: string;
         };
         CAMPAIGN: {
@@ -518,6 +522,10 @@ export declare const BrokerMessages: {
             DIALER_CAMPAIGN_DETAILS: string;
             GET_CAMPAIGN_USER_LEADS: string;
         };
+        LEGAL_PORTAL: {
+            GET_CLIENT: string;
+            GET_LOAN_TIMELINE: string;
+        };
         ENKASH: {
             GENERATE_PAYMENT_LINK: string;
             INIT: string;
@@ -662,6 +670,12 @@ export declare const BrokerMessages: {
             };
             MIGRATE_MESSAGE_FILES: string;
         };
+        NOTICE: {
+            VIEW_LINK: string;
+            TRACKING_LIST: string;
+            UPDATE: string;
+            TRACKING_BY_LEAD: string;
+        };
         MAIL: {
             SEND: string;
         };

package/constants/brokerMessages/index.js

@@ -85,6 +85,10 @@ exports.BrokerMessages = {
             MIGRATE_CLIENT_PRODUCT_TYPE: 'MIGRATE-CLIENT-PRODUCT-TYPE',
             GET_X_API_KEY: 'CRM-CLIENT-GET-X-API-KEY',
             GET_X_API_KEY_BY_CLIENT_ID: 'CRM-CLIENT-GET-X-API-KEY-BY-CLIENT-ID',
+            GET_LEGAL_PORTAL_API_KEY: 'CRM-CLIENT-GET-LEGAL-PORTAL-API-KEY',
+            GET_LEGAL_PORTAL_API_KEY_BY_CLIENT_ID: 'CRM-CLIENT-GET-LEGAL-PORTAL-API-KEY-BY-CLIENT-ID',
+            GENERATE_LEGAL_PORTAL_API_KEY: 'CRM-CLIENT-GENERATE-LEGAL-PORTAL-API-KEY',
+            GET_LEGAL_CLIENT_VIA_INTEGRATION: 'CRM-CLIENT-GET-LEGAL-CLIENT-VIA-INTEGRATION',
             GET_META_ONBOARD_DETAILS_BY_CLIENT_UID: 'CRM-CLIENT-GET-META-ONBOARD-DETAILS-BY-CLIENT-UID',
         },
         CAMPAIGN: {
@@ -521,6 +525,10 @@ exports.BrokerMessages = {
             DIALER_CAMPAIGN_DETAILS: 'DIALER-CAMPAIGN-DETAILS',
             GET_CAMPAIGN_USER_LEADS: 'GET-CAMPAIGN-USER-LEADS',
         },
+        LEGAL_PORTAL: {
+            GET_CLIENT: 'INTEGRATION-LEGAL-PORTAL-GET-CLIENT',
+            GET_LOAN_TIMELINE: 'INTEGRATION-LEGAL-PORTAL-GET-LOAN-TIMELINE',
+        },
         ENKASH: {
             GENERATE_PAYMENT_LINK: 'GENERATE-PAYMENT-LINK',
             INIT: 'PAYMENT-INITIATE',
@@ -665,6 +673,12 @@ exports.BrokerMessages = {
             },
             MIGRATE_MESSAGE_FILES: 'MIGRATE-MESSAGE-FILES',
         },
+        NOTICE: {
+            VIEW_LINK: 'NOTICE-VIEW-LINK',
+            TRACKING_LIST: 'NOTICE-TRACKING-LIST',
+            UPDATE: 'NOTICE-UPDATE',
+            TRACKING_BY_LEAD: 'NOTICE-TRACKING-BY-LEAD',
+        },
         MAIL: {
             SEND: 'MAIL-SEND',
         },

package/constants/brokerMessages/index.ts

@@ -83,6 +83,12 @@ export const BrokerMessages = {
       MIGRATE_CLIENT_PRODUCT_TYPE: 'MIGRATE-CLIENT-PRODUCT-TYPE',
       GET_X_API_KEY: 'CRM-CLIENT-GET-X-API-KEY',
       GET_X_API_KEY_BY_CLIENT_ID: 'CRM-CLIENT-GET-X-API-KEY-BY-CLIENT-ID',
+      GET_LEGAL_PORTAL_API_KEY: 'CRM-CLIENT-GET-LEGAL-PORTAL-API-KEY',
+      GET_LEGAL_PORTAL_API_KEY_BY_CLIENT_ID:
+        'CRM-CLIENT-GET-LEGAL-PORTAL-API-KEY-BY-CLIENT-ID',
+      GENERATE_LEGAL_PORTAL_API_KEY: 'CRM-CLIENT-GENERATE-LEGAL-PORTAL-API-KEY',
+      GET_LEGAL_CLIENT_VIA_INTEGRATION:
+        'CRM-CLIENT-GET-LEGAL-CLIENT-VIA-INTEGRATION',
       GET_META_ONBOARD_DETAILS_BY_CLIENT_UID:
         'CRM-CLIENT-GET-META-ONBOARD-DETAILS-BY-CLIENT-UID',
     },
@@ -528,6 +534,10 @@ export const BrokerMessages = {
       DIALER_CAMPAIGN_DETAILS: 'DIALER-CAMPAIGN-DETAILS',
       GET_CAMPAIGN_USER_LEADS: 'GET-CAMPAIGN-USER-LEADS',
     },
+    LEGAL_PORTAL: {
+      GET_CLIENT: 'INTEGRATION-LEGAL-PORTAL-GET-CLIENT',
+      GET_LOAN_TIMELINE: 'INTEGRATION-LEGAL-PORTAL-GET-LOAN-TIMELINE',
+    },
     ENKASH: {
       GENERATE_PAYMENT_LINK: 'GENERATE-PAYMENT-LINK',
       INIT: 'PAYMENT-INITIATE',
@@ -673,6 +683,12 @@ export const BrokerMessages = {
       },
       MIGRATE_MESSAGE_FILES: 'MIGRATE-MESSAGE-FILES',
     },
+    NOTICE: {
+      VIEW_LINK: 'NOTICE-VIEW-LINK',
+      TRACKING_LIST: 'NOTICE-TRACKING-LIST',
+      UPDATE: 'NOTICE-UPDATE',
+      TRACKING_BY_LEAD: 'NOTICE-TRACKING-BY-LEAD',
+    },
     MAIL: {
       SEND: 'MAIL-SEND',
     },

package/interfaces/clients/index.d.ts

@@ -17,6 +17,8 @@ export interface IClients extends DatabaseObject {
     apiKey?: string | null;
     metaOnboardDetails?: Record<string, unknown> | null;
     wabaAccounts?: IClientWabaAccountInput[];
+    /** Notice/legal portal — generate in Collection, paste into Legal */
+    legalPortalApiKey?: string | null;
 }
 export interface IClientResponse extends IClients {
     targets?: IClientTarget[];
@@ -41,6 +43,12 @@ export interface IClientTarget {
 export interface IClientGetXApiKeyByClientIdPayload {
     clientId: number;
 }
+/** Legal notice portal API key (Collection ↔ Legal) */
+export interface IClientLegalPortalApiKeyResponse {
+    legalPortalApiKey: string | null;
+}
+/** @deprecated Use IClientLegalPortalApiKeyResponse */
+export type IClientApiKeyResponse = IClientLegalPortalApiKeyResponse;
 export interface IClientMetaOnboardDetailsPayload {
     clientUId: string;
 }

package/interfaces/clients/index.ts

@@ -18,6 +18,8 @@ export interface IClients extends DatabaseObject {
   apiKey?: string | null;
   metaOnboardDetails?: Record<string, unknown> | null;
   wabaAccounts?: IClientWabaAccountInput[];
+  /** Notice/legal portal — generate in Collection, paste into Legal */
+  legalPortalApiKey?: string | null;
 }
 
 export interface IClientResponse extends IClients {
@@ -46,10 +48,17 @@ export interface IClientGetXApiKeyByClientIdPayload {
   clientId: number;
 }
 
+/** Legal notice portal API key (Collection ↔ Legal) */
+export interface IClientLegalPortalApiKeyResponse {
+  legalPortalApiKey: string | null;
+}
+
+/** @deprecated Use IClientLegalPortalApiKeyResponse */
+export type IClientApiKeyResponse = IClientLegalPortalApiKeyResponse;
+
 export interface IClientMetaOnboardDetailsPayload {
   clientUId: string;
 }
-
 export interface IClientMetaOnboardDetailsRow {
   clientUId: string;
   clientId: number;

package/interfaces/index.d.ts

@@ -24,6 +24,7 @@ export * from './loanParticipants';
 export * from './loans';
 export * from './loginDetails';
 export * from './merchants';
+export * from './notices';
 export * from './modules';
 export * from './payload';
 export * from './paymentAccounts';
@@ -80,6 +81,7 @@ export * from './autoCallingTempRecords';
 export * from './loanSummary';
 export * from './skipRecords';
 export * from './metaWhatsapp';
+export * from './integration/legalPortal';
 import { ConnectionOptions, Dialect, ReplicationOptions } from 'sequelize/types';
 export interface DBConnection extends ConnectionOptions {
     host: string;

package/interfaces/index.js

@@ -27,6 +27,7 @@ tslib_1.__exportStar(require("./loanParticipants"), exports);
 tslib_1.__exportStar(require("./loans"), exports);
 tslib_1.__exportStar(require("./loginDetails"), exports);
 tslib_1.__exportStar(require("./merchants"), exports);
+tslib_1.__exportStar(require("./notices"), exports);
 tslib_1.__exportStar(require("./modules"), exports);
 tslib_1.__exportStar(require("./payload"), exports);
 tslib_1.__exportStar(require("./paymentAccounts"), exports);
@@ -83,3 +84,4 @@ tslib_1.__exportStar(require("./autoCallingTempRecords"), exports);
 tslib_1.__exportStar(require("./loanSummary"), exports);
 tslib_1.__exportStar(require("./skipRecords"), exports);
 tslib_1.__exportStar(require("./metaWhatsapp"), exports);
+tslib_1.__exportStar(require("./integration/legalPortal"), exports);

package/interfaces/index.ts

@@ -24,6 +24,7 @@ export * from './loanParticipants';
 export * from './loans';
 export * from './loginDetails';
 export * from './merchants';
+export * from './notices';
 export * from './modules';
 export * from './payload';
 export * from './paymentAccounts';
@@ -80,6 +81,7 @@ export * from './autoCallingTempRecords';
 export * from './loanSummary';
 export * from './skipRecords';
 export * from './metaWhatsapp';
+export * from './integration/legalPortal';
 
 import {
   ConnectionOptions,

package/interfaces/integration/index.d.ts

@@ -1 +1,2 @@
 export * from './ezsip';
+export * from './legalPortal';

package/interfaces/integration/index.js

@@ -2,3 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./ezsip"), exports);
+tslib_1.__exportStar(require("./legalPortal"), exports);

package/interfaces/integration/index.ts

@@ -1 +1,2 @@
 export * from './ezsip';
+export * from './legalPortal';

package/interfaces/integration/legalPortal/index.d.ts

@@ -0,0 +1,40 @@
+/** Collection client ref — integration-ms loads legalPortalApiKey from CRM clients table */
+export interface ILegalPortalClientRefPayload {
+    uId?: string;
+    clientId?: number;
+}
+export interface ILegalPortalGetClientPayload extends ILegalPortalClientRefPayload {
+    legalClientId: number;
+}
+export interface ILegalPortalGetLoanTimelinePayload extends ILegalPortalClientRefPayload {
+    loanNumber: string;
+}
+/** Collection CRM-compatible communication timeline row */
+export interface ILoanCommunicationTimelineRow {
+    id: number;
+    communicationType: string;
+    status: string | null;
+    message: string | null;
+    clickToAction: string | null;
+    createdAt: string;
+    comments: string | null;
+    dispositionName: string | null;
+    subDispositionName: string | null;
+    noticeViewLink?: string | null;
+    noticeDownloadLink?: string | null;
+}
+export interface ILoanNoticeTimelineResponse {
+    loanNumber: string;
+    leadId: string;
+    loanNumberFieldKey: string;
+    count: number;
+    rows: ILoanCommunicationTimelineRow[];
+    /** @deprecated Use rows — kept for older @cleardu/types consumers */
+    events?: ILoanCommunicationTimelineRow[];
+}
+/** @deprecated Use ILoanCommunicationTimelineRow */
+export type ILoanNoticeTimelineEvent = ILoanCommunicationTimelineRow;
+/** @deprecated Use ILegalPortalClientRefPayload */
+export type ILegalPortalHealthPayload = ILegalPortalClientRefPayload;
+/** @deprecated Use ILegalPortalClientRefPayload */
+export type ILegalHelloPayload = ILegalPortalClientRefPayload;

package/interfaces/integration/legalPortal/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/integration/legalPortal/index.ts

@@ -0,0 +1,47 @@
+/** Collection client ref — integration-ms loads legalPortalApiKey from CRM clients table */
+export interface ILegalPortalClientRefPayload {
+  uId?: string;
+  clientId?: number;
+}
+
+export interface ILegalPortalGetClientPayload extends ILegalPortalClientRefPayload {
+  legalClientId: number;
+}
+
+export interface ILegalPortalGetLoanTimelinePayload extends ILegalPortalClientRefPayload {
+  loanNumber: string;
+}
+
+/** Collection CRM-compatible communication timeline row */
+export interface ILoanCommunicationTimelineRow {
+  id: number;
+  communicationType: string;
+  status: string | null;
+  message: string | null;
+  clickToAction: string | null;
+  createdAt: string;
+  comments: string | null;
+  dispositionName: string | null;
+  subDispositionName: string | null;
+  noticeViewLink?: string | null;
+  noticeDownloadLink?: string | null;
+}
+
+export interface ILoanNoticeTimelineResponse {
+  loanNumber: string;
+  leadId: string;
+  loanNumberFieldKey: string;
+  count: number;
+  rows: ILoanCommunicationTimelineRow[];
+  /** @deprecated Use rows — kept for older @cleardu/types consumers */
+  events?: ILoanCommunicationTimelineRow[];
+}
+
+/** @deprecated Use ILoanCommunicationTimelineRow */
+export type ILoanNoticeTimelineEvent = ILoanCommunicationTimelineRow;
+
+/** @deprecated Use ILegalPortalClientRefPayload */
+export type ILegalPortalHealthPayload = ILegalPortalClientRefPayload;
+
+/** @deprecated Use ILegalPortalClientRefPayload */
+export type ILegalHelloPayload = ILegalPortalClientRefPayload;

package/interfaces/notices/index.d.ts

@@ -0,0 +1,41 @@
+/** Notice module types (Collection notice portal — separate from Legal Collection integration) */
+export type { ILegalPortalClientRefPayload, ILegalPortalGetClientPayload, ILegalPortalGetLoanTimelinePayload, ILoanCommunicationTimelineRow, ILoanNoticeTimelineResponse, } from '../integration/legalPortal';
+/** @deprecated Use ILegalPortalGetClientPayload */
+export type { ILegalPortalGetClientPayload as IIntegrationGetLegalClientPayload } from '../integration/legalPortal';
+/** @deprecated Use ILegalPortalClientRefPayload — key resolved via clientId/uId in integration-ms */
+export interface INoticeClientAuth {
+    legalPortalApiKey: string;
+}
+export interface INoticeViewLinkPayload {
+    ref: string;
+    ch?: string;
+    legalPortalApiKey?: string;
+    ipAddress?: string;
+    userAgent?: string;
+    acceptLanguage?: string;
+    referer?: string;
+    cookie?: string;
+}
+export interface INoticeViewLinkResponse {
+    redirectUrl: string;
+}
+export interface INoticeTrackingListPayload extends INoticeClientAuth, Record<string, unknown> {
+    isExport?: boolean;
+    type?: string;
+    status?: string;
+    method?: string;
+    jobId?: number;
+    templateId?: number;
+    noticeTypeId?: number;
+    courtType?: string;
+    trackingStatus?: string;
+    page?: number;
+    size?: number;
+}
+export interface INoticeUpdatePayload extends INoticeClientAuth {
+    id: number;
+    payload: Record<string, unknown>;
+}
+export interface INoticeTrackingByLeadPayload extends INoticeClientAuth {
+    leadId: string;
+}

package/interfaces/notices/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/notices/index.ts

@@ -0,0 +1,56 @@
+/** Notice module types (Collection notice portal — separate from Legal Collection integration) */
+export type {
+  ILegalPortalClientRefPayload,
+  ILegalPortalGetClientPayload,
+  ILegalPortalGetLoanTimelinePayload,
+  ILoanCommunicationTimelineRow,
+  ILoanNoticeTimelineResponse,
+} from '../integration/legalPortal';
+
+/** @deprecated Use ILegalPortalGetClientPayload */
+export type { ILegalPortalGetClientPayload as IIntegrationGetLegalClientPayload } from '../integration/legalPortal';
+
+/** @deprecated Use ILegalPortalClientRefPayload — key resolved via clientId/uId in integration-ms */
+export interface INoticeClientAuth {
+  legalPortalApiKey: string;
+}
+
+export interface INoticeViewLinkPayload {
+  ref: string;
+  ch?: string;
+  legalPortalApiKey?: string;
+  ipAddress?: string;
+  userAgent?: string;
+  acceptLanguage?: string;
+  referer?: string;
+  cookie?: string;
+}
+
+export interface INoticeViewLinkResponse {
+  redirectUrl: string;
+}
+
+export interface INoticeTrackingListPayload
+  extends INoticeClientAuth,
+    Record<string, unknown> {
+  isExport?: boolean;
+  type?: string;
+  status?: string;
+  method?: string;
+  jobId?: number;
+  templateId?: number;
+  noticeTypeId?: number;
+  courtType?: string;
+  trackingStatus?: string;
+  page?: number;
+  size?: number;
+}
+
+export interface INoticeUpdatePayload extends INoticeClientAuth {
+  id: number;
+  payload: Record<string, unknown>;
+}
+
+export interface INoticeTrackingByLeadPayload extends INoticeClientAuth {
+  leadId: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cleardu/types",
-  "version": "1.0.551",
+  "version": "1.0.552",
   "description": "Nest - modern, fast, powerful node.js web framework (@aws)",
   "author": "Kamil Mysliwiec",
   "license": "MIT",