@bisondesk/core-sdk 1.0.162 → 1.0.164

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/core-sdk",
-  "version": "1.0.162",
+  "version": "1.0.164",
   "description": "",
   "scripts": {
     "clean": "rm -rf build dist lib *.tsbuildinfo",
@@ -11,13 +11,13 @@
   },
   "author": "TheTruckCompany",
   "dependencies": {
-    "@bisondesk/commons-sdk": "1.0.162",
+    "@bisondesk/commons-sdk": "1.0.164",
     "joi": "17.4.0",
     "lru-cache": "6.0.0"
   },
   "devDependencies": {
     "@types/lru-cache": "5.1.0",
     "@types/node": "16.11.7",
-    "typescript": "4.5.2"
+    "typescript": "4.6.3"
   }
 }

package/src/apis/leasing-administration.ts

@@ -4,9 +4,41 @@ import {
 } from '@bisondesk/commons-sdk/lib/constants';
 import { XError } from '@bisondesk/commons/lib/errors';
 import fetch, { Response } from 'node-fetch';
-import { LeasingAdminUpload, LeasingAdminUploadStatus } from '../types/leasing-administration';
+import {
+  LeasingAdminUpload,
+  LeasingAdminUploadStatus,
+  NewLeasingAdminUploadRequest,
+} from '../types/leasing-administration';
 import { cleanHeaders, getAdminAuth } from './utils';
 
