@bisondesk/core-sdk 1.0.21 → 1.0.23-B

package/src/types/opportunities.ts

@@ -0,0 +1,496 @@
+import { Document } from '@bisondesk/commons-sdk/lib/types';
+import { OpportunityType } from '../constants';
+import { Contact, Organization } from './crm';
+import { Interest } from './leads';
+import { Payment } from './payments';
+import { LeasingQuote, QuoteStatus } from './quotes';
+import { DataRecord, ReferenceData } from './utils';
+import { Vehicle } from './vehicles';
+
+export enum OpportunityActions {
+  CREATE_QUOTE = 'create_quote',
+  LOSE = 'lose',
+  REOPEN = 'reopen',
+  START_PREPARATION = 'start_preparation',
+  REVERT_PREPARATION = 'revert_preparation',
+  START_DELIVERY = 'start_delivery',
+  REVERT_DELIVERY = 'revert_delivery',
+  SET_CUSTOMER = 'set_customer',
+  SET_DOCUMENTS = 'set_documents',
+  SET_INTEREST = 'set_interest',
+  SET_METADATA = 'set_metadata',
+  SET_VEHICLE = 'set_vehicle',
+  ADD_ACTIVITY = 'add_activity',
+  ADD_PAYMENT = 'add_payment',
+  SWITCH_VEHICLE = 'switch_vehicle',
+}
+
+export enum OpportunityDealStatus {
+  SALES_AGREED = 'sales_agreed',
+  FIRST_PAYMENT = 'first_payment',
+  FULL_PAYMENT = 'full_payment',
+}
+
+export enum OpportunityStatus {
+  PROSPECTION = 'prospection',
+  DISCOVERY = 'discovery',
+  EVALUATION = 'evaluation',
+  REVIEW = 'review',
+  PREPARATION = 'preparation',
+  DELIVERY = 'delivery',
+}
+
+export const OpportunityStatusOrder: OpportunityStatus[] = [
+  OpportunityStatus.PROSPECTION,
+  OpportunityStatus.DISCOVERY,
+  OpportunityStatus.EVALUATION,
+  OpportunityStatus.REVIEW,
+  OpportunityStatus.PREPARATION,
+  OpportunityStatus.DELIVERY,
+];
+
+export enum OpportunityLogisticStatus {
+  AT_ORIGIN = 'at_origin',
+  DELIVERED = 'delivered',
+}
+export const OpportunityWonColumnId = 'closed_won';
+
+export const OpportunityKanbanColumns = [...OpportunityStatusOrder, OpportunityWonColumnId];
+
+export const OpportunityKanbanEndColumns: string[] = [OpportunityWonColumnId];
+
+export enum OpportunityLostReasonValues {
+  Expensive = 'expensive',
+  AlreadySold = 'already_sold',
+  BadExperience = 'bad_experience',
+  IncorrectVehicleCondition = 'incorrect_vehicle_condition',
+  NoStock = 'not_enough_stock',
+  SlowDelivery = 'slow_delivery',
+  HighDeposit = 'deposit_too_high',
+  NoAnswer = 'client_not_answered',
+}
+
+type BaseBid = {
+  vehicleId: string;
+  opportunityId?: string;
+  contactId: string;
+  amount: string;
+};
+
+export type NewBid = BaseBid & {};
+
+export type Bid = BaseBid & {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+};
+
+type BaseOpportunity = {
+  accountManager?: string;
+  administrativePerson?: string;
+  type: OpportunityType;
+  organizationId?: string;
+  contactId?: string;
+  vehicleId?: string;
+  source?: string; // e.g. website, autoscout, mobile...
+  branch: string;
+  inquiry?: string;
+  branchCountry: string;
+};
+
+export type NewOpportunity = BaseOpportunity & {
+  id?: undefined;
+  createdAt?: undefined;
+  createdBy?: undefined;
+  modifiedAt?: undefined;
+  modifiedBy?: undefined;
+};
+
+export type Opportunity = BaseOpportunity & {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  validatedAt?: string;
+  validatedBy?: string;
+  acceptedAt?: string;
+  acceptedBy?: string;
+  lastActivityAt?: string; // last time we reached out to the customer, regardless of medium
+  reviewedAt?: string;
+  reviewedBy?: string;
+  preparedAt?: string;
+  preparedBy?: string;
+  lostAt?: string;
+  lostBy?: string;
+  wonAt?: string;
+  lostReason?: OpportunityLostReasonValues;
+  deliveredAt?: string;
+  deliveredBy?: string;
+  status: OpportunityStatus;
+  dealStatus?: OpportunityDealStatus;
+  logisticStatus?: OpportunityLogisticStatus;
+  activeQuoteId?: string;
+  contractId?: string;
+  amount?: string;
+  interest?: Interest;
+  documents?: Document[];
+  leasingContractId?: string;
+};
+
+export type OpportunityUpdate = {
+  vehicleId?: string | null;
+  accountManager?: string | null;
+  administrativePerson?: string | null;
+  contactId?: string | null;
+  activeQuoteId?: string | null;
+  interest?: Interest | null;
+  reviewed?: boolean;
+  prepared?: boolean;
+  lost?: boolean;
+  lostReason?: OpportunityLostReasonValues;
+  documents?: Document[];
+  branch?: string;
+  branchCountry?: string;
+  type?: OpportunityType;
+  lastActivityAt?: string | null; // null gives the possibility to delete this field if all activities are deleted
+  source?: string | null;
+};
+
+export type PaymentSummary = {
+  total: string;
+  paid: string;
+  entries: DataRecord<Payment>[];
+};
+
+export type OpportunityBFF = {
+  related: {
+    sameVehicleOpenOpportunities?: number;
+  };
+  opportunity: DataRecord<Opportunity, ReferenceData>;
+  vehicle?: DataRecord<Vehicle>;
+  bids: DataRecord<Bid>[];
+  quotes: DataRecord<LeasingQuote>[];
+  activeQuote?: DataRecord<LeasingQuote>;
+  payments: PaymentSummary | undefined;
+  customer?: {
+    contact: DataRecord<Contact>;
+    org?: DataRecord<Organization>;
+  };
+};
+
+export type OpportunityEvent = {
+  opportunity: Opportunity;
+  action: 'create' | 'update' | 'delete';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+export type QuoteEvent = {
+  quote: LeasingQuote;
+  opportunity: Opportunity;
+  action: 'create' | 'update' | 'delete';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+/* Quote summary with information that should be common to different types of quotes */
+export type QuoteInfo = {
+  status: QuoteStatus;
+  roi: string;
+  id: string;
+};
+
+export type SearchOpportunity = {
+  contact?: Contact;
+  opportunity: Opportunity;
+  org?: Organization;
+  vehicle?: Vehicle;
+  quote?: QuoteInfo;
+  custom: {
+    unassigned: boolean;
+    assignees: string[];
+  };
+};
+
+export const QUOTE_CREATED_NOTIFICATION_ORIGIN = 'quote-created';
+export const QUOTE_VALIDATOR_FEEDBACK_NOTIFICATION_ORIGIN = 'quote-validator-feedback';
+export const QUOTE_CUSTOMER_FEEDBACK_NOTIFICATION_ORIGIN = 'quote-customer-feedback';
+export const OPPORTUNITY_CLOSED_NOTIFICATION_ORIGIN = 'opportunity-closed';
+
+export type OpportunityNotificationData = {
+  quoteVersion?: number;
+};
+
+export type LeasingQuoteTemplateData = {
+  opportunity: {
+    id: string;
+  };
+  currentDate: string;
+  vehicle: {
+    make: string;
+    model: string;
+    type?: string;
+    km: string | number;
+    vin: string;
+    mainImage: string;
+    localLicensePlate: boolean;
+    description: string;
+    year?: string | number;
+  };
+  accountManager: {
+    fullName: string;
+    email: string;
+    phone: string;
+  };
+  customer: {
+    company: string;
+    fullName: string;
+    vatNumber?: string;
+    address?: string;
+  };
+  settingId: string;
+  leasing: {
+    deposit: string;
+    startupFee: string;
+    totalExtras: string;
+    totalBeforeDeliveryExclVat: string;
+    totalBeforeDelivery: string;
+    installment: string;
+    duration: number;
+    monthlyInsurance: string;
+    monthlyTax: string;
+    monthlyTaxesInsurance: string;
+    residual: string;
+    offerNumber: string;
+    extras: { name: string }[];
+  };
+};
+
+export type LeasingProformaTemplateData = {
+  opportunity: {
+    id: string;
+    offerNumber: string;
+  };
+  currentDate: string;
+  accountManager: {
+    fullName: string;
+    email: string;
+    phone: string;
+  };
+  vehicle: {
+    line1: string;
+    line2: string;
+    stockNumber: string;
+  };
+  c: {
+    organizationId?: string;
+    clientNumber: number;
+    company: string;
+    fullName: string;
+    vatNumber?: string;
+    email?: string;
+    phone?: string;
+    address?: string;
+  };
+  i: {
+    description: string;
+    vat: string;
+    quantity: number;
+    unitPriceExclVat: string;
+    amount: string;
+    amountExclVat: string;
+  }[];
+  t: {
+    totalExclVat: string;
+    vatAmount: string;
+    displayVatMessage: boolean;
+    total: string;
+    monthly: string;
+    monthlyExclVat: string;
+    residual: string;
+    residualExclVat: string;
+    duration: number;
+  };
+};
+
+export type OpportunitiesKanbanColumn = {
+  status: string;
+  results: SearchOpportunity[];
+  totalCount: number;
+  totalValue: string;
+};
+
+export type HpLeasingDealRequest = {
+  tenantId: string;
+  initiatedBy: 'bisondesk';
+  processMetaId: string;
+  processRunData: {
+    entityOwner: string;
+    leasingContractOwner: string;
+    foreseenDeliveryDate?: string;
+    deliveryAddressLeasing?: string;
+    nameSalesPerson: string;
+    durationLeasingInMonths: number;
+    vanCourier: boolean;
+    newVehicle?: boolean;
+    newTrailer?: boolean;
+    registrationOnTtcoBe?: string;
+    yearOfConstruction?: number;
+    chassisnumber?: string;
+    vehicleModel?: string;
+    vehicleCategory2?: string;
+    licencePlate?: string;
+    vatPercentage?: number;
+
+    opportunityContractId: string;
+    opportunityId: string;
+
+    company?: string;
+    customerNumber?: number; //bisondesk external id
+    //MrLease fields
+    vehicle?: string;
+    salesPriceEur: string;
+    depositFullAmountExclVat: string;
+    depositToBePrepaidExclVat: string;
+    vehicleMake3?: string;
+
+    //TTC fields
+    vehicleOriginalReference?: string;
+    salesPrice: string;
+    depositFullAmount: string;
+    depositAmountToBePrepaid: string;
+    make?: string;
+
+    //Extras
+    garageExtrasCodes: string[];
+    allExtrasDescriptions: string[];
+    administrationExtrasCodes: string[];
+    logisticExtrasCodes: string[];
+    customRequestDescriptions: string[];
+  };
+};
+
+export type HpLeasingDealResponse = {
+  entityId: string;
+  id: string;
+  status: string;
+  leasingContractNumber?: string;
+};
+
+export type HpLeasingContractRequest = {
+  tenantId: string;
+  initiatedBy: 'bisondesk';
+  processMetaId: string;
+  processRunData: {
+    entityOwner: string;
+    company?: string;
+    vehicle?: string;
+    ldNumber: number;
+    vanCourier: boolean;
+    startDate: number;
+    opportunityContractId: string;
+    data: {
+      leasingParameter: {
+        allRisksPercentage: number;
+        allRisksTaxPercentage: number;
+        civilLiability: number;
+        entityId: string;
+        oneTimeRoadTax: number;
+        specialInsurance: number;
+        yearlyRoadTax: number;
+        countries: string[];
+        vehicleCategory: string;
+      };
+
+      calculatorRequest: {
+        bankDeposit: number;
+        bankDurationInMonths: number;
+        bankInterestRatePercentage: number;
+        bankResidualValue: number;
+        deposit: number;
+        durationInMonths: number;
+        includesAllRisks: boolean;
+        includesCivilLiability: boolean;
+        includesOneTimeRoadTax: boolean;
+        includesSpecialInsurance: boolean;
+        includesYearlyRoadTax: boolean;
+        insuranceAmount: number;
+        interestRatePercentage: number;
+        marginPercentage: number;
+        monthlyAdministrationFee: 0;
+        purchasePrice: number;
+        residualValue: number;
+        salesPrice: number;
+        startupFeePercentage: number;
+      };
+
+      calculatorResponse: {
+        ROI: number;
+        ROIDifference: number;
+        ROIPerYear: number;
+        ROITarget: number;
+        allRisksInsuranceAmount: number;
+        bankContractValue: number;
+        bankLeasingAmount: number;
+        cashDeficit: number;
+        financingAmount: number;
+        leasingAmount: number;
+        leasingContractValue: number;
+        leasingProfit: number;
+        monthlyTaxRetailPrice: number;
+        oneTimeTaxCost: number;
+        totalMonthlyPayment: number;
+        totalProfit: number;
+        vehicleProfit: number;
+      };
+
+      cashInValues: CashInRow[];
+
+      cashOutValues: CashOutRow[];
+    };
+  };
+};
+
+export type HpLeasingContractResponse = {
+  entityId: string;
+  id: string;
+  status: string;
+  createdAt: string;
+  updatedAt: string;
+  dateOfFinalSettlement: string;
+  startDate: string;
+  email: string;
+  contractNumber: string;
+};
+
+export type CashInRow = {
+  time: number;
+  deposit: number;
+  monthlyAdministrationFee: 0; //Legacy field - Should always be 0
+  residualValue: number;
+  startupFee: number;
+  leasingAmountWithoutAdminFee: number;
+  insurancePayment: number;
+  taxPayment: number;
+  cashIn: number;
+  cumulativeCash: number;
+};
+
+export type CashOutRow = {
+  time: number;
+  deposit: number;
+  residualValue: number;
+  leasingAmount: number;
+  insurancePayment: number;
+  taxPayment: number;
+  cashOut: number;
+  cumulativeCash: number;
+};
+
+export type SwitchOpportunityVehicleRequest = {
+  opportunityId: string;
+  newVehicleId: string;
+};

package/src/types/payments.ts

@@ -0,0 +1,40 @@
+export enum PaymentActions {
+  DELETE = 'delete',
+  EDIT = 'edit',
+}
+
+type BasePayment = {
+  opportunityId: string;
+  amount: string;
+  description?: string;
+  vehicleId: string;
+  organizationId: string;
+};
+
+export type NewPayment = BasePayment & {
+  id?: undefined;
+  createdAt?: undefined;
+  createdBy?: undefined;
+  modifiedAt?: undefined;
+  modifiedBy?: undefined;
+  deletedAt?: undefined;
+  deletedBy?: undefined;
+  paidAt: string;
+};
+
+export type Payment = BasePayment & {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  deletedAt?: string;
+  deletedBy?: string;
+  paidAt?: string;
+};
+
+export type PaymentUpdate = {
+  description?: string;
+  amount?: string;
+  paidAt?: string;
+};

package/src/types/picklists.ts

@@ -1,36 +1,47 @@
 import { MultiLangValue } from '@bisondesk/commons-sdk/lib/types';
-////////////////////////////////////////////////////////////////////
-// Picklist
-////////////////////////////////////////////////////////////////////
 
 export type PicklistValueUpdateRequest = {
   picklistId: string;
   value: PicklistValue | NewPicklistValue;
 };
-export type NewPicklistValue = {
+
+export type NewPicklistValue<T = Record<string, string>> = {
   color?: string;
   sortPriority?: number;
   titles: MultiLangValue;
   dependency?: PicklistValueDependency;
+  meta?: T;
 };
-export type PicklistValue = NewPicklistValue & {
+
+export type PicklistValue<T = any> = NewPicklistValue<T> & {
   id: string;
   system?: boolean;
 };
+
 export type PicklistValueListRequest = {
   picklistId: string;
   limit: number;
   offset: number;
+  dependencies?: PicklistValueDependency[];
 };
+
 export type PicklistValueRequest = {
   picklistId: string;
   valueId: string;
 };
-export type AdHocPicklistValues = {
+
+export type AdHocPicklistValues<T = any> = {
   [picklistId: string]: {
-    [valueId: string]: PicklistValue;
+    [valueId: string]: PicklistValue<T>;
   };
 };
+
+export type AdHocPicklistRequest = {
+  requests: PicklistValueRequest[];
+  preferredLang: string;
+  tenantLang: string;
+};
+
 export type AdHocPicklistValueDisplay = {
   [picklistId: string]: {
     [valueId: string]: {
@@ -39,26 +50,32 @@ export type AdHocPicklistValueDisplay = {
     };
   };
 };
+
 export type PicklistOptionsRequest = {
   picklistId: string;
   dependencies?: PicklistValueDependency[];
   lang: string;
 };
+
 export type QuickAddPicklistValue = {
   sortPriority?: number;
   titles: MultiLangValue;
 };
+
 export type NewPicklist = {
+  id?: undefined;
   titles: MultiLangValue;
   values: QuickAddPicklistValue[];
   customSort?: boolean;
 };
+
 export type BasePicklist = {
   customSort?: boolean;
   id: string;
   system?: boolean;
   titles: MultiLangValue;
 };
+
 export type PicklistInfo = BasePicklist & {
   count: number;
   modifiedAt: string;
@@ -67,3 +84,5 @@ export type PicklistValueDependency = {
   picklistId: string;
   values: string[];
 };
+
+export type PicklistCollection = (BasePicklist & { data: PicklistValue[] })[];