@fragus/sam-types 1.2.21 → 1.2.23

package/package.json

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