@blackcode_sa/metaestetics-api 1.7.32 → 1.7.33

package/dist/admin/index.d.mts

@@ -1035,6 +1035,70 @@ declare enum ClinicTag {
     HOLIDAY_HOURS = "holiday_hours"
 }
 
+/**
+ * Enum for practitioner invite status
+ */
+declare enum PractitionerInviteStatus {
+    PENDING = "pending",
+    ACCEPTED = "accepted",
+    REJECTED = "rejected",
+    CANCELLED = "cancelled"
+}
+/**
+ * Interface for proposed working hours in practitioner invite
+ */
+interface ProposedWorkingHours {
+    monday: {
+        start: string;
+        end: string;
+    } | null;
+    tuesday: {
+        start: string;
+        end: string;
+    } | null;
+    wednesday: {
+        start: string;
+        end: string;
+    } | null;
+    thursday: {
+        start: string;
+        end: string;
+    } | null;
+    friday: {
+        start: string;
+        end: string;
+    } | null;
+    saturday: {
+        start: string;
+        end: string;
+    } | null;
+    sunday: {
+        start: string;
+        end: string;
+    } | null;
+}
+/**
+ * Main interface for practitioner invite
+ */
+interface PractitionerInvite {
+    id: string;
+    practitionerId: string;
+    clinicId: string;
+    practitionerInfo: PractitionerProfileInfo;
+    clinicInfo: ClinicInfo;
+    proposedWorkingHours: ProposedWorkingHours;
+    status: PractitionerInviteStatus;
+    invitedBy: string;
+    message?: string | null;
+    rejectionReason?: string | null;
+    cancelReason?: string | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    acceptedAt?: Timestamp | null;
+    rejectedAt?: Timestamp | null;
+    cancelledAt?: Timestamp | null;
+}
+
 /**
  * Interface for clinic contact information
  */
@@ -1919,6 +1983,102 @@ declare class PractitionerAggregationService {
     inactivateProceduresForPractitioner(procedureIds: string[]): Promise<void>;
 }
 
