@fragus/sam-types 1.2.6 → 1.2.8

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.6",
+  "version": "1.2.8",
   "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/contractCreation/contractCreation.d.ts

@@ -20,6 +20,7 @@ export interface IContractCreationData {
   templates: IGenericContractTemplateResponse[]
   templatesAllDisabled?: boolean
   hiddenNetPrice: boolean
+  hideRetailPriceTooltip: boolean
 }
 
 export interface IProviderHasAccessToProductsRequest {
@@ -229,7 +230,7 @@ export interface IAvailableFreeWarrantyDurationPrice {
   finlandPriceId?: number
   totalPrice: PriceSpecification
   isEnabledAndAvailable?: boolean | null // Dependent of optional user setting for this DurationPrice-group or default setting in WarrantyData.
-  debug?: any // For debugging purposes.
+  debug?: unknown // For debugging purposes.
 }
 
 export interface IAvailableFreeWarranty {

package/types/admin/contractCreation/priceCalculation.d.ts

@@ -57,6 +57,14 @@ export interface IStandardV4PricingToolContractCalculationRequest extends IContr
   v4ProductId: number // V4 contract product / "template" id.
 }
 
+/**
+ * The V4 retail price, set only for providers using it; the dealer price fields stay unchanged.
+ */
+export interface IRetailPriceCalculation {
+  amountPrPayment: PriceSpecification
+  contractCost: PriceSpecification
+}
+
 /**
  * The type returned by a price calculation.
  */
@@ -78,6 +86,7 @@ export interface IContractCalculationResponse {
   providerCost: PriceSpecification
   providerPayments: number
   providerShare: PriceSpecification
-  x_debugData?: any // For debugging purposes.
+  retailPrice?: IRetailPriceCalculation
+  x_debugData?: Record<string, unknown> | null // For debugging purposes.
   serviceInfo?: string[] // Service information, mainly for ax.
 }

package/types/contractProvider.d.ts

@@ -41,6 +41,9 @@ export interface IContractProviderRequest extends IProviderCustomizationResponse
   optionsConditions?: string
   fetchWarrantiesFromV4: boolean
   hiddenNetPrice: boolean
+  useRetailPrice?: boolean
+  /** Only allowed together with `useRetailPrice`. */
+  hideRetailPriceTooltip?: boolean
   v4ProviderId: number | null
   /** Groups the provider joins on create; an update ignores it. */
   contractProviderGroupIds?: number[]
@@ -93,6 +96,8 @@ export interface IContractProviderResponse extends IProviderCustomizationRespons
   created: Date
   updated: Date
   hiddenNetPrice: boolean
+  useRetailPrice: boolean
+  hideRetailPriceTooltip: boolean
   /** Read-only, from the provider's `FRAGUS_INVOICING` flag. */
   fragusInvoicing?: boolean
   /** Read-only, from the provider's `INTERNAL_USE` flag. */
@@ -209,6 +214,8 @@ export interface IContractProviderOverviewDetails {
   disableContractTemplates: boolean
   fetchWarrantiesFromV4: boolean
   hiddenNetPrice: boolean
+  useRetailPrice: boolean
+  hideRetailPriceTooltip: boolean
 }
 
 export interface IPaginatedContractProviderListResponse {

package/types/responseErrors/contractProviderErrors.d.ts

@@ -0,0 +1 @@
+export type ContractProviderErrors = 'HIDE_RETAIL_PRICE_TOOLTIP_REQUIRES_USE_RETAIL_PRICE'

package/types/responseErrors/index.d.ts

@@ -1,6 +1,7 @@
 import { AdjustmentRequestResponseErrors } from './adjustmentRequestResponseErrors'
 import { AdminPaymentErrors } from './adminPaymentErrors'
 import { CalculatorResponseErrors } from './calculatorResponseErrors'
+import { ContractProviderErrors } from './contractProviderErrors'
 import { ContractProviderGroupErrors } from './contractProviderGroupErrors'
 import { ContractResponseErrors } from './contractResponseErrors'
 import { GenericResponseErrors } from './genericResponseTypes'
@@ -18,6 +19,7 @@ export type ResponseErrors =
   | AdjustmentRequestResponseErrors
   | AdminPaymentErrors
   | CalculatorResponseErrors
+  | ContractProviderErrors
   | ContractProviderGroupErrors
   | ContractResponseErrors
   | GenericResponseErrors

package/types/responseErrors/userAndCustomerErrors.d.ts

@@ -1 +1 @@
-export declare type UserAndCustomerErrors = 'GENERIC_CONTACT_PERSON_NOT_FOUND' | 'GENERIC_CUSTOMER_ALREADY_EXISTS' | 'GENERIC_CUSTOMER_EMAIL_ALREADY_EXISTS_AS_USER' | 'GENERIC_CUSTOMER_NOT_FOUND' | 'GENERIC_FORBIDDEN_ROLE' | 'GENERIC_NODE_ROLE_NOT_FOUND' | 'GENERIC_USER_ALREADY_EXISTS' | 'GENERIC_USER_CONFIGURATION_NOT_FOUND' | 'GENERIC_USER_NOT_FOUND' | 'GENERIC_USERNAME_OR_PASSWORD_NOT_FOUND';
+export declare type UserAndCustomerErrors = 'GENERIC_CONTACT_PERSON_NOT_FOUND' | 'GENERIC_CUSTOMER_ALREADY_EXISTS' | 'GENERIC_CUSTOMER_EMAIL_ALREADY_EXISTS_AS_USER' | 'GENERIC_CUSTOMER_NOT_FOUND' | 'GENERIC_FORBIDDEN_ROLE' | 'REPORTS_USER_NO_ADMIN_LOGIN' | 'GENERIC_NODE_ROLE_NOT_FOUND' | 'GENERIC_USER_ALREADY_EXISTS' | 'GENERIC_USER_CONFIGURATION_NOT_FOUND' | 'GENERIC_USER_NOT_FOUND' | 'GENERIC_USERNAME_OR_PASSWORD_NOT_FOUND';

package/types/responseErrors/userAndCustomerErrors.ts

@@ -4,6 +4,7 @@ export type UserAndCustomerErrors =
   | 'GENERIC_CUSTOMER_EMAIL_ALREADY_EXISTS_AS_USER' // The customer's email already exists as a (Seller/Admin/SuperAdmin/...) -User.
   | 'GENERIC_CUSTOMER_NOT_FOUND'
   | 'GENERIC_FORBIDDEN_ROLE'
+  | 'REPORTS_USER_NO_ADMIN_LOGIN' // Admin login refused: the user only has the reports role, used through the report API.
   | 'GENERIC_NODE_ROLE_NOT_FOUND'
   | 'GENERIC_USER_ALREADY_EXISTS'
   | 'GENERIC_USER_CONFIGURATION_NOT_FOUND'