@fragus/sam-types 1.0.0

package/types/admin/vehicle/vehicle.d.ts

@@ -0,0 +1,58 @@
+import {
+  ContractState,
+  ContractValueType,
+  IEssentialContract,
+  IIncludedContractOption,
+  TV4PTProductType,
+} from './../../index'
+import { PaymentGateway } from './../../payment'
+import { PriceSpecification } from './../../priceSpecification'
+
+export interface IEssentialVehicle {
+  registrationDate: Date | string
+  modelYear: number
+  vin: string
+  registrationNumber: string
+  brandName: string
+  modelName: string
+  fuelTypeName: string
+}
+
+export interface IApiVehicleWithContracts extends IEssentialVehicle {
+  vehicleId: number
+  contracts: IApiVehicleContract[]
+}
+
+export interface IApiVehicleWithEssentialContracts extends IEssentialVehicle {
+  contracts: IEssentialContract[]
+}
+
+export interface IApiVehicleContract {
+  serviceContractId: number
+  amount: PriceSpecification
+  contractStartDate: Date | string
+  contractEndDate: Date | string
+  tosUrl: string
+  totUrl: string
+  contractState: ContractState
+  prettyIdentifier: string
+  pdfUrl: string
+  serviceInfoPDFUrl?: string
+  includedOptions: IIncludedContractOption[]
+  contractTemplateInternalName: string // Name used internally (in pricefile etc.)
+  contractTemplateExternalName: string // The name shown to end-users.
+  duration: number
+  mileage: number
+  paymentGateway?: PaymentGateway
+  reference?: string
+  extendedFrom?: number
+  value?: number
+  valueType?: ContractValueType
+  contractProductType: null | TV4PTProductType
+}
+
+export interface IApiVehicleIncludedContractOption {
+  description: string
+  assoc: 'PROPERTY' | 'ADDITIONAL'
+  termsRef: string | null
+}

package/types/admin/vehicleBlacklist/index.d.ts

@@ -0,0 +1,16 @@
+export interface IBlacklistedVehicleRequest {
+    id?: number
+    brand: string
+    model: string
+    fuelType: string
+}
+
+export interface IBlacklistedVehicleResponse {
+    id: number
+    brand: string
+    model: string
+    fuelType: string
+    parentRecord?: boolean
+}
+
+export type BlacklistedVehicleOrderByType = keyof IBlacklistedVehicleRequest

package/types/admin/workshop/index.d.ts

@@ -0,0 +1 @@
+export * from './workshop'

package/types/admin/workshop/workshop.d.ts

@@ -0,0 +1,5 @@
+export interface IImportStatusReport {
+  line: number
+  isImported: boolean
+  reasonCode: string
+}

package/types/app.d.ts

@@ -0,0 +1,5 @@
+export interface App {
+  appId: number
+  name: string
+  identifier: string
+}

package/types/brand.d.ts

@@ -0,0 +1,4 @@
+export interface Brand {
+  name: string
+  id?: number
+}

package/types/chart.d.ts

@@ -0,0 +1,38 @@
+import { IPaymentFailureReason } from './index'
+
+// Generic charting types, ie. they are not specific to one application but generally usable in most types of charts.
+
+export interface IChartValue {
+  x: Date | string | number
+  y: number
+}
+
+export interface IChartDateValue extends IChartValue {
+  x: Date | string
+}
+
+export interface IChartInvoiceTooltip {
+  state: number
+  successfulPaymentDate?: Date
+  failureReason?: IPaymentFailureReason
+}
+
+export interface IChartInvoiceValue extends IChartDateValue {
+  tooltipData: IChartInvoiceTooltip
+}
+
+export interface IChartStringValue<TooltipData = undefined> extends IChartValue {
+  x: string
+}
+
+export interface IProviderStats {
+  offers: number
+  created: number
+  expiring: number
+  avgDuration: number
+  avgMileage: number
+}
+
+export interface ITopSellerChart {
+  seriesTopSellers: IChartStringValue[]
+}

package/types/contactPerson.d.ts

