@cleardu/types 1.0.542 → 1.0.544

package/interfaces/metaWhatsapp.ts

@@ -0,0 +1,69 @@
+export interface IMetaWhatsappTenantPayload {
+  clientUId?: string;
+  clientId?: number;
+  xApiKey?: string;
+}
+
+export interface IMetaWhatsappRequestPayload
+  extends IMetaWhatsappTenantPayload {
+  body?: any;
+  query?: Record<string, any>;
+  headers?: Record<string, string>;
+  wabaId?: string;
+  name?: string;
+  /** Meta WhatsApp template id (`rawResponse.data.id` from CRM). */
+  id?: string;
+  phoneNumberId?: string;
+  mediaId?: string;
+}
+
+export interface IFacebookOnboardingResponse {
+  data?: {
+    user?: Record<string, any>;
+    isNewUser?: boolean;
+    metaClientInfo?: {
+      wabaId?: string;
+      phoneNumberId?: string;
+      phoneNumber?: string;
+      wabaName?: string;
+      verifiedPhoneName?: string;
+      businessId?: string;
+      tokenExpiresAt?: string;
+      isWebhookSubscribed?: boolean;
+    };
+  };
+}
+
+export interface IMetaFacebookOnboardingPersistPayload {
+  clientUId: string;
+  onboardingResponse: IFacebookOnboardingResponse;
+}
+
+/** `picture.data` from Facebook JS SDK login payload. */
+export interface IFacebookPictureData {
+  height: number;
+  width: number;
+  url: string;
+  is_silhouette: boolean;
+}
+
+export interface IFacebookPicture {
+  data: IFacebookPictureData;
+}
+
+export interface IFacebookOnboardingBody {
+  name: string;
+  picture: IFacebookPicture;
+  id: string;
+  userID: string;
+  expiresIn: number;
+  accessToken: string;
+  signedRequest: string;
+  graphDomain: string;
+  data_access_expiration_time: number;
+}
+
+export interface IMetaWhatsappResponse<T = any> {
+  status: number;
+  data: T;
+}

package/interfaces/templates/index.d.ts

