@fragus/sam-types 1.2.23 → 1.2.25

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.23",
+  "version": "1.2.25",
   "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/productBlacklist/index.d.ts

@@ -1,6 +1,8 @@
+import { IBlacklistOwner, IBlacklistOwnersRequest } from '../vehicleBlacklist'
+
 /**
- * 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.
+ * The vehicles a 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
@@ -10,43 +12,38 @@ export interface IBlacklistedProductVehicle {
   modelYearTo: number | null
 }
 
-/** A warranty product blacklisted by its exact name (case-insensitive) or its V4 product id; exactly one is set. */
+/**
+ * A product blacklisted by its exact name, ignoring case (a warranty, or a service agreement by its internal or
+ * external name), or by its V4 product id; exactly one is set. The owners are the providers and groups, at least one in
+ * all. A rule cannot be changed once created, only its owners.
+ */
 export interface IBlacklistedProductRequest {
-  warrantyName: string | null
+  productName: 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[]
-  }
+  providerIds: number[]
+  contractProviderGroupIds: number[]
 }
 
+export type IBlacklistedProductOwnersRequest = IBlacklistOwnersRequest
+
+export type IBlacklistedProductOwner = IBlacklistOwner
+
 export interface IBlacklistedProductResponse {
   id: number
-  warrantyName: string | null
+  productName: string | null
   v4ProductId: number | null
   vehicle: IBlacklistedProductVehicle | null
-  parentRecord?: boolean
-  groupRecord?: boolean
+  providers: IBlacklistedProductOwner[]
+  contractProviderGroups: IBlacklistedProductOwner[]
 }
 
-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
-}
+export type IBlacklistedProductListRecord = IBlacklistedProductResponse
 
-/** Which providers and groups a blacklisted product is registered for. */
-export interface IBlacklistedProductScope {
-  providerIds: number[]
-  contractProviderGroupIds: number[]
+/** The `debug` of a PRODUCT_BLACKLIST_ALREADY_EXISTS (409) response: the identical rule that exists. */
+export interface IBlacklistedProductConflict {
+  id: number
 }
 
-export type BlacklistedProductOrderByType = 'id' | 'warrantyName' | 'v4ProductId'
+export type BlacklistedProductOrderByType = 'id' | 'productName' | 'v4ProductId'

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

@@ -1,20 +1,36 @@
-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
+/** Owners to add to and remove from a blacklist rule; it must keep at least one. */
+export interface IBlacklistOwnersRequest {
   providerIds: {
     add: number[]
     remove: number[]
   }
-  contractProviderGroupIds?: {
+  contractProviderGroupIds: {
     add: number[]
     remove: number[]
   }
 }
 
+/** A provider or a provider group a blacklist rule applies to. */
+export interface IBlacklistOwner {
+  id: number
+  name: string
+}
+
+/**
+ * A vehicle blacklisted for its owners: the providers and groups, at least one in all. A rule cannot be changed once
+ * created, only its owners.
+ */
+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: number[]
+  contractProviderGroupIds: number[]
+}
+
 export interface IBlacklistedVehicleResponse {
   id: number
   brand: string
@@ -22,22 +38,15 @@ export interface IBlacklistedVehicleResponse {
   fuelType: string
   modelYearFrom: number | null
   modelYearTo: number | null
-  parentRecord?: boolean
-  groupRecord?: boolean
+  providers: IBlacklistOwner[]
+  contractProviderGroups: IBlacklistOwner[]
 }
 
-export interface IBlacklistedVehicleListRecord extends IBlacklistedVehicleResponse {
-  // Null on a group-owned entry: the two owners are exclusive.
-  providerId: number | null
-  providerName: string | null
-  contractProviderGroupId: number | null
-  contractProviderGroupName: string | null
-}
+export type IBlacklistedVehicleListRecord = IBlacklistedVehicleResponse
 
-/** Which providers and groups a blacklisted vehicle is registered for. */
-export interface IBlacklistedVehicleScope {
-  providerIds: number[]
-  contractProviderGroupIds: number[]
+/** The `debug` of a VEHICLE_BLACKLIST_ALREADY_EXISTS (409) response: the identical rule that exists. */
+export interface IBlacklistedVehicleConflict {
+  id: number
 }
 
 export type BlacklistedVehicleOrderByType = 'id' | 'brand' | 'model' | 'fuelType'

package/types/responseErrors/vehcileBlacklistErrors.d.ts

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