+/**
+ * @class PractitionerInviteAggregationService
+ * @description Handles aggregation tasks and side effects related to practitioner invite lifecycle events.
+ * This service is intended to be used primarily by background functions (e.g., Cloud Functions)
+ * triggered by changes in the practitioner-invites collection.
+ */
+declare class PractitionerInviteAggregationService {
+    private db;
+    /**
+     * Constructor for PractitionerInviteAggregationService.
+     * @param firestore Optional Firestore instance. If not provided, it uses the default admin SDK instance.
+     */
+    constructor(firestore?: admin.firestore.Firestore);
+    /**
+     * Handles side effects when a practitioner invite is first created.
+     * This function would typically be called by a Firestore onCreate trigger.
+     * @param {PractitionerInvite} invite - The newly created PractitionerInvite object.
+     * @returns {Promise<void>}
+     */
+    handleInviteCreate(invite: PractitionerInvite): Promise<void>;
+    /**
+     * Handles side effects when a practitioner invite is updated.
+     * This function would typically be called by a Firestore onUpdate trigger.
+     * @param {PractitionerInvite} before - The PractitionerInvite object before the update.
+     * @param {PractitionerInvite} after - The PractitionerInvite object after the update.
+     * @returns {Promise<void>}
+     */
+    handleInviteUpdate(before: PractitionerInvite, after: PractitionerInvite): Promise<void>;
+    /**
+     * Handles side effects when a practitioner invite is deleted.
+     * @param deletedInvite - The PractitionerInvite object that was deleted.
+     * @returns {Promise<void>}
+     */
+    handleInviteDelete(deletedInvite: PractitionerInvite): Promise<void>;
+    /**
+     * Handles the business logic when a practitioner accepts an invite.
+     * This includes adding the practitioner to the clinic and the clinic to the practitioner.
+     * @param {PractitionerInvite} invite - The accepted invite
+     * @returns {Promise<void>}
+     */
+    private handleInviteAccepted;
+    /**
+     * Handles the business logic when a practitioner rejects an invite.
+     * @param {PractitionerInvite} invite - The rejected invite
+     * @returns {Promise<void>}
+     */
+    private handleInviteRejected;
+    /**
+     * Handles the business logic when an invite is cancelled by admin.
+     * @param {PractitionerInvite} invite - The cancelled invite
+     * @returns {Promise<void>}
+     */
+    private handleInviteCancelled;
+    /**
+     * Adds practitioner information to a clinic when an invite is accepted.
+     * @param clinicId - ID of the clinic to update
+     * @param doctorInfo - Doctor information to add to the clinic
+     * @returns {Promise<void>}
+     */
+    private addPractitionerToClinic;
+    /**
+     * Updates practitioner information in a clinic.
+     * @param clinicId - ID of the clinic to update
+     * @param doctorInfo - Updated doctor information
+     * @returns {Promise<void>}
+     */
+    private updatePractitionerInfoInClinic;
+    /**
+     * Adds a clinic to a practitioner's profile with working hours from the invite.
+     * @param {string} practitionerId - The practitioner ID
+     * @param {ClinicInfo} clinicInfo - The clinic information
+     * @param {PractitionerInvite} invite - The accepted invite containing working hours
+     * @returns {Promise<void>}
+     */
+    private addClinicToPractitioner;
+    /**
+     * Updates the working hours for an existing practitioner-clinic relationship.
+     * @param {string} practitionerId - The practitioner ID
+     * @param {PractitionerInvite} invite - The accepted invite containing new working hours
+     * @returns {Promise<void>}
+     */
+    private updatePractitionerWorkingHours;
+    /**
+     * Fetches a practitioner by ID.
+     * @param practitionerId The practitioner ID.
+     * @returns {Promise<Practitioner | null>} The practitioner or null if not found.
+     */
+    private fetchPractitionerById;
+    /**
+     * Fetches a clinic by ID.
+     * @param clinicId The clinic ID.
+     * @returns {Promise<Clinic | null>} The clinic or null if not found.
+     */
+    private fetchClinicById;
+}
+
 /**
  * @class ProcedureAggregationService
  * @description Handles aggregation tasks related to procedure data updates/deletions.
@@ -2904,4 +3064,4 @@ declare class AppointmentMailingService extends BaseMailingService {
  */
 declare function freeConsultationInfrastructure(db?: admin.firestore.Firestore): Promise<boolean>;
 
-export { APPOINTMENTS_COLLECTION, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentMediaItem, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CalendarAdminService, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type CreateAppointmentData, type CreateAppointmentHttpData, type DoctorInfo, DocumentManagerAdminService, type FilledDocument, FilledFormsAggregationService, type InitializeAppointmentFormsResult, type LinkedFormInfo, Logger, MediaType, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientReviewInfo, PaymentStatus, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureExtendedInfo, type ProcedureSummaryInfo, type Review, type ReviewAddedEmailData, type ReviewRequestEmailData, ReviewsAggregationService, type SearchAppointmentsParams, type TimeInterval, type UpdateAppointmentData, UserRole, freeConsultationInfrastructure };
+export { APPOINTMENTS_COLLECTION, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentMediaItem, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CalendarAdminService, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type CreateAppointmentData, type CreateAppointmentHttpData, type DoctorInfo, DocumentManagerAdminService, type FilledDocument, FilledFormsAggregationService, type InitializeAppointmentFormsResult, type LinkedFormInfo, Logger, MediaType, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientReviewInfo, PaymentStatus, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, type PractitionerInvite, PractitionerInviteAggregationService, PractitionerInviteMailingService, PractitionerInviteStatus, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureExtendedInfo, type ProcedureSummaryInfo, type Review, type ReviewAddedEmailData, type ReviewRequestEmailData, ReviewsAggregationService, type SearchAppointmentsParams, type TimeInterval, type UpdateAppointmentData, UserRole, freeConsultationInfrastructure };

