@fragus/sam-types 1.0.0

package/types/admin/contractCreation/contractCreation.d.ts

@@ -0,0 +1,314 @@
+import { IContractDetailsRecord } from '..'
+import { DurationOptions, IContractOptionResponse, TMileageDurationsMap, TV4PTProductType } from '../..'
+import { IContractTemplateResponse, IGenericContractTemplateResponse, PriceSource } from '../../contractTemplate'
+import { PaymentGateway, PaymentType } from '../../payment'
+import { Other } from '../../product'
+import { ITermsOfServiceResponse } from '../../termsOfService'
+import { IVehicleInfo, TVehicleType, Vehicle, VehicleAlongItsContracts } from '../../vehicle'
+import { IAdminCustomer } from '../customer/customer'
+import { PriceSpecification } from './../../priceSpecification'
+import { ICarCollection } from './carData'
+import { IContractCalculationResponse } from './priceCalculation'
+
+
+export type ContractType = 'STANDARD' | 'CUSTOM' | 'EXTERNAL'
+
+export type ServiceContractFlag = 'DISTRIBUTE_DOWNPAYMENT' | 'NULLIFY_DOWNPAYMENT'
+
+export interface IContractCreationData {
+  payment: IContractCreationPayment
+  termsOfTradeRef?: string
+  cars: ICarCollection
+  templates: IGenericContractTemplateResponse[]
+  templatesAllDisabled?: boolean
+}
+
+export interface IProviderHasAccessToProductsRequest {
+  providerId: number | string
+}
+
+export interface IProviderHasAccessToProductsResponse {
+  hasAccess: boolean
+}
+
+export interface IContractCreationPayment {
+  stripeToken: string
+  paymentGateways: PaymentGateway[]
+}
+
+export type ContractValueTypeEnum = 'Mileage' | 'Hours' | 'Services' | 'None'
+export type ContractValueType = Exclude<ContractValueTypeEnum, 'None'> | undefined
+
+interface ICommonContractUpdateRequest {
+  priceSource?: PriceSource
+  contractProductType: TV4PTProductType | null
+  contractProviderId: number
+  contractTemplateId: number | null
+  serviceVariantId: string
+  serviceVariantName: string
+  value?: number
+  valueType: ContractValueType
+  duration: number
+  mileage?: number
+  startDateISOString: string
+  optionIds: number[]
+  providerPayments: number
+  providerShare: number
+  reference?: string
+  startMileage?: number
+  startValue?: number
+  startValueType: ContractValueType
+  type: ContractType
+  offerExpiresAt?: Date
+}
+
+interface ISubscription {
+  amountPrPayment: PriceSpecification
+  firstPaymentDate: Date
+  lastPaymentDate: Date
+  numberOfPayments: number
+}
+
+interface IOptionInfo {
+  name: string
+  abbreviation: string
+  description: string
+  termsOfService?: ITermsOfServiceResponse | null
+}
+
+interface IContractInfo {
+  templateName: string
+  prettyIdentifier: string
+  minimumPaymentsCount: null | number
+  termsUrl: string
+  duration: number
+  mileage: number
+  value: number | undefined
+  startMileage: number
+  startDate: Date
+  endDate: Date
+  includedOptions: IOptionInfo[]
+  additionalOptions: IOptionInfo[]
+  startValue: number | undefined
+  startValueType: ContractValueType | undefined
+  valueType: ContractValueType | undefined
+}
+
+interface IContractProviderPaymentInfo {
+  administrativeName: string
+  address: string
+  postal_code: string
+  city: string
+  phone: string
+  termsUrl: string
+}
+interface IPublicKeyResponse {
+  publicKey: string
+  stripeAccount: string
+}
+/*
+ * The folling info is only what the paying "customer" needs to know
+ * when presenting this info. For more specific and sensitive info,
+ * it is already saved on the database.
+ */
+interface IBasicPaymentInformationResponse {
+  publicKey: string
+  contractProvider: IContractProviderPaymentInfo
+  contract: IContractInfo
+  totalAmount: PriceSpecification | null
+  minimumTotalAmount: PriceSpecification | null
+  downpayment: PriceSpecification
+  subscriptions: ISubscription[]
+  paymentGateway: PaymentGateway
+}
+/*
+ * The folling info is only what the paying "customer" needs to know
+ * when presenting this info. For more specific and sensitive info,
+ * it is already saved on the database.
+ */
+interface IPaymentInformationResponse extends IBasicPaymentInformationResponse {
+  customer: IAdminCustomer
+  product: Vehicle | Other
+}
+interface ISetupIntentResponse {
+  clientSecret: string
+}
+
+interface ISetPaymentMethodRequest {
+  contractId: string | number
+  paymentMethodId: string
+}
+interface ISetPaymentMethodResponse {
+  status: 'processing' | 'succeeded'
+}
+
+interface ICommonContractCreationRequest extends ICommonContractUpdateRequest {
+  contractTemplateName: string
+  product: Vehicle | Other
+  paymentGateway: PaymentGateway
+  customerId?: number
+  customer?: IAdminCustomer
+  invoiceCustomerId?: number
+  invoiceCustomer?: IAdminCustomer
+  isDownpaymentDistributed: boolean
+}
+
+export interface IContractAdjustmentRequest extends ICommonContractUpdateRequest {
+  amountPerPayment?: number
+}
+
+export interface ICustomContractCreationRequest extends ICommonContractCreationRequest {
+  type: 'CUSTOM'
+  amountPerPayment: number
+}
+
+export interface IStandardContractCreationRequest extends ICommonContractCreationRequest {
+  type: 'STANDARD'
+}
+
+export interface IStandardV4PricingToolContractCreationRequest extends IStandardContractCreationRequest {
+  vehicleInfo: IVehicleInfo
+  v4ProductId: number
+}
+
+export interface IStandardV4PricingToolContractPrintCreationRequest
+  extends IStandardV4PricingToolContractCreationRequest {
+  type: 'STANDARD'
+  amountPerPayment?: number
+  adjustedFrom?: string
+  isAdjustment?: boolean
+}
+
+export interface IContractPrintCreationRequest extends ICommonContractCreationRequest {
+  type: 'STANDARD' | 'CUSTOM'
+  amountPerPayment?: number
+  adjustedFrom?: string
+  isAdjustment?: boolean
+}
+
+/**
+ * @deprecated warrantyId Not needed, if using the "NEW WAY" and V4PT, this will be loaded from the already saved contract.
+ * @deprecated modelModelId
+ * @deprecated finlandPriceId
+ */
+export interface ICreateDelaerPaidContractRequest {
+  prettyIdentifier: string | null
+  warrantyId: number | null // SAM Warranty ID.
+  warrantyLengthMonths: number
+  modelModelId?: number
+  vehicleAlongItsContracts: Vehicle | VehicleAlongItsContracts
+  startMileage: number
+  customerId?: number
+  customer?: IAdminCustomer
+  startDate: Date | null
+  finlandPriceId?: number
+  endMileage?: number // For debugging.
+  reference?: string
+}
+
+export interface ICreateDelaerPaidContractResponse {
+  req: ICreateDelaerPaidContractRequest
+  success: boolean
+  error: string
+  startDate: Date
+  endDate: Date
+  warrantyType: string
+  customerId: number
+}
+
+export interface IAvailableFreeWarrantyDurationPrice {
+  allowedDistanceMileage: undefined | number // Allowed driving limit/distance during this Warranty duration.
+  allowedPowerV4Interval:
+    | undefined
+    | {
+        lookedUpEngineMaxPower: number
+        minEngineMaxPower: number
+        maxEngineMaxPower: number
+      }
+  customerPrice: PriceSpecification | null
+  durationMonths: number
+  finlandPriceId?: number
+  totalPrice: PriceSpecification
+  isEnabledAndAvailable?: boolean | null // Dependent of optional user setting for this DurationPrice-group or default setting in WarrantyData.
+  debug?: any // For debugging purposes.
+}
+
+export interface IAvailableFreeWarranty {
+  warrantyId: number
+  warrantyName: string
+  description: string
+  maxYears: number
+  oneTimeFeeYear: PriceSpecification
+  externalId: number
+  calculationMethod: 100 | 200
+  maxStartMileage: number
+  maxEndMileage: number // The absolute maximum End-Mileage Odometer reading for this product.
+  maxStartHours?: number
+  maxEndHours?: number
+  maxStartServices?: number
+  maxEndServices?: number
+  warrantyTermsRef: string
+  contractStartDate: Date
+  durationsPrices: IAvailableFreeWarrantyDurationPrice[]
+  weight: number
+  warrantyColor: string
+  warrantyBGColor: string | null
+  fuelTypes: null | string[] // Only available for these fuelTypes, null means all fuelTypes.
+  vehicleTypes: null | TVehicleType[] // Only available for these vehicleTypes, null means all vehicleTypes.
+  isForbidDealerPaid: boolean
+}
+
+export interface IContractCreationResponse {
+  serviceContractId: number
+  prettyIdentifier: string
+}
+
+export interface IAdminContractActivationRequest {
+  paymentGateway: PaymentGateway
+  paymentType: PaymentType
+  creditCardToken?: string
+}
+
+export interface IAdminContractActivationResponse {
+  serviceContract: IContractDetailsRecord
+}
+
+export interface IAdminContractResponse {
+  type: ContractType
+  contractName: string
+  product: Vehicle | Other
+  contractTemplate: IContractTemplateResponse
+  additionalOptions: IContractOptionResponse[]
+  includedAdditionalOptions: IContractOptionResponse[]
+  durations: DurationOptions[]
+  mileageDurationsMap: TMileageDurationsMap | null // Structure for ContractFlowDurationMileageVer2 for V4PricingTool contracts.
+  duration: number
+  mileage: number
+  startMileage: number
+  contractStartDateISO: null | Date
+  value: number | undefined
+  valueType: ContractValueType
+  startValue: number | undefined
+  startValueType: ContractValueType
+  paymentGateway: PaymentGateway
+  customerId: number
+  customer: IAdminCustomer
+  availableTemplatesExtension?: IContractTemplateResponse[]
+  availableDurationsExtension?: DurationOptions[]
+}
+
+export interface IAdminContractAdjustmentResponse extends IAdminContractResponse {
+  payments: IContractCalculationResponse
+  invoiceCustomerId: number
+  invoiceCustomer: IAdminCustomer
+}
+
+export interface IAdminContractOfferCopyResponse extends IAdminContractResponse {
+  payments: Partial<IContractCalculationResponse>
+  reference: string
+  customTerms: string
+}
+
+export interface IContractOfferPrintData {
+  token: string
+}

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

