@fragus/sam-types 1.0.82 → 1.0.83

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.82",
+  "version": "1.0.83",
   "name": "@fragus/sam-types",
   "description": "Typescript interfaces for all types used to communicate between SAM client(s) and the SAM API",
   "author": "Fragus",

package/types/admin/chart/contractCharts.d.ts

@@ -61,7 +61,6 @@ export interface IPaymentMileageCharts {
   paymentChart: IPaymentChart
   mileageChart: IMileageChart
   valueChart: IValueChart
-  serviceCount: number
 }
 
 export interface IContractChartsFilterParams {

package/types/admin/contract/basicInfo.d.ts

@@ -0,0 +1,20 @@
+import { PriceSource } from '../../contractTemplate'
+import { ContractState, ContractType, IIncludedContractOption, PaymentGateway, TV4PTProductType } from '../../index'
+import { IContractHealth } from './health'
+
+export interface IBasicContractInfo {
+  contractState: ContractState
+  contractStateName: string
+  contractType: ContractType
+  contractProductType: null | TV4PTProductType
+  priceSource: PriceSource | null
+  extendedFromId: number | null
+  extendedToId: number | null
+  paymentGateway: PaymentGateway
+  contractName: string // Contract (template) name.
+  templateDescription: string
+  additionalOptions: IIncludedContractOption[]
+  health: IContractHealth[]
+  productContract: boolean
+  offerExpirationDate?: string
+}

package/types/admin/contract/contractDetails.d.ts

@@ -1,4 +1,3 @@
-import { ContractState } from '../../index'
 import { TV4PTProductType } from '../../v4PricingTool'
 import { ContractType, ContractValueType, ServiceContractFlag } from './../../admin/contractCreation'
 import { IContactPersonResponse } from './../../contactPerson'
@@ -8,91 +7,77 @@ import { IIncludedContractOption } from './../../includedContractOption'
 import { PaymentGateway } from './../../payment'
 import { PriceSpecification } from './../../priceSpecification'
 
-export interface IAdminCustomTermsRecord {
-  customTerms: string
-}
-
-export interface IFileItem {
-  name: string
-  v4URL: string
-}
-
-/**
- * This interface is used for contract settlement page in Admin.
- * Contains calculated value of mileage | hours | services for contract.
- */
-export interface IEstimatedContractValue {
-  estimatedValue: number
-}
-
-/**
- * This interface is used for contract details page in Admin.
- * It contains all the necessary/basic information about the contract for header, and shared data for tabs.
- */
-export interface IContractDetailsBasic {
-  prettyIdentifier: string
-  contractState: ContractState
+export interface IContractDetailsRecord {
+  serviceContractId?: number // Note: Do not expose this id for non-Devs/normal users, use the pretty-id for those. For debugging purposes, etc.
   contractType: ContractType
   contractProductType: null | TV4PTProductType
-  contractName: string
-  priceSource: PriceSource | null
-  paymentGateway: PaymentGateway
-  isProduct: boolean
-  offerExpiresAt: Date
-  customerTotalCost: number
-  serviceVariantName?: string
-  settledUnits: number | null
-  contractTemplateMinPaymentsCount: number | null
-  expirationDate: Date
-  isExtendedFromAnotherContract: boolean
-
-  valueType: ContractValueType
-  startValueType: ContractValueType
+  contractPdfUrl: string
+  duration: number // Duration [months].
+  startMileage?: number // Current meter/odometer-reading [km].
+  mileage: number // Allowed mileage/distance [km] to drive during contract duration [months].
   startValue?: number
+  startValueType: ContractValueType
+  endValue?: number
+  maxEndValue?: number
+  endMileage: number // End-mileage [km] at end of duration [months].
+  maxEndMileage?: number // Absolute maximum end-mileage [km] for product - Hard mileage cap/limit.
+  expirationDate: Date | string
+  extendedFrom: IContractResponse | null
+  includedOptions: IIncludedContractOption[] | null
   value?: number
-
-  calculationMethod?: number
-  endMileage: number
+  valueType: ContractValueType
+  monthlyTemplatePrice: PriceSpecification
+  monthlyPrice: PriceSpecification
+  paymentMethod: PaymentGateway
+  cardWallet: string | null // wallet name, e.g. 'apple_pay', 'google_pay', 'link', used for card payment
+  prettyIdentifierShort: string
+  prettyIdentifier: string
+  providerPayments: number
+  providerShare: PriceSpecification
+  reference: string
+  warrantyReference?: string
+  seller?: IContactPersonResponse
   startDate: Date | string
-  duration: number
+  termsPdfUrl: string
+  termsOfTradePdfUrl: string
+  filesContainerAlongContract: null | IFileItem[] // Optional extra files, except the TOS file.
   totalPrice: PriceSpecification
-  underHoursCharge?: number
+  contractTemplateId: null | number
+  contractName: string // Contract (template) name.
+  priceSource: null | PriceSource
+  contractTemplateDescription: string
+  contractTemplateMinPaymentsCount: number | null
+  contractTemplateIsArchived: boolean
+  isProduct: boolean
+  serviceVariantId: string
+  flags: ServiceContractFlag[]
+  stripeCustomerLink: string | null
+  stripeSubscriptionLink: string | null
+  customTerms?: string
+  adjustedFrom?: string
+  adjustedTo?: string
+  createdByProvider?: string
+  provider?: string
+  settledUnits?: number | null
+  overdrivenCharge?: number
   underdrivenCharge?: number
-  underServicesCharge?: number
+  calculationMethod?: number
   overHoursCharge?: number
+  underHoursCharge?: number
   overServicesCharge?: number
-  overdrivenCharge?: number
+  underServicesCharge?: number
+}
 
-  startMileage?: number
-  serviceVariantId: string
-  serviceContractId?: number
-  providerShare: PriceSpecification
+export interface IAdminCustomTermsRecord {
+  customTerms: string
+}
 
-  monthlyPrice: PriceSpecification
-  mileage: number
-  maxEndMileage?: number
-  warrantyReference?: string
+export interface IUnitsListResponse {
+  units: number
+  date: Date | string
 }
 
-/**
- * This interface is used for contract details page in Admin but for specifics section.
- * It contains additional information about the contract that is not necessary for header and shared data, but is necessary for specifics tab.
- * There is joined data from different tables, so it is separated from basic response.
- */
-export interface IContractDetailsSpecifics {
-  includedOptions: IIncludedContractOption[] | null
-  termsPdfUrl: string
-  termsOfTradePdfUrl: string
-  stripeSubscriptionLink: string | null
-  stripeCustomerLink: string | null
-  seller: { name: string; email: string }
-  providerName: string
-  extendedFrom?: string
-  adjustedTo?: string
-  customTerms?: string
-  createdByProvider: string
-  contractTemplateId: number | null
-  contractPdfUrl: string
-  cardWallet: string | null
-  filesContainerAlongContract: null | IFileItem[]
+export interface IFileItem {
+  name: string
+  v4URL: string
 }

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

@@ -1,3 +1,4 @@
+export * from './basicInfo'
 export * from './contractDetails'
 export * from './health'
 export * from './templateLookup'

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

@@ -1,3 +1,4 @@
+import { IContractDetailsRecord } from '..'
 import { DurationOptions, IContractOptionResponse, TMileageDurationsMap, TV4PTProductType } from '../..'
 import { IContractTemplateResponse, IGenericContractTemplateResponse, PriceSource } from '../../contractTemplate'
 import { PaymentGateway, PaymentType } from '../../payment'
@@ -9,6 +10,7 @@ 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'
@@ -267,6 +269,10 @@ export interface IAdminContractActivationRequest {
   creditCardToken?: string
 }
 
+export interface IAdminContractActivationResponse {
+  serviceContract: IContractDetailsRecord
+}
+
 export interface IAdminContractResponse {
   type: ContractType
   contractName: string

package/types/contract/contractFilter.d.ts

@@ -27,15 +27,6 @@ export interface IContractFilterOptions {
   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.
@@ -56,3 +47,12 @@ export interface IWarrantyFilterParams {
   created: IContractFilterDate
   expired: IContractFilterDate
 }
+
+export interface IContractCountersResponse {
+  /** Count of contracts grouped by state (excludes Draft) */
+  perState: Partial<Record<ContractState, number>>
+  /** Number of Active contracts expiring within 90 days */
+  expiring: number
+  /** Number of Expired/Terminated contracts ready for settlement (action > 30 days ago) */
+  forSettlement: number
+}

package/types/locale.d.ts

@@ -22,3 +22,15 @@ export interface Locale {
  * @deprecated 'en-GB'
  */
 export type IsoLocale = 'da-DK' | 'sv-SE' | 'fi-FI' | 'nb-NO' | 'en' | 'en-GB' // NOTE: 'en-GB' is deprecated.
+
+export interface LocaleRecord {
+  name: string
+  nameLocal: string
+  defaultFormat: {
+    currency?: string
+    date?: string
+    mileage?: string
+  }
+}
+
+export type LocaleRecords = Record<IsoLocale, LocaleRecord>