@bisondesk/core-sdk 1.0.21 → 1.0.23-B

package/src/types/leads.ts

@@ -0,0 +1,144 @@
+import {
+  PhoneNumberRawValue,
+  PhoneNumberValue,
+  SearchPermissions,
+} from '@bisondesk/commons-sdk/lib/types';
+import { PublicSearchDefinition } from './definitions';
+import { ReferenceData } from './utils';
+import { SearchVehicle } from './vehicles';
+
+export type SearchLead = Lead;
+
+export type InputSearchLead = SearchLead & {
+  permissions: SearchPermissions;
+};
+
+export type RankedSearchLead = SearchLead & { score: number };
+
+export type LeadPublicSearchDefinitions = {
+  searchLead: PublicSearchDefinition;
+};
+
+export type LeadEvent = {
+  id: string;
+  action: 'upsert' | 'delete';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+export type LeadContact = {
+  accountManager?: string;
+  companyName?: string;
+  country: string;
+  email?: string;
+  name: string;
+  phone?: PhoneNumberValue | PhoneNumberRawValue;
+  remarks?: string;
+
+  // Fields used to link lead to existing org and contact.
+  organizationId?: string;
+  contactId?: string;
+  orgNumber?: number;
+};
+
+export type LeadScore = {
+  leadId: string;
+  score: number;
+  scores: { name: string; value: number }[];
+};
+
+export type VehicleScore = {
+  vehicleId: string;
+  score: number;
+};
+
+export type LeadVehicles = {
+  vehicles: VehicleScore[];
+};
+
+export type VehicleLeads = {
+  leads: LeadScore[];
+};
+
+export type VehicleLeadsResponse = VehicleLeads & {
+  leadsById: { [leadId: string]: Lead };
+};
+
+export type LeadVehiclesResponse = LeadVehicles & {
+  vehiclesById: { [vehicleId: string]: SearchVehicle };
+};
+
+export type LeadStats = {
+  lastClientConversation?: string;
+  lastClientTx?: string;
+  clientTxs?: number;
+};
+
+export type LeadVehicle = {
+  createdAt: string;
+  vehicleId: string;
+  saleId?: string;
+};
+
+export type Lead = {
+  id: string;
+  createdAt: string;
+  contact: LeadContact;
+  interests: Interest[];
+  vehicles: LeadVehicle[];
+  stats?: LeadStats;
+};
+
+export type InterestVersion = {
+  make: string;
+  models?: string[];
+};
+
+export type Interest = {
+  id: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  extended?: string[];
+  heightened?: string[];
+  adr?: boolean;
+  age?: number;
+  axleConfigurations?: string[];
+  bodystyle?: string;
+  cabins?: string[];
+  category: string;
+  crane?: boolean;
+  damaged?: boolean;
+  euronorms?: string[];
+  horsepower?: number;
+  used?: boolean;
+  kilometers?: number;
+  versions?: InterestVersion[];
+  price?: number;
+  leasing?: boolean;
+  retarderIntarder?: boolean;
+  suspensions?: string[];
+  tailgate?: boolean;
+  transmissions?: string[];
+  autoGenerated?: boolean;
+
+  remarks?: string;
+};
+
+export type InterestResponse = {
+  interest: Interest;
+  meta: ReferenceData;
+};
+
+export type InterestSearchRequest = { interest: Interest; offset: number; limit: number };
+
+export type VehicleLeadsSearchRequest = { vehicleId: string };
+
+export type InterestAutocompleteRequest = { vehicleId: string };
+
+export type LeadVehiclesSearchRequest = { leadId: string };
+
+export type SimilarVehiclesRequest = {
+  offset: number;
+  limit: number;
+};

package/src/types/leasing-administration.ts

@@ -0,0 +1,131 @@
+import { AttachmentValue } from '@bisondesk/commons-sdk/lib/types';
+import { LeasingAdminUploadHandlers } from '../constants';
+
+export type LeasingAdminUploadStatus = 'success' | 'processing' | 'error';
+
+export type LeasingAdminUploadMetadata = { [key in string]?: unknown };
+export type LeasingAdminUploadAttachments = { [key in string]?: AttachmentValue };
+
+export type LeasingAdminUploadEvent<
+  M extends LeasingAdminUploadMetadata = {},
+  A extends LeasingAdminUploadAttachments = {}
+> = LeasingAdminUpload<M, A> & { tenantId: string };
+
+export type LeasingAdminUpload<
+  M extends LeasingAdminUploadMetadata = {},
+  A extends LeasingAdminUploadAttachments = {}
+> = {
+  id: string;
+  updatedAt: string;
+  createdAt: string;
+  createdBy: string;
+
+  status: LeasingAdminUploadStatus;
+  attachments: A;
+  metadata: M;
+  handlerId: LeasingAdminUploadHandlers;
+};
+
+export type NewLeasingAdminUploadRequest<
+  M extends LeasingAdminUploadMetadata = {},
+  A extends LeasingAdminUploadAttachments = {}
+> = {
+  attachments: A;
+  metadata: M;
+  handlerId: LeasingAdminUploadHandlers;
+};
+
+export type DhondtAttachments = {
+  json: AttachmentValue;
+};
+
+export type BelfiusAttachments = {
+  xlsx: AttachmentValue;
+  json?: AttachmentValue; // json version of the xlsx file
+};
+
+export type BelfiusMetadata = {
+  totalLines: number;
+  totalIncludingVat: string;
+};
+
+export type DhondtMetadata = {
+  invoiceNumber: string;
+  invoiceDate: string;
+};
+
+export type DhondtInvoiceLine = {
+  BrutoPremie: number;
+  Chassisnummer: string;
+  Datum: string;
+  NettoPremie: number;
+  Plaatnummer: string;
+  Taksen: number;
+  VoertuigVlootNummer: string | undefined;
+};
+
+export type INGMetadata = {
+  capital: 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 = {
+  AMORTIZATION: number;
+  AVENANT: number;
+  CODE_DEVISE: string;
+  CONTRACT: number;
+  CUSTOMER: string;
+  DATE_INVOICE: number;
+  DESCRIPTION: string;
+  DUE_DATE: number;
+  INTEREST: number;
+  INVOICE: number;
+  RATE: number;
+  RENTAL: number;
+  REST_DESCIPT: string;
+  VAT: number;
+  'VAT INCL': number;
+  VAT_NUMBER: string;
+};
+
+export type BelfiusInvoiceLine = {
+  capital: string;
+  contractNr: string;
+  interest: string;
+  invoiceNr: string;
+  invoiceDate: string;
+  rentExcl: string;
+  rentIncl: string;
+  vatAmount: string;
+  vehicleId: string;
+  stockNumber: string;
+};
+
+export type DiffableBelfiusInvoiceLine = Omit<
+  BelfiusInvoiceLine,
+  'invoiceNr' | 'invoiceDate' | 'capital' | 'interest'
+>;
+
+export type LineDiff<T> = {
+  [Property in keyof T]: {
+    value: T[Property];
+    before: T[Property];
+  };
+};
+
+export type Diff<T> = {
+  added: T[];
+  removed: T[];
+  changed: LineDiff<T>[];
+};

package/src/types/leasing-search.ts

@@ -0,0 +1,24 @@
+import { InsuranceEntry } from '@bisondesk/commons-sdk/lib/insurance';
+import { SearchPermissions } from '@bisondesk/commons-sdk/lib/types';
+import { Organization } from './crm';
+import { PublicSearchDefinition } from './definitions';
+import { LeasingContract } from './leasing';
+import { Vehicle } from './vehicles';
+
+export type LeasingPublicSearchDefinitions = {
+  searchLeasingContract: PublicSearchDefinition;
+};
+
+export type SearchLeasingContract = {
+  contract: LeasingContract;
+  org: Organization;
+  vehicle: Vehicle;
+  custom: {
+    active: boolean;
+    insurance?: InsuranceEntry;
+  };
+};
+
+export type InputSearchLeasingContract = SearchLeasingContract & {
+  permissions: SearchPermissions;
+};

package/src/types/leasing-settings.ts

@@ -0,0 +1,111 @@
+import { MultiLangValue } from '@bisondesk/commons-sdk/lib/types';
+import { Categories, OpportunityType } from '../constants';
+import { SortFilter } from './search';
+
+export type LeasingQuoteParams = { id: string; name: string; modifiedAt: string } & {
+  countryCode: 'be';
+  insurance: {
+    allRisksCost: string;
+    allRisksTax: string;
+    allRisksFees: string;
+    allRisksMinimumCost: string;
+    specialTechnicalInsuranceCost: string;
+    specialTechnicalInsuranceTax: string;
+    specialTechnicalInsuranceFees: string;
+    civilLiabilitiesCost: string;
+    civilLiabilitiesTax: string;
+    civilLiabilitiesFees: string;
+    roadAssistanceMonthlySalesPrice: string; // monthly Price
+    roadAssistanceMonthlyCostPrice: string; // monthly Price
+    margin: string;
+  };
+  leasing: {
+    leasingInterestRate: string;
+    leasingDuration: number;
+    leasingStartupFeePercentage: string;
+    leasingDepositPercentage: string;
+    leasingResidualValuePercentage: string;
+  };
+  taxes: {
+    oneTimeRoadTax: string;
+    yearlyRoadTax: string;
+    margin: string;
+  };
+  costs: {
+    bankDepositPercentage: string;
+    bankInterestRate: string;
+    bankResidualValuePercentage: string;
+    trackAndTrace24Cost: string;
+    trackAndTrace36Cost: string;
+    trackAndTrace48Cost: string;
+    trackAndTraceMaxCost: string;
+  };
+};
+
+type BaseLeasingQuoteExtraSettings = {
+  referenceCode: string;
+  active: boolean;
+  costPrice: string;
+  countryCode: string;
+  deliveryPackage: boolean;
+  displayByDefault: boolean;
+  hint?: MultiLangValue;
+  name: MultiLangValue;
+  salesPrice: string;
+  vehicleCategoryRestrictions: Categories[];
+  departments: string[];
+  departmentTitles?: { [department: string]: string };
+  opportunityTypeRestrictions: OpportunityType[];
+};
+
+export type BaseLeasingQuoteExtraInput = {
+  agreedPrice: string;
+  costPrice: string;
+  hint?: MultiLangValue;
+  name: MultiLangValue;
+  referenceCode: string;
+  quantity: number;
+  id: string;
+  departments: string[];
+  departmentTitles?: { [department: string]: string };
+};
+
+export type NewLeasingQuoteExtraSettings = BaseLeasingQuoteExtraSettings & {
+  id?: undefined;
+};
+
+export type LeasingQuoteExtraSettings = BaseLeasingQuoteExtraSettings & {
+  id: string;
+};
+
+export enum LeasingItemsPaymentSplit {
+  Customer = 'customer',
+  Split = 'split',
+  Company = 'company',
+}
+
+export type LeasingDeliveryPackageInput = BaseLeasingQuoteExtraInput & { salesPrice: string };
+
+export type CustomLeasingQuoteExtraInput = BaseLeasingQuoteExtraInput & {
+  paymentSplit: LeasingItemsPaymentSplit;
+  leasingPercentage: string;
+};
+
+export type LeasingQuoteExtraInput = BaseLeasingQuoteExtraInput & {
+  salesPrice: string;
+  paymentSplit: LeasingItemsPaymentSplit;
+  leasingPercentage: string;
+};
+
+export type LeasingQuoteExtrasRequest = {
+  deliveryPackage?: boolean;
+  displayByDefault?: boolean;
+  vehicleCategory?: Categories;
+  country: string;
+  name?: string;
+  active?: boolean;
+  offset?: number;
+  limit?: number;
+  sortBy?: SortFilter;
+  opportunityType?: OpportunityType;
+};