@@ -0,0 +1,16 @@
+import { IAddressRequest, IAddressResponse } from './address'
+
+export interface IContactPersonRequest {
+  name: string
+  email: string
+  phone: string
+  address: IAddressRequest
+}
+
+export interface IContactPersonResponse {
+  contactPersonId: number
+  name: string
+  email: string
+  phone: string
+  address: IAddressResponse
+}

package/types/contract/contract.d.ts

@@ -0,0 +1,75 @@
+import { IEssentialContractProviderInfo } from '../admin/contractProvider'
+import { IEssentialVehicle } from '../admin/vehicle'
+import { IContractOptionResponse } from '../contractOption'
+import { IContractProviderResponse } from '../contractProvider'
+import { IContractTemplateResponse, PriceSource } from '../contractTemplate'
+import { Customer } from '../customer'
+import {
+  ContractState,
+  ContractValueType,
+  IIncludedContractOption,
+  PaymentGateway,
+  PriceSpecification,
+  TIsoCountry,
+  TV4PTProductType,
+} from '../index'
+import { ICalculationResponse } from '../priceCalculation'
+import { Other } from '../product'
+import { Vehicle } from '../vehicle'
+
+export interface IEssentialContract {
+  prettyIdentifier: string
+  contractState: ContractState
+  contractStartDate: Date | string
+  contractEndDate: Date | string
+  contractName: string
+  contractProductType: null | TV4PTProductType
+}
+
+export interface IContractDetailsForCustomer extends IEssentialContract {
+  includedOptions: IIncludedContractOption[]
+  amount: PriceSpecification
+  tosUrl: string
+  totUrl: string
+  serviceInfoPDFUrl?: string
+  valueType?: ContractValueType
+  value?: number
+  duration: number
+  vehicle: IEssentialVehicle
+  provider: IEssentialContractProviderInfo
+  paymentGateway: PaymentGateway
+  priceSource: PriceSource
+  contractProductType: null | TV4PTProductType
+  offerExpiresAt?: Date | string
+}
+
+export interface IContractResponse {
+  id: number
+  customer: Customer
+  product: Vehicle | Other
+  duration: string
+  mileage: string
+  value?: string
+  valueType?: ContractValueType
+  startMileage: number
+  startValue?: number
+  startValueType?: ContractValueType
+  template: null | IContractTemplateResponse
+  calculationMethod: number
+  options: IContractOptionResponse[]
+  payment: ICalculationResponse
+  prettyIdentifier: string
+  startDate: string
+  endDate: string
+  state: ContractState
+  contractProvider: IContractProviderResponse
+  templateImage: string
+  termsRef: string
+  termsOfTradeRef?: string
+  paymentGateway: PaymentGateway
+  offerExpiresAt?: Date
+}
+
+export interface IBasicContractDetailsResponse extends IEssentialContract {
+  country: TIsoCountry
+}

package/types/contract/contractActivation.d.ts

@@ -0,0 +1,5 @@
+export interface IContractActivationRequest {
+  contractId: number
+  accessToken: string
+  stripeToken?: string
+}

package/types/contract/contractFilter.d.ts

@@ -0,0 +1,58 @@
+import { TContractObject } from '../admin/product'
+import { ContractState, WarrantyState } from '../index'
+
+export interface IContractFilterDate {
+  min: string
+  max: string
+}
+
+export interface IContractFilterOption {
+  title: string
+  id: ContractState
+}
+
+export interface IWarrantyFilterOption {
+  title: string
+  id: WarrantyState
+}
+
+export interface IContractFilterOptions {
+  contractStates: IContractFilterOption[]
+  templates: IContractFilterOption[]
+  options: IContractFilterOption[]
+  sellers: IContractFilterOption[]
+  subProviders: IContractFilterOption[]
+  created: IContractFilterDate
+  expired: IContractFilterDate
+  activeTypes: TContractObject[]
+}
+
+export interface IContractStatusCount {
+  contractState: ContractState
+  count: number
+}
+
+export interface IContractProductTypeCountResponse {
+  [contractObjectType: string]: number
+}
+
+export interface IContractFilterParams {
+  contractStates: ContractState[]
+  contractObjectType: TContractObject // Renamed from contractProduct.
+  templates: number[]
+  options: number[]
+  sellers: number[]
+  subProviders: number[]
+  created: IContractFilterDate
+  expired: IContractFilterDate
+  activeTypes: TContractObject[]
+}
+
+export interface IWarrantyFilterParams {
+  contractStates: ContractState[]
+  templates: number[]
+  options: number[]
+  sellers: number[]
+  created: IContractFilterDate
+  expired: IContractFilterDate
+}

