@fragus/sam-types 1.2.14 → 1.2.16

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.14",
+  "version": "1.2.16",
   "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/contractProvider/index.d.ts

@@ -34,6 +34,7 @@ export interface IContractProviderInfo extends IEssentialContractProviderInfo {
   isUseV4PTOnlyForSigning: boolean
   fragusInvoicing?: boolean
   isInternalUse?: boolean
+  hasPriceSigns?: boolean
 }
 
 export interface ICreateTestContractProvider {

package/types/contractProviderGroup.d.ts

@@ -37,6 +37,7 @@ export interface IContractProviderGroupUsage {
   documentCount: number
   dashboardBannerCount: number
   featureFlagCount: number
+  priceSignSetupCount: number
 }
 
 export interface IUpsertContractProviderGroupRequest {

package/types/dashboardBanner.d.ts

@@ -11,10 +11,6 @@ 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
    */
@@ -40,5 +36,4 @@ export interface DashboardBannerResponse extends DashboardBannerRequest {
  */
 export interface ProviderDashboardBannerResponse {
   text: string
-  qrUrl: string | null
 }

package/types/index.d.ts

@@ -223,3 +223,4 @@ export * from './contractProviderFlags';
 export * from './fragusInvoicing';
 export * from './providerDocument';
 export * from './contractProviderGroup';
+export * from './priceSign';

package/types/index.ts

@@ -242,3 +242,4 @@ export * from './contractProviderFlags'
 export * from './fragusInvoicing'
 export * from './providerDocument'
 export * from './contractProviderGroup'
+export * from './priceSign'

package/types/priceSign.d.ts

@@ -0,0 +1,168 @@
+import { TIsoCountry } from './country'
+
+export type TPriceSignMonths = number
+
+export type TPriceSignFormat = 'pdf' | 'png' | 'jpeg'
+
+/** 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 with `maxHpTiers` HP tiers. */
+  maxPeriodsWithMaxTiers: number
+  countries: TIsoCountry[]
+  /** Durations offered as one-click picks; any other whole month in range can still be added. */
+  quickPickMonths: TPriceSignMonths[]
+}
+
+export interface IPriceSignPeriod {
+  months: TPriceSignMonths
+  suggestedPrice: string
+  suggestedSupplements: string[]
+  excludedTiers: number[]
+}
+
+export interface IPriceSignBenefit {
+  title: string
+  body: string
+}
+
+export interface IPriceSignDealerPrice {
+  months: TPriceSignMonths
+  price: string
+  supplements: string[]
+  hidden: boolean
+}
+
+export interface IPriceSignTemplate {
+  templateId: number
+  country: TIsoCountry
+  templateName: string
+  visible: boolean
+  name: string
+  nameAccent: string
+  years: string
+  km: string
+  deductible: string
+  repairLimit: string
+  /** Ascending HP thresholds; each starts a supplement tier. */
+  tiers: number[]
+  periods: IPriceSignPeriod[]
+  intro: string
+  coverageIntro: string
+  bullets: string[]
+  footnote: string
+  updatedBy: string | null
+  updatedAt: string
+}
+
+export interface IPriceSignSharedContent {
+  country: TIsoCountry
+  familyName: string
+  repairLimitLabel: string
+  repairLimitNote: string
+  benefits: IPriceSignBenefit[]
+  coverageHeading: string
+  periodsHeading: string
+  vatNote: string
+  supplementLabel: string
+  tierHeading: string
+  tierLabel: string
+}
+
+export interface IPriceSignSetupTemplate {
+  templateId: number
+  /** 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
+}
+
+/** 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
+  tiers: number[] | null
+  /** Full periods as edited; the api keeps only those that differ from the template. */
+  periods: IPriceSignPeriod[]
+}
+
+/** 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
+  /** Effective rows: the dealer's own values over the setup's. */
+  prices: IPriceSignDealerPrice[]
+  updatedAt: string | null
+}
+
+export interface IPriceSignDealerPricesRequest {
+  templateId: number
+  prices: IPriceSignDealerPrice[]
+}
+
+export interface IPriceSignCatalog {
+  shared: IPriceSignSharedContent
+  /** Visible templates with the dealer's setup applied. */
+  templates: IPriceSignTemplate[]
+  groupName: string | null
+  logoUrl: string | null
+  logoUsable: boolean
+  downloadAvailable: boolean
+}
+
+export interface IPriceSignRenderRequest {
+  /** One page per template, in this order. */
+  templateIds: number[]
+  logo: 'provider' | 'none' | { dataUrl: string }
+  /** Aligned with `templateIds`. */
+  prices?: IPriceSignDealerPrice[][]
+}
+
+export interface IPriceSignEditorPreviewRequest {
+  template: Pick<IPriceSignTemplate, Exclude<keyof IPriceSignTemplate, 'templateId' | 'updatedBy' | 'updatedAt'>> & {
+    templateId?: number
+  }
+  shared?: IPriceSignSharedContent
+  setup?: Pick<IPriceSignSetupTemplateRequest, 'tiers' | 'periods'>
+  prices?: IPriceSignDealerPrice[]
+}

package/types/responseErrors/index.d.ts

@@ -9,6 +9,7 @@ import { ImportErrors } from './importErrors'
 import { InvalidProductTypeErrors } from './invalidProductTypeErrors'
 import { InvoiceErrors } from './invoiceErrors'
 import { PasswordErrors } from './passwordResponseErrors'
+import { PriceSignResponseErrors } from './priceSignResponseErrors'
 import { paymentResponseErrors } from './paymentResponseErrors'
 import { RateLimitErrors } from './rateLimitErrors'
 import { UserAndCustomerErrors } from './userAndCustomerErrors'
@@ -32,3 +33,4 @@ export type ResponseErrors =
   | VatLookupResponseErrors
   | VehcileBlacklistErrors
   | InvoiceErrors
+  | PriceSignResponseErrors

package/types/responseErrors/priceSignResponseErrors.d.ts

@@ -0,0 +1,6 @@
+export type PriceSignResponseErrors =
+  | 'PRICE_SIGN_VALIDATION'
+  | 'PRICE_SIGN_IN_USE'
+  | 'PRICE_SIGN_FONT_MISSING'
+  | 'PRICE_SIGNS_DK_ONLY'
+  | 'PRICE_SIGN_SETUP_CONFLICT'