@@ -0,0 +1,3 @@
+export * from './carData'
+export * from './contractCreation'
+export * from './priceCalculation'

package/types/admin/contractCreation/priceCalculation.d.ts

@@ -0,0 +1,83 @@
+import { PriceSource, TV4PTProductType } from '../../'
+import { PriceSpecification } from '../../priceSpecification'
+import { IVehicleInfo } from '../../vehicle'
+import { ContractType, ContractValueType } from './contractCreation'
+
+export interface IContractCalculationRequest {
+  priceSource?: PriceSource
+  contractProductType: TV4PTProductType | null
+  contractTemplateId: number
+  duration: number // AKA durationMonths, in months.
+  startDateISOString: string
+  isAdjustment: boolean
+  isDownpaymentDistributed: boolean
+  mileage: number // AKA distance, in km.
+  modelYear: number
+  optionIds: number[]
+  providerPayments: number
+  providerShare: number
+  registrationDate: string
+  registrationNumber: string
+  serviceVariantId: string
+  type: ContractType
+  valueType: ContractValueType
+  adjustedFrom?: string
+  startMileage?: number
+  startValue?: number
+  startValueType?: ContractValueType
+  value?: number
+  vin?: string
+}
+
+export interface IStandardContractCalculationRequest extends IContractCalculationRequest {
+  brandId: number
+  productModelId: number
+  fuelTypeId: number
+}
+
+export interface IStandardAxContractCalculationRequest extends IContractCalculationRequest {
+  brandName: string
+  productModelName: string
+  fuelTypeName: string
+}
+
+export interface ICustomContractCalculationRequest extends IContractCalculationRequest {
+  amountPerPayment: number
+  brandName: string
+  productModelName: string
+  fuelTypeName: string
+}
+
+/**
+ * For V4PricingTool.
+ * @note The product in v4ProductId, not to be confused with product that is either a Vehicle or Other.
+ */
+export interface IStandardV4PricingToolContractCalculationRequest extends IContractCalculationRequest {
+  vehicleInfo: IVehicleInfo
+  v4ProductId: number // V4 contract product / "template" id.
+}
+
+/**
+ * The type returned by a price calculation.
+ */
+export interface IContractCalculationResponse {
+  adjustedAmount?: PriceSpecification
+  adjustedContractFullCost?: PriceSpecification
+  adjustedPaymentsLeft?: number
+  amountPrPayment: PriceSpecification
+  contractCost: PriceSpecification
+  contractEndDate: string
+  contractStartDate: string
+  customerCost: PriceSpecification
+  customerPayments: number
+  customerShare: PriceSpecification
+  distributedAmount: PriceSpecification
+  downpayment: PriceSpecification
+  firstPaymentDate: string
+  isDownpaymentDistributed: boolean
+  providerCost: PriceSpecification
+  providerPayments: number
+  providerShare: PriceSpecification
+  x_debugData?: any // For debugging purposes.
+  serviceInfo?: string[] // Service information, mainly for ax.
+}

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

