@iveri/contracts 0.42.0 → 0.44.0

package/dist/api/clinic/clinic-appointment.type.d.ts

@@ -28,7 +28,11 @@ export interface ClinicAppointment {
     /** When the specialist, the room and any machine are free again, which includes the buffer. */
     blockedUntil: IsoDateTime;
     currency: string;
+    /** What the client pays, after any promotion. */
     totalMinor: number;
+    /** How much a promotion took off, as it stood when this was booked. */
+    discountMinor: number;
+    promotionName: Nullable<LocalizedText>;
     lines: ClinicAppointmentLine[];
     note: Nullable<string>;
     createdAt: IsoDateTime;

package/dist/api/clinic/clinic-client.type.d.ts

@@ -8,6 +8,12 @@ export interface ClinicClient {
     lastName: string;
     phone: string;
     email: Nullable<string>;
+    /**
+     * When the address in `email` was shown to belong to this client. Null means nothing is sent to
+     * it: anybody can register with an address that is not theirs, and a booking email carries a
+     * treatment name.
+     */
+    emailConfirmedAt: Nullable<IsoDateTime>;
     createdAt: IsoDateTime;
     updatedAt: IsoDateTime;
 }

package/dist/api/clinic/clinic-my-appointment.type.d.ts

@@ -16,6 +16,8 @@ export interface MyClinicAppointment {
     endsAt: IsoDateTime;
     currency: string;
     totalMinor: number;
+    discountMinor: number;
+    promotionName: Nullable<LocalizedText>;
     lines: ClinicAppointmentLine[];
     note: Nullable<string>;
     /** Whether the clinic's rules still let this client cancel it themselves. */
@@ -34,4 +36,10 @@ export interface SaveMyClinicClientRequest {
     lastName: string;
     phone: string;
     email?: Nullable<string>;
+    /** The language the client reads, which their emails are written in. */
+    localeCode?: string;
+}
+/** The token from a confirmation link. It is the only thing the public route accepts. */
+export interface ConfirmClinicEmailRequest {
+    token: string;
 }

package/dist/api/clinic/clinic-profile.type.d.ts

@@ -11,6 +11,8 @@ export interface ClinicProfile {
     tagline: Nullable<LocalizedText>;
     phone: Nullable<string>;
     email: Nullable<string>;
+    /** The clinic's public website, which the links in its emails point at. No path, no trailing slash. */
+    siteUrl: Nullable<string>;
     /** Nothing about the clinic is public until this is true. */
     isPublished: boolean;
     /** How long before a booking a client can still cancel it themselves. */
@@ -26,6 +28,7 @@ export interface SaveClinicProfileRequest {
     tagline?: Nullable<LocalizedText>;
     phone?: Nullable<string>;
     email?: Nullable<string>;
+    siteUrl?: Nullable<string>;
     isPublished: boolean;
     clientCancelCutoffHours: number;
     bookingHorizonDays: number;

package/dist/api/clinic/clinic-promotion.type.d.ts

@@ -0,0 +1,34 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { LocalizedText } from './localized-text.type.js';
+/**
+ * A percentage off the treatments it names, at the branches it names.
+ *
+ * `startsOn` and `endsOn` are calendar days (`YYYY-MM-DD`), both included, read in the branch's own
+ * time zone. What matters is the day of the visit, not the day it was booked.
+ */
+export interface ClinicPromotion {
+    id: UUID;
+    name: LocalizedText;
+    description: Nullable<LocalizedText>;
+    discountPercent: number;
+    startsOn: string;
+    endsOn: string;
+    /** Whether the site may announce this across the top of every page. */
+    showInBanner: boolean;
+    treatmentIds: UUID[];
+    locationIds: UUID[];
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface SaveClinicPromotionRequest {
+    name: LocalizedText;
+    description?: Nullable<LocalizedText>;
+    discountPercent: number;
+    startsOn: string;
+    endsOn: string;
+    showInBanner: boolean;
+    treatmentIds: UUID[];
+    locationIds: UUID[];
+}

package/dist/api/clinic/clinic-promotion.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/clinic-public.type.d.ts

@@ -34,6 +34,17 @@ export interface PublicTreatmentOption {
     name: LocalizedText;
     durationMinutes: number;
     priceMinor: number;
+    /** The price under the treatment's promotion, or null when there is none. */
+    promotionPriceMinor: Nullable<number>;
+}
+/** The best promotion running today for one treatment. */
+export interface PublicTreatmentPromotion {
+    id: UUID;
+    name: LocalizedText;
+    discountPercent: number;
+    endsOn: string;
+    /** Where it applies. Booking at any other branch costs the full price. */
+    locationIds: UUID[];
 }
 export interface PublicTreatment {
     id: UUID;
@@ -44,6 +55,7 @@ export interface PublicTreatment {
     minDaysBetweenSessions: Nullable<number>;
     isBookableOnline: boolean;
     options: PublicTreatmentOption[];
+    promotion: Nullable<PublicTreatmentPromotion>;
 }
 export interface PublicSpecialist {
     id: UUID;
@@ -51,3 +63,15 @@ export interface PublicSpecialist {
     locationId: UUID;
     treatmentIds: UUID[];
 }
+/** A promotion running today, biggest discount first. */
+export interface PublicPromotion {
+    id: UUID;
+    name: LocalizedText;
+    description: Nullable<LocalizedText>;
+    discountPercent: number;
+    startsOn: string;
+    endsOn: string;
+    showInBanner: boolean;
+    treatmentIds: UUID[];
+    locationIds: UUID[];
+}

package/dist/api/clinic/clinic-slot.type.d.ts

@@ -1,9 +1,16 @@
 import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
 import type { UUID } from '../../type/uuid.type.js';
+import type { LocalizedText } from './localized-text.type.js';
 /** A time one specialist can start this treatment, with a room and any machine free for all of it. */
 export interface ClinicSlot {
     staffMemberId: UUID;
     startsAt: IsoDateTime;
     /** When the treatment itself finishes, without the buffer after it. */
     endsAt: IsoDateTime;
+    /** What this visit would cost at this time, after any promotion. */
+    totalMinor: number;
+    /** How much a promotion takes off. Zero when none applies. */
+    discountMinor: number;
+    promotionName: Nullable<LocalizedText>;
 }

package/dist/api/clinic/index.d.ts

@@ -8,6 +8,7 @@ export * from './clinic-lead.type.js';
 export * from './clinic-location.type.js';
 export * from './clinic-my-appointment.type.js';
 export * from './clinic-profile.type.js';
+export * from './clinic-promotion.type.js';
 export * from './clinic-public.type.js';
 export * from './clinic-resource-status.enum.js';
 export * from './clinic-room.type.js';

package/dist/api/clinic/index.js

@@ -8,6 +8,7 @@ export * from './clinic-lead.type.js';
 export * from './clinic-location.type.js';
 export * from './clinic-my-appointment.type.js';
 export * from './clinic-profile.type.js';
+export * from './clinic-promotion.type.js';
 export * from './clinic-public.type.js';
 export * from './clinic-resource-status.enum.js';
 export * from './clinic-room.type.js';

package/dist/enum/user-permission.enum.d.ts

@@ -446,7 +446,11 @@ export declare enum UserPermission {
     /** Read callback requests and questions sent from a clinic's website or app. */
     CLINIC_LEAD_READ = "clinic:lead:read",
     /** Mark those requests as handled. */
-    CLINIC_LEAD_MANAGE = "clinic:lead:manage"
+    CLINIC_LEAD_MANAGE = "clinic:lead:manage",
+    /** See what a clinic is promoting and publishing. */
+    CLINIC_MARKETING_READ = "clinic:marketing:read",
+    /** Change what a clinic is promoting and publishing, including its discounts. */
+    CLINIC_MARKETING_MANAGE = "clinic:marketing:manage"
 }
 /**
  * Every member, for seeding the owner role and validating custom-role input.

package/dist/enum/user-permission.enum.js

@@ -509,6 +509,10 @@ export var UserPermission;
     UserPermission["CLINIC_LEAD_READ"] = "clinic:lead:read";
     /** Mark those requests as handled. */
     UserPermission["CLINIC_LEAD_MANAGE"] = "clinic:lead:manage";
+    /** See what a clinic is promoting and publishing. */
+    UserPermission["CLINIC_MARKETING_READ"] = "clinic:marketing:read";
+    /** Change what a clinic is promoting and publishing, including its discounts. */
+    UserPermission["CLINIC_MARKETING_MANAGE"] = "clinic:marketing:manage";
 })(UserPermission || (UserPermission = {}));
 /**
  * Every member, for seeding the owner role and validating custom-role input.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iveri/contracts",
-  "version": "0.42.0",
+  "version": "0.44.0",
   "description": "Wire contracts shared by every Iveri backend and frontend. Zero runtime dependencies.",
   "license": "MIT",
   "repository": {