package/types/contract/contractList.d.ts

@@ -0,0 +1,53 @@
+import { IContractHealth } from './../admin/contract/health'
+import { ContractState } from './../index'
+import { IContractFilterDate, IContractFilterOption } from './contractFilter'
+
+export interface IContractListRecord {
+  prettyIdentifier: string
+  brand: string
+  contractEndDate: Date | string
+  contractCreationDate: Date | string
+  contractState: ContractState
+  contractName: string
+  contractTemplateDescription: string
+  customerName: string
+  customerCompanyName: string
+  registrationNumber?: string
+  serialNumber?: string
+  itemNumber?: string
+  itemNumber2?: string
+  sellerName: string
+  health: IContractHealth[]
+}
+
+export type ContractListOrderByType =
+  | 'prettyIdentifier'
+  | 'brand'
+  | 'productBrand'
+  | 'contractEndDate'
+  | 'contractCreationDate'
+  | 'contractState'
+  | 'customerCompanyName'
+  | 'contractTemplateDescription'
+  | 'contractName'
+  | 'customerName'
+  | 'registrationNumber'
+  | 'sellerName'
+  | 'serialNumber'
+  | 'serialNumber2'
+  | 'itemNumber'
+  | 'itemNumber2'
+  | 'createdByProvider'
+
+export interface IWarrantyListRecord {
+  prettyIdentifier: string
+  brand: string
+  warrantyEndDate: Date | string
+  warrantyCreationDate: Date | string
+  warrantyState: ContractState
+  warrantyeName: string
+  customerName: string
+  customerCompanyName: string
+  registrationNumber: string
+  sellerName: string
+}

package/types/contract/contractOffer.d.ts

@@ -0,0 +1,34 @@
+import { ContractValueType } from '../admin'
+import { Customer } from '../customer'
+import { ProductAlongItsContracts } from '../product'
+import { VehicleAlongItsContracts } from '../vehicle'
+import { IContractOptionResponse } from './../contractOption'
+import { IContractTemplateResponse } from './../contractTemplate'
+import { PaymentGateway } from './../payment'
+
+export interface IContractOfferRequest<TProduct = VehicleAlongItsContracts> {
+  contractProviderId: number
+  userId?: number
+  customer?: Customer
+  product?: TProduct
+  duration: number
+  mileage: number
+  startDateISOString: string
+  startMileage: number
+  value?: number
+  valueType?: ContractValueType
+  startValue?: number
+  startValueType?: ContractValueType
+  template?: IContractTemplateResponse
+  options: IContractOptionResponse[]
+  paymentGateway: PaymentGateway
+}
+
+export interface IContractOfferResponse {
+  contractId: number
+  token: string
+  paymentGateway: PaymentGateway
+  prettyIdentifier: string
+}
+
+type ProductTypeContract = VehicleAlongItsContracts | ProductAlongItsContracts

package/types/contract/contractQuery.d.ts