@@ -0,0 +1,47 @@
+import { IApiOtherWithContracts } from '../../admin/product'
+import { IApiVehicleWithContracts } from '../../admin/vehicle'
+import { IsoLocale } from '../../locale'
+
+export type ContractProviderOrderBy = 'providerId' | 'administrativeName' | 'inactive'
+
+export interface IEssentialContractProviderInfo {
+  administrativeName: string
+  email: string
+  phone: string
+  // TODO: add TIsoCountry type
+  country: string
+  logo: string
+  isShowLogoOnWeb?: boolean
+  webLogoBanner?: string | null
+}
+
+export interface IContractProviderInfo extends IEssentialContractProviderInfo {
+  providerId: number
+  parentProviderId: number | null
+  address1: string
+  address2?: string
+  city: string
+  zipcode: string
+  locale: IsoLocale
+  currency: string
+  webTitle?: string | null
+  isUseWhiteBGOnWeb?: boolean
+  isForceEnableCustomContracts?: boolean
+  productsEnabled?: boolean
+  webLogoSquare?: string | null
+  vatPct: number
+  inactive: boolean
+  isUsingV4PricingTool: boolean
+  isUseV4PTOnlyForSigning: boolean
+}
+
+export interface ICreateTestContractProvider {
+  administrativeName: string
+  countryIsoCode: string
+}
+
+export interface IProviderWithContracts {
+  provider: IContractProviderInfo
+  vehicles?: IApiVehicleWithContracts[]
+  products?: IApiOtherWithContracts[]
+}