@@ -1,12 +1,96 @@
-import { languageCodes, templateTypes } from '../../constants';
+import { languageCodes, metaTemplateStatus, templateTypes } from '../../constants';
 import { DatabaseObject } from '../baseObject';
 import { IListPayload } from '../payload';
 export interface ITemplate extends DatabaseObject {
     type: templateTypes;
     name: string;
     message: string;
-    languageCode: languageCodes;
+    languageCode: string;
     isActive: boolean;
+    category?: string | null;
+    component?: Record<string, unknown> | unknown[] | null;
+    rawResponse?: Record<string, unknown> | null;
+    metaApprovalStatus?: metaTemplateStatus | null;
+    wabaId?: string | null;
+    clientId?: number | null;
+}
+export interface IMetaWhatsappTemplateListParams {
+    clientUId?: string;
+    wabaId?: string;
+    page?: number;
+    size?: number;
+    q?: string;
+}
+export type IMetaWhatsappTemplateButtonType = 'QUICK_REPLY' | 'URL' | 'PHONE_NUMBER';
+export interface IMetaWhatsappTemplateButton {
+    type: IMetaWhatsappTemplateButtonType;
+    text: string;
+    url?: string;
+    phone_number?: string;
+}
+/**
+ * Cleardu Meta WhatsApp integration POST body for template create
+ * (`BrokerMessages.INTEGRATION.MESSAGES.WHATSAPP.META.WHATSAPP.CREATE_TEMPLATE` → `payload.body`).
+ * Built in CRM; forwarded unchanged by integration-ms to the Meta adapter.
+ */
+export interface IMetaWhatsappTemplateIntegrationBody {
+    wabaId: string;
+    template: {
+        name: string;
+        language: string;
+        category: string;
+        components: Record<string, unknown>[];
+    };
+}
+/**
+ * Body of `BrokerMessages.CRM.WHATSAPP_META.TEMPLATE.CREATE` (`@Payload('body')`).
+ * Matches `CreateMetaWhatsappTemplateDto`; `user` is supplied separately on the message payload.
+ */
+export interface IMetaWhatsappTemplateCreatePayload {
+    clientUId: string;
+    wabaId: string;
+    phoneNumberId?: string;
+    name: string;
+    message: string;
+    languageCode: languageCodes;
+    /** Required for Meta create unless `metaCreateBody` is supplied. */
+    category?: string;
+    headerText?: string;
+    footerText?: string;
+    buttons?: IMetaWhatsappTemplateButton[];
+    /** Meta `components` array when not sending a full `metaCreateBody`. */
+    component?: Record<string, unknown>[];
+    isActive?: boolean;
+    /** When set, forwarded as-is to integration instead of a derived Meta create shape. */
+    metaCreateBody?: Record<string, unknown>;
+}
+export interface IMetaWhatsappTemplateUpdatePayload {
+    clientUId: string;
+    userId: number;
+    id: number;
+    name?: string;
+    message?: string;
+    languageCode?: languageCodes;
+    category?: string;
+    component?: Record<string, unknown> | unknown[];
+    isActive?: boolean;
+    metaApprovalStatus?: metaTemplateStatus;
+}
+export interface IMetaWhatsappTemplateSyncPayload {
+    clientUId: string;
+    wabaId: string;
+}
+/** CRM broker payload: delete Meta WhatsApp template by CRM `templates.id` only. */
+export interface IMetaWhatsappTemplateDeletePayload {
+    id: number;
+}
+/** Dropdown option for Meta WhatsApp template `{{parameter}}` placeholders. */
+export interface IMetaWhatsappTemplateParameterField {
+    key: string;
+    source: 'borrower' | 'loan' | 'loan_participant' | 'loan_contact' | 'client';
+}
+export interface IMetaWhatsappTemplateParameterFieldsResult {
+    fields: IMetaWhatsappTemplateParameterField[];
 }
 export interface ISmartPingTemplate extends DatabaseObject {
     templateId: string;

package/interfaces/templates/index.ts

@@ -1,4 +1,8 @@
-import { languageCodes, templateTypes } from '../../constants';
+import {
+  languageCodes,
+  metaTemplateStatus,
+  templateTypes,
+} from '../../constants';
 import { DatabaseObject } from '../baseObject';
 import { IListPayload } from '../payload';
 
@@ -6,8 +10,105 @@ export interface ITemplate extends DatabaseObject {
   type: templateTypes;
   name: string;
   message: string;
-  languageCode: languageCodes;
+  languageCode: string;
   isActive: boolean;
+  category?: string | null;
+  component?: Record<string, unknown> | unknown[] | null;
+  rawResponse?: Record<string, unknown> | null;
+  metaApprovalStatus?: metaTemplateStatus | null;
+  wabaId?: string | null;
+  clientId?: number | null;
+}
+
+export interface IMetaWhatsappTemplateListParams {
+  clientUId?: string;
+  wabaId?: string;
+  page?: number;
+  size?: number;
+  q?: string;
+}
+
+export type IMetaWhatsappTemplateButtonType =
+  | 'QUICK_REPLY'
+  | 'URL'
+  | 'PHONE_NUMBER';
+
+export interface IMetaWhatsappTemplateButton {
+  type: IMetaWhatsappTemplateButtonType;
+  text: string;
+  url?: string;
+  phone_number?: string;
+}
+
+/**
+ * Cleardu Meta WhatsApp integration POST body for template create
+ * (`BrokerMessages.INTEGRATION.MESSAGES.WHATSAPP.META.WHATSAPP.CREATE_TEMPLATE` → `payload.body`).
+ * Built in CRM; forwarded unchanged by integration-ms to the Meta adapter.
+ */
+export interface IMetaWhatsappTemplateIntegrationBody {
+  wabaId: string;
+  template: {
+    name: string;
+    language: string;
+    category: string;
+    components: Record<string, unknown>[];
+  };
+}
+
+/**
+ * Body of `BrokerMessages.CRM.WHATSAPP_META.TEMPLATE.CREATE` (`@Payload('body')`).
+ * Matches `CreateMetaWhatsappTemplateDto`; `user` is supplied separately on the message payload.
+ */
+export interface IMetaWhatsappTemplateCreatePayload {
+  clientUId: string;
+  wabaId: string;
+  phoneNumberId?: string;
+  name: string;
+  message: string;
+  languageCode: languageCodes;
+  /** Required for Meta create unless `metaCreateBody` is supplied. */
+  category?: string;
+  headerText?: string;
+  footerText?: string;
+  buttons?: IMetaWhatsappTemplateButton[];
+  /** Meta `components` array when not sending a full `metaCreateBody`. */
+  component?: Record<string, unknown>[];
+  isActive?: boolean;
+  /** When set, forwarded as-is to integration instead of a derived Meta create shape. */
+  metaCreateBody?: Record<string, unknown>;
+}
+
+export interface IMetaWhatsappTemplateUpdatePayload {
+  clientUId: string;
+  userId: number;
+  id: number;
+  name?: string;
+  message?: string;
+  languageCode?: languageCodes;
+  category?: string;
+  component?: Record<string, unknown> | unknown[];
+  isActive?: boolean;
+  metaApprovalStatus?: metaTemplateStatus;
+}
+
+export interface IMetaWhatsappTemplateSyncPayload {
+  clientUId: string;
+  wabaId: string;
+}
+
+/** CRM broker payload: delete Meta WhatsApp template by CRM `templates.id` only. */
+export interface IMetaWhatsappTemplateDeletePayload {
+  id: number;
+}
+
+/** Dropdown option for Meta WhatsApp template `{{parameter}}` placeholders. */
+export interface IMetaWhatsappTemplateParameterField {
+  key: string;
+  source: 'borrower' | 'loan' | 'loan_participant' | 'loan_contact' | 'client';
+}
+
+export interface IMetaWhatsappTemplateParameterFieldsResult {
+  fields: IMetaWhatsappTemplateParameterField[];
 }
 
 export interface ISmartPingTemplate extends DatabaseObject {
@@ -19,4 +120,4 @@ export interface ISmartPingTemplate extends DatabaseObject {
 }
 export interface ITemplateFilterParams extends IListPayload {
   provider: string;
-}
+}

package/interfaces/whatsapp/index.d.ts

@@ -2,6 +2,10 @@ import { WhereOptions } from 'sequelize';
 import { communicationType, whatsAppStatus } from '../../constants';
 import { DatabaseObject } from '../baseObject';
 import { IListPayload } from '../payload';
+export interface IMetaWhatsAppWebhookResult {
+    status: boolean;
+    message?: string;
+}
 export interface IWhatsAppMessages extends DatabaseObject {
     loanId: number;
     messageId?: string;

package/interfaces/whatsapp/index.ts

@@ -3,6 +3,11 @@ import { communicationType, whatsAppStatus } from '../../constants';
 import { DatabaseObject } from '../baseObject';
 import { IListPayload } from '../payload';
 
+export interface IMetaWhatsAppWebhookResult {
+  status: boolean;
+  message?: string;
+}
+
 export interface IWhatsAppMessages extends DatabaseObject {
   loanId: number;
   messageId?: string;
@@ -158,10 +163,10 @@ export interface CommunicationHistoryLoanWise extends IListPayload {
 }
 
 export interface CommunicationReport {
-	title: string;
-	ftd: string;
-	mtd: string;
-	paid?: string;
-	unpaid?: string;
-	partialyPaid?: string;
-}
+  title: string;
+  ftd: string;
+  mtd: string;
+  paid?: string;
+  unpaid?: string;
+  partialyPaid?: string;
+}

package/package.json

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