@blackcode_sa/metaestetics-api 1.14.29 → 1.14.34

package/dist/admin/index.d.mts

@@ -2030,6 +2030,49 @@ interface PatientRequirementInstance {
  */
 declare const PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME = "patientRequirements";
 
+declare const INVITE_TOKENS_COLLECTION = "inviteTokens";
+/**
+ * @enum PatientTokenStatus
+ * @description Represents the status of a patient registration token.
+ * @property {string} ACTIVE - The token is active and can be used for registration.
+ * @property {string} USED - The token has been used and is no longer valid.
+ * @property {string} EXPIRED - The token has expired and is no longer valid.
+ */
+declare enum PatientTokenStatus {
+    ACTIVE = "active",
+    USED = "used",
+    EXPIRED = "expired"
+}
+/**
+ * @interface PatientToken
+ * @description Represents a registration token for a patient to claim their profile.
+ * These tokens are stored in a subcollection under the patient's profile.
+ * @property {string} id - The unique identifier for the token document.
+ * @property {string} token - The unique token string (e.g., a 6-character code).
+ * @property {string} patientId - The ID of the patient profile this token is for.
+ * @property {string} email - The email address the invitation was sent to.
+ * @property {string} clinicId - The ID of the clinic that created the invitation.
+ * @property {PatientTokenStatus} status - The current status of the token.
+ * @property {string} createdBy - The ID of the admin user who created the token.
+ * @property {Timestamp} createdAt - The timestamp when the token was created.
+ * @property {Timestamp} expiresAt - The timestamp when the token expires.
+ * @property {string} [usedBy] - The ID of the user who used the token (optional).
+ * @property {Timestamp} [usedAt] - The timestamp when the token was used (optional).
+ */
+interface PatientToken {
+    id: string;
+    token: string;
+    patientId: string;
+    email: string;
+    clinicId: string;
+    status: PatientTokenStatus;
+    createdBy: string;
+    createdAt: Timestamp;
+    expiresAt: Timestamp;
+    usedBy?: string;
+    usedAt?: Timestamp;
+}
+
 /**
  * Base metrics interface with common properties
  */
@@ -3085,11 +3128,11 @@ type Notification = PreRequirementNotification | PostRequirementNotification | R
  * This helps avoid a direct dependency on mailgun.js in the API package if not desired,
  * or provides clearer typing if it is.
  */
-interface NewMailgunMessagesAPI$2 {
+interface NewMailgunMessagesAPI$3 {
     create(domain: string, data: any): Promise<any>;
 }
-interface NewMailgunClient$2 {
-    messages: NewMailgunMessagesAPI$2;
+interface NewMailgunClient$3 {
+    messages: NewMailgunMessagesAPI$3;
 }
 /**
  * Base mailing service class that provides common functionality for all mailing services
@@ -3097,13 +3140,13 @@ interface NewMailgunClient$2 {
  */
 declare class BaseMailingService {
     protected db: FirebaseFirestore.Firestore;
-    protected mailgunClient: NewMailgunClient$2;
+    protected mailgunClient: NewMailgunClient$3;
     /**
      * Constructor for BaseMailingService
      * @param firestore Firestore instance provided by the caller
      * @param mailgunClient Mailgun client instance (mailgun.js v10+) provided by the caller
      */
-    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$2);
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$3);
     /**
      * Sends an email using the new Mailgun client API.
      * @param domain The Mailgun domain to send from (e.g., mg.metaesthetics.net)
@@ -3132,11 +3175,11 @@ declare class BaseMailingService {
     protected renderTemplate(template: string, variables: Record<string, string>): string;
 }
 
-interface NewMailgunMessagesAPI$1 {
+interface NewMailgunMessagesAPI$2 {
     create(domain: string, data: any): Promise<any>;
 }
-interface NewMailgunClient$1 {
-    messages: NewMailgunMessagesAPI$1;
+interface NewMailgunClient$2 {
+    messages: NewMailgunMessagesAPI$2;
 }
 /**
  * Interface for the data required to send a practitioner invitation email
@@ -3182,7 +3225,7 @@ declare class PractitionerInviteMailingService extends BaseMailingService {
      * @param firestore Firestore instance provided by the caller
      * @param mailgunClient Mailgun client instance (mailgun.js v10+) provided by the caller
      */
-    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$1);
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$2);
     /**
      * Sends a practitioner invitation email
      * @param data The practitioner invitation data
@@ -3205,11 +3248,11 @@ declare class PractitionerInviteMailingService extends BaseMailingService {
     }): Promise<void>;
 }
 
-interface NewMailgunMessagesAPI {
+interface NewMailgunMessagesAPI$1 {
     create(domain: string, data: any): Promise<any>;
 }
-interface NewMailgunClient {
-    messages: NewMailgunMessagesAPI;
+interface NewMailgunClient$1 {
+    messages: NewMailgunMessagesAPI$1;
 }
 /**
  * Interface for sending practitioner invitation email data
@@ -3295,7 +3338,7 @@ declare class ExistingPractitionerInviteMailingService extends BaseMailingServic
      * @param firestore Firestore instance provided by the caller
      * @param mailgunClient Mailgun client instance (mailgun.js v10+) provided by the caller
      */