package/types/admin/customer/customer.d.ts

@@ -0,0 +1,29 @@
+// Note: response is handled as 200 OK or 500 Internal Server Error.
+export interface IAdminCustomerLoginRequest {
+  prettyIdentifier: string
+}
+
+export interface IAdminCustomer {
+  id?: number
+  prettyIdentifier?: string
+  name: string
+  email: string
+  emailBounceType?: string | undefined
+  phone: string
+  address: string
+  city: string
+  zip: string | number
+  customerType: CustomerType
+  cvr?: string
+  ean?: string
+  companyName?: string
+  vatLookup?: VatLookup
+}
+
+export interface CustomerUpdateResponse extends IAdminCustomer {
+  extSysCustomerUpdateMessage?: string
+}
+
+export type CustomerType = 'PRIVATE' | 'BUSINESS'
+
+export type VatLookup = 'INTERNAL' | 'REMOTE'

package/types/admin/customer/customerList.d.ts

@@ -0,0 +1,9 @@
+export type CustomerListOrderByType =
+  | 'prettyIdentifier'
+  | 'name'
+  | 'address'
+  | 'zip'
+  | 'city'
+  | 'phone'
+  | 'email'
+  | 'cvr'

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

@@ -0,0 +1,2 @@
+export * from './customer'
+export * from './customerList'

