@fragus/sam-types 1.2.16 → 1.2.18

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.16",
+  "version": "1.2.18",
   "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/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

@@ -1,7 +1,5 @@
 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. */
@@ -15,11 +13,11 @@ export interface IPriceSignLimits {
   maxPeriodsWithMaxTiers: number
   countries: TIsoCountry[]
   /** Durations offered as one-click picks; any other whole month in range can still be added. */
-  quickPickMonths: TPriceSignMonths[]
+  quickPickMonths: number[]
 }
 
 export interface IPriceSignPeriod {
-  months: TPriceSignMonths
+  months: number
   suggestedPrice: string
   suggestedSupplements: string[]
   excludedTiers: number[]
@@ -31,7 +29,7 @@ export interface IPriceSignBenefit {
 }
 
 export interface IPriceSignDealerPrice {
-  months: TPriceSignMonths
+  months: number
   price: string
   supplements: string[]
   hidden: boolean
@@ -158,10 +156,20 @@ export interface IPriceSignRenderRequest {
   prices?: IPriceSignDealerPrice[][]
 }
 
+/** Body of a template create or update; the api sets the id and the audit fields. */
+export type TPriceSignTemplateRequest = Pick<
+  IPriceSignTemplate,
+  Exclude<keyof IPriceSignTemplate, 'templateId' | 'updatedBy' | 'updatedAt'>
+>
+
+/** Body of a shared content save; the country comes from the url. */
+export type TPriceSignSharedContentRequest = Pick<
+  IPriceSignSharedContent,
+  Exclude<keyof IPriceSignSharedContent, 'country'>
+>
+
 export interface IPriceSignEditorPreviewRequest {
-  template: Pick<IPriceSignTemplate, Exclude<keyof IPriceSignTemplate, 'templateId' | 'updatedBy' | 'updatedAt'>> & {
-    templateId?: number
-  }
+  template: TPriceSignTemplateRequest & { templateId?: number }
   shared?: IPriceSignSharedContent
   setup?: Pick<IPriceSignSetupTemplateRequest, 'tiers' | 'periods'>
   prices?: IPriceSignDealerPrice[]

package/types/responseErrors/priceSignResponseErrors.d.ts

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