@fragus/sam-types 1.2.22 → 1.2.24

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.22",
+  "version": "1.2.24",
   "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

@@ -0,0 +1,63 @@
+/**
+ * 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
+  model: string
+  fuelType: string
+  modelYearFrom: number | null
+  modelYearTo: number | null
+}
+
+/**
+ * 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 {
+  productName: string | null
+  v4ProductId: number | null
+  /** Only for these vehicles; missing or null blacklists the product for every vehicle. */
+  vehicle?: IBlacklistedProductVehicle | null
+  providerIds: number[]
+  contractProviderGroupIds: number[]
+}
+
+/** Owners to add to and remove from a rule; it must keep at least one. */
+export interface IBlacklistedProductOwnersRequest {
+  providerIds: {
+    add: number[]
+    remove: number[]
+  }
+  contractProviderGroupIds: {
+    add: number[]
+    remove: number[]
+  }
+}
+
+export interface IBlacklistedProductOwner {
+  id: number
+  name: string
+}
+
+export interface IBlacklistedProductResponse {
+  id: number
+  productName: string | null
+  v4ProductId: number | null
+  vehicle: IBlacklistedProductVehicle | null
+  providers: IBlacklistedProductOwner[]
+  contractProviderGroups: IBlacklistedProductOwner[]
+}
+
+export interface IBlacklistedProductListRecord extends IBlacklistedProductResponse {
+  /** True in a sub provider's list when the rule applies to it only through its parent. */
+  parentRecord: boolean
+}
+
+/** The `debug` of a PRODUCT_BLACKLIST_ALREADY_EXISTS (409) response: the identical rule that exists. */
+export interface IBlacklistedProductConflict {
+  id: number
+}
+
+export type BlacklistedProductOrderByType = 'id' | 'productName' | 'v4ProductId'

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

@@ -2,6 +2,9 @@ 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[]
@@ -17,6 +20,8 @@ export interface IBlacklistedVehicleResponse {
   brand: string
   model: string
   fuelType: string
+  modelYearFrom: number | null
+  modelYearTo: number | null
   parentRecord?: boolean
   groupRecord?: boolean
 }

package/types/responseErrors/vehcileBlacklistErrors.d.ts

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