package/types/admin/index.d.ts

@@ -0,0 +1,13 @@
+export * from './auth'
+export * from './chart'
+export * from './contract'
+export * from './contractCreation'
+export * from './customer'
+export * from './vehicle'
+export * from './workshop'
+export * from './user'
+export * from './stripe'
+export * from './payment'
+export * from './product'
+export * from './contractProvider'
+export * from './contactInformation'

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

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

package/types/admin/payment/payment.d.ts

@@ -0,0 +1,13 @@
+export interface ICreditCard {
+  cardToken: string
+  isDefault: boolean
+}
+
+export interface ICreditCardRecord {
+  cardId: string
+  brand: string
+  expireYear: number
+  expireMonth: number
+  last4: string
+  isDefault: boolean
+}

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

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

package/types/admin/product/product.d.ts

@@ -0,0 +1,40 @@
+import { ContractState, IIncludedContractOption, TV4PTProductType } from './../../index'
+import { PaymentGateway } from './../../payment'
+import { PriceSpecification } from './../../priceSpecification'
+
+export type TContractObject = 'Product' | 'Vehicle' // Renamed from: export type ProductType = 'Product' | 'Vehicle'
+
+export interface IApiOtherWithContracts {
+  otherId: number
+  registrationDate: Date | string
+  modelYear: number
+  serialNumber: string
+  serialNumber2: string
+  itemNumber: string
+  itemNumber2: string
+  brandName: string
+  modelName: string
+  fuelTypeName: string
+  contracts: IApiOtherContract[]
+}
+
+export interface IApiOtherContract {
+  serviceContractId: number
+  amount: PriceSpecification
+  contractStartDate: Date | string
+  contractEndDate: Date | string
+  tosUrl: string
+  totUrl: string
+  contractState: ContractState
+  prettyIdentifier: string
+  pdfUrl: 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
+  contractProductType: null | TV4PTProductType
+}

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

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

package/types/admin/stripe/stripeTOS.d.ts

@@ -0,0 +1,7 @@
+export interface IStripeTOSAcceptance {
+  id: string
+  businessName: string
+  date: number
+  ip: string
+  userAgent: string
+}

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

@@ -0,0 +1,2 @@
+export * from './userList'
+export * from './user'

package/types/admin/user/responseErrors/index.d.ts

@@ -0,0 +1,3 @@
+import { PasswordErrors } from './passwordResponseErrors'
+
+export type ResponseErrors = PasswordErrors

package/types/admin/user/responseErrors/passwordResponseErrors.d.ts

@@ -0,0 +1 @@
+export type PasswordErrors = 'PASSWORD_MISMATCH' | 'PASSWORD_VALIDATION_ERROR'

package/types/admin/user/user.d.ts

@@ -0,0 +1,23 @@
+export interface IAdminUserInfo {
+  name: string
+  phone: string
+  address: string
+  zip: string
+  city: string
+  email: string
+}
+
+export interface IUserPasswordChangeRequest {
+  password: string
+  newPassword: string
+}
+
+export interface ICustomerPasswordChangeRequest {
+  newPassword: string
+}
+
+export interface IUserRoleChangeRequest {
+  roleId: number
+  contractProviderId: number
+  token: string
+}

package/types/admin/user/userList.d.ts

@@ -0,0 +1,19 @@
+import { UserRole } from '../auth'
+
+export type UserListOrderByType = 'name' | 'role' | 'email' | 'phone' | 'providerId'
+
+interface INullableRole {
+  providerId: number
+  role: UserRole | null
+}
+
+export interface IUserListRecord {
+  userId?: number
+  name: string
+  email: string
+  phone: string
+  role?: UserRole
+  roles?: INullableRole[]
+  localeCode?: string
+  departmentName?: string
+}

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

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