@@ -0,0 +1,68 @@
+// @NOTE - Deprecate this file
+import { ISearchQuery, OrderDirection } from '../queryParams'
+import { PaymentGateway } from './../payment'
+import { IContractFilterOptions } from './contractFilter'
+
+export type ContractOrderBy =
+  | 'prettyIdentifier'
+  | 'contractName'
+  | 'registrationNumber'
+  | 'serialNumber'
+  | 'serialNumber2'
+  | 'itemNumber'
+  | 'itemNumber2'
+  | 'customerName'
+  | 'contractCreationDate'
+  | 'contractEndDate'
+  | 'sellerName'
+  | 'contractState'
+  | 'brand'
+
+export type WarrantyOrderBy =
+  | 'prettyIdentifier'
+  | 'contractName'
+  | 'registrationNumber'
+  | 'serialNumber'
+  | 'serialNumber2'
+  | 'itemNumber'
+  | 'itemNumber2'
+  | 'customerName'
+  | 'contractCreationDate'
+  | 'contractEndDate'
+  | 'sellerName'
+  | 'contractState'
+  | 'brand'
+
+export interface IContractQuery extends ISearchQuery<ContractOrderBy> {
+  createdDateStart?: Date | string
+  createdDateEnd?: Date | string
+  expirationDateStart?: Date | string
+  expirationDateEnd?: Date | string
+  createdDate?: Date | string
+  expirationDate?: Date | string
+  filtering?: IContractFilterOptions
+}
+
+export interface IContractSearchResult {
+  prettyIdentifier: string
+  contractCreationDate: Date
+  contractEndDate: Date
+  sellerName: string
+  registrationNumber: string
+  brand: string
+  customerName: string
+  paymentMethod: PaymentGateway
+}
+
+export interface IMappedContractQuery extends IContractQuery {
+  limit: number
+  offset: number
+  orderBy: ContractOrderBy
+  orderDirection: OrderDirection
+  createdDateStart?: Date
+  createdDateEnd?: Date
+  expirationDateStart?: Date
+  expirationDateEnd?: Date
+  createdDate?: Date
+  expirationDate?: Date
+}

package/types/contractAction.d.ts

@@ -0,0 +1,40 @@
+import { ContractActionType } from './index'
+import { PriceSpecification } from './priceSpecification'
+
+export type TActionSeverityType = 'Info' | 'Warning' | 'Error'
+export type TActionOrderBy = 'id' | 'created' | 'action' | 'userName' | 'comment'
+
+export interface IContractActionRequest {
+  severityType?: TActionSeverityType
+  action: ContractActionType
+  userId: number | undefined
+  comment: string | undefined
+  details: { [k: string]: any }
+  messageId?: string
+}
+
+export interface IContractActionResponse {
+  id: number
+  created: Date | string
+  action: ContractActionType
+  userName: string
+  comment: string
+  severityType: TActionSeverityType | null
+  details?: string
+}
+
+export interface ISettlementActionRequest {
+  id: number
+  settlementComment: string
+  shareComment: boolean
+}
+
+export interface ISettlementActionResponse {
+  id: number
+  created: Date | string
+  type: ContractActionType
+  userName: string
+  settlementComment: string
+  shareComment: boolean
+  amount: PriceSpecification
+}

package/types/contractOption.d.ts

@@ -0,0 +1,50 @@
+import { PriceSpecification } from './priceSpecification'
+import { ITermsOfServiceResponse } from './termsOfService'
+
+export interface IContractOptionRequest {
+  description: string
+  conditionText: string
+  weight?: number
+  price: PriceSpecification
+  contractProviderId: number
+  archived?: boolean
+  abbreviation: string
+  optionGroup: number | null
+  internalName: string
+  showOnWebcalc: boolean
+  warranty: number | null
+  calculationMethod: number | null
+}
+
+export interface IBasicContractOption {
+  internalName: string
+  description: string // External name.
+  v4FixedPrice?: boolean
+  v4PriceListID?: number
+  v4ParameterID?: number // Index of PriceList parameter (parameterID).
+  v4Value?: string | number
+}
+
+export interface IGenericContractOptionResponse extends IBasicContractOption {
+  id: number
+  price: PriceSpecification
+  conditionText: string
+  weight: number // (!) Sort order.
+  contractProviderId: number | null
+  abbreviation: string
+  optionGroup: number | null
+  warranty: number | null | undefined
+  calculationMethod: number | null
+  termsOfService?: ITermsOfServiceResponse | null
+  maxEndAge?: number
+}
+
+export interface IContractOptionResponse extends IGenericContractOptionResponse {
+  showOnWebcalc: boolean
+  maxEndMileage?: number
+}
+
+export interface IProductContractOptionResponse extends IGenericContractOptionResponse {
+  maxEndServices?: number
+  maxEndHours?: number
+}

package/types/contractProvider.d.ts