package/dist/admin/index.d.ts

@@ -1035,6 +1035,70 @@ declare enum ClinicTag {
     HOLIDAY_HOURS = "holiday_hours"
 }
 
+/**
+ * Enum for practitioner invite status
+ */
+declare enum PractitionerInviteStatus {
+    PENDING = "pending",
+    ACCEPTED = "accepted",
+    REJECTED = "rejected",
+    CANCELLED = "cancelled"
+}
+/**
+ * Interface for proposed working hours in practitioner invite
+ */
+interface ProposedWorkingHours {
+    monday: {
+        start: string;
+        end: string;
+    } | null;
+    tuesday: {
+        start: string;
+        end: string;
+    } | null;
+    wednesday: {
+        start: string;
+        end: string;
+    } | null;
+    thursday: {
+        start: string;
+        end: string;
+    } | null;
+    friday: {
+        start: string;
+        end: string;
+    } | null;
+    saturday: {
+        start: string;
+        end: string;
+    } | null;
+    sunday: {
+        start: string;
+        end: string;
+    } | null;
+}
+/**
+ * Main interface for practitioner invite
+ */
+interface PractitionerInvite {
+    id: string;
+    practitionerId: string;
+    clinicId: string;
+    practitionerInfo: PractitionerProfileInfo;
+    clinicInfo: ClinicInfo;
+    proposedWorkingHours: ProposedWorkingHours;
+    status: PractitionerInviteStatus;
+    invitedBy: string;
+    message?: string | null;
+    rejectionReason?: string | null;
+    cancelReason?: string | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    acceptedAt?: Timestamp | null;
+    rejectedAt?: Timestamp | null;
+    cancelledAt?: Timestamp | null;
+}
+
 /**
  * Interface for clinic contact information
  */
@@ -1919,6 +1983,102 @@ declare class PractitionerAggregationService {
     inactivateProceduresForPractitioner(procedureIds: string[]): Promise<void>;
 }
 
