@bisondesk/core-sdk 1.0.584 → 1.0.586

package/src/types/prospects.ts

@@ -0,0 +1,192 @@
+import { MultiLangValue } from '@bisondesk/commons-sdk/types';
+import { BaseEvent } from './internal-events.js';
+import { BaseSearchRequest } from './search.js';
+import { Contact, Organization } from './crm.js';
+import { Interest } from './interests.js';
+import { DataRecord, ReferenceData } from './utils.js';
+import { NextList } from '@bisondesk/commons-sdk/types';
+import { Task } from '@bisondesk/commons-sdk/tasks';
+
+export enum ProspectActions {
+  CLOSE = 'close',
+  REOPEN = 'reopen',
+  ENGAGE = 'engage',
+  SET_METADATA = 'set_metadata',
+  SET_OBJECTIVES = 'set_objectives',
+  SET_CUSTOMER = 'set_customer',
+  ADD_ACTIVITY = 'add_activity',
+  DELETE = 'delete',
+}
+
+export enum ProspectStatus {
+  NURTURE = 'nurture',
+  ATTEMPTING = 'attempting',
+  ENGAGED = 'engaged',
+  CLOSED = 'closed',
+}
+
+export const ProspectStatusOrder: ProspectStatus[] = [
+  ProspectStatus.NURTURE,
+  ProspectStatus.ATTEMPTING,
+  ProspectStatus.ENGAGED,
+];
+
+export const ProspectKanbanColumns = [...ProspectStatusOrder, ProspectStatus.CLOSED];
+
+export const ProspectKanbanEndColumns: string[] = [ProspectStatus.CLOSED];
+
+export enum ProspectClosedReason {
+  CONVERTED = 'converted',
+  DEFERRED = 'deferred',
+  NO_REPLY = 'no_reply',
+  NOT_INTERESTED = 'not_interested',
+  AUTOMATIC = 'automatic',
+}
+
+export enum ProspectPriority {
+  LOW = 'low',
+  NORMAL = 'normal',
+  HIGH = 'high',
+}
+
+export type ProspectObjective = {
+  id: string;
+  title: MultiLangValue;
+};
+
+type BaseProspect = {
+  contactId?: string;
+  organizationId?: string;
+  branchId: string;
+  accountManager?: string;
+  priority: ProspectPriority;
+  score?: number;
+  objectives: ProspectObjective[];
+};
+
+export type NewProspect = BaseProspect & {
+  id?: undefined;
+  createdAt?: undefined;
+  createdBy?: undefined;
+  modifiedAt?: undefined;
+  modifiedBy?: undefined;
+};
+
+export type Prospect = BaseProspect & {
+  id: string;
+
+  status: ProspectStatus;
+
+  attemptingAt?: string;
+  attemptingBy?: string;
+  engagedAt?: string;
+  engagedBy?: string;
+  closedAt?: string;
+  closedBy?: string;
+  closedReason?: ProspectClosedReason;
+
+  createdAt: string;
+  createdBy: string;
+  modifiedAt: string;
+  modifiedBy: string;
+};
+
+export type ProspectUpdate = {
+  contactId?: string | null;
+  organizationId?: string | null;
+  branchId?: string;
+  accountManager?: string | null;
+  priority?: ProspectPriority;
+  score?: number | null;
+  objectives?: ProspectObjective[];
+
+  close?: boolean;
+  closedReason?: ProspectClosedReason;
+  reopen?: boolean;
+  engage?: boolean;
+};
+
+export type ProspectBff = {
+  prospect: DataRecord<Prospect>;
+  contact?: DataRecord<Contact>;
+  org?: DataRecord<Organization>;
+  tasks: DataRecord<Task>[];
+};
+
+/************
+ *
+ * Search
+ */
+
+export type SearchProspect = {
+  contact?: Contact;
+  prospect: Prospect;
+  org?: Organization;
+  /**
+   * Interests denormalized from the prospect's lead:
+   * - Org-linked prospects: union of the org's own interests and every contact's interests for that org.
+   * - Contact-only prospects: just the contact's interests.
+   */
+  interests?: Interest[];
+  custom: {
+    closed: boolean;
+    unassigned: boolean;
+    /**
+     * Country of the lead, preferring contact country over org country when both are set.
+     */
+    country?: string;
+  };
+};
+
+/************
+ *
+ * Kanban
+ */
+
+export type ProspectsKanbanColumn = {
+  status: string;
+  results: SearchProspect[];
+  totalCount: number;
+};
+
+export type MSearchProspectsKanbanColumn = {
+  column: ProspectsKanbanColumn;
+  nextToken?: string;
+};
+
+export type KanbanProspectsSearchRequest = BaseSearchRequest & {
+  nextTokens?: Record<string, string | undefined>;
+};
+
+export type KanbanProspectsNextList = Omit<
+  NextList<ProspectsKanbanColumn, ReferenceData>,
+  'nextToken'
+> & {
+  nextTokens?: Record<string, string | undefined>;
+};
+
+/************
+ *
+ * Events
+ */
+
+type BaseProspectEvent = BaseEvent & {
+  id: string;
+  actionAt: string;
+  tenantId: string;
+  userId: string;
+};
+
+export type ProspectCreatedEvent = BaseProspectEvent & {
+  action: 'create';
+  prospect: Prospect;
+  previousProspect?: undefined;
+};
+
+export type ProspectUpdatedEvent = BaseProspectEvent & {
+  action: 'update';
+  prospect: Prospect;
+  previousProspect: Prospect;
+};
+
+export type ProspectEvent = ProspectCreatedEvent | ProspectUpdatedEvent;

package/src/types/vehicles.ts

@@ -241,6 +241,7 @@ export type SearchVehicle = {
     sold: boolean;
     isReserved: boolean;
     hasPayments: boolean;
+    listedOnWebsite: boolean;
     publishedOnWebsiteAt?: string;
     originalBranchId: string;
   };