@@ -0,0 +1,116 @@
+import { IContactPersonRequest, IContactPersonResponse } from './contactPerson'
+import { ICountryRequest, ICountryResponse } from './country'
+import { ContractState, TCurrency, TV4PTProductType } from './index'
+import { PaymentGateway } from './payment'
+import { IProviderCustomizationResponse } from './providerBranding'
+
+export interface IContractProviderRequest extends IProviderCustomizationResponse {
+  administrativeName: string
+  cvrCode: string
+  country: ICountryRequest
+  omnicarFee: number
+  paymentGateways: PaymentGateway[]
+  postmarkFromEmail: string
+  
+  logo: string
+  contactFormUrl: string
+  showRegistrationSelectionPage: boolean
+  sendWelcomeLetter: boolean
+  finalizedDate: Date | null
+  providerIdentifier: string
+  contactPerson: IContactPersonRequest
+  termsOfTradeRef: string
+  visibleToOtherChildren: boolean
+  webCalcEnabled: boolean
+  webTitle: string | null
+  isUseWhiteBGOnWeb: boolean
+  isForceAllowCustomContracts: boolean
+  isShowLogoOnWeb: boolean
+  webLogoBanner: string | null
+  webLogoSquare: string | null
+  disableContractTemplates: boolean
+  productsEnabled: boolean
+  parentProviderId: number | null
+  autoSettlement: boolean
+  fragusContactPersonName: string | null
+  providerGroup: string | null
+  providerCategory: string | null
+  additionalEmails: string | null
+  isUsingV4PricingTool: boolean
+  isUseV4PTOnlyForSigning: boolean
+  isLoadOptionalProviderCustomization: boolean
+}
+
+export interface IContractProviderResponse extends IProviderCustomizationResponse {
+  contractProviderId: number
+  administrativeName: string
+  parentProviderId: number | null
+  cvrCode: string
+  country: ICountryResponse
+  currency?: TCurrency
+  omnicarFee: number
+  paymentGateways: PaymentGateway[]
+  postmarkFromEmail: string
+
+  logo: string
+  logoUrl?: string | null
+  contactFormUrl: string
+  showRegistrationSelectionPage: boolean
+  sendWelcomeLetter: boolean
+  finalizedDate: Date | null
+  providerIdentifier: string
+  contactPerson: IContactPersonResponse
+  termsOfTradeRef: string
+  visibleToOtherChildren: boolean
+  webCalcEnabled: boolean
+  webTitle: string | null
+  isUseWhiteBGOnWeb: boolean
+  isForceAllowCustomContracts: boolean
+  isShowLogoOnWeb: boolean
+  webLogoBanner: string | null
+  webLogoBannerUrl?: string | null
+  webLogoSquare: string | null
+  webLogoSquareUrl?: string | null
+  disableContractTemplates: boolean
+  productsEnabled: boolean
+  state: ProviderState
+  autoSettlement: boolean
+  isAllowContractsWithoutVehiclePriceModel: boolean
+  fragusContactPersonName: string | null
+  providerGroup: string | null
+  providerCategory: string | null
+  additionalEmails: string | null
+  isUsingV4PricingTool: boolean
+  isUseV4PTOnlyForSigning: boolean
+  isLoadOptionalProviderCustomization: boolean // Has providerCustomizationLoaded been loaded?
+  generalConditions: string
+  optionsConditions?: string
+}
+
+export interface IContractProviderListItemResponse {
+  administrativeName: string
+  autoSettlement: boolean
+  contractProviderId: number
+  country: ICountryResponse
+  cvrCode: string
+  disableContractTemplates: boolean
+  fragusContactPersonName: string | null
+  isAllowContractsWithoutVehiclePriceModel: boolean
+  isForceEnableCustomContract: boolean
+  isShowLogoOnWeb: boolean
+  isUseWhiteBGOnWeb: boolean
+  isUsingV4PricingTool: boolean
+  isUseV4PTOnlyForSigning: boolean
+  omnicarFee: number
+  parentProviderId: number | null
+  productsEnabled: boolean
+  providerCategory: string | null
+  providerGroup: string | null
+  providerIdentifier: string
+  state: ProviderState
+  webCalcEnabled: boolean
+  generalConditions: string
+  optionsConditions?: string
+}
+
+export type ProviderState = 'Active' | 'Inactive'