@fragus/sam-types 1.2.15 → 1.2.17

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.15",
+  "version": "1.2.17",
   "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/contractProviderFlags.d.ts

@@ -3,7 +3,6 @@ export type TContractProviderFlagKey =
   | 'ALPINE_EXTENDED_PDF_TITLE'
   | 'FRAGUS_INVOICING'
   | 'INTERNAL_USE'
-  | 'PRICE_SIGNS'
 
 /** Exactly one of the two ids is sent: a flag row is owned by a provider or by a group. */
 export interface ContractProviderFlagRequest {

package/types/dashboardBanner.d.ts

@@ -11,6 +11,10 @@ export interface DashboardBannerRequest {
    */
   countryIso?: TIsoCountry | null
   contractProviderGroupId?: number | null
+  /**
+   * An https link (a campaign or information page) that Admin shows as a QR code under the text; null for none.
+   */
+  qrUrl?: string | null
   /**
    * ISO date string (YYYY-MM-DD) for the start date of the banner
    */
@@ -36,4 +40,5 @@ export interface DashboardBannerResponse extends DashboardBannerRequest {
  */
 export interface ProviderDashboardBannerResponse {
   text: string
+  qrUrl: string | null
 }

package/types/priceSign.d.ts

@@ -4,14 +4,14 @@ export type TPriceSignMonths = number
 
 export type TPriceSignFormat = 'pdf' | 'png' | 'jpeg'
 
-/** Limits the api enforces on templates and HP indices; Superadmin builds its form from them. */
+/** 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 whose HP index has `maxHpTiers` tiers. */
+  /** 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. */
@@ -37,14 +37,6 @@ export interface IPriceSignDealerPrice {
   hidden: boolean
 }
 
-export interface IPriceSignHpIndex {
-  hpIndexId: number
-  country: TIsoCountry
-  name: string
-  tiers: number[]
-  usedBy?: string[]
-}
-
 export interface IPriceSignTemplate {
   templateId: number
   country: TIsoCountry
@@ -56,7 +48,8 @@ export interface IPriceSignTemplate {
   km: string
   deductible: string
   repairLimit: string
-  hpIndexId: number | null
+  /** Ascending HP thresholds; each starts a supplement tier. */
+  tiers: number[]
   periods: IPriceSignPeriod[]
   intro: string
   coverageIntro: string
@@ -66,16 +59,6 @@ export interface IPriceSignTemplate {
   updatedAt: string
 }
 
-export interface IPriceSignCombo {
-  comboId: number
-  country: TIsoCountry
-  templateName: string
-  visible: boolean
-  pages: [number, number]
-  updatedBy: string | null
-  updatedAt: string
-}
-
 export interface IPriceSignSharedContent {
   country: TIsoCountry
   familyName: string
@@ -90,38 +73,77 @@ export interface IPriceSignSharedContent {
   tierLabel: string
 }
 
-export interface IPriceSignGroupSetup {
+export interface IPriceSignSetupTemplate {
   templateId: number
-  hpIndexId: number | null
+  /** 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
 }
 
-export interface IPriceSignGroupConflict {
-  providerId: number
-  providerName: 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
-  otherGroupName: string
+  tiers: number[] | null
+  /** Full periods as edited; the api keeps only those that differ from the template. */
+  periods: IPriceSignPeriod[]
 }
 
-export interface IPriceSignGroup {
-  groupId: number
-  name: string
-  templateIds: number[]
-  conflicts: IPriceSignGroupConflict[]
+/** 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
-  hpIndexId: number | null
+  /** Effective rows: the dealer's own values over the setup's. */
+  prices: IPriceSignDealerPrice[]
+  updatedAt: string | null
+}
+
+export interface IPriceSignDealerPricesRequest {
+  templateId: number
   prices: IPriceSignDealerPrice[]
-  updatedAt: string
 }
 
 export interface IPriceSignCatalog {
   shared: IPriceSignSharedContent
-  hpIndices: IPriceSignHpIndex[]
+  /** Visible templates with the dealer's setup applied. */
   templates: IPriceSignTemplate[]
-  combos: IPriceSignCombo[]
   groupName: string | null
   logoUrl: string | null
   logoUsable: boolean
@@ -129,10 +151,10 @@ export interface IPriceSignCatalog {
 }
 
 export interface IPriceSignRenderRequest {
-  /** Exactly one of the two ids is sent: one template or one combo. */
-  templateId?: number
-  comboId?: number
+  /** One page per template, in this order. */
+  templateIds: number[]
   logo: 'provider' | 'none' | { dataUrl: string }
+  /** Aligned with `templateIds`. */
   prices?: IPriceSignDealerPrice[][]
 }
 
@@ -141,6 +163,6 @@ export interface IPriceSignEditorPreviewRequest {
     templateId?: number
   }
   shared?: IPriceSignSharedContent
-  groupId?: number
+  setup?: Pick<IPriceSignSetupTemplateRequest, 'tiers' | 'periods'>
   prices?: IPriceSignDealerPrice[]
 }

package/types/responseErrors/priceSignResponseErrors.d.ts

@@ -3,3 +3,4 @@ export type PriceSignResponseErrors =
   | 'PRICE_SIGN_IN_USE'
   | 'PRICE_SIGN_FONT_MISSING'
   | 'PRICE_SIGNS_DK_ONLY'
+  | 'PRICE_SIGN_SETUP_CONFLICT'