@fragus/sam-types 1.2.20 → 1.2.22

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.20",
+  "version": "1.2.22",
   "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/contractProvider/index.d.ts

@@ -34,6 +34,7 @@ export interface IContractProviderInfo extends IEssentialContractProviderInfo {
   isUseV4PTOnlyForSigning: boolean
   fragusInvoicing?: boolean
   isInternalUse?: boolean
+  hasPriceSigns?: boolean
 }
 
 export interface ICreateTestContractProvider {

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

@@ -18,6 +18,8 @@ export interface IAdminCustomer {
   ean?: string
   companyName?: string
   vatLookup?: VatLookup
+  /** Set when the customer's data has been anonymised (by the archive cron or from MyPage); it is then read-only. */
+  dataDeleted?: boolean
 }
 
 export interface CustomerUpdateResponse extends IAdminCustomer {

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

@@ -2,9 +2,6 @@ export interface IBlacklistedVehicleRequest {
   brand: string
   model: string
   fuelType: string
-  /** Inclusive model year range; null on either end means no limit. */
-  modelYearFrom?: number | null
-  modelYearTo?: number | null
   providerIds: {
     add: number[]
     remove: number[]
@@ -20,8 +17,6 @@ export interface IBlacklistedVehicleResponse {
   brand: string
   model: string
   fuelType: string
-  modelYearFrom: number | null
-  modelYearTo: number | null
   parentRecord?: boolean
   groupRecord?: boolean
 }

package/types/contract/contractList.d.ts

@@ -14,6 +14,8 @@ export interface IContractListRecord {
   contractTemplateDescription: string
   customerName: string
   customerCompanyName: string
+  /** Set when the customer's data has been anonymised; the name columns then hold placeholders. */
+  customerDataDeleted?: boolean
   registrationNumber?: string
   serialNumber?: string
   itemNumber?: string

package/types/contractProviderGroup.d.ts

@@ -37,6 +37,7 @@ export interface IContractProviderGroupUsage {
   documentCount: number
   dashboardBannerCount: number
   featureFlagCount: number
+  priceSignSetupCount: number
 }
 
 export interface IUpsertContractProviderGroupRequest {

package/types/index.d.ts

@@ -223,3 +223,4 @@ export * from './contractProviderFlags';
 export * from './fragusInvoicing';
 export * from './providerDocument';
 export * from './contractProviderGroup';
+export * from './priceSign';

package/types/index.ts

@@ -242,3 +242,4 @@ export * from './contractProviderFlags'
 export * from './fragusInvoicing'
 export * from './providerDocument'
 export * from './contractProviderGroup'
+export * from './priceSign'

package/types/myPage/deleteMyData.d.ts

@@ -0,0 +1,20 @@
+import { ContractState } from '../index'
+
+export interface IDeleteMyDataOpenContract {
+  prettyIdentifier: string
+  contractState: ContractState
+}
+
+/**
+ * Whether the customer may anonymise their own data from MyPage. Refused while any contract is in a state that can
+ * still charge, refund or mail the customer; those contracts are listed in `openContracts`.
+ */
+export interface IDeleteMyDataStatusResponse {
+  allowed: boolean
+  openContracts: IDeleteMyDataOpenContract[]
+}
+
+/** Body of the MyPage delete-my-data endpoint; the customer confirms with their current password. */
+export interface IDeleteMyDataRequest {
+  password: string
+}

package/types/myPage/index.d.ts

@@ -1 +1,2 @@
 export * from './payment'
+export * from './deleteMyData'

package/types/priceSign.d.ts

@@ -0,0 +1,176 @@
+import { TIsoCountry } from './country'
+
+export type TPriceSignFormat = 'pdf' | 'png' | 'jpeg'
+
+/** Limits the api enforces on templates and setups; Superadmin builds its forms from them. */
+export interface IPriceSignLimits {
+  minMonths: number
+  maxMonths: number
+  maxHpTiers: number
+  minPeriods: number
+  maxPeriods: number
+  /** Max periods on a sign with `maxHpTiers` HP tiers. */
+  maxPeriodsWithMaxTiers: number
+  countries: TIsoCountry[]
+  /** Durations offered as one-click picks; any other whole month in range can still be added. */
+  quickPickMonths: number[]
+}
+
+export interface IPriceSignPeriod {
+  months: number
+  suggestedPrice: string
+  suggestedSupplements: string[]
+  excludedTiers: number[]
+}
+
+export interface IPriceSignBenefit {
+  title: string
+  body: string
+}
+
+export interface IPriceSignDealerPrice {
+  months: number
+  price: string
+  supplements: string[]
+  hidden: boolean
+}
+
+export interface IPriceSignTemplate {
+  templateId: number
+  country: TIsoCountry
+  templateName: string
+  visible: boolean
+  name: string
+  nameAccent: string
+  years: string
+  km: string
+  deductible: string
+  repairLimit: string
+  /** Ascending HP thresholds; each starts a supplement tier. */
+  tiers: number[]
+  periods: IPriceSignPeriod[]
+  intro: string
+  coverageIntro: string
+  bullets: string[]
+  footnote: string
+  updatedBy: string | null
+  updatedAt: string
+}
+
+export interface IPriceSignSharedContent {
+  country: TIsoCountry
+  familyName: string
+  repairLimitLabel: string
+  repairLimitNote: string
+  benefits: IPriceSignBenefit[]
+  coverageHeading: string
+  periodsHeading: string
+  vatNote: string
+  supplementLabel: string
+  tierHeading: string
+  tierLabel: string
+}
+
+export interface IPriceSignSetupTemplate {
+  templateId: number
+  /** null follows the template's tiers. */
+  tiers: number[] | null
+  /** Only the periods that differ from the template. */
+  periods: IPriceSignPeriod[]
+  /** Dealers of this setup with their own prices for this template; a tier change clears them. */
+  dealerPriceCount: number
+  updatedBy: string | null
+  updatedAt: string
+}
+
+/** A setup belongs to one provider or one group and grants its members price signs. */
+export interface IPriceSignSetupSummary {
+  setupId: number
+  contractProviderId: number | null
+  providerName: string | null
+  contractProviderGroupId: number | null
+  groupName: string | null
+  groupArchived: boolean
+  templateCount: number
+  createdBy: string | null
+  createdAt: string
+}
+
+export interface IPriceSignSetup extends IPriceSignSetupSummary {
+  templates: IPriceSignSetupTemplate[]
+}
+
+export interface IPriceSignSetupTemplateRequest {
+  templateId: number
+  tiers: number[] | null
+  /** Full periods as edited; the api keeps only those that differ from the template. */
+  periods: IPriceSignPeriod[]
+}
+
+/** The owner is set on create only: exactly one of the two ids. */
+export interface IPriceSignSetupRequest {
+  contractProviderId?: number
+  contractProviderGroupId?: number
+  templates: IPriceSignSetupTemplateRequest[]
+}
+
+export interface IPriceSignSetupCandidates {
+  providers: { contractProviderId: number; name: string }[]
+  groups: { contractProviderGroupId: number; name: string }[]
+}
+
+export interface IPriceSignTemplateUsage {
+  groups: number
+  providers: number
+  /** Dealers with their own prices for this template. */
+  dealerPrices: number
+}
+
+export interface IPriceSignDealerPrices {
+  templateId: number
+  /** Effective rows: the dealer's own values over the setup's. */
+  prices: IPriceSignDealerPrice[]
+  updatedAt: string | null
+}
+
+export interface IPriceSignDealerPricesRequest {
+  templateId: number
+  prices: IPriceSignDealerPrice[]
+}
+
+export interface IPriceSignCatalog {
+  shared: IPriceSignSharedContent
+  /** Visible templates with the dealer's setup applied. */
+  templates: IPriceSignTemplate[]
+  groupName: string | null
+  logoUrl: string | null
+  logoUsable: boolean
+  downloadAvailable: boolean
+}
+
+export interface IPriceSignRenderRequest {
+  /** One page per template, in this order. */
+  templateIds: number[]
+  logo: 'provider' | 'none' | { dataUrl: string }
+  /** Aligned with `templateIds`. */
+  prices?: IPriceSignDealerPrice[][]
+}
+
+/** Body of a template create or update; the api sets the id and the audit fields. */
+export type TPriceSignTemplateRequest = Pick<
+  IPriceSignTemplate,
+  Exclude<keyof IPriceSignTemplate, 'templateId' | 'updatedBy' | 'updatedAt'>
+>
+
+/** Body of a shared content save; the country comes from the url. */
+export type TPriceSignSharedContentRequest = Pick<
+  IPriceSignSharedContent,
+  Exclude<keyof IPriceSignSharedContent, 'country'>
+>
+
+export interface IPriceSignEditorPreviewRequest {
+  template: TPriceSignTemplateRequest & { templateId?: number }
+  shared?: IPriceSignSharedContent
+  setup?: Pick<IPriceSignSetupTemplateRequest, 'tiers' | 'periods'>
+  prices?: IPriceSignDealerPrice[]
+}

package/types/responseErrors/index.d.ts

@@ -9,6 +9,7 @@ import { ImportErrors } from './importErrors'
 import { InvalidProductTypeErrors } from './invalidProductTypeErrors'
 import { InvoiceErrors } from './invoiceErrors'
 import { PasswordErrors } from './passwordResponseErrors'
+import { PriceSignResponseErrors } from './priceSignResponseErrors'
 import { paymentResponseErrors } from './paymentResponseErrors'
 import { RateLimitErrors } from './rateLimitErrors'
 import { UserAndCustomerErrors } from './userAndCustomerErrors'
@@ -32,3 +33,4 @@ export type ResponseErrors =
   | VatLookupResponseErrors
   | VehcileBlacklistErrors
   | InvoiceErrors
+  | PriceSignResponseErrors

package/types/responseErrors/priceSignResponseErrors.d.ts

@@ -0,0 +1,5 @@
+export type PriceSignResponseErrors =
+  | 'PRICE_SIGN_VALIDATION'
+  | 'PRICE_SIGN_FONT_MISSING'
+  | 'PRICE_SIGNS_DK_ONLY'
+  | 'PRICE_SIGN_SETUP_CONFLICT'

package/types/responseErrors/userAndCustomerErrors.d.ts

@@ -1 +1 @@
-export declare type UserAndCustomerErrors = 'GENERIC_CONTACT_PERSON_NOT_FOUND' | 'GENERIC_CUSTOMER_ALREADY_EXISTS' | 'GENERIC_CUSTOMER_EMAIL_ALREADY_EXISTS_AS_USER' | 'GENERIC_CUSTOMER_NOT_FOUND' | 'GENERIC_FORBIDDEN_ROLE' | 'REPORTS_USER_NO_ADMIN_LOGIN' | 'GENERIC_NODE_ROLE_NOT_FOUND' | 'GENERIC_USER_ALREADY_EXISTS' | 'GENERIC_USER_CONFIGURATION_NOT_FOUND' | 'GENERIC_USER_NOT_FOUND' | 'GENERIC_USERNAME_OR_PASSWORD_NOT_FOUND';
+export declare type UserAndCustomerErrors = 'GENERIC_CONTACT_PERSON_NOT_FOUND' | 'GENERIC_CUSTOMER_ALREADY_EXISTS' | 'GENERIC_CUSTOMER_EMAIL_ALREADY_EXISTS_AS_USER' | 'GENERIC_CUSTOMER_NOT_FOUND' | 'CUSTOMER_HAS_OPEN_CONTRACTS' | 'GENERIC_FORBIDDEN_ROLE' | 'REPORTS_USER_NO_ADMIN_LOGIN' | 'GENERIC_NODE_ROLE_NOT_FOUND' | 'GENERIC_USER_ALREADY_EXISTS' | 'GENERIC_USER_CONFIGURATION_NOT_FOUND' | 'GENERIC_USER_NOT_FOUND' | 'GENERIC_USERNAME_OR_PASSWORD_NOT_FOUND';

package/types/responseErrors/userAndCustomerErrors.ts

@@ -3,6 +3,7 @@ export type UserAndCustomerErrors =
   | 'GENERIC_CUSTOMER_ALREADY_EXISTS'
   | 'GENERIC_CUSTOMER_EMAIL_ALREADY_EXISTS_AS_USER' // The customer's email already exists as a (Seller/Admin/SuperAdmin/...) -User.
   | 'GENERIC_CUSTOMER_NOT_FOUND'
+  | 'CUSTOMER_HAS_OPEN_CONTRACTS' // MyPage delete-my-data refused: a contract can still charge, refund or mail the customer.
   | 'GENERIC_FORBIDDEN_ROLE'
   | 'REPORTS_USER_NO_ADMIN_LOGIN' // Admin login refused: the user only has the reports role, used through the report API.
   | 'GENERIC_NODE_ROLE_NOT_FOUND'

package/types/responseErrors/vehcileBlacklistErrors.d.ts

@@ -1,5 +1,3 @@
 export type VehcileBlacklistErrors =
     | 'DUPLICATE_RECORD'
     | 'VEHICLE_BLACKLIST_NOT_FOUND'
-    | 'PRODUCT_BLACKLIST_NOT_FOUND'
-    | 'CONTRACT_PRODUCT_BLACKLISTED'

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

@@ -1,52 +0,0 @@
-/**
- * The vehicles a warranty product is blacklisted for, matched like a vehicle blacklist entry: `*` in model or fuel type
- * matches any, and the model year range is inclusive with null meaning no limit.
- */
-export interface IBlacklistedProductVehicle {
-  brand: string
-  model: string
-  fuelType: string
-  modelYearFrom: number | null
-  modelYearTo: number | null
-}
-
-/** A warranty product blacklisted by its exact name (case-insensitive) or its V4 product id; exactly one is set. */
-export interface IBlacklistedProductRequest {
-  warrantyName: string | null
-  v4ProductId: number | null
-  /** Only for these vehicles; missing or null blacklists the product for every vehicle. */
-  vehicle?: IBlacklistedProductVehicle | null
-  providerIds: {
-    add: number[]
-    remove: number[]
-  }
-  contractProviderGroupIds?: {
-    add: number[]
-    remove: number[]
-  }
-}
-
-export interface IBlacklistedProductResponse {
-  id: number
-  warrantyName: string | null
-  v4ProductId: number | null
-  vehicle: IBlacklistedProductVehicle | null
-  parentRecord?: boolean
-  groupRecord?: boolean
-}
-
-export interface IBlacklistedProductListRecord extends IBlacklistedProductResponse {
-  // Null on a group-owned entry: the two owners are exclusive.
-  providerId: number | null
-  providerName: string | null
-  contractProviderGroupId: number | null
-  contractProviderGroupName: string | null
-}
-
-/** Which providers and groups a blacklisted product is registered for. */
-export interface IBlacklistedProductScope {
-  providerIds: number[]
-  contractProviderGroupIds: number[]
-}
-
-export type BlacklistedProductOrderByType = 'id' | 'warrantyName' | 'v4ProductId'