@bisondesk/core-sdk 1.0.493 → 1.0.494

package/src/types/activities.ts

@@ -6,6 +6,7 @@ export enum ActivityType {
   MEETING = 'meeting',
   EMAIL = 'email',
   CHAT = 'chat',
+  SMS = 'sms',
 }
 
 export enum ActivityActions {
@@ -13,15 +14,16 @@ export enum ActivityActions {
   EDIT = 'edit',
 }
 
-type BaseActivity = {
+export interface BaseActivity<Meta = ActivityV2Meta> {
   type: ActivityType;
   businessEntityId: BusinessEntityIds;
   recordId: string;
   description?: string;
   readonly?: boolean;
-};
+  meta?: Meta;
+}
 
-export type NewActivity = BaseActivity & {
+export type NewActivity<Meta = ActivityV2Meta> = BaseActivity<Meta> & {
   id?: undefined;
   createdAt?: undefined;
   createdBy?: undefined;
@@ -30,7 +32,7 @@ export type NewActivity = BaseActivity & {
   activityAt?: string;
 };
 
-export type Activity = BaseActivity & {
+export type Activity<Meta = ActivityV2Meta> = BaseActivity<Meta> & {
   id: string;
   createdAt: string;
   createdBy: string;
@@ -73,3 +75,46 @@ export type ActivityDeleteEvent = BaseActivityEvent & {
   data: undefined;
   previousData: Activity;
 };
+
+/************
+ * ActivityV2Meta Types
+ * These types are used to define the structure of the metadata for different activity types.
+ ************/
+
+export type ActivityV2Meta =
+  | EmailDebtorsDossierActivityPayload
+  | CallDebtorsDossierActivityPayload
+  | MeetingDebtorsDossierActivityPayload
+  | ChatDebtorsDossierActivityPayload;
+
+export type EmailDebtorsDossierActivityPayload = {
+  /*   from: { email: string; name?: string; external?: boolean };
+  to: { email: string; name?: string }[];
+  cc?: { email: string; name?: string }[];
+  bcc?: { email: string; name?: string }[];
+  subject?: string;
+  attachments?: AttachmentValue[]; */
+};
+
+export type CallDebtorsDossierActivityPayload = {
+  /*  from: { phone: string; name?: string; external?: boolean };
+  to: string;
+  duration?: number;
+  recordingUrl?: string;
+  transcription?: string; */
+};
+
+export type MeetingDebtorsDossierActivityPayload = {
+  /*   organizer: string;
+  participants: string[];
+  location?: string;
+  startTime: string;
+  endTime: string; */
+};
+
+export type ChatDebtorsDossierActivityPayload = {
+  /*   from: { phone: string; name?: string; external?: boolean };
+  to: string[]; */
+  message: string;
+  platform: 'whatsapp' | 'sms';
+};

package/src/types/internal-events.ts

@@ -12,6 +12,7 @@ export enum EventTypes {
   ACTIVITY = 'activities',
   EXTERNAL_VEHICLE_SALE = 'external-vehicle-sales',
   AMORTIZATION_DOC = 'amortization-docs',
+  DEBTOR_DOSSIER = 'debtor-dossiers',
 }
 
 export enum InternalNotificationChannels {

package/src/types/journeys.ts

@@ -12,6 +12,7 @@ export type JourneyTaskConfig<T> = {
   priority?: TaskPriority;
   tag?: string;
   description?: MultiLangValue;
+  dueDateInDays?: number; //now + dueDateInDays days
   completionCriteria: RulesLogic<AdditionalOperation>;
   prerequisiteTaskIds: string[];
   requiredAtStatus?: T; //Required at a given status or higher
@@ -26,3 +27,9 @@ export type JourneyConfig<T> = {
   createdBy: string;
   disabled: boolean;
 };
+
+export type JourneyConfigCustomTasks<T> = Pick<JourneyConfig<T>, 'businessEntityId' | 'tasks'> & {
+  recordId: string;
+  createdAt: string;
+  createdBy: string;
+};

package/src/types/leasing-debtors.ts

@@ -1,4 +1,9 @@
+import { EmailMessage } from '@bisondesk/commons-sdk/messages';
+import { NextList, PaginatedList } from '@bisondesk/commons-sdk/types';
 import { Contact, Organization } from './crm.js';
+import { LeasingContract } from './leasing.js';
+import { BaseSearchRequest, SortFilter } from './search.js';
+import { DataRecord, ReferenceData } from './utils.js';
 
 export type MonthData = {
   activeContractIds: string[];
@@ -33,3 +38,307 @@ export type SearchDebtorInfo = {
     hasActiveContracts: boolean;
   };
 };
+
+export enum DebtorsDossierStatus {
+  AUTO_REMINDER = 'auto_reminder',
+  OVERDUE = 'overdue',
+  CONTACT_ATTEMPTED = 'contact_attempted',
+  DIALOGUE = 'dialogue',
+  PROMISE_TO_PAY = 'promise_to_pay',
+  FAILURE = 'failure',
+  RESOLVED = 'resolved',
+}
+
+export const debtorsDossierStatusToDateFieldMap: Record<
+  DebtorsDossierStatus,
+  { date: keyof DossierStatusLogFields; author: keyof DossierStatusLogFields } | null
+> = {
+  [DebtorsDossierStatus.AUTO_REMINDER]: null,
+  [DebtorsDossierStatus.OVERDUE]: { date: 'overdueAt', author: 'overdueBy' },
+  [DebtorsDossierStatus.CONTACT_ATTEMPTED]: { date: 'contactedAt', author: 'contactedBy' },
+  [DebtorsDossierStatus.DIALOGUE]: { date: 'dialogueAt', author: 'dialogueBy' },
+  [DebtorsDossierStatus.PROMISE_TO_PAY]: { date: 'promiseToPayAt', author: 'promiseToPayBy' },
+  [DebtorsDossierStatus.FAILURE]: { date: 'failedAt', author: 'failedBy' },
+  [DebtorsDossierStatus.RESOLVED]: { date: 'resolvedAt', author: 'resolvedBy' },
+};
+
+/******
+ * Auto Follow-Up Types
+ ******/
+
+export type DebtorAutoFollowUp = {
+  id: string;
+  organizationId: string;
+  organizationName: string;
+  status: 'ONGOING' | 'ERROR' | 'SUCCESS' | 'EXPIRED' | 'DISCARDED';
+  emails: EmailMessage[];
+  createdAt: string;
+  modifiedAt: string;
+  completedAt?: string;
+  nextActionAt: string;
+  riskLevel: number;
+};
+
+export type ListOverdueRemindersResponse = PaginatedList<DebtorAutoFollowUp, ReferenceData>;
+export type ListOverdueRemindersRequest = {
+  offset: number;
+  limit: number;
+  sortBy: SortFilter;
+};
+
+/******
+ * Debtor Dossier Types
+ ******/
+
+export enum DebtorsDossierActions {
+  SET_METADATA = 'set_metadata',
+  ADD_ACTIVITY = 'add_activity',
+  FINISH = 'finish',
+  SET_DOCUMENTS = 'set_documents',
+  SET_PAYMENT_PLAN = 'set_payment_plan',
+  SET_LEGAL_DOSSIER = 'set_legal_dossier',
+}
+
+export type DossierStatusLogFields = {
+  failedAt?: string;
+  failedBy?: string;
+  resolvedAt?: string;
+  contactedAt?: string;
+  contactedBy?: string;
+  overdueAt?: string;
+  overdueBy?: string;
+  resolvedBy?: string;
+  dialogueAt?: string;
+  dialogueBy?: string;
+  promiseToPayAt?: string;
+  promiseToPayBy?: string;
+};
+
+export type BaseDebtorsDossier = {
+  organizationId: string;
+  contactId?: string;
+  tags: string[];
+  origin: 'manual' | 'auto';
+  autoFollowUpId?: string;
+  administrativeUserId?: string;
+  branchId: string;
+  tenantId: string;
+};
+export type DebtorsDossierStatusAudit = {
+  from: DebtorsDossierStatus;
+  to: DebtorsDossierStatus;
+  changedAt: string;
+  changedBy: string;
+};
+
+export type DebtorsDossier = BaseDebtorsDossier &
+  DossierStatusLogFields & {
+    id: string;
+    createdAt: string;
+    createdBy: string;
+    updatedAt: string;
+    updatedBy: string;
+    status: DebtorsDossierStatus;
+    statusAudit: DebtorsDossierStatusAudit[];
+  };
+
+export type NewDebtorsDossier = BaseDebtorsDossier & {
+  id?: undefined;
+  createdBy?: undefined;
+  createdAt?: undefined;
+  updatedBy?: undefined;
+  updatedAt?: undefined;
+};
+
+export type DebtorsDossierBff = {
+  dossier: DataRecord<DebtorsDossier>;
+  organization?: Organization;
+  contact?: Contact;
+  leasingContracts: LeasingContract[];
+  debt?: DebtorInfo;
+  paymentPlan?: DebtorsPaymentPlan;
+  legalDossier?: LegalDossier;
+  trackAndTraceDevices: {
+    /*     odometer: TrackAndTraceOdometerData;
+    device: TrackAndTraceDevice; */
+  }[];
+};
+
+export type UpdateDebtorsDossier = Partial<
+  Pick<
+    DebtorsDossier,
+    'status' | 'tags' | 'contactId' | 'administrativeUserId' | 'branchId' | 'organizationId'
+  >
+> & {
+  overdue?: boolean;
+  resolve?: boolean;
+  terminate?: boolean;
+};
+
+/******
+ * Payment Plan Types
+ ******/
+
+export type DebtorsPaymentPlan = {
+  id: string;
+  debtorDossierId: string;
+
+  notes?: string;
+
+  reminders?: {
+    frequency: {
+      every: number;
+      period: 'days' | 'weeks' | 'months';
+    };
+    endCondition:
+      | {
+          endDate: string; // ISO date string
+        }
+      | {
+          occurrences: number; // Number of reminders to send
+        };
+  };
+
+  createdAt: string;
+  createdBy: string;
+  updatedAt: string;
+  updatedBy: string;
+};
+
+export type NewPaymentPlan = Omit<
+  DebtorsPaymentPlan,
+  'id' | 'createdAt' | 'updatedAt' | 'createdBy' | 'updatedBy'
+>;
+
+export type UpdatePaymentPlan = Partial<Pick<DebtorsPaymentPlan, 'notes' | 'reminders'>>;
+
+/******
+ * Legal Dossier Types
+ ******/
+
+export enum LegalDossierStatus {
+  ASSESSMENT = 'assessment',
+  PRE_LEGAL_NOTICE = 'pre_legal_notice',
+  SENT_TO_LAWYER = 'sent_to_lawyer',
+  FILED = 'filed',
+  IN_COURT = 'in_court',
+  JUDGMENT = 'judgment',
+  ENFORCEMENT = 'enforcement',
+  SETTLEMENT = 'settlement',
+  CLOSED_RECOVERED = 'closed_recovered',
+  CLOSED_UNRECOVERABLE = 'closed_unrecoverable',
+  ON_HOLD = 'on_hold',
+}
+
+export type LegalDossier = {
+  id: string;
+  debtorDossierId: string;
+  caseNumber?: string;
+  notes?: string;
+  createdAt: string;
+  createdBy: string;
+  updatedAt: string;
+  updatedBy: string;
+  status: LegalDossierStatus;
+};
+
+export type NewLegalDossier = Omit<
+  LegalDossier,
+  'id' | 'createdAt' | 'updatedAt' | 'createdBy' | 'updatedBy'
+>;
+
+export type UpdateLegalDossier = Partial<Pick<LegalDossier, 'caseNumber' | 'status' | 'notes'>>;
+
+/******
+ * Debtor Dossier Events
+ ******/
+
+export type DebtorsDossierCreateEvent = {
+  action: 'created';
+  data: DebtorsDossier;
+  previousData?: undefined;
+  tenantId: string;
+  userId: string;
+};
+
+export type DebtorsDossierUpdateEvent = {
+  action: 'updated';
+  data: DebtorsDossier;
+  previousData: DebtorsDossier;
+  tenantId: string;
+  userId: string;
+};
+
+export type DebtorsDossierDeleteEvent = {
+  action: 'deleted';
+  data?: undefined;
+  previousData: DebtorsDossier;
+  tenantId: string;
+  userId: string;
+};
+
+export type DebtorsDossierEvent =
+  | DebtorsDossierCreateEvent
+  | DebtorsDossierUpdateEvent
+  | DebtorsDossierDeleteEvent;
+
+/************
+ *
+ * Search
+ */
+
+export type SearchDebtorsDossier = {
+  contact?: Contact;
+  debtorsDossier: DebtorsDossier;
+  org?: Organization;
+  legalDossier?: LegalDossier;
+  paymentPlan?: DebtorsPaymentPlan;
+};
+
+/************
+ *
+ * Kanban
+ */
+
+export type DebtorsDossierKanbanColumn = {
+  status: string;
+  results: SearchDebtorsDossier[];
+  totalCount: number;
+  totalValue: string;
+};
+
+export type MSearchDebtorsDossierKanbanColumn = {
+  column: DebtorsDossierKanbanColumn;
+  nextToken?: string;
+};
+
+export type KanbanDebtorsDossierSearchRequest = BaseSearchRequest & {
+  nextTokens?: Record<string, string | undefined>;
+};
+
+export type KanbanDebtorsDossierNextList = Omit<
+  NextList<DebtorsDossierKanbanColumn, ReferenceData>,
+  'nextToken'
+> & {
+  nextTokens?: Record<string, string | undefined>;
+};
+
+export const DebtorsDossierStatusOrder: DebtorsDossierStatus[] = [
+  DebtorsDossierStatus.AUTO_REMINDER,
+  DebtorsDossierStatus.OVERDUE,
+  DebtorsDossierStatus.CONTACT_ATTEMPTED,
+  DebtorsDossierStatus.DIALOGUE,
+  DebtorsDossierStatus.PROMISE_TO_PAY,
+];
+
+export const DebtorsDossierWonColumnId = DebtorsDossierStatus.RESOLVED;
+
+export const DebtorsDossierKanbanEndColumns: string[] = [
+  DebtorsDossierStatus.RESOLVED,
+  DebtorsDossierStatus.FAILURE,
+];
+
+export const DebtorsDossierKanbanColumns = [
+  ...DebtorsDossierStatusOrder,
+  ...DebtorsDossierKanbanEndColumns,
+];

package/src/types/leasing-search.ts

@@ -22,6 +22,7 @@ export type SearchLeasingContract = {
     insurance?: InsuranceEntry;
     externalTracking?: boolean;
     accountManager?: string;
+    lastIssuedInvoiceDate?: string;
   };
 };
 

package/src/types/leasing.ts

@@ -42,19 +42,6 @@ export type LeasingConditionEvent = {
   tenantId: string;
 };
 
-export type OverdueDossier = {
-  id: string;
-  organizationId: string;
-  organizationName: string;
-  status: 'ONGOING' | 'ERROR' | 'SUCCESS' | 'EXPIRED' | 'DISCARDED';
-  emails: EmailMessage[];
-  createdAt: string;
-  modifiedAt: string;
-  completedAt?: string;
-  nextActionAt: string;
-  riskLevel: number;
-};
-
 export type LeasingContractClient = {
   organizationId: string;
   contactIds: string[];
@@ -193,13 +180,6 @@ export type OpportunityRef = BaseRef & {
   //Since VAT is client specific and contracts can be transferred between clients, we always handle values without VAT
 };
 
-export type ListOverdueRemindersResponse = PaginatedList<OverdueDossier, ReferenceData>;
-export type ListOverdueRemindersRequest = {
-  offset: number;
-  limit: number;
-  sortBy: SortFilter;
-};
-
 export type NewLeasingConditions = {
   parameters: {
     yearlyRoadTax: string;

package/src/types/marketing.ts

@@ -7,7 +7,7 @@ export enum MarketingPlatform {
   machineryplanet = 'machineryplanet',
   machinetrack = 'machinetrack',
   marktnet = 'marktnet',
-  mobile = 'mobile',
+  // mobile = 'mobile',
   truck1st = 'truck1st', // Truck1.eu
   trucks = 'trucks', //Trucks.nl
   truckscout = 'truckscout24',

package/src/utils/debtors-dossiers.ts

@@ -0,0 +1,73 @@
+import { DebtorsDossier, DebtorsDossierStatus } from '@bisondesk/core-sdk/types/leasing-debtors';
+
+export const DebtorsDossierStatusOrder: DebtorsDossierStatus[] = [
+  DebtorsDossierStatus.AUTO_REMINDER,
+  DebtorsDossierStatus.OVERDUE,
+  DebtorsDossierStatus.CONTACT_ATTEMPTED,
+  DebtorsDossierStatus.DIALOGUE,
+  DebtorsDossierStatus.PROMISE_TO_PAY,
+  DebtorsDossierStatus.FAILURE,
+  DebtorsDossierStatus.RESOLVED,
+];
+
+type CompareInput = {
+  currentStatus: DebtorsDossierStatus;
+  referenceStatus: DebtorsDossierStatus;
+};
+
+const compareDebtorsDossierStatus = (input: CompareInput) => {
+  const { currentStatus, referenceStatus } = input;
+
+  const currentStatusIdx = DebtorsDossierStatusOrder.indexOf(currentStatus);
+  const referenceStatusIdx = DebtorsDossierStatusOrder.indexOf(referenceStatus);
+
+  return {
+    currentStatusIdx,
+    referenceStatusIdx,
+  };
+};
+
+export const getPreviousStatus = (
+  currentStatus: DebtorsDossierStatus
+): DebtorsDossierStatus | undefined => {
+  const currentIndex = DebtorsDossierStatusOrder.indexOf(currentStatus);
+  if (currentIndex <= 0) {
+    return;
+  }
+  return DebtorsDossierStatusOrder[currentIndex - 1];
+};
+
+export const getNextStatus = (status: DebtorsDossierStatus): DebtorsDossierStatus | undefined => {
+  const statusIndex = DebtorsDossierStatusOrder.indexOf(status);
+  if (statusIndex >= DebtorsDossierStatusOrder.length - 1) {
+    return;
+  }
+  return DebtorsDossierStatusOrder[statusIndex + 1];
+};
+
+export const isSameOrAfterReferenceDebtorsDossierStatus = (input: CompareInput): boolean => {
+  const { currentStatusIdx, referenceStatusIdx } = compareDebtorsDossierStatus(input);
+
+  return currentStatusIdx >= referenceStatusIdx;
+};
+
+export const isAfterReferenceDebtorsDossierStatus = (input: CompareInput): boolean => {
+  const { currentStatusIdx, referenceStatusIdx } = compareDebtorsDossierStatus(input);
+
+  return currentStatusIdx > referenceStatusIdx;
+};
+
+export const isSameOrBeforeReferenceDebtorsDossierStatus = (input: CompareInput): boolean => {
+  const { currentStatusIdx, referenceStatusIdx } = compareDebtorsDossierStatus(input);
+
+  return currentStatusIdx <= referenceStatusIdx;
+};
+
+export const isBeforeReferenceDebtorsDossierStatus = (input: CompareInput): boolean => {
+  const { currentStatusIdx, referenceStatusIdx } = compareDebtorsDossierStatus(input);
+
+  return currentStatusIdx < referenceStatusIdx;
+};
+
+export const isDossierFinished = (dossier: DebtorsDossier): boolean =>
+  dossier.resolvedAt != null || dossier.failedAt != null;

package/src/utils/search.ts

@@ -1,17 +1,24 @@
 import { joinWithSeparator } from '@bisondesk/commons-sdk/formatting';
 import { BusinessEntityIds } from '../constants.js';
 import { Contact, Organization, SearchOrganization } from '../types/crm.js';
+import { DebtorsDossier, SearchDebtorsDossier } from '../types/leasing-debtors.js';
 import { SearchLeasingContract } from '../types/leasing-search.js';
 import { LeasingContract } from '../types/leasing.js';
 import { Opportunity, SearchOpportunity } from '../types/opportunities.js';
 import { SearchVehicle, Vehicle } from '../types/vehicles.js';
 
-export type GlobalBusinessEntity = Opportunity | Vehicle | Organization | LeasingContract;
+export type GlobalBusinessEntity =
+  | Opportunity
+  | Vehicle
+  | Organization
+  | LeasingContract
+  | DebtorsDossier;
 export type GlobalSearchEntity =
   | SearchOpportunity
   | SearchVehicle
   | SearchOrganization
-  | SearchLeasingContract;
+  | SearchLeasingContract
+  | SearchDebtorsDossier;
 
 export const getCustomerInformation = (org?: Organization, contact?: Contact) => {
   if (org != null) {