@iveri/contracts 0.48.0 → 0.49.0

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

@@ -0,0 +1,68 @@
+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 { ClinicPaymentMethod } from './clinic-payment-method.enum.js';
+import type { ClinicResourceStatus } from './clinic-resource-status.enum.js';
+import type { LocalizedText } from './localized-text.type.js';
+/** A prepaid package the clinic offers: so many sessions of one option at one price. */
+export interface ClinicCoursePlan {
+    id: UUID;
+    treatmentId: UUID;
+    optionId: UUID;
+    name: LocalizedText;
+    sessionCount: number;
+    priceMinor: number;
+    currency: string;
+    /** How long a sold course lasts, or `null` when it does not run out. */
+    validityDays: Nullable<number>;
+    status: ClinicResourceStatus;
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface CreateClinicCoursePlanRequest {
+    optionId: UUID;
+    name: LocalizedText;
+    sessionCount: number;
+    priceMinor: number;
+    validityDays?: Nullable<number>;
+}
+export interface UpdateClinicCoursePlanRequest {
+    name?: LocalizedText;
+    sessionCount?: number;
+    priceMinor?: number;
+    validityDays?: Nullable<number>;
+    status?: ClinicResourceStatus;
+}
+/** A course a client has bought, holding what was agreed then. A later change to the plan does not touch it. */
+export interface ClinicCourse {
+    id: UUID;
+    clientId: UUID;
+    planId: UUID;
+    treatmentId: UUID;
+    optionId: UUID;
+    name: LocalizedText;
+    sessionsTotal: number;
+    sessionsUsed: number;
+    priceMinor: number;
+    currency: string;
+    expiresAt: Nullable<IsoDateTime>;
+    /** Set when the course was refunded, after which its remaining sessions are gone. */
+    closedAt: Nullable<IsoDateTime>;
+    createdAt: IsoDateTime;
+}
+export interface SellClinicCourseRequest {
+    planId: UUID;
+    locationId: UUID;
+    method: ClinicPaymentMethod;
+    note?: Nullable<string>;
+}
+/** A client's own view of a course they bought. */
+export interface MyClinicCourse {
+    id: UUID;
+    treatmentId: UUID;
+    name: LocalizedText;
+    sessionsTotal: number;
+    sessionsUsed: number;
+    expiresAt: Nullable<IsoDateTime>;
+    isClosed: boolean;
+}

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

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

package/dist/api/clinic/clinic-payment-method.enum.d.ts

@@ -0,0 +1,13 @@
+/**
+ * How a visit was paid for. The first three are money the clinic received.
+ *
+ * `course` and `bonus` settle a visit without any money changing hands that day, so a day's takings
+ * keep them apart: the money for a course came in on the day it was sold.
+ */
+export declare enum ClinicPaymentMethod {
+    CASH = "cash",
+    CARD = "card",
+    TRANSFER = "transfer",
+    COURSE = "course",
+    BONUS = "bonus"
+}

package/dist/api/clinic/clinic-payment-method.enum.js

@@ -0,0 +1,14 @@
+/**
+ * How a visit was paid for. The first three are money the clinic received.
+ *
+ * `course` and `bonus` settle a visit without any money changing hands that day, so a day's takings
+ * keep them apart: the money for a course came in on the day it was sold.
+ */
+export var ClinicPaymentMethod;
+(function (ClinicPaymentMethod) {
+    ClinicPaymentMethod["CASH"] = "cash";
+    ClinicPaymentMethod["CARD"] = "card";
+    ClinicPaymentMethod["TRANSFER"] = "transfer";
+    ClinicPaymentMethod["COURSE"] = "course";
+    ClinicPaymentMethod["BONUS"] = "bonus";
+})(ClinicPaymentMethod || (ClinicPaymentMethod = {}));

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

@@ -0,0 +1,112 @@
+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 { ClinicAppointmentStatus } from './clinic-appointment-status.enum.js';
+import type { ClinicCourse, MyClinicCourse } from './clinic-course.type.js';
+import type { ClinicPaymentMethod } from './clinic-payment-method.enum.js';
+import type { LocalizedText } from './localized-text.type.js';
+/** One line in the clinic's ledger. It is never edited: money given back is a new line pointing at it. */
+export interface ClinicPayment {
+    id: UUID;
+    locationId: UUID;
+    clientId: UUID;
+    clientName: string;
+    /** The visit this was for, or `null` when it paid for a course. */
+    appointmentId: Nullable<UUID>;
+    /** The course this sold or used, or `null` when no course was involved. */
+    courseId: Nullable<UUID>;
+    method: ClinicPaymentMethod;
+    /** Negative for a refund. */
+    amountMinor: number;
+    currency: string;
+    refundsPaymentId: Nullable<UUID>;
+    /** Why money was given back. Only a refund has one. */
+    reason: Nullable<string>;
+    note: Nullable<string>;
+    /** How much of this can still be given back. Always zero on a refund. */
+    refundableMinor: number;
+    recordedByName: Nullable<string>;
+    createdAt: IsoDateTime;
+}
+export interface RecordClinicPaymentRequest {
+    method: ClinicPaymentMethod;
+    /** Required except for a course, whose session is worth what its line on the visit costs. */
+    amountMinor?: number;
+    /** Required for a course. */
+    courseId?: UUID;
+    note?: Nullable<string>;
+}
+export interface RefundClinicPaymentRequest {
+    /** Omitted to give back everything left. A course session or bonus is always given back whole. */
+    amountMinor?: number;
+    reason: string;
+}
+export interface ClinicBonusBalance {
+    currency: string;
+    amountMinor: number;
+}
+/** What reception needs at the desk for one visit. */
+export interface ClinicVisitPayments {
+    appointmentId: UUID;
+    clientId: UUID;
+    clientName: string;
+    locationId: UUID;
+    treatmentName: LocalizedText;
+    status: ClinicAppointmentStatus;
+    currency: string;
+    totalMinor: number;
+    paidMinor: number;
+    dueMinor: number;
+    payments: ClinicPayment[];
+    /** This client's bonus in the visit's currency. */
+    bonusBalanceMinor: number;
+    /** This client's courses that can pay for a line of this visit. */
+    usableCourses: ClinicCourse[];
+}
+/** How much has been paid towards one visit. */
+export interface ClinicVisitBalance {
+    appointmentId: UUID;
+    paidMinor: number;
+}
+export interface ClinicClientAccount {
+    clientId: UUID;
+    clientName: string;
+    bonusBalances: ClinicBonusBalance[];
+    courses: ClinicCourse[];
+    /** The newest payments, whatever they were for. */
+    payments: ClinicPayment[];
+}
+/** One currency's day. The three money figures are net of refunds, so cash is what the drawer should hold. */
+export interface ClinicTakingsLine {
+    currency: string;
+    cashMinor: number;
+    cardMinor: number;
+    transferMinor: number;
+    netMinor: number;
+    refundedMinor: number;
+    courseRedeemedMinor: number;
+    bonusSpentMinor: number;
+}
+/** A visit that finished with money still owing. */
+export interface ClinicUnsettledVisit {
+    appointmentId: UUID;
+    clientName: string;
+    treatmentName: LocalizedText;
+    currency: string;
+    totalMinor: number;
+    paidMinor: number;
+    dueMinor: number;
+}
+export interface ClinicDailyTakings {
+    locationId: UUID;
+    /** The branch's own calendar day, `YYYY-MM-DD`. */
+    date: string;
+    lines: ClinicTakingsLine[];
+    payments: ClinicPayment[];
+    unsettled: ClinicUnsettledVisit[];
+}
+/** What a client holds at this clinic. */
+export interface MyClinicWallet {
+    bonusBalances: ClinicBonusBalance[];
+    courses: MyClinicCourse[];
+}

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

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

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

@@ -19,6 +19,8 @@ export interface ClinicProfile {
     clientCancelCutoffHours: number;
     /** How far ahead a client can book. */
     bookingHorizonDays: number;
+    /** The share of money paid that comes back as bonus. Zero means the clinic runs no bonus programme. */
+    bonusEarnPercent: number;
     createdAt: IsoDateTime;
     updatedAt: IsoDateTime;
 }
@@ -32,4 +34,5 @@ export interface SaveClinicProfileRequest {
     isPublished: boolean;
     clientCancelCutoffHours: number;
     bookingHorizonDays: number;
+    bonusEarnPercent?: number;
 }

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

@@ -2,6 +2,7 @@ export * from './clinic-appointment-status.enum.js';
 export * from './clinic-appointment.type.js';
 export * from './clinic-client.type.js';
 export * from './clinic-consent-form.type.js';
+export * from './clinic-course.type.js';
 export * from './clinic-device.type.js';
 export * from './clinic-lead-kind.enum.js';
 export * from './clinic-lead-status.enum.js';
@@ -14,6 +15,8 @@ export * from './clinic-gallery.type.js';
 export * from './clinic-media.type.js';
 export * from './clinic-newsletter-channel.enum.js';
 export * from './clinic-newsletter.type.js';
+export * from './clinic-payment-method.enum.js';
+export * from './clinic-payment.type.js';
 export * from './clinic-profile.type.js';
 export * from './clinic-promotion.type.js';
 export * from './clinic-public.type.js';

package/dist/api/clinic/index.js

@@ -2,6 +2,7 @@ export * from './clinic-appointment-status.enum.js';
 export * from './clinic-appointment.type.js';
 export * from './clinic-client.type.js';
 export * from './clinic-consent-form.type.js';
+export * from './clinic-course.type.js';
 export * from './clinic-device.type.js';
 export * from './clinic-lead-kind.enum.js';
 export * from './clinic-lead-status.enum.js';
@@ -14,6 +15,8 @@ export * from './clinic-gallery.type.js';
 export * from './clinic-media.type.js';
 export * from './clinic-newsletter-channel.enum.js';
 export * from './clinic-newsletter.type.js';
+export * from './clinic-payment-method.enum.js';
+export * from './clinic-payment.type.js';
 export * from './clinic-profile.type.js';
 export * from './clinic-promotion.type.js';
 export * from './clinic-public.type.js';

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

@@ -456,7 +456,13 @@ export declare enum UserPermission {
     /** Add to a client's clinical record: screening answers, signed consent and the treatment log. */
     CLINIC_RECORD_MANAGE = "clinic:record:manage",
     /** See who has read a client's clinical record, which reading the record does not show. */
-    CLINIC_RECORD_AUDIT = "clinic:record:audit"
+    CLINIC_RECORD_AUDIT = "clinic:record:audit",
+    /** See what has been paid, each client's balance and the day's takings. */
+    CLINIC_PAYMENT_READ = "clinic:payment:read",
+    /** Record money taken at the desk and sell prepaid courses. */
+    CLINIC_PAYMENT_RECORD = "clinic:payment:record",
+    /** Give money back. Its own permission, because reception taking money does not imply returning it. */
+    CLINIC_PAYMENT_REFUND = "clinic:payment:refund"
 }
 /**
  * Every member, for seeding the owner role and validating custom-role input.

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

@@ -519,6 +519,12 @@ export var UserPermission;
     UserPermission["CLINIC_RECORD_MANAGE"] = "clinic:record:manage";
     /** See who has read a client's clinical record, which reading the record does not show. */
     UserPermission["CLINIC_RECORD_AUDIT"] = "clinic:record:audit";
+    /** See what has been paid, each client's balance and the day's takings. */
+    UserPermission["CLINIC_PAYMENT_READ"] = "clinic:payment:read";
+    /** Record money taken at the desk and sell prepaid courses. */
+    UserPermission["CLINIC_PAYMENT_RECORD"] = "clinic:payment:record";
+    /** Give money back. Its own permission, because reception taking money does not imply returning it. */
+    UserPermission["CLINIC_PAYMENT_REFUND"] = "clinic:payment:refund";
 })(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.48.0",
+  "version": "0.49.0",
   "description": "Wire contracts shared by every Iveri backend and frontend. Zero runtime dependencies.",
   "license": "MIT",
   "repository": {