@bisondesk/commons-sdk 1.0.197 → 1.0.198

package/src/hyperdms.ts

@@ -1,614 +0,0 @@
-export enum HdmsActivities {
-  DOCUMENT_UPSERT = 'DOCUMENT_UPSERT',
-  ORGANIZATION_UPSERT = 'ORGANIZATION_UPSERT',
-  VEHICLE_MODIFY = 'VEHICLE_MODIFY',
-}
-
-export type HdmsOrganization = {
-  billingEmail?: string;
-  countryCode: string;
-  createdAt: number;
-  createdBy: string;
-  deleted?: boolean;
-  externalId: number;
-  id: string;
-  name: string;
-  ownerOrg: string;
-  ownerOrgs: string[];
-  parentId?: string;
-  segment?: string;
-  type?: 'COMPANY' | 'INDIVIDUAL';
-  vatNumber?: string;
-  website?: string;
-};
-
-export type HdmsContact = {
-  accountManagers: string[];
-  createdAt: number;
-  createdBy: string;
-  deleted?: boolean;
-  emails: { label: string; value: string }[];
-  firstName?: string;
-  id: string;
-  job?: string;
-  language: string; // the english name of the language, ex: Portuguese
-  lastName?: string;
-  nickname?: string;
-  notes?: string;
-  phones: { label: string; value: string }[];
-};
-
-export type HdmsAddress = {
-  addressLines: string[];
-  city?: string;
-  countryCode: string;
-  createdAt: number;
-  createdBy: string;
-  deleted?: boolean;
-  id: string;
-  labels: Array<'TRANSPORT_ADDRESS' | 'LEGAL_ADDRESS'>;
-  zipCode?: string;
-  position?: {
-    lat: number;
-    lon: number;
-  };
-};
-
-export type HdmsRecurringLeasingInvoice = {
-  id: string;
-  vehicleId: string;
-  vehicleSaleId: string;
-  vehicleAdministrativeNumber: string;
-  vehicleStockNumber: string;
-  organizationId: string;
-  startDate: string;
-  totalExecutions: number;
-  executions: number;
-  active: boolean;
-  billingEmail: string;
-  invoiceNotes: string;
-  lineDescription: string;
-  lineSubcategory: string;
-  ownerOrg: string;
-  journal: string;
-  vatCode: string;
-  amountExclusive: number;
-  createdBy: string;
-  createdAt: number;
-  lastModifiedBy: string;
-  lastModifiedAt: number;
-  lastExecutedAt: number;
-  lastExecutedFinanceDocumentId: string;
-};
-
-export type HdmsPicklistValue = {
-  property: string;
-  id: string;
-  name: string;
-  lang: string;
-  sort: number;
-  dependency?: {
-    property_dependency: string;
-    allowed_dependency_ids: string[];
-  };
-};
-
-export type HdmsActivityEvent<T = {}> = {
-  who: string;
-  what: string;
-  when: number;
-  metadata: T;
-};
-
-export type HdmsRole = {
-  id: string;
-  vehicleId: string;
-  designation: string;
-};
-
-export type HdmsVehicle = HdmsBaseVehicle & {
-  administrative_number: string;
-  deleted_date?: number;
-  id: string;
-  location?: string;
-  meta_id: string;
-  offer_id?: string;
-  organization: string;
-  stock_number: string;
-  transaction_type: string;
-  segments?: string[];
-};
-
-export type HdmsBaseVehicle = {
-  created_at: number;
-  created_by: string;
-  last_updated_at: number;
-  last_updated_by: string;
-  advertised_year?: number;
-  leasing_eligible: boolean;
-  external_id?: string;
-  category: string;
-  bodywork?: string;
-  extended_length?: string;
-  extended_height?: string;
-  make: string;
-  year?: number;
-  advertise_targets?: {
-    PUBLIC_WEBSITE: boolean;
-    HEXON: boolean;
-  };
-  advertise_overrides?: {
-    PUBLIC_WEBSITE?: boolean;
-    HEXON?: boolean;
-  };
-  description?: string;
-  public_description?: string;
-  licence_plate?: string;
-  technical_description?: string;
-  registration_country?: string;
-  first_registration_date?: number;
-  coc_pvg?: string;
-  technical_inspection_end_date?: number;
-  gearbox?: 'Automatic' | 'Manual' | 'Semi-Automatic';
-  gearbox_make?: string;
-  gearbox_type?: string;
-  number_of_gears?: number;
-  kilometers?: number;
-  euronorm?: string;
-  configuration?: string;
-  option_retarder?: boolean;
-  option_engine_brake?: boolean;
-  option_damaged?: boolean;
-  option_lift?: boolean;
-  option_crane?: boolean;
-  crane_make?: string;
-  crane_model?: string;
-  crane_position?: 'Behind the cabin' | 'Rear';
-  crane_year?: number;
-  cabin?: 'Day' | 'Sleep / Small' | 'Sleep / Medium' | 'Sleep / Large';
-  cabin_model?: string;
-  total_load_kg?: number;
-  weight_empty_vehicle_kg?: number;
-  power_hp?: number;
-  number_of_cylinders?: number;
-  chassis_number?: string;
-  suspension?: 'Air' | 'Air/Steel' | 'Steel';
-  height_cm?: number;
-  width_cm?: number;
-  length_cm?: number;
-  wheelbase_cm?: number;
-  bodywork_height_cm?: number;
-  bodywork_width_cm?: number;
-  bodywork_length_cm?: number;
-  bodywork_make?: string;
-  bodywork_type?: string;
-  cooling_engine_make?: string;
-  bodywork_volume_l?: number;
-  bodywork_number_of_compartments?: number;
-  option_sliding_roof?: boolean;
-  option_pump?: boolean;
-  option_hoses?: boolean;
-  option_counter?: boolean;
-  option_high_pressure_pump?: boolean;
-  tank_transport_material?: string;
-  option_tipper_left?: boolean;
-  option_tipper_right?: boolean;
-  option_tipper_back?: boolean;
-  bodywork_floor_height_cm?: number;
-  bodywork_number_of_cars?: number;
-  cooling_engine?: string;
-  electric_cooling_operating_hours?: number;
-  diesel_cooling_operating_hours?: number;
-  tailgate_make?: string;
-  tailgate_model?: string;
-  tailgate_type?: string;
-  tailgate_max_load_kg?: number;
-  option_extensible?: boolean;
-  option_airco?: boolean;
-  option_standard_airco?: boolean;
-  option_alloy_wheels?: boolean;
-  option_aluminium_fuel_tank?: boolean;
-  option_abs?: boolean;
-  option_central_locking?: boolean;
-  option_central_lubrication?: boolean;
-  option_trailer_coupling?: boolean;
-  option_cruise_control?: boolean;
-  option_electric_door_mirrors?: boolean;
-  option_electric_windows?: boolean;
-  option_low_noise?: boolean;
-  option_gps?: boolean;
-  option_particle_filter?: boolean;
-  option_power_take_off?: boolean;
-  option_cd_player?: boolean;
-  option_refrigerator?: boolean;
-  option_reversing_camera?: boolean;
-  option_roof_spoiler?: boolean;
-  option_spoilers?: boolean;
-  option_side_skirts?: boolean;
-  option_speed_limiter?: boolean;
-  option_spotlights?: boolean;
-  option_stability_control?: boolean;
-  option_television?: boolean;
-  option_toolbox?: boolean;
-  option_twin_fuel_tank?: boolean;
-  option_parking_heater?: boolean;
-  option_visor?: boolean;
-  option_xenon_lights?: boolean;
-  option_tailgate?: boolean;
-  option_spare_wheel?: boolean;
-  option_forklift?: boolean;
-  option_adr?: boolean;
-  option_spare_key?: boolean;
-  option_hydraulic_tipper_kit?: boolean;
-  number_of_doors?: number;
-  fuel?: string;
-  engine_displacement_cc?: number;
-  make_model?: string;
-  make_model_type?: string;
-  option_low_deck?: boolean;
-  first_hand?: boolean;
-  axles?: HdmsAxle[];
-};
-
-export type HdmsAxle = {
-  axle_number: number;
-  axle_position?: string;
-  make?: string;
-  tire_size?: string;
-  tire_profile_left?: number;
-  tire_profile_right?: number;
-  tire_profile_inner_left?: number;
-  tire_profile_inner_right?: number;
-  brakes?: 'Disc' | 'Drum';
-  suspension?: 'Steel' | 'Air' | 'Hydraulic';
-  reduction?: string;
-  option_lift?: boolean;
-  option_twin_wheel?: boolean;
-  option_steering?: boolean;
-  option_alloy_wheels?: boolean;
-  option_driven?: boolean;
-  option_differential_lock?: boolean;
-};
-
-export type HdmsVehicleSaleDealStatus =
-  | 'SALE_AGREED'
-  | 'FIRST_PAYMENT_RECEIVED'
-  | 'FULL_PAYMENT_RECEIVED'
-  | 'DELETED';
-
-export type HdmsVehiclePurchaseDealStatus =
-  | 'PURCHASE_AGREED'
-  | 'FIRST_PAYMENT_ALLOWED'
-  | 'FIRST_PAYMENT_SENT'
-  | 'FULL_PAYMENT_ALLOWED'
-  | 'FULL_PAYMENT_SENT'
-  | 'DELETED';
-
-export type HdmsVehicleSaleLogisticsStatus = 'AT_ORIGIN' | 'DELIVERED';
-export type HdmsVehiclePurchaseLogisticsStatus = 'AT_ORIGIN' | 'ARRIVED' | 'CHECKED_IN';
-
-export type HdmsVehicleStatus = {
-  deleted: boolean;
-  option?: {
-    id: string;
-    expirationDate: number;
-  };
-  sale?: {
-    id: string;
-    dealStatus: HdmsVehicleSaleDealStatus;
-    logisticsStatus: HdmsVehicleSaleLogisticsStatus;
-  };
-  purchase?: {
-    id: string;
-    dealStatus: HdmsVehiclePurchaseDealStatus;
-    logisticsStatus: HdmsVehiclePurchaseLogisticsStatus;
-  };
-};
-
-export type HdmsPrice = {
-  currency?: string; // EUR
-  premium?: number;
-} & (
-  | {
-      internet: number;
-      minimum?: number;
-    }
-  | {
-      internet?: number;
-      minimum: number;
-    }
-);
-
-export type HdmsVehicleOrganizationSummary = {
-  organization_id: string;
-  contact_id: string;
-  address_id: string;
-  transport_address_id?: string;
-};
-
-export type HdmsVehicleSale = {
-  id: string;
-  vehicle_id: string;
-  organization_summary: HdmsVehicleOrganizationSummary;
-  modified_at: number;
-  modified_by: string;
-  log: {
-    sale_agreed_date?: number;
-  };
-  leasing_contract?: string;
-
-  // TODO
-};
-
-export type HdmsClientSaleRef = {
-  vehicle_id: string;
-  sale_id: string;
-  created_at: number;
-  status: HdmsVehicleSaleDealStatus;
-};
-
-export type HdmsClientSales = {
-  sales: HdmsClientSaleRef[];
-  organization_id: string;
-  contact_id: string;
-};
-
-export enum HdmsDocumentStatusValue {
-  SCANNED = 'SCANNED',
-  DRAFT = 'DRAFT',
-  CREATED = 'CREATED',
-  REJECTED = 'REJECTED',
-  SAVING = 'SAVING',
-  VALIDATED = 'VALIDATED',
-}
-
-export type HdmsDocumentStatus = {
-  documentId: string;
-  status: HdmsDocumentStatusValue;
-  createdBy: string;
-  createdAt: number;
-};
-
-export type HdmsTag = {
-  value: string;
-  sourceId: string;
-  sourceType: string;
-};
-
-export type HdmsViewer = {
-  username: string;
-  sourceId: string;
-  sourceType: string;
-};
-
-export type HdmsAssociation = {
-  type: string;
-  id: string;
-  description: string;
-};
-
-export type HdmsAdminDocument = {
-  id: string;
-  scanId?: string;
-  metaId: string;
-  ownerOrg: string;
-
-  supertype: 'Administrative';
-  type?:
-    | 'General Administrative'
-    | 'Logistics Administrative'
-    | 'Sale Administrative'
-    | 'Purchase Administrative';
-  subtype?: string;
-  number?: string;
-  qrCode?: string;
-
-  organizationSummary?: HdmsDocumentOrganizationSummary;
-
-  attachment: HdmsAttachment;
-
-  notes?: string;
-
-  associations: HdmsAssociation[];
-  tags: HdmsTag[];
-  viewers: HdmsViewer[];
-
-  createdAt: number;
-  createdBy: string;
-  lastUpdatedAt: number;
-  lastUpdatedBy: string;
-  deletedAt?: number;
-  deletedBy?: string;
-};
-
-export type HdmsFinanceDocument = {
-  id: string;
-  scanId?: string;
-  metaId: string;
-  ownerOrg: string;
-
-  supertype: 'Finance';
-  type: 'Sale Finance' | 'Purchase Finance';
-  subtype: 'Invoice' | 'Credit Note' | 'Proforma' | 'Purchase Order';
-  number: string;
-  qrCode?: string;
-
-  organizationSummary?: HdmsDocumentOrganizationSummary;
-
-  attachment: HdmsAttachment;
-
-  notes?: string;
-
-  associations: HdmsAssociation[];
-  tags: HdmsTag[];
-  viewers: HdmsViewer[];
-
-  createdAt: number;
-  createdBy: string;
-  lastUpdatedAt: number;
-  lastUpdatedBy: string;
-  deletedAt?: number;
-  deletedBy?: string;
-
-  issueDate: number;
-  amountInclusive: number;
-  amountVat: number;
-  salesperson?: {
-    username: string;
-    displayName: string;
-  };
-  journal?: string;
-};
-
-export type HdmsFinanceLine = {
-  id: string;
-  financeDocumentId: string;
-
-  categoryContext: string; // vehicle, other
-  category: string; // sale, purchase, other
-  subcategory: string; // purchase_cost, ...
-  description: string;
-  unitPriceExclusive: number;
-  vatCode: string;
-  vatCoefficient: number;
-  quantity: number;
-
-  createdAt: number;
-  createdBy: string;
-
-  associations: HdmsAssociation[];
-};
-
-export type NewHdmsBooking = {
-  bookingNumber: string;
-  financeDocumentId: string;
-};
-
-export type HdmsBooking = NewHdmsBooking & {
-  amount?: number;
-  createdAt: number;
-  createdBy: string;
-  journal?: string;
-  modifiedAt: number;
-  modifiedBy: string;
-  organization: string;
-  paid?: boolean;
-  reportingPeriod?: number;
-  reportingYear?: number;
-};
-
-export type HdmsVehiclePurchase = {
-  id: string;
-  vehicle_id: string;
-  organization_summary: HdmsVehicleOrganizationSummary;
-  purchase_cost?: number;
-  purchase_cost_taxable?: number;
-  vat_percentage?: number;
-  commission_cost?: number;
-  available_week?: string;
-  pickup_location?: string;
-  internal_transport_cost?: number;
-  external_transport_cost?: number;
-  internal_garage_cost?: number;
-  external_garage_cost?: number;
-  carwash_cost?: number;
-  spoiler_mounting_cost?: number;
-  load_stack_cost?: number;
-  total_cost: number;
-  other_costs?: number;
-  status: string;
-  logistics_status: string;
-  log: {
-    purchase_agreed_date?: number;
-    purchase_agreed_reporter?: string;
-    first_payment_allowed_date?: number;
-    first_payment_allowed_reporter?: string;
-    first_payment_sent_date?: number;
-    first_payment_sent_reporter?: string;
-    full_payment_allowed_date?: number;
-    full_payment_allowed_reporter?: string;
-    full_payment_sent_date?: number;
-    full_payment_sent_reporter?: string;
-    checked_in_date?: number;
-    checked_in_reporter?: string;
-    deleted_date?: number;
-    deleted_reporter?: string;
-  };
-};
-
-export type HdmsAttachment = {
-  id: string;
-  folder: string;
-  extension: string;
-  original_name: string;
-  mime_type?: string;
-  category: 'Image' | 'Document';
-  main_picture?: boolean;
-  orientation?: number;
-  upload_date: number;
-  upload_by_employee_name?: string;
-  unrestricted?: boolean;
-  properties?: {
-    NUMBER_OF_PAGES?: string;
-  };
-  url?: string;
-};
-
-export type HdmsAccount = {
-  username: string;
-  email: string;
-  otherEmails: string[];
-};
-
-export type HdmsAccountQueryRequest = {
-  emails: string[];
-  phones: string[];
-};
-
-export type HdmsDocumentOrganizationSummary = {
-  id: string;
-  code: string;
-  name: string;
-  country: string;
-  vatNumber?: string;
-
-  addressLine1?: string;
-  addressLine2?: string;
-  addressLine3?: string;
-  postcode?: string;
-  city?: string;
-
-  email?: string;
-  phone?: string;
-  fax?: string;
-};
-
-export type HdmsDebtDossier = {
-  overdueSince?: number;
-  overdueInvoices: number;
-  overdueAmount: number;
-  unpaidInvoices: number;
-  unpaidAmount: number;
-};
-
-export type HdmsExactPurchaseLine = {
-  description: string;
-  glAccountCode: string;
-  quantity: number;
-  unitPrice: number;
-  vatCode: string;
-};
-
-export type NewHdmsExactPurchase = {
-  description: string;
-  invoiceDate: number;
-  invoiceNumber: string;
-  journal: string;
-  lines: HdmsExactPurchaseLine[];
-  supplierCode: string;
-  attachment?: HdmsAttachment;
-};
-
-export type HdmsExactPurchase = NewHdmsExactPurchase & {
-  bookingNumber: string;
-};