+/**
+ * @class PractitionerInviteAggregationService
+ * @description Handles aggregation tasks and side effects related to practitioner invite lifecycle events.
+ * This service is intended to be used primarily by background functions (e.g., Cloud Functions)
+ * triggered by changes in the practitioner-invites collection.
+ */
+declare class PractitionerInviteAggregationService {
+    private db;
+    /**
+     * Constructor for PractitionerInviteAggregationService.
+     * @param firestore Optional Firestore instance. If not provided, it uses the default admin SDK instance.
+     */
+    constructor(firestore?: admin.firestore.Firestore);
+    /**
+     * Handles side effects when a practitioner invite is first created.
+     * This function would typically be called by a Firestore onCreate trigger.
+     * @param {PractitionerInvite} invite - The newly created PractitionerInvite object.
+     * @returns {Promise<void>}
+     */
+    handleInviteCreate(invite: PractitionerInvite): Promise<void>;
+    /**
+     * Handles side effects when a practitioner invite is updated.
+     * This function would typically be called by a Firestore onUpdate trigger.
+     * @param {PractitionerInvite} before - The PractitionerInvite object before the update.
+     * @param {PractitionerInvite} after - The PractitionerInvite object after the update.
+     * @returns {Promise<void>}
+     */
+    handleInviteUpdate(before: PractitionerInvite, after: PractitionerInvite): Promise<void>;
+    /**
+     * Handles side effects when a practitioner invite is deleted.
+     * @param deletedInvite - The PractitionerInvite object that was deleted.
+     * @returns {Promise<void>}
+     */
+    handleInviteDelete(deletedInvite: PractitionerInvite): Promise<void>;
+    /**
+     * Handles the business logic when a practitioner accepts an invite.
+     * This includes adding the practitioner to the clinic and the clinic to the practitioner.
+     * @param {PractitionerInvite} invite - The accepted invite
+     * @returns {Promise<void>}
+     */
+    private handleInviteAccepted;
+    /**
+     * Handles the business logic when a practitioner rejects an invite.
+     * @param {PractitionerInvite} invite - The rejected invite
+     * @returns {Promise<void>}
+     */
+    private handleInviteRejected;
+    /**
+     * Handles the business logic when an invite is cancelled by admin.
+     * @param {PractitionerInvite} invite - The cancelled invite
+     * @returns {Promise<void>}
+     */
+    private handleInviteCancelled;
+    /**
+     * Adds practitioner information to a clinic when an invite is accepted.
+     * @param clinicId - ID of the clinic to update
+     * @param doctorInfo - Doctor information to add to the clinic
+     * @returns {Promise<void>}
+     */
+    private addPractitionerToClinic;
+    /**
+     * Updates practitioner information in a clinic.
+     * @param clinicId - ID of the clinic to update
+     * @param doctorInfo - Updated doctor information
+     * @returns {Promise<void>}
+     */
+    private updatePractitionerInfoInClinic;
+    /**
+     * Adds a clinic to a practitioner's profile with working hours from the invite.
+     * @param {string} practitionerId - The practitioner ID
+     * @param {ClinicInfo} clinicInfo - The clinic information
+     * @param {PractitionerInvite} invite - The accepted invite containing working hours
+     * @returns {Promise<void>}
+     */
+    private addClinicToPractitioner;
+    /**
+     * Updates the working hours for an existing practitioner-clinic relationship.
+     * @param {string} practitionerId - The practitioner ID
+     * @param {PractitionerInvite} invite - The accepted invite containing new working hours
+     * @returns {Promise<void>}
+     */
+    private updatePractitionerWorkingHours;
+    /**
+     * Fetches a practitioner by ID.
+     * @param practitionerId The practitioner ID.
+     * @returns {Promise<Practitioner | null>} The practitioner or null if not found.
+     */
+    private fetchPractitionerById;
+    /**
+     * Fetches a clinic by ID.
+     * @param clinicId The clinic ID.
+     * @returns {Promise<Clinic | null>} The clinic or null if not found.
+     */
+    private fetchClinicById;
+}
+
 /**
  * @class ProcedureAggregationService
  * @description Handles aggregation tasks related to procedure data updates/deletions.
@@ -2904,4 +3064,4 @@ declare class AppointmentMailingService extends BaseMailingService {
  */
 declare function freeConsultationInfrastructure(db?: admin.firestore.Firestore): Promise<boolean>;
 
-export { APPOINTMENTS_COLLECTION, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentMediaItem, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CalendarAdminService, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type CreateAppointmentData, type CreateAppointmentHttpData, type DoctorInfo, DocumentManagerAdminService, type FilledDocument, FilledFormsAggregationService, type InitializeAppointmentFormsResult, type LinkedFormInfo, Logger, MediaType, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientReviewInfo, PaymentStatus, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureExtendedInfo, type ProcedureSummaryInfo, type Review, type ReviewAddedEmailData, type ReviewRequestEmailData, ReviewsAggregationService, type SearchAppointmentsParams, type TimeInterval, type UpdateAppointmentData, UserRole, freeConsultationInfrastructure };
+export { APPOINTMENTS_COLLECTION, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentMediaItem, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CalendarAdminService, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type CreateAppointmentData, type CreateAppointmentHttpData, type DoctorInfo, DocumentManagerAdminService, type FilledDocument, FilledFormsAggregationService, type InitializeAppointmentFormsResult, type LinkedFormInfo, Logger, MediaType, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientReviewInfo, PaymentStatus, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, type PractitionerInvite, PractitionerInviteAggregationService, PractitionerInviteMailingService, PractitionerInviteStatus, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureExtendedInfo, type ProcedureSummaryInfo, type Review, type ReviewAddedEmailData, type ReviewRequestEmailData, ReviewsAggregationService, type SearchAppointmentsParams, type TimeInterval, type UpdateAppointmentData, UserRole, freeConsultationInfrastructure };