-    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient);
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$1);
     /**
      * Sends an invitation email to an existing practitioner
      * @param data The invitation email data
@@ -4466,6 +4509,81 @@ declare class Logger {
     static debug(message: string, data?: any): void;
 }
 
+/**
+ * Minimal interface for the mailgun.js client if not importing full types
+ */
+interface NewMailgunMessagesAPI {
+    create(domain: string, data: any): Promise<any>;
+}
+interface NewMailgunClient {
+    messages: NewMailgunMessagesAPI;
+}
+/**
+ * Interface for the data required to send a patient invitation email
+ */
+interface PatientInviteEmailData {
+    /** The token object from the patient service */
+    token: {
+        id: string;
+        token: string;
+        patientId: string;
+        email: string;
+        clinicId: string;
+        expiresAt: admin.firestore.Timestamp;
+    };
+    /** Patient basic info */
+    patient: {
+        firstName: string;
+        lastName: string;
+    };
+    /** Clinic info */
+    clinic: {
+        name: string;
+        contactEmail: string;
+        contactName?: string;
+    };
+    /** Config options */
+    options?: {
+        registrationUrl?: string;
+        customSubject?: string;
+        fromAddress?: string;
+        mailgunDomain?: string;
+    };
+}
+/**
+ * Service for sending patient invitation emails
+ * Follows the same pattern as PractitionerInviteMailingService
+ */
+declare class PatientInviteMailingService extends BaseMailingService {
+    private readonly DEFAULT_REGISTRATION_URL;
+    private readonly DEFAULT_SUBJECT;
+    private readonly DEFAULT_MAILGUN_DOMAIN;
+    /**
+     * Constructor for PatientInviteMailingService
+     * @param firestore - Firestore instance provided by the caller
+     * @param mailgunClient - Mailgun client instance (mailgun.js v10+) provided by the caller
+     */
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient);
+    /**
+     * Sends a patient invitation email
+     * @param data - The patient invitation data
+     * @returns Promise resolved when email is sent
+     */
+    sendInvitationEmail(data: PatientInviteEmailData): Promise<any>;
+    /**
+     * Handles the patient token creation event from Cloud Functions.
+     * Fetches necessary data and sends the invitation email.
+     * @param tokenData - The fully typed token object including its id
+     * @param mailgunConfig - Mailgun configuration (from, domain, optional registrationUrl)
+     * @returns Promise resolved when the email is sent
+     */
+    handleTokenCreationEvent(tokenData: PatientToken, mailgunConfig: {
+        fromAddress: string;
+        domain: string;
+        registrationUrl?: string;
+    }): Promise<void>;
+}
+
 interface AppointmentEmailDataBase {
     appointment: Appointment;
     options?: {
@@ -4507,7 +4625,7 @@ interface ReviewAddedEmailData extends AppointmentEmailDataBase {
  */
 declare class AppointmentMailingService extends BaseMailingService {
     private readonly DEFAULT_MAILGUN_DOMAIN;
-    constructor(firestore: admin.firestore.Firestore, mailgunClient: NewMailgunClient$2);
+    constructor(firestore: admin.firestore.Firestore, mailgunClient: NewMailgunClient$3);
     /**
      * Formats a Firestore Timestamp in the clinic's timezone
      * @param timestamp - Firestore Timestamp (UTC)
@@ -4678,4 +4796,4 @@ declare class UserProfileAdminService {
     initializePractitionerRole(userId: string): Promise<User>;
 }
 
-export { ANALYTICS_COLLECTION, AnalyticsAdminService, type AnalyticsDateRange, type AnalyticsFilters, type AnalyticsMetadata, type AnalyticsPeriod, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AppointmentTrend, type AvailableSlot, BaseMailingService, type BaseMetrics, type BaseNotification, type BillingInfo, type BillingTransaction, BillingTransactionType, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CANCELLATION_ANALYTICS_SUBCOLLECTION, CLINICS_COLLECTION, CLINIC_ANALYTICS_SUBCOLLECTION, CalendarAdminService, type CancellationMetrics, type CancellationRateTrend, type CancellationReasonStats, type Clinic, type ClinicAdminNotificationData, ClinicAggregationService, type ClinicAnalytics, type ClinicComparisonMetrics, type ClinicInfo, type ClinicLocation, type CostPerPatientMetrics, type CreateBillingTransactionData, DASHBOARD_ANALYTICS_SUBCOLLECTION, type DashboardAnalytics, type DoctorInfo, DocumentManagerAdminService, type DurationTrend, type EntityType, type ExistingPractitionerInviteEmailData, ExistingPractitionerInviteMailingService, type FilledDocument, FilledFormsAggregationService, type GroupedAnalyticsBase, type GroupedPatientBehaviorMetrics, type GroupedPatientRetentionMetrics, type GroupedPractitionerPerformanceMetrics, type GroupedProcedurePerformanceMetrics, type GroupedProductUsageMetrics, type GroupedRevenueMetrics, type GroupedTimeEfficiencyMetrics, type GroupingPeriod, type InitializeAppointmentFormsResult, Logger, NOTIFICATIONS_COLLECTION, NO_SHOW_ANALYTICS_SUBCOLLECTION, type NewMailgunClient$2 as NewMailgunClient, type NoShowMetrics, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENTS_COLLECTION, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, PATIENT_SENSITIVE_INFO_COLLECTION, PRACTITIONER_ANALYTICS_SUBCOLLECTION, PROCEDURE_ANALYTICS_SUBCOLLECTION, type PatientProfile as Patient, PatientAggregationService, type PatientAnalytics, PatientInstructionStatus, type PatientLifetimeValueMetrics, type PatientProfile, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientRetentionMetrics, type PatientSensitiveInfo, type PaymentStatusBreakdown, type PlanDetails, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, type PractitionerAnalytics, type PractitionerInvite, PractitionerInviteAggregationService, type PractitionerInviteEmailData, PractitionerInviteMailingService, PractitionerInviteStatus, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureAnalytics, type ProcedurePopularity, type ProcedureProfitability, type ProcedureSummaryInfo, type ProductRevenueMetrics, type ProductUsageByProcedure, type ProductUsageMetrics, REVENUE_ANALYTICS_SUBCOLLECTION, type ReadStoredAnalyticsOptions, type RequirementSourceProcedure, type RevenueMetrics, type RevenueTrend, type Review, type ReviewAddedEmailData, type ReviewMetrics, type ReviewRequestEmailData, type ReviewTrend, ReviewsAggregationService, type StoredCancellationMetrics, type StoredClinicAnalytics, type StoredDashboardAnalytics, type StoredNoShowMetrics, type StoredPractitionerAnalytics, type StoredProcedureAnalytics, type StoredRevenueMetrics, type StoredTimeEfficiencyMetrics, type StripeTransactionData, SubscriptionStatus, TIME_EFFICIENCY_ANALYTICS_SUBCOLLECTION, type TimeEfficiencyMetrics, type TimeInterval, type TrendPeriod, UserProfileAdminService, UserRole, freeConsultationInfrastructure };
+export { ANALYTICS_COLLECTION, AnalyticsAdminService, type AnalyticsDateRange, type AnalyticsFilters, type AnalyticsMetadata, type AnalyticsPeriod, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AppointmentTrend, type AvailableSlot, BaseMailingService, type BaseMetrics, type BaseNotification, type BillingInfo, type BillingTransaction, BillingTransactionType, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CANCELLATION_ANALYTICS_SUBCOLLECTION, CLINICS_COLLECTION, CLINIC_ANALYTICS_SUBCOLLECTION, CalendarAdminService, type CancellationMetrics, type CancellationRateTrend, type CancellationReasonStats, type Clinic, type ClinicAdminNotificationData, ClinicAggregationService, type ClinicAnalytics, type ClinicComparisonMetrics, type ClinicInfo, type ClinicLocation, type CostPerPatientMetrics, type CreateBillingTransactionData, DASHBOARD_ANALYTICS_SUBCOLLECTION, type DashboardAnalytics, type DoctorInfo, DocumentManagerAdminService, type DurationTrend, type EntityType, type ExistingPractitionerInviteEmailData, ExistingPractitionerInviteMailingService, type FilledDocument, FilledFormsAggregationService, type GroupedAnalyticsBase, type GroupedPatientBehaviorMetrics, type GroupedPatientRetentionMetrics, type GroupedPractitionerPerformanceMetrics, type GroupedProcedurePerformanceMetrics, type GroupedProductUsageMetrics, type GroupedRevenueMetrics, type GroupedTimeEfficiencyMetrics, type GroupingPeriod, INVITE_TOKENS_COLLECTION, type InitializeAppointmentFormsResult, Logger, NOTIFICATIONS_COLLECTION, NO_SHOW_ANALYTICS_SUBCOLLECTION, type NewMailgunClient$3 as NewMailgunClient, type NoShowMetrics, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENTS_COLLECTION, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, PATIENT_SENSITIVE_INFO_COLLECTION, PRACTITIONER_ANALYTICS_SUBCOLLECTION, PROCEDURE_ANALYTICS_SUBCOLLECTION, type PatientProfile as Patient, PatientAggregationService, type PatientAnalytics, PatientInstructionStatus, type PatientInviteEmailData, PatientInviteMailingService, type PatientLifetimeValueMetrics, type PatientProfile, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientRetentionMetrics, type PatientSensitiveInfo, type PatientToken, PatientTokenStatus, type PaymentStatusBreakdown, type PlanDetails, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, type PractitionerAnalytics, type PractitionerInvite, PractitionerInviteAggregationService, type PractitionerInviteEmailData, PractitionerInviteMailingService, PractitionerInviteStatus, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureAnalytics, type ProcedurePopularity, type ProcedureProfitability, type ProcedureSummaryInfo, type ProductRevenueMetrics, type ProductUsageByProcedure, type ProductUsageMetrics, REVENUE_ANALYTICS_SUBCOLLECTION, type ReadStoredAnalyticsOptions, type RequirementSourceProcedure, type RevenueMetrics, type RevenueTrend, type Review, type ReviewAddedEmailData, type ReviewMetrics, type ReviewRequestEmailData, type ReviewTrend, ReviewsAggregationService, type StoredCancellationMetrics, type StoredClinicAnalytics, type StoredDashboardAnalytics, type StoredNoShowMetrics, type StoredPractitionerAnalytics, type StoredProcedureAnalytics, type StoredRevenueMetrics, type StoredTimeEfficiencyMetrics, type StripeTransactionData, SubscriptionStatus, TIME_EFFICIENCY_ANALYTICS_SUBCOLLECTION, type TimeEfficiencyMetrics, type TimeInterval, type TrendPeriod, UserProfileAdminService, UserRole, freeConsultationInfrastructure };

package/dist/admin/index.d.ts

@@ -2030,6 +2030,49 @@ interface PatientRequirementInstance {
  */
 declare const PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME = "patientRequirements";
 
+declare const INVITE_TOKENS_COLLECTION = "inviteTokens";
+/**
+ * @enum PatientTokenStatus
+ * @description Represents the status of a patient registration token.
+ * @property {string} ACTIVE - The token is active and can be used for registration.
+ * @property {string} USED - The token has been used and is no longer valid.
+ * @property {string} EXPIRED - The token has expired and is no longer valid.
+ */
+declare enum PatientTokenStatus {
+    ACTIVE = "active",
+    USED = "used",
+    EXPIRED = "expired"
+}
+/**
+ * @interface PatientToken
+ * @description Represents a registration token for a patient to claim their profile.
+ * These tokens are stored in a subcollection under the patient's profile.
+ * @property {string} id - The unique identifier for the token document.
+ * @property {string} token - The unique token string (e.g., a 6-character code).
+ * @property {string} patientId - The ID of the patient profile this token is for.
+ * @property {string} email - The email address the invitation was sent to.
+ * @property {string} clinicId - The ID of the clinic that created the invitation.
+ * @property {PatientTokenStatus} status - The current status of the token.
+ * @property {string} createdBy - The ID of the admin user who created the token.
+ * @property {Timestamp} createdAt - The timestamp when the token was created.
+ * @property {Timestamp} expiresAt - The timestamp when the token expires.
+ * @property {string} [usedBy] - The ID of the user who used the token (optional).
+ * @property {Timestamp} [usedAt] - The timestamp when the token was used (optional).
+ */
+interface PatientToken {
+    id: string;
+    token: string;
+    patientId: string;
+    email: string;
+    clinicId: string;
+    status: PatientTokenStatus;
+    createdBy: string;
+    createdAt: Timestamp;
+    expiresAt: Timestamp;
+    usedBy?: string;
+    usedAt?: Timestamp;
+}
+
 /**
  * Base metrics interface with common properties
  */
@@ -3085,11 +3128,11 @@ type Notification = PreRequirementNotification | PostRequirementNotification | R
  * This helps avoid a direct dependency on mailgun.js in the API package if not desired,
  * or provides clearer typing if it is.
  */
-interface NewMailgunMessagesAPI$2 {
+interface NewMailgunMessagesAPI$3 {
     create(domain: string, data: any): Promise<any>;
 }
-interface NewMailgunClient$2 {
-    messages: NewMailgunMessagesAPI$2;
+interface NewMailgunClient$3 {
+    messages: NewMailgunMessagesAPI$3;
 }
 /**
  * Base mailing service class that provides common functionality for all mailing services
@@ -3097,13 +3140,13 @@ interface NewMailgunClient$2 {
  */
 declare class BaseMailingService {
     protected db: FirebaseFirestore.Firestore;
-    protected mailgunClient: NewMailgunClient$2;
+    protected mailgunClient: NewMailgunClient$3;
     /**
      * Constructor for BaseMailingService
      * @param firestore Firestore instance provided by the caller
      * @param mailgunClient Mailgun client instance (mailgun.js v10+) provided by the caller
      */
-    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$2);
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$3);
     /**
      * Sends an email using the new Mailgun client API.
      * @param domain The Mailgun domain to send from (e.g., mg.metaesthetics.net)
@@ -3132,11 +3175,11 @@ declare class BaseMailingService {
     protected renderTemplate(template: string, variables: Record<string, string>): string;
 }
 
-interface NewMailgunMessagesAPI$1 {
+interface NewMailgunMessagesAPI$2 {
     create(domain: string, data: any): Promise<any>;
 }
-interface NewMailgunClient$1 {
-    messages: NewMailgunMessagesAPI$1;
+interface NewMailgunClient$2 {
+    messages: NewMailgunMessagesAPI$2;
 }
 /**
  * Interface for the data required to send a practitioner invitation email
@@ -3182,7 +3225,7 @@ declare class PractitionerInviteMailingService extends BaseMailingService {
      * @param firestore Firestore instance provided by the caller
      * @param mailgunClient Mailgun client instance (mailgun.js v10+) provided by the caller
      */
-    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$1);
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$2);
     /**
      * Sends a practitioner invitation email
      * @param data The practitioner invitation data
@@ -3205,11 +3248,11 @@ declare class PractitionerInviteMailingService extends BaseMailingService {
     }): Promise<void>;
 }
 
-interface NewMailgunMessagesAPI {
+interface NewMailgunMessagesAPI$1 {
     create(domain: string, data: any): Promise<any>;
 }
-interface NewMailgunClient {
-    messages: NewMailgunMessagesAPI;
+interface NewMailgunClient$1 {
+    messages: NewMailgunMessagesAPI$1;
 }
 /**
  * Interface for sending practitioner invitation email data
@@ -3295,7 +3338,7 @@ declare class ExistingPractitionerInviteMailingService extends BaseMailingServic
      * @param firestore Firestore instance provided by the caller
      * @param mailgunClient Mailgun client instance (mailgun.js v10+) provided by the caller
      */
-    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient);
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$1);
     /**
      * Sends an invitation email to an existing practitioner
      * @param data The invitation email data
@@ -4466,6 +4509,81 @@ declare class Logger {
     static debug(message: string, data?: any): void;
 }
 
+/**
+ * Minimal interface for the mailgun.js client if not importing full types
+ */
+interface NewMailgunMessagesAPI {
+    create(domain: string, data: any): Promise<any>;
+}
+interface NewMailgunClient {
+    messages: NewMailgunMessagesAPI;
+}
+/**
+ * Interface for the data required to send a patient invitation email
+ */
+interface PatientInviteEmailData {
+    /** The token object from the patient service */
+    token: {
+        id: string;
+        token: string;
+        patientId: string;
+        email: string;
+        clinicId: string;
+        expiresAt: admin.firestore.Timestamp;
+    };
+    /** Patient basic info */
+    patient: {
+        firstName: string;
+        lastName: string;
+    };
+    /** Clinic info */
+    clinic: {
+        name: string;
+        contactEmail: string;
+        contactName?: string;
+    };
+    /** Config options */
+    options?: {
+        registrationUrl?: string;
+        customSubject?: string;
+        fromAddress?: string;
+        mailgunDomain?: string;
+    };
+}
+/**
+ * Service for sending patient invitation emails
+ * Follows the same pattern as PractitionerInviteMailingService
+ */
+declare class PatientInviteMailingService extends BaseMailingService {
+    private readonly DEFAULT_REGISTRATION_URL;
+    private readonly DEFAULT_SUBJECT;
+    private readonly DEFAULT_MAILGUN_DOMAIN;
+    /**
+     * Constructor for PatientInviteMailingService
+     * @param firestore - Firestore instance provided by the caller
+     * @param mailgunClient - Mailgun client instance (mailgun.js v10+) provided by the caller
+     */
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient);
+    /**
+     * Sends a patient invitation email
+     * @param data - The patient invitation data
+     * @returns Promise resolved when email is sent
+     */
+    sendInvitationEmail(data: PatientInviteEmailData): Promise<any>;
+    /**
+     * Handles the patient token creation event from Cloud Functions.
+     * Fetches necessary data and sends the invitation email.
+     * @param tokenData - The fully typed token object including its id
+     * @param mailgunConfig - Mailgun configuration (from, domain, optional registrationUrl)
+     * @returns Promise resolved when the email is sent
+     */
+    handleTokenCreationEvent(tokenData: PatientToken, mailgunConfig: {
+        fromAddress: string;
+        domain: string;
+        registrationUrl?: string;
+    }): Promise<void>;
+}
+
 interface AppointmentEmailDataBase {
     appointment: Appointment;
     options?: {
@@ -4507,7 +4625,7 @@ interface ReviewAddedEmailData extends AppointmentEmailDataBase {
  */
 declare class AppointmentMailingService extends BaseMailingService {
     private readonly DEFAULT_MAILGUN_DOMAIN;
-    constructor(firestore: admin.firestore.Firestore, mailgunClient: NewMailgunClient$2);
+    constructor(firestore: admin.firestore.Firestore, mailgunClient: NewMailgunClient$3);
     /**
      * Formats a Firestore Timestamp in the clinic's timezone
      * @param timestamp - Firestore Timestamp (UTC)
@@ -4678,4 +4796,4 @@ declare class UserProfileAdminService {
     initializePractitionerRole(userId: string): Promise<User>;
 }
 
-export { ANALYTICS_COLLECTION, AnalyticsAdminService, type AnalyticsDateRange, type AnalyticsFilters, type AnalyticsMetadata, type AnalyticsPeriod, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AppointmentTrend, type AvailableSlot, BaseMailingService, type BaseMetrics, type BaseNotification, type BillingInfo, type BillingTransaction, BillingTransactionType, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CANCELLATION_ANALYTICS_SUBCOLLECTION, CLINICS_COLLECTION, CLINIC_ANALYTICS_SUBCOLLECTION, CalendarAdminService, type CancellationMetrics, type CancellationRateTrend, type CancellationReasonStats, type Clinic, type ClinicAdminNotificationData, ClinicAggregationService, type ClinicAnalytics, type ClinicComparisonMetrics, type ClinicInfo, type ClinicLocation, type CostPerPatientMetrics, type CreateBillingTransactionData, DASHBOARD_ANALYTICS_SUBCOLLECTION, type DashboardAnalytics, type DoctorInfo, DocumentManagerAdminService, type DurationTrend, type EntityType, type ExistingPractitionerInviteEmailData, ExistingPractitionerInviteMailingService, type FilledDocument, FilledFormsAggregationService, type GroupedAnalyticsBase, type GroupedPatientBehaviorMetrics, type GroupedPatientRetentionMetrics, type GroupedPractitionerPerformanceMetrics, type GroupedProcedurePerformanceMetrics, type GroupedProductUsageMetrics, type GroupedRevenueMetrics, type GroupedTimeEfficiencyMetrics, type GroupingPeriod, type InitializeAppointmentFormsResult, Logger, NOTIFICATIONS_COLLECTION, NO_SHOW_ANALYTICS_SUBCOLLECTION, type NewMailgunClient$2 as NewMailgunClient, type NoShowMetrics, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENTS_COLLECTION, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, PATIENT_SENSITIVE_INFO_COLLECTION, PRACTITIONER_ANALYTICS_SUBCOLLECTION, PROCEDURE_ANALYTICS_SUBCOLLECTION, type PatientProfile as Patient, PatientAggregationService, type PatientAnalytics, PatientInstructionStatus, type PatientLifetimeValueMetrics, type PatientProfile, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientRetentionMetrics, type PatientSensitiveInfo, type PaymentStatusBreakdown, type PlanDetails, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, type PractitionerAnalytics, type PractitionerInvite, PractitionerInviteAggregationService, type PractitionerInviteEmailData, PractitionerInviteMailingService, PractitionerInviteStatus, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureAnalytics, type ProcedurePopularity, type ProcedureProfitability, type ProcedureSummaryInfo, type ProductRevenueMetrics, type ProductUsageByProcedure, type ProductUsageMetrics, REVENUE_ANALYTICS_SUBCOLLECTION, type ReadStoredAnalyticsOptions, type RequirementSourceProcedure, type RevenueMetrics, type RevenueTrend, type Review, type ReviewAddedEmailData, type ReviewMetrics, type ReviewRequestEmailData, type ReviewTrend, ReviewsAggregationService, type StoredCancellationMetrics, type StoredClinicAnalytics, type StoredDashboardAnalytics, type StoredNoShowMetrics, type StoredPractitionerAnalytics, type StoredProcedureAnalytics, type StoredRevenueMetrics, type StoredTimeEfficiencyMetrics, type StripeTransactionData, SubscriptionStatus, TIME_EFFICIENCY_ANALYTICS_SUBCOLLECTION, type TimeEfficiencyMetrics, type TimeInterval, type TrendPeriod, UserProfileAdminService, UserRole, freeConsultationInfrastructure };
+export { ANALYTICS_COLLECTION, AnalyticsAdminService, type AnalyticsDateRange, type AnalyticsFilters, type AnalyticsMetadata, type AnalyticsPeriod, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AppointmentTrend, type AvailableSlot, BaseMailingService, type BaseMetrics, type BaseNotification, type BillingInfo, type BillingTransaction, BillingTransactionType, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CANCELLATION_ANALYTICS_SUBCOLLECTION, CLINICS_COLLECTION, CLINIC_ANALYTICS_SUBCOLLECTION, CalendarAdminService, type CancellationMetrics, type CancellationRateTrend, type CancellationReasonStats, type Clinic, type ClinicAdminNotificationData, ClinicAggregationService, type ClinicAnalytics, type ClinicComparisonMetrics, type ClinicInfo, type ClinicLocation, type CostPerPatientMetrics, type CreateBillingTransactionData, DASHBOARD_ANALYTICS_SUBCOLLECTION, type DashboardAnalytics, type DoctorInfo, DocumentManagerAdminService, type DurationTrend, type EntityType, type ExistingPractitionerInviteEmailData, ExistingPractitionerInviteMailingService, type FilledDocument, FilledFormsAggregationService, type GroupedAnalyticsBase, type GroupedPatientBehaviorMetrics, type GroupedPatientRetentionMetrics, type GroupedPractitionerPerformanceMetrics, type GroupedProcedurePerformanceMetrics, type GroupedProductUsageMetrics, type GroupedRevenueMetrics, type GroupedTimeEfficiencyMetrics, type GroupingPeriod, INVITE_TOKENS_COLLECTION, type InitializeAppointmentFormsResult, Logger, NOTIFICATIONS_COLLECTION, NO_SHOW_ANALYTICS_SUBCOLLECTION, type NewMailgunClient$3 as NewMailgunClient, type NoShowMetrics, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENTS_COLLECTION, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, PATIENT_SENSITIVE_INFO_COLLECTION, PRACTITIONER_ANALYTICS_SUBCOLLECTION, PROCEDURE_ANALYTICS_SUBCOLLECTION, type PatientProfile as Patient, PatientAggregationService, type PatientAnalytics, PatientInstructionStatus, type PatientInviteEmailData, PatientInviteMailingService, type PatientLifetimeValueMetrics, type PatientProfile, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientRetentionMetrics, type PatientSensitiveInfo, type PatientToken, PatientTokenStatus, type PaymentStatusBreakdown, type PlanDetails, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, type PractitionerAnalytics, type PractitionerInvite, PractitionerInviteAggregationService, type PractitionerInviteEmailData, PractitionerInviteMailingService, PractitionerInviteStatus, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureAnalytics, type ProcedurePopularity, type ProcedureProfitability, type ProcedureSummaryInfo, type ProductRevenueMetrics, type ProductUsageByProcedure, type ProductUsageMetrics, REVENUE_ANALYTICS_SUBCOLLECTION, type ReadStoredAnalyticsOptions, type RequirementSourceProcedure, type RevenueMetrics, type RevenueTrend, type Review, type ReviewAddedEmailData, type ReviewMetrics, type ReviewRequestEmailData, type ReviewTrend, ReviewsAggregationService, type StoredCancellationMetrics, type StoredClinicAnalytics, type StoredDashboardAnalytics, type StoredNoShowMetrics, type StoredPractitionerAnalytics, type StoredProcedureAnalytics, type StoredRevenueMetrics, type StoredTimeEfficiencyMetrics, type StripeTransactionData, SubscriptionStatus, TIME_EFFICIENCY_ANALYTICS_SUBCOLLECTION, type TimeEfficiencyMetrics, type TimeInterval, type TrendPeriod, UserProfileAdminService, UserRole, freeConsultationInfrastructure };