@fragus/sam-types 1.2.21 → 1.2.22

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.21",
+  "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/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/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/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'