+export const createLeasingAdminUpload = async (
+  tenantId: string,
+  data: NewLeasingAdminUploadRequest,
+  opts?: { serviceId: string }
+): Promise<LeasingAdminUpload> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(
+    `${process.env.CORE_API_ORIGIN}/api/leasing/administration/uploads`,
+    {
+      method: 'POST',
+      headers: cleanHeaders({
+        Authorization: auth,
+        'Content-Type': 'application/json',
+        [TENANT_ID_ADMIN_HEADER]: tenantId,
+        [SERVICE_ID_ADMIN_HEADER]: opts?.serviceId,
+      }),
+      body: JSON.stringify(data),
+    }
+  );
+
+  if (response.ok) {
+    return response.json();
+  }
+
+  const body = await response.text();
+  throw new XError(response.statusText, { body, data, opts });
+};
+
 export const updateLeasingAdminUploadStatus = async (
   tenantId: string,
   handlerId: string,

package/src/constants.ts

@@ -82,15 +82,20 @@ export const MAX_PRICE = 100_000;
 export const PRICE_ROUNDING = 1000;
 export const KM_ROUNDING = 100_000;
 
+//
+// Leasing administration
+//
 export enum LeasingAdminUploadHandlers {
   DhondtMonthly = 'dhondt-monthly-invoice',
   DhondtProrata = 'dhondt-prorata-invoice',
   Belfius = 'belfius-monthly-invoice',
+  ING = 'ing-monthly-invoice',
 }
 
 export enum LeasingAdminEntities {
   Dhondt = 'dhondt',
   Becris = 'becris',
+  ING = 'ing',
 }
 
 export enum LeasingAdminUploadErrors {

package/src/types/crm.ts

@@ -56,6 +56,11 @@ export type Organization = BaseOrganization & {
   externalId?: number;
   id: string;
   debt?: OrganizationDebtInfo;
+  blocked?: boolean;
+  blockedAt?: string;
+  blockedBy?: string;
+  blockedReason?: string;
+  openOpportunitiesCount: number;
 };
 
 export type OrganizationDebtInfo = {

package/src/types/leads.ts

@@ -120,6 +120,7 @@ export type Interest = {
   suspensions?: string[];
   tailgate?: boolean;
   transmissions?: string[];
+  autoGenerated?: boolean;
 
   remarks?: string;
 };

package/src/types/leasing-administration.ts

@@ -64,6 +64,21 @@ export type DhondtInvoiceLine = {
   VoertuigVlootNummer: string;
 };
 
+export type INGMetadata = {
+  capital: string;
+  chassisNumber: string;
+  emailId: string;
+  interest: string;
+  invoiceDate: string;
+  invoiceNumber: string;
+  pdfUrl: string;
+  stockNumber: string;
+};
+
+export type INGAttachments = {
+  email: AttachmentValue;
+};
+
 export type DiffableDhondtInvoiceLine = DhondtInvoiceLine;
 
 export type BelfiusRawInvoiceLine = {

package/src/types/messages.ts

@@ -45,6 +45,8 @@ export type TemplatedEmailRequest = {
 };
 
 export type EmailRequest = {
+  references?: string[] | string;
+  inReplyTo?: string; // messageId of the email to reply to
   destinations: EmailDestination[];
   replyTo?: EmailAddress;
   source: EmailAddress;

package/src/types/opportunities.ts

@@ -1,65 +1,119 @@
+import { Contact, Organization } from './crm';
+import { AttachmentValue } from './fields';
 import { Interest } from './leads';
+import { DataRecord } from './utils';
 import { Vehicle } from './vehicles';
 
-enum OpportunityDealStatus {
+export enum OpportunityDealStatus {
   SALES_AGREED = 'sales_agreed',
   FIRST_PAYMENT = 'first_payment',
   FULL_PAYMENT = 'full_payment',
 }
 
-enum OpportunityStatus {
-  PROSPECTING = 'prospecting',
-  DISCOVERY = 'discovery',
-  CUSTOMER_EVALUATING = 'customer_evaluating',
-  NEGOTIATION_REVIEW = 'negotiation_review',
-  WON = 'won',
-  LOST = 'lost',
+export enum OpportunityStatus {
+  PROSPECTION = 'prospection',
+  VEHICLE_DISCOVERY = 'vehicle_discovery',
+  QUOTE_EVALUATION = 'quote_evaluation',
+  VEHICLE_LOCKED = 'vehicle_locked',
+  QUOTE_ACCEPTED = 'quote_accepted',
+  CLOSED_WON = 'closed_won',
+  CLOSED_LOST = 'closed_lost',
 }
 
-enum OpportunityLogisticStatus {
+export enum OpportunityLogisticStatus {
   AT_ORIGIN = 'at_origin',
   DELIVERED = 'delivered',
 }
 
-enum OpportunityType {
+export enum OpportunityType {
   LEASING = 'leasing',
   SALES = 'sales',
 }
 
-export type Bid = {
-  id: string;
+export enum OpportunityLostReasonValues {
+  NOT_INTERESTED = 'not_interested',
+  NOT_ENOUGH_INFO = 'not_enough_info',
+  NO_RESPONSE = 'no_response',
+  QUOTE_REJECTED = 'quote_rejected',
+}
+
+export enum QuoteStatusValues {
+  CREATED = 'created',
+  VALIDATED = 'validated',
+  INVALIDATED = 'invalidated',
+  ACCEPTED = 'accepted',
+  REJECTED = 'rejected',
+}
+
+export type BaseBid = {
   vehicleId: string;
-  opportunityId: string;
+  opportunityId?: string;
   contactId: string;
   amount: string;
+};
+
+export type NewBid = BaseBid & {};
+
+export type Bid = BaseBid & {
+  id: string;
   createdAt: string;
   createdBy: string;
 };
 
-export type Quote = {
+export type QuoteStatus = {
+  status: QuoteStatusValues;
+  date: string;
+  author: string;
+};
+
+export type QuoteCalculatorValues = {
+  pruchasePrice: string;
+};
+
+export type BaseQuote = {
   id: string;
+  opportunityId: string;
+  vehicleId: string;
+  contactId: string;
+  createdAt: string;
+  createdBy: string;
+  updatedAt: string;
+  updatedBy: string;
+  calculatorValues: QuoteCalculatorValues;
+};
+
+export type NewQuote = BaseQuote & {
+  id?: undefined;
+  createdAt?: undefined;
+  createdBy?: undefined;
+  modifiedAt?: undefined;
+  modifiedBy?: undefined;
+};
+
+export type Quote = BaseQuote & {
+  version: number;
+  status: QuoteStatus;
+  monthlyAmount: string;
+  residualAmount: string;
+  beforeDeliveryAmount: string;
+  roi: string;
+  cashflow: string;
+  profitability: string;
+  proformaPdf?: AttachmentValue;
+  quotePdf?: AttachmentValue;
+};
+
+export type QuoteUpdate = {
+  status: QuoteStatus;
 };
 
 type BaseOpportunity = {
-  accountManager?: string;
-  countryCode: string;
+  accountManager: string;
+  type: OpportunityType;
   organizationId?: string;
-  /** will not be filled if organizationId is present */
-  orgName?: string;
   contactId?: string;
-  /** will not be filled if contactId is present */
-  contactName?: string;
   vehicleId?: string;
-  vechicle?: Vehicle;
-  bids?: Bid[];
-  dealStatus: OpportunityDealStatus;
-  logisticStatus: OpportunityLogisticStatus;
-  type: OpportunityType;
-  contractId?: string;
-  quotes?: Quote[];
-  amount: string;
-  status: OpportunityStatus;
-  interest: Interest;
+  source: string; // e.g. manual, website, autoscout, mobile...
 };
 
 export type NewOpportunity = BaseOpportunity & {
@@ -70,10 +124,60 @@ export type NewOpportunity = BaseOpportunity & {
   modifiedBy?: undefined;
 };
 
+export type OpportunityDocument = {
+  type: string; // passport, driving_license, ...
+  displayName: string;
+  file: AttachmentValue;
+};
+
 export type Opportunity = BaseOpportunity & {
   id: string;
   createdAt: string;
   createdBy: string;
   modifiedAt: string;
   modifiedBy: string;
+  lostAt?: string;
+  lostBy?: string;
+  lostReason?: OpportunityLostReasonValues;
+  deliveredAt?: string;
+  deliveredBy?: string;
+  status: OpportunityStatus;
+  dealStatus?: OpportunityDealStatus;
+  logisticStatus?: OpportunityLogisticStatus;
+  activeQuoteId?: string;
+  contractId?: string;
+  amount?: string;
+  interest?: Interest;
+  documents?: OpportunityDocument[];
+};
+
+export type OpportunityUpdate = {
+  vehicleId?: string | null;
+  accountManager?: string;
+  contactId?: string | null;
+  activeQuoteId?: string;
+  interest?: Interest | null;
+  lost?: boolean;
+  lostReason?: OpportunityLostReasonValues;
+  delivered?: boolean;
+  documents?: OpportunityDocument[];
+};
+
+export type OpportunityBFF = {
+  opportunity: DataRecord<Opportunity>;
+  vehicle?: DataRecord<Vehicle>;
+  bids: DataRecord<Bid>[];
+  quotes: DataRecord<Quote>[];
+  customer?: {
+    contact: DataRecord<Contact>;
+    org?: DataRecord<Organization>;
+  };
+};
+
+export type OpportunityEvent = {
+  opportunity: Opportunity;
+  action: 'create' | 'update' | 'delete';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
 };

package/src/types/tenants.ts

@@ -18,6 +18,7 @@ export type Tenant = PublicTenant & {
   emailDomain: string;
   hyperdmsIds?: string[];
   hyperportalId?: string;
+  exactAccounting?: boolean;
 };
 
 export type HdmsVehiclesSync = {

package/src/types/utils.ts

@@ -40,7 +40,8 @@ export type AdHocRecordTitles = {
   };
 };
 
-export type MetaRecord<T> = {
+export type DataRecord<T, M = undefined> = {
   record: T;
-  meta: ReferenceData;
+  meta?: M; // typically ReferenceData
+  actions: string[];
 };

package/src/types/vehicles.ts

@@ -64,6 +64,7 @@ export type VehicleInternalInfo = {
     currency?: string;
   };
   status: VehicleStatus;
+  openOpportunitiesCount: number;
   updatedAt: string;
 };